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

Class: DBDataSet

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

Class Overview

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

Класс позволяющий выводить данные из БД


Author(s):

  • dr.Pavka

Variables

Methods


Child classes:

Register
Форма регистрации
UserProfile
Форма редактирования данных пользователя
OrderForm
Предназначен для формирования заказа пользователем
ProductList
Выводит список продуктов для заданного раздела
CurrencySwitcher
Переключатель валют
Feed
Абстрактный класс предок для компонентов основывающихся на структуре сайта
FeedbackForm
Форма обратной связи
Grid
Сетка

Inherited Constants

Inherited Variables

Inherited Methods

Class: DataSet

DataSet::__construct()
Конструктор класса
DataSet::addToolbar()
Устанавливает объекты тулбара
DataSet::addTranslation()
Добавляет переводы
DataSet::addWYSIWYGTranslations()
Добавляет переводы для тулбара WYSIWYG вызывается в потомках
DataSet::build()
Проверяет наличие пострителя передает ему данные и описание данны
DataSet::buildJS()
Строит описание JS объектов
DataSet::cleanup()
Чистка от лишних и вердоносных html тегов Вызывается в single режиме
DataSet::cleanupHTML()
Удаляет потенциально опасный и лишний HTML код
DataSet::createBuilder()
Создает построитель
DataSet::createData()
Загружает данные
DataSet::createDataDescription()
Создаем объект описания данных
DataSet::createPager()
Создает листалку
DataSet::createToolbar()
Создание панелей инструментов
DataSet::defineParams()
Добавлены: Параметр datasetAction Параметр recordsPerPage
DataSet::downloadFile()
Метод возвращает файл
DataSet::formatDate()
Метод используется для форматирования даты и времени в полях date и datetime Запрашивается через AJAX Получает данные из POST и возвращает строку даты
DataSet::getData()
Возвращает объект данных
DataSet::getDataDescription()
Возвращает описание данных
DataSet::getDataSetAction()
Возвращает адрес обработчика формы
DataSet::getTitle()
Возвращает название компонента
DataSet::getToolbar()
Возвращает набор тулбаров
DataSet::getType()
Возвращает тип компонента
DataSet::loadData()
Абстрактный метод загрузки данных
DataSet::loadDataDescription()
Абстрактный метод загрузки описания данных Используется для загрузки внешнего описания данных (не из конфигурации)
DataSet::prepare()
Подготовительные действия перед вызовом основного действия.
DataSet::setData()
Устанавливает данные
DataSet::setDataDescription()
Устанавливает описание данных
DataSet::setDataSetAction()
Устанавливает адрес обработчика формы
DataSet::setTitle()
Устанавливает название компонента
DataSet::setType()
Устанавливает тип компонента

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 22]
Класс позволяющий выводить данные из БД



Tags:

author:   dr.Pavka


[ Top ]


Class Variables

$filter = array()

[line 46]

Условия выборки



Tags:

access:   private

Type:   array


[ Top ]

$limit =  null

[line 62]

Ограничение количества записей



Tags:

access:   private

Type:   array


[ Top ]

$order =  null

[line 54]

Условие сортировки



Tags:

access:   private

Type:   mixed


[ Top ]

$pk =  false

[line 38]

Имя поля первичного ключа



Tags:

access:   private

Type:   string


[ Top ]

$previousAction =  false

[line 71]

Действие которое исполнялось на предыдущем шаге используется в методе сохранения



Tags:

access:   private

Type:   string


[ Top ]

$translationTableName =  false

[line 30]

Имя таблицы содержащей переводы



Tags:

access:   private

Type:   string


[ Top ]



Class Methods


constructor __construct [line 78]

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

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



Tags:

access:   public


Overridden in child classes as:

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

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

Parameters:

   $name  
   $module  
Document   $document  
array   $params  

[ Top ]

method addFilterCondition [line 429]

void addFilterCondition( $filter)

Добавляет условие к фильтру



Tags:

access:   protected


Parameters:

   $filter  

[ Top ]

method clearFilter [line 447]

void clearFilter( )

Сброс фильтра



Tags:

final:  
access:   protected


[ Top ]

method createBuilder [line 554]

Builder createBuilder( )

Для мультиязычного грида подменяем построитель



Tags:

access:   protected


Overrides DataSet::createBuilder() (Создает построитель)

[ Top ]

method createDataDescription [line 571]

DataDescription createDataDescription( )

добавлена обработка ключей



Tags:

access:   protected


Overridden in child classes as:

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. Поле должно содержать две маленькие латинские буквы

Overrides DataSet::createDataDescription() (Создаем объект описания данных)

[ Top ]

method defineParams [line 90]

type defineParams( )

Добавлен параметр tableName



Tags:

access:   protected


Overridden in child classes as:

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 DataSet::defineParams() (Добавлены: Параметр datasetAction Параметр recordsPerPage)

[ Top ]

method getDataLanguage [line 191]

int getDataLanguage( )

Возвращает язык на которм берутся данные



Tags:

access:   protected


Overridden in child classes as:

Grid::getDataLanguage()
переписан родительский метод

[ Top ]

method getFilter [line 401]

mixed getFilter( )

Возвращает значение фильтра



Tags:

final:  
access:   public


[ Top ]

method getFKData [line 594]

array getFKData( $fkTableName, $fkKeyName)

Возвращает данные о значения в связанной таблицы



Tags:

access:   protected


Overridden in child classes as:

ProductEditor::getFKData()
Возвращает данные о значения в связанной таблицы Добавлена возможность вызвать окно "добавить производителя" из списка выбора

Parameters:

   $fkTableName  
   $fkKeyName  

[ Top ]

method getLimit [line 493]

array getLimit( )

Возвращает ограничения по количеству записей



Tags:

final:  
access:   protected


[ Top ]

method getOrder [line 459]

array getOrder( )

Возвращает условия сортровки



Tags:

final:  
access:   protected


[ Top ]

method getPK [line 520]

string getPK( )

Возвращает имя поля - первичного ключа



Tags:

final:  
access:   protected


[ Top ]

method getPreviousAction [line 661]

string getPreviousAction( )

Возвращает предыдущее действие



Tags:

final:  
access:   protected


[ Top ]

method getTableName [line 385]

string getTableName( )

Возвращает имя таблицы



Tags:

final:  
access:   protected


[ Top ]

method getTranslationTableName [line 606]

string getTranslationTableName( )

Возвращает имя таблицы переводов



Tags:

final:  
access:   protected


[ Top ]

method loadData [line 138]

array loadData( )

Переопределенный метод загрузки данных



Tags:

access:   protected


Overridden in child classes as:

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()
Переопределенный метод сохранения

Overrides DataSet::loadData() (Абстрактный метод загрузки данных)

[ Top ]

method loadDataDescription [line 107]

array loadDataDescription( )

Переопределенный метод загрузки описания данных Возвращает информацию о колонках в основной таблице и таблице переводов



Tags:

access:   protected


Overridden in child classes as:

OrderForm::loadDataDescription()
Подтягиваем перечень полей из таблицы пользователей
UserEditor::loadDataDescription()
Load

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

[ Top ]

method multiLoadData [line 206]

array multiLoadData( )

Загрузка мультиязычных данных



Tags:

access:   private


[ Top ]

method recordExists [line 644]

void recordExists( string $id, [mixed $fieldName = false])

Определяет существует ли запись с идентификатором переданным в параметре Вызывается из методов где нужно быть уверенным в наличии записи(view, edit,delete)



Tags:

final:  
access:   protected


Parameters:

string   $id  
mixed   $fieldName  

[ Top ]

method setFilter [line 415]

void setFilter( mixed $filter)

Устанавливает значение фильтра



Tags:

see:   QAL::select()
final:  
access:   protected


Parameters:

mixed   $filter  

[ Top ]

method setLimit [line 506]

void setLimit( $limit)

Устанавливает ограничения по количеству записей



Tags:

final:  
access:   protected


Parameters:

array   $limit  

[ Top ]

method setOrder [line 472]

void setOrder( mixed $order)

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



Tags:

final:  
access:   protected


Parameters:

mixed   $order  

[ Top ]

method setParam [line 370]

void setParam( string $name, mixed $value)

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



Tags:

access:   protected


Overrides Component::setParam() (Устанавливает значение параметра компонента, если такой существует.)

Parameters:

string   $name  
mixed   $value  

[ Top ]

method setPK [line 542]

void setPK( $primaryColumnName)



Tags:

access:   protected


Parameters:

   $primaryColumnName  

[ Top ]

method setTableName [line 358]

type setTableName( string $tableName)

Устанавливает имя таблицы



Tags:

access:   protected


Parameters:

string   $tableName  

[ Top ]

method view [line 617]

void view( )

Метод выводит форму просмотра



Tags:

access:   protected


Overridden in child classes as:

ProductList::view()
Выводит продук
Feed::view()
Добавляем крошку
NewsFeed::view()
View
UserOrderHistory::view()
Добавлена хлебная крошка Order_detail сделан пользовательским типом

[ Top ]

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