energine
[ class tree: energine ] [ index: energine ] [ all elements ]

Class: Builder

Source Location: /framework/Builder.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --Builder

Построитель.


Author(s):

  • dr.Pavka

Variables

Methods


Child classes:

JSONBuilder
Построитель данных в формат JSON (JavaScript Object Notation).
MultiLanguageBuilder
Построитель для мультиязычных компонентов.
TreeBuilder
Построитель древовидных данных.
SimpleBuilder
Построитель XML-документа.

Inherited Constants

Inherited Variables

Inherited Methods

Class: DBWorker

DBWorker::__construct()
Конструктор класса.
DBWorker::dateToString()
Дата прописью Обертка над DBWorker::_dateToString
DBWorker::translate()
Нестатический метод-обёртка над DBWorker::_translate - для удобства использования внутри производных классов.
DBWorker::_dateToString()
Возвращает дату в виде строки прописью
DBWorker::_translate()
Возвращает перевод текстовой константы из таблицы переводов для указанного языка. Если язык явно не указан - используется текущий язык.

Class: Object

Object::__construct()
Пустой конструктор
Object::getConfigValue()
Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer()
Возвращает значение счетчика времени выполнения.
Object::resetTimer()
Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer()
Запускает счетчик времени выполнения.
Object::stopTimer()
Останавливает счетчик времени выполнения.
Object::_getConfigValue()
Возвращает значение указанного параметра конфигурации.

Class Details

[line 23]
Построитель.

Создаёт XML-документ основываясь на переданных ему данных и мета-данных.




Tags:

author:   dr.Pavka
abstract:  


[ Top ]


Class Variables

$data =

[line 35]



Tags:

var:   данные
access:   protected

Type:   Data


[ Top ]

$dataDescription =

[line 29]



Tags:

var:   мета-данные
access:   protected

Type:   DataDescription


[ Top ]

$result =

[line 41]



Tags:

var:   результирующий документ
access:   protected

Type:   DOMDocument


[ Top ]



Class Methods


constructor __construct [line 49]

void __construct( )

Конструктор класса.



Tags:

access:   public


Overridden in child classes as:

JSONBuilder::__construct()
Конструктор класса.
JSONUploadBuilder::__construct()
Конструктор класса
JSONDivBuilder::__construct()
Конструктор класса
MultiLanguageBuilder::__construct()
Конструктор класса.
TreeBuilder::__construct()
Конструктор класса.
SimpleBuilder::__construct()
Конструктор класса.

Overrides DBWorker::__construct() (Конструктор класса.)

[ Top ]

method build [line 84]

boolean build( )

Создаёт результирующий XML-документ.



Tags:

access:   public


Overridden in child classes as:

JSONBuilder::build()
Создает результирующий JSON-объект.

[ Top ]

method createField [line 125]

DOMNode createField( string $fieldName, FieldDescription $fieldInfo, [mixed $fieldValue = false], [mixed $fieldProperties = false])

Создаёт XML-описание поля данных.



Tags:

access:   protected


Parameters:

string   $fieldName  
FieldDescription   $fieldInfo  
mixed   $fieldValue  
mixed   $fieldProperties  

[ Top ]

method createOptions [line 217]

DOMNode createOptions( FieldDescription $fieldInfo, [mixed $data = false])

Создает набор возможных значений поля типа select.



Tags:

access:   protected


Parameters:

FieldDescription   $fieldInfo  
mixed   $data  

[ Top ]

method getResult [line 101]

DOMNode getResult( )

Возвращает результат работы построителя.



Tags:

access:   public


Overridden in child classes as:

JSONBuilder::getResult()
Возвращает результат работы построителя.
JSONUploadBuilder::getResult()
В ответ добавляется значение текущей директории
JSONDivBuilder::getResult()

[ Top ]

method run [line 112]

void run( )

Используется в производных классах для построения результата.

Результат должен быть записан в Builder::$result.




Tags:

access:   protected


Overridden in child classes as:

MultiLanguageBuilder::run()
Построение результата.
TreeBuilder::run()
Построение результата.
SimpleBuilder::run()
Построение результата.

[ Top ]

method setData [line 74]

void setData( Data $data)

Устанавливает данные.



Tags:

access:   public


Parameters:

Data   $data   данные

[ Top ]

method setDataDescription [line 63]

void setDataDescription( DataDescription $dataDescription)

Устанавливает мета-данные.



Tags:

access:   public


Parameters:

DataDescription   $dataDescription   мета-данные

[ Top ]

В создании документации нам помог: phpDocumentor