<?php

/**
 * Класс Builder.
 *
 * @package energine
 * @subpackage core
 * @author dr.Pavka
 * @copyright ColoCall 2006
 * @version $Id: Builder.class.php,v 1.7 2008/03/14 15:18:41 pavka Exp $
 */

//require_once('core/framework/DBWorker.class.php');
//require_once('core/framework/DataDescription.class.php');
//require_once('core/framework/Data.class.php');

/**
 * Построитель.
 * Создаёт XML-документ основываясь на переданных ему данных и мета-данных.
 *
 * @package energine
 * @subpackage core
 * @abstract
 */
abstract class Builder extends DBWorker {

    /**
     * @access protected
     * @var DataDescription мета-данные
     */
    protected $dataDescription;

    /**
     * @access protected
     * @var Data данные
     */
    protected $data;

    /**
     * @access protected
     * @var DOMDocument результирующий документ
     */
    protected $result;

    /**
     * Конструктор класса.
     *
     * @access public
     * @return void
     */
    public function __construct() {
        parent::__construct();

        $this->dataDescription = false;
        $this->data = false;
        $this->result = new DOMDocument('1.0', 'UTF-8');
    }

    /**
     * Устанавливает мета-данные.
     *
     * @access public
     * @param DataDescription $dataDescription мета-данные
     * @return void
     */
    public function setDataDescription(DataDescription $dataDescription) {
        $this->dataDescription = $dataDescription;
    }

    /**
     * Устанавливает данные.
     *
     * @access public
     * @param Data $data данные
     * @return void
     */
    public function setData(Data $data) {
        $this->data = $data;
    }

    /**
     * Создаёт результирующий XML-документ.
     *
     * @access public
     * @return boolean
     */
    public function build() {
        // если отсутствует описание данных - построение невозможно
        if ($this->dataDescription == false) {
            throw new SystemException('ERR_DEV_NO_DATA_DESCRIPTION', SystemException::ERR_DEVELOPER);
        }
        $this->run();
        return ($this->result instanceof DOMDocument ? true : false);
    }

    /**
     * Возвращает результат работы построителя.
     *
     * @access public
     * @return DOMNode
     */
    public function getResult() {
        return $this->result->documentElement;
    }

    /**
     * Используется в производных классах для построения результата.
     * Результат должен быть записан в Builder::$result.
     *
     * @access protected
     * @return void
     */
    protected function run() {
    }

    /**
     * Создаёт XML-описание поля данных.
     *
     * @access protected
     * @param string $fieldName
     * @param FieldDescription $fieldInfo
     * @param mixed $fieldValue
     * @param mixed $fieldProperties
     * @return DOMNode
     */
     protected function createField($fieldName, FieldDescription $fieldInfo, $fieldValue = false, $fieldProperties = false) {
        $result = $this->result->createElement('field');
        $result->setAttribute('name', $fieldName);
        $result->setAttribute('type', $fieldInfo->getType());
        $length = $fieldInfo->getLength();
        if ($length !== true) {
            $result->setAttribute('length', $length);
        }
        $result->setAttribute('mode', $fieldInfo->getMode());

        foreach ($fieldInfo->getPropertyNames() as $propName) {
            $propValue = $fieldInfo->getPropertyValue($propName);
            if ($propValue != '' && !is_array($propValue)) {
                $result->setAttribute($propName, $propValue);
            }
        }

        if ($fieldProperties) {
        	foreach ($fieldProperties as $propName => $propValue) {
        		$result->setAttribute($propName, $propValue);
        	}
        }

        if ($fieldValue instanceof DOMNode) {
            try {
        	   $result->appendChild($fieldValue);
            }
            catch (Exception $e) {
                $result->appendChild($this->result->importNode($fieldValue,true));
            }
        }
        elseif ($fieldValue !== false) {
            if (!empty($fieldValue)) {
                switch ($fieldInfo->getType()) {
                    case FieldDescription::FIELD_TYPE_DATETIME:
                    case FieldDescription::FIELD_TYPE_DATE:
                    case FieldDescription::FIELD_TYPE_HIDDEN:
                            try {
                                $fieldValue = @strftime($fieldInfo->getPropertyValue('outputFormat'), $fieldValue);
                            }
                            catch (Exception  $dummy){};
                        break;
                    default: // not used
                }
            }
            $result->nodeValue = str_replace('&', '&amp;', $fieldValue);
        }

        return $result;
     }

    /**
     * Создает набор возможных значений поля типа select.
     *
     * @access protected
     * @param FieldDescription $fieldInfo
     * @param mixed $data
     * @return DOMNode
     */
    protected function createOptions(FieldDescription $fieldInfo, $data = false) {
        $fieldValue = $this->result->createElement('options');
        if(is_array($fieldInfo->getAvailableValues()))
        foreach ($fieldInfo->getAvailableValues() as $key => $option) {
            $dom_option = $this->result->createElement('option', str_replace('&', '&amp;', $option['value']));
            $dom_option->setAttribute('id', $key);
            if ($option['attributes']) {
                foreach ($option['attributes'] as $attrName => $attrValue) {
                    $dom_option->setAttribute($attrName, $attrValue);
                }
            }
            // для поля типа multi-select
            if (is_array($data) && in_array($key, $data)) {
                $dom_option->setAttribute('selected', 'selected');
            }
            $fieldValue->appendChild($dom_option);
        }
        return $fieldValue;
    }
}