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

Class: DataSet

Source Location: /modules/share/components/DataSet.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --Component
         |
         --DataSet

Предок для формы, списка, и дерева; содержит методы работы с панелью инструментов и набором данных.


Author(s):

  • dr.Pavka

Variables

Constants

Methods


Child classes:

RestorePassword
Форма восстановления пароля
LoginForm
Вывод формы авторизации
PriceLoader
Класс для загрузки прайса
BasketList
Класс выводящий содержимое корзины, не для редактирования
BasketForm
Корзина с выбранными продуктами
ManufacturerList
Класс выводящий список производителей для раздела каталога
ImageManager
Менеджер изображений.
ChildDivisions
Класс передназначен для вівода дочерних разделов текущего раздела
BreadCrumbs
"Хлебные крошки"
TextBlock
Текстовый блок.
MainMenu
Класс выводит главное меню(меню первого уровня)
FileLibrary
Библитека изображений
SitemapTree
Карта сайта
TextBlockSource
Исходный код текстового блока.
DBDataSet
Класс позволяющий выводить данные из БД
LangSwitcher
переключатель языков

Inherited Constants

Inherited Variables

Inherited Methods

Class: Component

Component::__construct()
Конструктор класса.
Component::build()
Строит результат работы компонента используя определённый построитель.
Component::defineParams()
Определяет допустимые параметры компонента и их значения по-умолчанию в виде массива array(paramName => defaultValue).
Component::determineAction()
Определяет текущее действие
Component::disable()
Отключает отображение компонента
Component::enable()
Включает отображение компонента
Component::enabled()
Возвращает активность компонента
Component::generateError()
Генерирует ошибку и добавляет её в список ошибок компонента.
Component::getAction()
Определяет имя текущего действия компонента.
Component::getActionParams()
Возвращает параметры действия.
Component::getBuilder()
Возвращает построитель компонента.
Component::getMethodRights()
Возвращает уровень прав пользователя, необходимых для запуска текущего действия компонента.
Component::getName()
Возвращает имя компонента.
Component::getParam()
Возвращает значение параметра компонента, или null, если такого параметра не существует.
Component::getProperty()
Возвращает значение свойства компонента.
Component::handleErrors()
Обрабатывает ошибки, произошедшие во время работы компонента.
Component::isActive()
Возвращает флаг активности компонента
Component::main()
Действие по-умолчанию.
Component::prepare()
Метод подготовки данных.
Component::removeProperty()
Удаляет свойство компонента.
Component::run()
Запускает компонент на исполнение.
Component::setBuilder()
Устанавливает построитель компонента.
Component::setParam()
Устанавливает значение параметра компонента, если такой существует.
Component::setProperty()
Устанавливает значение свойства компонента.

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 27]
Предок для формы, списка, и дерева; содержит методы работы с панелью инструментов и набором данных.



Tags:

author:   dr.Pavka
abstract:  


[ Top ]


Class Variables

$data =  false

[line 68]

Данные



Tags:

access:   private

Type:   Data


[ Top ]

$dataDescription =  false

[line 60]

Описание данных



Tags:

access:   private

Type:   DataDescription


[ Top ]

$js =

[line 84]

JavaScript



Tags:

access:   protected

Type:   DOMNode


[ Top ]

$pager =

[line 108]

Список страниц (pager)



Tags:

access:   protected

Type:   Pager


[ Top ]

$toolbar = array()

[line 76]

Панели инструментов



Tags:

var:   of Toolbar
access:   private

Type:   array


[ Top ]

$type =

[line 92]

Тип компонента



Tags:

access:   private

Type:   string


[ Top ]



Class Methods


static method cleanupHTML [line 668]

static string cleanupHTML( string $data)

Удаляет потенциально опасный и лишний HTML код



Tags:

access:   public


Parameters:

string   $data  

[ Top ]

method addToolbar [line 196]

void addToolbar( mixed $toolbar)

Устанавливает объекты тулбара



Tags:

access:   protected


Parameters:

mixed   $toolbar  

[ Top ]

method addTranslation [line 563]

void addTranslation( $tag)

Добавляет переводы



Tags:

final:  
access:   protected


Parameters:

   $tag  

[ Top ]

method addWYSIWYGTranslations [line 627]

void addWYSIWYGTranslations( )

Добавляет переводы для тулбара WYSIWYG вызывается в потомках



Tags:

final:  
access:   protected


[ Top ]

method build [line 383]

DOMDocument build( )

Проверяет наличие пострителя передает ему данные и описание данны



Tags:

access:   public


Overridden in child classes as:

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()
Переопределенный метод Для формы редактирования, если чекбокс языка по умолчания отмечен делает его неактивным

Overrides Component::build() (Строит результат работы компонента используя определённый построитель.)

[ Top ]

method buildJS [line 451]

DOMNode buildJS( )

Строит описание JS объектов



Tags:

access:   protected


Overridden in child classes as:

TextBlock::buildJS()
Строит JS описание

[ Top ]

method cleanup [line 612]

void cleanup( )

Чистка от лишних и вердоносных html тегов Вызывается в single режиме



Tags:

access:   protected


[ Top ]

constructor __construct [line 116]

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

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



Tags:

access:   public


Overridden in child classes as:

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 Component::__construct() (Конструктор класса.)

Parameters:

   $name  
   $module  
Document   $document  
array   $params  

[ Top ]

method createBuilder [line 271]

Builder createBuilder( )

Создает построитель



Tags:

access:   protected


Overridden in child classes as:

SitemapTree::createBuilder()
Переопределяет посторитель
DBDataSet::createBuilder()
Для мультиязычного грида подменяем построитель

[ Top ]

method createData [line 431]

Data createData( )

Загружает данные



Tags:

access:   protected


Overridden in child classes as:

ChildDivisions::createData()
TextBlock::createData()
Создаем свои данные
UserProfile::createData()
Для метода success создаем свой объект данных
OrderForm::createData()
Если пользователь аутентифицирован загружаем его данные из объекта AuthUser
ProductList::createData()
Для поля producer_id вместо ключа выводится значение а ключ пишется в аттрибут
UserEditor::createData()
Для методов add и edit добавляется инфо о роли
RoleEditor::createData()
Для методов add и edit добавляется инфо о роли
FeedEditor::createData()
Определяем данные для smap_id

[ Top ]

method createDataDescription [line 281]

DataDescription createDataDescription( )

Создаем объект описания данных



Tags:

access:   protected


Overridden in child classes as:

BasketForm::createDataDescription()
Для поля product_id изменяем тип
ManufacturerList::createDataDescription()
Перечень полей
ImageManager::createDataDescription()
ChildDivisions::createDataDescription()
Устанавливаем перечень полей
ProductDivisions::createDataDescription()
Добавлено поле количество продуктов
BrotherDivisions::createDataDescription()
Убираем DescriptionRtf
BreadCrumbs::createDataDescription()
Поскольку изменение перечня полей невозможно, принудительно выставляем необходимые значения
TextBlock::createDataDescription()
Переопределен метод создания объекта мета данных
MainMenu::createDataDescription()
Принудительно выставляем необходимый перечень полей
DBDataSet::createDataDescription()
добавлена обработка ключей
UserProfile::createDataDescription()
Для метода success переопределен метод создания объекта метаданных
ProductList::createDataDescription()
Поле producer_id в списке должно выводиться как текст
Feed::createDataDescription()
Убираем smap_id
Grid::createDataDescription()
Если поле OrderColumn присутствует в списке, убираем его
UserEditor::createDataDescription()
Для методов add и edit добавляется поле роли
RoleEditor::createDataDescription()
Добавляется fake поле user_div_rights в котором находятся данные
ProductEditor::createDataDescription()
Для поля smap_id формируется Дерево разделов Добавляются поля product_price, curr_id
ParamValuesEditor::createDataDescription()
В зависимости от типа продукта выставляется тип поля ppv_value
CurrencyEditor::createDataDescription()
OrderHistory::createDataDescription()
Формат даты создания заказа
ProductParamsEditor::createDataDescription()
Поле pp_type сделано selectом
FeedEditor::createDataDescription()
Для форм поле smap_id віводим как string
DivisionEditor::createDataDescription()
Для setRole создаем свое описание данных Для поля smap_pid формируется Дерево разделов
TemplateEditor::createDataDescription()
LanguageEditor::createDataDescription()
Добавляем паттерн и сообщение об ошибке для описания поля lang_abbr. Поле должно содержать две маленькие латинские буквы
LangSwitcher::createDataDescription()
Создаем перечень полей

[ Top ]

method createPager [line 336]

void createPager( )

Создает листалку



Tags:

access:   protected


Overridden in child classes as:

ProductList::createPager()
Переписан родительский метод Для метода showManufacturer изменяет принцип получения actionParams

[ Top ]

method createToolbar [line 311]

array createToolbar( )

Создание панелей инструментов



Tags:

access:   protected


Overridden in child classes as:

TextBlock::createToolbar()
Создание панели инструментов

[ Top ]

method defineParams [line 135]

array defineParams( )

Добавлены: Параметр datasetAction Параметр recordsPerPage



Tags:

access:   protected


Overridden in child classes as:

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()
Добавляем параметр - имя связанного компонента

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

[ Top ]

method downloadFile [line 598]

void downloadFile( $data $data, $MIMEType $MIMEType, $fileName $fileName)

Метод возвращает файл



Tags:

final:  
access:   protected


Parameters:

$data   $data   string данные файла
$MIMEType   $MIMEType   string тип файла
$fileName   $fileName   string имя файла

[ Top ]

method formatDate [line 575]

void formatDate( )

Метод используется для форматирования даты и времени в полях date и datetime Запрашивается через AJAX Получает данные из POST и возвращает строку даты



Tags:

final:  
access:   protected


[ Top ]

method getData [line 165]

Data getData( )

Возвращает объект данных



Tags:

final:  
access:   protected


[ Top ]

method getDataDescription [line 227]

DataDescription getDataDescription( )

Возвращает описание данных



Tags:

final:  
access:   protected


[ Top ]

method getDataSetAction [line 508]

string getDataSetAction( )

Возвращает адрес обработчика формы



Tags:

access:   protected


[ Top ]

method getTitle [line 551]

string getTitle( )

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



Tags:

access:   protected


[ Top ]

method getToolbar [line 177]

mixed getToolbar( [string $toolbarName = false])

Возвращает набор тулбаров



Tags:

return:   (array of ToolBar or Toolbar)
access:   protected


Parameters:

string   $toolbarName  

[ Top ]

method getType [line 533]

string getType( )

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



Tags:

access:   protected


[ Top ]

method loadData [line 361]

mixed loadData( )

Абстрактный метод загрузки данных



Tags:

access:   protected


Overridden in child classes as:

LoginForm::loadData()
BasketList::loadData()
Загружаем данные
BasketForm::loadData()
Загружаем цены
ManufacturerList::loadData()
Загрузка данных
ChildDivisions::loadData()
Переопределенный метод загрузки данных
ProductDivisions::loadData()
Добавляем значения количества продуктов
BrotherDivisions::loadData()
Переопределенный метод загрузки данных
BreadCrumbs::loadData()
Переопределенный метод загрузки данных
MainMenu::loadData()
Переопределенный метод загрузки данных
FileLibrary::loadData()
Метод загрузки данных
SitemapTree::loadData()
Загружает данные о дереве разделов
DBDataSet::loadData()
Переопределенный метод загрузки данных
ProductList::loadData()
Добавляет значение product_price(если есть в перечне полей
Grid::loadData()
Для действия main не выводим данные Для действия save определяем другой формат данных
UserEditor::loadData()
Для метода редактирования убирается пароль
RoleEditor::loadData()
Переопределенный метод сохранения
ProductEditor::loadData()
Для метода edit добавляем данные о полях из внешней таблицы
ParamValuesEditor::loadData()
Всегда выводятся все присвоенные этому типу параметра значения
UserOrderHistory::loadData()
Для вывода списка - вызываем дедовский метод загрузеи данных, поскольку в родиетльском работает AJAX
OrderDetails::loadData()
Загружает данные
DivisionEditor::loadData()
Добавляет данные об УРЛ
LanguageEditor::loadData()
Переопределенный метод сохранения
LangSwitcher::loadData()
Method Description

[ Top ]

method loadDataDescription [line 372]

mixed loadDataDescription( )

Абстрактный метод загрузки описания данных Используется для загрузки внешнего описания данных (не из конфигурации)



Tags:

access:   protected


Overridden in child classes as:

FileLibrary::loadDataDescription()
Загружает описание данных из таблицы
DBDataSet::loadDataDescription()
Переопределенный метод загрузки описания данных Возвращает информацию о колонках в основной таблице и таблице переводов
OrderForm::loadDataDescription()
Подтягиваем перечень полей из таблицы пользователей
UserEditor::loadDataDescription()
Load

[ Top ]

method prepare [line 248]

void prepare( )

Подготовительные действия перед вызовом основного действия.



Tags:

access:   protected


Overridden in child classes as:

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

Overrides Component::prepare() (Метод подготовки данных.)

[ Top ]

method setData [line 154]

void setData( Data $data)

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



Tags:

final:  
access:   protected


Parameters:

Data   $data  

[ Top ]

method setDataDescription [line 216]

void setDataDescription( DataDescription $dataDescription)

Устанавливает описание данных



Tags:

final:  
access:   protected


Parameters:

DataDescription   $dataDescription  

[ Top ]

method setDataSetAction [line 483]

void setDataSetAction( string $action, [bool $isFullURI = false])

Устанавливает адрес обработчика формы



Tags:

access:   protected


Parameters:

string   $action  
bool   $isFullURI  

[ Top ]

method setTitle [line 542]

void setTitle( string $title)

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



Tags:

access:   protected


Parameters:

string   $title  

[ Top ]

method setType [line 519]

void setType( string $type)

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



Tags:

access:   protected


Parameters:

string   $type  

[ Top ]


Class Constants

COMPONENT_TYPE_FORM =  'form'

[line 37]

Тип компонента - форма


[ Top ]

COMPONENT_TYPE_FORM_ADD =  QAL::INSERT

[line 42]

Тип формы - форма добавления


[ Top ]

COMPONENT_TYPE_FORM_ALTER =  QAL::UPDATE

[line 47]

Тип формы - форма редактирования


[ Top ]

COMPONENT_TYPE_LIST =  'list'

[line 32]

Тип компонента - список


[ Top ]

TB_PREFIX =  'toolbar_'

[line 52]

Префикс названия панели инструментов


[ Top ]


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