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

Class: OrderForm

Source Location: /modules/shop/components/OrderForm.class.php

Class Overview

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

Предназначен для формирования заказа пользователем


Author(s):

  • dr.Pavka

Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: DBDataSet

DBDataSet::__construct()
Конструктор класса
DBDataSet::addFilterCondition()
Добавляет условие к фильтру
DBDataSet::clearFilter()
Сброс фильтра
DBDataSet::createBuilder()
Для мультиязычного грида подменяем построитель
DBDataSet::createDataDescription()
добавлена обработка ключей
DBDataSet::defineParams()
Добавлен параметр tableName
DBDataSet::getDataLanguage()
Возвращает язык на которм берутся данные
DBDataSet::getFilter()
Возвращает значение фильтра
DBDataSet::getFKData()
Возвращает данные о значения в связанной таблицы
DBDataSet::getLimit()
Возвращает ограничения по количеству записей
DBDataSet::getOrder()
Возвращает условия сортровки
DBDataSet::getPK()
Возвращает имя поля - первичного ключа
DBDataSet::getPreviousAction()
Возвращает предыдущее действие
DBDataSet::getTableName()
Возвращает имя таблицы
DBDataSet::getTranslationTableName()
Возвращает имя таблицы переводов
DBDataSet::loadData()
Переопределенный метод загрузки данных
DBDataSet::loadDataDescription()
Переопределенный метод загрузки описания данных Возвращает информацию о колонках в основной таблице и таблице переводов
DBDataSet::multiLoadData()
Загрузка мультиязычных данных
DBDataSet::recordExists()
Определяет существует ли запись с идентификатором переданным в параметре Вызывается из методов где нужно быть уверенным в наличии записи(view, edit,delete)
DBDataSet::setFilter()
Устанавливает значение фильтра
DBDataSet::setLimit()
Устанавливает ограничения по количеству записей
DBDataSet::setOrder()
Устанавливает условие сортровки
DBDataSet::setParam()
Для параметра tableName устанавливаем еще и имя таблицы переводов
DBDataSet::setPK()
DBDataSet::setTableName()
Устанавливает имя таблицы
DBDataSet::view()
Метод выводит форму просмотра

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 24]
Предназначен для формирования заказа пользователем



Tags:

author:   dr.Pavka


[ Top ]


Class Variables

$order =

[line 31]

Корзина



Tags:

access:   protected

Type:   Order
Overrides:   Array


[ Top ]



Class Methods


constructor __construct [line 41]

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

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



Tags:

access:   public


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

Parameters:

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

[ Top ]

method createData [line 107]

Data createData( )

Если пользователь аутентифицирован загружаем его данные из объекта AuthUser



Tags:

access:   protected


Overrides DataSet::createData() (Загружает данные)

[ Top ]

method defineParams [line 56]

int defineParams( )

Переопределен параметр active



Tags:

access:   protected


Overrides DBDataSet::defineParams() (Добавлен параметр tableName)

[ Top ]

method failure [line 169]

void failure( $errors)

Метод отрабатывающий если что то не так пошло



Tags:

access:   protected


Parameters:

   $errors  

[ Top ]

method loadDataDescription [line 85]

mixed loadDataDescription( )

Подтягиваем перечень полей из таблицы пользователей



Tags:

access:   protected


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

[ Top ]

method main [line 71]

void main( )

Если корзина - пуста то что заказывать?



Tags:

access:   protected


Overrides Component::main() (Действие по-умолчанию.)

[ Top ]

method save [line 128]

void save( )

Сохраняет данные о заказе



Tags:

access:   protected


[ Top ]

method success [line 203]

void success( )

Метод выводящий сообщение об успешном сохранении данных



Tags:

access:   protected


[ Top ]

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