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

Class: DivisionEditor

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

Class Overview

Object
   |
   --DBWorker
      |
      --Component
         |
         --DataSet
            |
            --DBDataSet
               |
               --Grid
                  |
                  --DivisionEditor

Редактор разделов


Author(s):

  • dr.Pavka

Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: Grid

Grid::__construct()
Конструктор класса
Grid::add()
Метод выводящий форму добавления
Grid::addAttFilesField()
Строит список дополнительных файлов Используется в тех случаях когда необходимо создать дополнительную вкладку с приаттачеными к записи файлами
Grid::addToolbarTranslations()
Добавляет переводы для WYSIWYG при необходимости
Grid::applyUserFilter()
Метод применеющий фильтр
Grid::build()
Переопределенный метод построения Перед построением - добавляется перевод После построения добавляется информация о закладках
Grid::buildAttachedFiles()
Grid::changeOrder()
Изменяет порядок следования
Grid::createDataDescription()
Если поле OrderColumn присутствует в списке, убираем его
Grid::defineParams()
Переопределен параметр configFilename
Grid::delete()
Внешний метод удаления
Grid::deleteData()
Внутренний метод удаления записи
Grid::down()
Метод для изменения порядка следования - вниз
Grid::edit()
Метод выводящий форму редактирования
Grid::exportCSV()
Выводит список в файл в формате CSV
Grid::fileLibrary()
Выводит компонент: библиотека изображений
Grid::generateError()
Переписан родительский метод генерации ошибки, поскольку для AJAX такая не подходит
Grid::generateThumbnail()
Метод генерящий thumbnail и сохраняющий его в БД
Grid::getDataLanguage()
переписан родительский метод
Grid::getOrderColumn()
Возвращает имя колонки для пользовательской сортировки
Grid::getRawData()
Выводит данные в JSON формате для AJAX
Grid::getSaver()
Возвращает объект Saver Есть смысл вызывать эту функцию только внутри save/saveSata во всех остальных случаях она возвращает false
Grid::imageManager()
Выводит компонент: менеджер изображений
Grid::loadData()
Для действия main не выводим данные Для действия save определяем другой формат данных
Grid::main()
Добавлены переводы для фильтра
Grid::prepareCSVString()
Формирует стоку в формате CSV из массива Callback для array_reduce
Grid::printData()
Метод выводящий данные для печати
Grid::save()
Внешний метод сохранения Вызывает внутренний метод сохранения saveData(), который и производит собственно все действия
Grid::saveData()
Внутренний метод сохранения
Grid::setOrderColumn()
Устанавливает имя колонки для пользовательской сортировки
Grid::setSaver()
Grid::up()
Метод для изменения порядка следования - вверх
Grid::upload()
Метод для заливки файла Вызывается в невидимом фрейме и должен отдать HTML страницу включающаю скрипт
Grid::uploadVideo()

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 23]
Редактор разделов



Tags:

author:   dr.Pavka
final:  


[ Top ]


Class Variables

$langEditor =

[line 59]

Редактор языков



Tags:

access:   private

Type:   LanguageEditor


[ Top ]

$roleEditor =

[line 52]

Редактор ролей



Tags:

access:   private

Type:   RoleEditor


[ Top ]

$templateEditor =

[line 30]

Редактор шаблонов



Tags:

access:   private

Type:   TemplateEditor


[ Top ]

$transEditor =

[line 38]

Редактор переводов



Tags:

access:   private

Type:   TranslationEditor


[ Top ]

$userEditor =

[line 45]

Редактор пользователей



Tags:

access:   private

Type:   UserEditor


[ Top ]



Class Methods


constructor __construct [line 66]

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

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



Tags:

access:   public


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

Parameters:

   $name  
   $module  
Document   $document  
array   $params  

[ Top ]

method build [line 516]

DOMNode build( )

Для метода setPageRights если раздел который редактируется - системный то дизейблятся вкладки с правами Для метода show слешатся имена разделов Для формы редактирования делается неактивным переключатель smap_default



Tags:

access:   public


Overrides Grid::build() (Переопределенный метод построения Перед построением - добавляется перевод После построения добавляется информация о закладках)

[ Top ]

method buildRightsTab [line 98]

DOMNode buildRightsTab( )

Строит вкладку прав



Tags:

access:   private


[ Top ]

method changeOrder [line 695]

JSON changeOrder( string $direction)

Изменяет порядок следования



Tags:

return:   String
access:   protected


Overrides Grid::changeOrder() (Изменяет порядок следования)

Parameters:

string   $direction  

[ Top ]

method createDataDescription [line 173]

DataDescription createDataDescription( )

Для setRole создаем свое описание данных Для поля smap_pid формируется Дерево разделов



Tags:

access:   protected


Overrides Grid::createDataDescription() (Если поле OrderColumn присутствует в списке, убираем его)

[ Top ]

method deleteData [line 486]

void deleteData( int $id)

Не позволяет удалить раздел по умолчанию а также системные разделы



Tags:

access:   protected


Overrides Grid::deleteData() (Внутренний метод удаления записи)

Parameters:

int   $id  

[ Top ]

method edit [line 457]

void edit( )



Tags:

access:   protected


Overrides Grid::edit() (Метод выводящий форму редактирования)

[ Top ]

method getProperties [line 569]

void getProperties( )

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



Tags:

access:   protected


[ Top ]

method getRawData [line 234]

void getRawData( [ $baseMethod = self::DEFAULT_ACTION_NAME])



Tags:

access:   protected


Overrides Grid::getRawData() (Выводит данные в JSON формате для AJAX)

Parameters:

   $baseMethod  

[ Top ]

method loadData [line 208]

array loadData( )

Добавляет данные об УРЛ



Tags:

access:   protected


Overrides Grid::loadData() (Для действия main не выводим данные Для действия save определяем другой формат данных)

[ Top ]

method main [line 472]

void main( )

Добавлен перевод для корня дерева разделов



Tags:

access:   protected


Overrides Grid::main() (Добавлены переводы для фильтра)

[ Top ]

method prepare [line 274]

Builder prepare( )

Подменяем построитель для метода setPageRights



Tags:

access:   protected


Overrides DataSet::prepare() (Подготовительные действия перед вызовом основного действия.)

[ Top ]

method save [line 346]

void save( )

Переопределенный внешний метод сохранения добавлено значение урла страницы Вызывает внутренний метод сохранения saveData(), который и производит собственно все действия



Tags:

access:   protected


Overrides Grid::save() (Внешний метод сохранения Вызывает внутренний метод сохранения saveData(), который и производит собственно все действия)

[ Top ]

method saveData [line 409]

void saveData( array 0)

Переопределенный метод сохранения Для того чтобы реализовать уникальность smap_default



Tags:

access:   protected


Overrides Grid::saveData() (Внутренний метод сохранения)

Parameters:

array   0  

[ Top ]

method selector [line 621]

void selector( )

Селектор



Tags:

access:   protected


[ Top ]

method setPageRights [line 84]

void setPageRights( )

Метод выводит форму назначения прав



Tags:

access:   protected


[ Top ]

method showLangEditor [line 682]

void showLangEditor( )

Вывод редактора языков



Tags:

access:   protected


[ Top ]

method showPageToolbar [line 605]

void showPageToolbar( )

Выводит панель управления страницей



Tags:

access:   protected


[ Top ]

method showRoleEditor [line 670]

void showRoleEditor( )

Вывод редактора ролей



Tags:

access:   protected


[ Top ]

method showTemplate [line 633]

void showTemplate( )

Вывод релактора шаблонов



Tags:

access:   protected


[ Top ]

method showTransEditor [line 646]

void showTransEditor( )

Вывод редактора переводов



Tags:

access:   protected


[ Top ]

method showUserEditor [line 658]

void showUserEditor( )

Вывод редактора пользователей



Tags:

access:   protected


[ Top ]

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