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

Class: ChildDivisions

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

Class Overview

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

Класс передназначен для вівода дочерних разделов текущего раздела


Author(s):

  • dr.Pavka

Variables

Constants

Methods


Child classes:

ProductDivisions
Список разделов магазина
BrotherDivisions
Класс передназначен для вівода дочерних разделов текущего раздела

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 23]
Класс передназначен для вівода дочерних разделов текущего раздела



Tags:

author:   dr.Pavka
todo:   класс необходимо переписать поскольку используется разный принцип получения данных для страниц и разделов


[ Top ]


Class Variables

$id =

[line 30]

Переменная содержащая идентификатор раздела для которого нужно выводить потомков



Tags:

access:   private

Type:   int


[ Top ]



Class Methods


constructor __construct [line 43]

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

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



Tags:

access:   public


Overridden in child classes as:

ProductDivisions::__construct()
Конструктор класса
BrotherDivisions::__construct()
Конструктор класса

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

Parameters:

   $name  
   $module  
Document   $document  
array   $params  

[ Top ]

method buildAttachedFilesField [line 170]

void buildAttachedFilesField( $attachedFilesData)



Tags:

access:   private


Parameters:

   $attachedFilesData  

[ Top ]

method createData [line 135]

void createData( )



Tags:

access:   protected


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

[ Top ]

method createDataDescription [line 108]

DataDescription createDataDescription( )

Устанавливаем перечень полей



Tags:

access:   protected


Overridden in child classes as:

ProductDivisions::createDataDescription()
Добавлено поле количество продуктов
BrotherDivisions::createDataDescription()
Убираем DescriptionRtf

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

[ Top ]

method defineParams [line 91]

int defineParams( )

Добавлен параметр id - идентификатор страницы



Tags:

access:   protected


Overridden in child classes as:

ProductDivisions::defineParams()
Параметр active выставлен в false

Overrides DataSet::defineParams() (Добавлены: Параметр datasetAction Параметр recordsPerPage)

[ Top ]

method filterDataByRights [line 242]

bool filterDataByRights( $row $row)

Callback функция для фильтрации массива данных о дочерних страницах(не разделах) по правам



Tags:

access:   private


Parameters:

$row   $row  

[ Top ]

method getID [line 69]

int getID( )

Возвращает значение id



Tags:

final:  
access:   protected


[ Top ]

method loadData [line 200]

mixed loadData( )

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



Tags:

access:   protected


Overridden in child classes as:

ProductDivisions::loadData()
Добавляем значения количества продуктов
BrotherDivisions::loadData()
Переопределенный метод загрузки данных

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

[ Top ]

method prepareSegment [line 252]

array prepareSegment( $row $row)

Callback функция для генерации полного URL дл страниц



Tags:

access:   private


Parameters:

$row   $row  

[ Top ]

method setID [line 80]

void setID( $id)

Устанавливает id



Tags:

final:  
access:   protected


Parameters:

   $id  

[ Top ]


Class Constants

PARENT_ID =  'parent'

[line 36]

Идентификатор указывающий на то что нужно исепользовать в качестве идентфикатора id родительской страниц


[ Top ]


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