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

Class: Component

Source Location: /framework/Component.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --Component

Компонент страницы.


Author(s):

  • 1m.dm

Variables

Constants

Methods


Child classes:

Remover
Класс которому передается имя компонента, который необходимо удалить Класс используется для случаев, когда пользователи с разными правми должны видеть разные компоненты
DataSet
Предок для формы, списка, и дерева; содержит методы работы с панелью инструментов и набором данных.

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 25]
Компонент страницы.



Tags:

author:   1m.dm


[ Top ]


Class Variables

$action =  self::DEFAULT_ACTION_NAME

[line 117]



Tags:

var:   имя текущего действия компонента
access:   private

Type:   string


[ Top ]

$actionParams =  false

[line 89]



Tags:

var:   параметры действия
access:   private

Type:   array


[ Top ]

$builder =  false

[line 123]



Tags:

var:   построитель результата работы компонента
access:   private

Type:   Builder


[ Top ]

$config =

[line 129]



Tags:

var:   конфигурация компонента
access:   protected

Type:   ComponentConfig


[ Top ]

$doc =

[line 35]



Tags:

var:   DOM-документ компонента
access:   protected

Type:   DOMDocument


[ Top ]

$document =

[line 53]



Tags:

var:   документ страницы
access:   public

Type:   Document


[ Top ]

$enabled =  true

[line 84]



Tags:

var:   Флаг, указывающий на то, является ли компонент активным
access:   private

Type:   boolean


[ Top ]

$errors = array()

[line 101]



Tags:

var:   список ошибок, произошедших во время работы компонента
access:   private

Type:   array


[ Top ]

$module =

[line 59]



Tags:

var:   имя модуля, которому принадлежит компонент
access:   protected

Type:   string


[ Top ]

$name =

[line 77]



Tags:

var:   имя компонента
access:   private

Type:   string


[ Top ]

$params =

[line 47]



Tags:

var:   параметры компонента
access:   protected

Type:   array


[ Top ]

$properties = array()

[line 95]



Tags:

var:   свойства компонента
access:   private

Type:   array


[ Top ]

$request =

[line 41]



Tags:

var:   экземпляр объекта Request
access:   protected

Type:   Request


[ Top ]

$response =

[line 65]



Tags:

var:   экземпляр объекта Response
access:   protected

Type:   Response


[ Top ]

$result =

[line 111]

Результат является объектом класса DOMNode или boolean: true - компонент отработал успешно, но ничего не вывел; false - произошла ошибка при работе компонента.



Tags:

var:   результат работы компонента
access:   private

Type:   mixed


[ Top ]

$rights =

[line 71]



Tags:

var:   уровень прав, необходимый для запуска метода компонента
access:   private

Type:   int


[ Top ]



Class Methods


constructor __construct [line 141]

void __construct( string $name, string $module, Document $document, [ $params = null])

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



Tags:

access:   public


Overridden in child classes as:

Remover::__construct()
Конструктор класса.
DataSet::__construct()
Конструктор класса
RestorePassword::__construct()
Конструктор класса
LoginForm::__construct()
Конструктор
PriceLoader::__construct()
Конструктор класса
BasketList::__construct()
Конструктор класса
BasketForm::__construct()
Конструктор класса
ManufacturerList::__construct()
Конструктор класса
ImageManager::__construct()
ChildDivisions::__construct()
Конструктор класса
ProductDivisions::__construct()
Конструктор класса
BrotherDivisions::__construct()
Конструктор класса
BreadCrumbs::__construct()
Конструктор класса
TextBlock::__construct()
Конструктор класса
MainMenu::__construct()
Конструктор класса
FileLibrary::__construct()
Конструктор класса
SitemapTree::__construct()
Конструктор класса
CatalogueTree::__construct()
Конструктор класса
GoogleSitemap::__construct()
Конструктор класса
TextBlockSource::__construct()
DBDataSet::__construct()
Конструктор класса
Register::__construct()
Конструктор класса
UserProfile::__construct()
Конструктор класса
OrderForm::__construct()
Конструктор класса
ProductList::__construct()
Конструктор класса
CurrencySwitcher::__construct()
Конструктор класса
Feed::__construct()
Конструктор класса
GalleryFeed::__construct()
Конструктор класса
NewsFeed::__construct()
Конструктор класса
FeedbackForm::__construct()
Конструктор класса
Grid::__construct()
Конструктор класса
UserEditor::__construct()
Конструктор класса
RoleEditor::__construct()
Конструктор класса
DiscountsEditor::__construct()
Конструктор класса
ProductEditor::__construct()
Конструктор класса
ManufacturersEditor::__construct()
Конструктор класса
ProductStatusEditor::__construct()
Конструктор класса
ParamValuesEditor::__construct()
Конструктор класса
CurrencyEditor::__construct()
Конструктор класса
OrderStatuses::__construct()
Конструктор класса
OrderHistory::__construct()
Конструктор класса
UserOrderHistory::__construct()
Конструктор класса
OrderDetails::__construct()
Конструктор класса
ProductTypeEditor::__construct()
Конструктор класса
ProductParamsEditor::__construct()
Конструктор класса
TranslationEditor::__construct()
Конструктор класса
FeedEditor::__construct()
Конструктор класса
GalleryEditor::__construct()
Конструктор класса
NewsEditor::__construct()
Конструктор класса
FeedbackList::__construct()
Конструктор класса
DivisionEditor::__construct()
Конструктор класса
TemplateEditor::__construct()
Конструктор класса
LanguageEditor::__construct()
Конструктор класса
LangSwitcher::__construct()
Конструктор класса

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

Parameters:

string   $name  
string   $module  
Document   $document  
array   $params  

[ Top ]

method build [line 483]

DOMDocument build( )

Строит результат работы компонента используя определённый построитель.



Tags:

access:   public


Overridden in child classes as:

DataSet::build()
Проверяет наличие пострителя передает ему данные и описание данны
TextBlock::build()
Для метода вывода редактора изображений вызывает построитель редактора изоборажений во всех других случаях - свой
ProductList::build()
Добавлена паенль поиска товаров
Grid::build()
Переопределенный метод построения Перед построением - добавляется перевод После построения добавляется информация о закладках
RoleEditor::build()
Переопределенный метод Для формы редактирования, если чекбоксы ролей по умолчанию отмечены делает их неактивными
ProductEditor::build()
Для метода showTree вызывается свой билдер
OrderHistory::build()
Выводим детали заказа
ProductTypeEditor::build()
Для метода showParams вызывается свой билдер
FeedEditor::build()
Для метода main убираем вызов построителя
DivisionEditor::build()
Для метода setPageRights если раздел который редактируется - системный то дизейблятся вкладки с правами Для метода show слешатся имена разделов Для формы редактирования делается неактивным переключатель smap_default
LanguageEditor::build()
Переопределенный метод Для формы редактирования, если чекбокс языка по умолчания отмечен делает его неактивным

[ Top ]

method defineParams [line 234]

array defineParams( )

Определяет допустимые параметры компонента и их значения по-умолчанию в виде массива array(paramName => defaultValue).



Tags:

access:   protected


Overridden in child classes as:

Remover::defineParams()
Добавлен параметр имя компонента
DataSet::defineParams()
Добавлены: Параметр datasetAction Параметр recordsPerPage
RestorePassword::defineParams()
Переопределен параметр active
LoginForm::defineParams()
Добавлены: Параметр successAction - УРЛ на который происходит переадресация в случае успеха
PriceLoader::defineParams()
Переопределен параметр active
ChildDivisions::defineParams()
Добавлен параметр id - идентификатор страницы
ProductDivisions::defineParams()
Параметр active выставлен в false
TextBlock::defineParams()
Добавлен параметр num
FileLibrary::defineParams()
Переопределен параметр active
DBDataSet::defineParams()
Добавлен параметр tableName
Register::defineParams()
Переопределен параметр active
UserProfile::defineParams()
Переопределен параметр active
OrderForm::defineParams()
Переопределен параметр active
ProductList::defineParams()
Добавлен параметр smapID
CurrencySwitcher::defineParams()
Добавлен параметр id - идентификатор страницы
Feed::defineParams()
Делаем компонент активным
FeedbackForm::defineParams()
Переопределен параметр active
Grid::defineParams()
Переопределен параметр configFilename
ParamValuesEditor::defineParams()
Добавлен параметр идентификатор продукта
OrderDetails::defineParams()
Добавляет параметр идентификатор заказа
ProductParamsEditor::defineParams()
Добавлены: Параметр productTypeID
FeedEditor::defineParams()
Добавляем параметр - имя связанного компонента

[ Top ]

method determineAction [line 296]

void determineAction( )

Определяет текущее действие



Tags:

access:   protected


[ Top ]

method disable [line 410]

void disable( )

Отключает отображение компонента



Tags:

final:  
access:   public


[ Top ]

method enable [line 422]

void enable( )

Включает отображение компонента



Tags:

final:  
access:   public


[ Top ]

method enabled [line 434]

boolean enabled( )

Возвращает активность компонента



Tags:

final:  
access:   public


[ Top ]

method generateError [line 523]

void generateError( int $errorType, string $errorMessage, [mixed $errorCustomInfo = false])

Генерирует ошибку и добавляет её в список ошибок компонента.



Tags:

access:   protected


Overridden in child classes as:

Grid::generateError()
Переписан родительский метод генерации ошибки, поскольку для AJAX такая не подходит

Parameters:

int   $errorType   тип ошибки
string   $errorMessage   сообщение об ошибке
mixed   $errorCustomInfo   дополнительная информация об ошибке

[ Top ]

method getAction [line 337]

string getAction( )

Определяет имя текущего действия компонента.



Tags:

final:  
access:   public


[ Top ]

method getActionParams [line 588]

array getActionParams( )

Возвращает параметры действия.



Tags:

access:   protected


[ Top ]

method getBuilder [line 223]

Builder getBuilder( )

Возвращает построитель компонента.



Tags:

final:  
access:   protected


[ Top ]

method getMethodRights [line 349]

int getMethodRights( )

Возвращает уровень прав пользователя, необходимых для запуска текущего действия компонента.



Tags:

final:  
access:   public


[ Top ]

method getName [line 360]

string getName( )

Возвращает имя компонента.



Tags:

final:  
access:   public


[ Top ]

method getParam [line 285]

mixed getParam( string $name)

Возвращает значение параметра компонента, или null, если такого параметра не существует.



Tags:

final:  
access:   protected


Parameters:

string   $name  

[ Top ]

method getProperty [line 458]

mixed getProperty( string $propName)

Возвращает значение свойства компонента.



Tags:

final:  
access:   protected


Parameters:

string   $propName  

[ Top ]

method handleErrors [line 547]

mixed handleErrors( )

Обрабатывает ошибки, произошедшие во время работы компонента.

Возвращает DOMDocument, представляющий ошибки компонента, или false, если никаких ошибок не произошло.




Tags:

final:  
access:   public


[ Top ]

method isActive [line 199]

bool isActive( )

Возвращает флаг активности компонента



Tags:

final:  
access:   protected


[ Top ]

method main [line 388]

boolean main( )

Действие по-умолчанию.



Tags:

access:   protected


Overridden in child classes as:

Remover::main()
Дизейблит компонент
PriceLoader::main()
Добавляем вкладку
BasketForm::main()
Выводим данные корзины
TextBlock::main()
Загрузка данных
FileLibrary::main()
Method Description
UserProfile::main()
Действие по умолчанию
OrderForm::main()
Если корзина - пуста то что заказывать?
CurrencySwitcher::main()
Method Description
Feed::main()
Фильтруем по разделам
NewsFeed::main()
Добавляем поле - флаг указывающий на то - существует ли текст новости
Grid::main()
Добавлены переводы для фильтра
FeedEditor::main()
Убираем все лишнее
DivisionEditor::main()
Добавлен перевод для корня дерева разделов

[ Top ]

method prepare [line 400]

void prepare( )

Метод подготовки данных.

Вызывается вначале работы метода, реализующего основное действие.




Tags:

access:   protected


Overridden in child classes as:

DataSet::prepare()
Подготовительные действия перед вызовом основного действия.
Register::prepare()
Получает список доступных полей из таблицы пользователей и генерит форму
DiscountsEditor::prepare()
ProductEditor::prepare()
Для метода редактирования изменяем данные для поля smap_id
TranslationEditor::prepare()
DivisionEditor::prepare()
Подменяем построитель для метода setPageRights

[ Top ]

method removeProperty [line 474]

void removeProperty( string $propName)

Удаляет свойство компонента.



Tags:

final:  
access:   protected


Parameters:

string   $propName  

[ Top ]

method run [line 371]

void run( )

Запускает компонент на исполнение.



Tags:

final:  
access:   public


[ Top ]

method setBuilder [line 212]

void setBuilder( Builder $builder)

Устанавливает построитель компонента.



Tags:

final:  
access:   protected


Parameters:

Builder   $builder  

[ Top ]

method setParam [line 252]

void setParam( string $name, mixed $value)

Устанавливает значение параметра компонента, если такой существует.

В противном случае возбуждается исключение.




Tags:

access:   protected


Overridden in child classes as:

DBDataSet::setParam()
Для параметра tableName устанавливаем еще и имя таблицы переводов

Parameters:

string   $name  
mixed   $value  

[ Top ]

method setProperty [line 446]

void setProperty( string $propName, mixed $propValue)

Устанавливает значение свойства компонента.



Tags:

final:  
access:   protected


Parameters:

string   $propName  
mixed   $propValue  

[ Top ]


Class Constants

DEFAULT_ACTION_NAME =  'main'

[line 30]

Имя действия по-умолчанию.


[ Top ]


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