Class: Grid

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

Class Overview

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

Сетка

Author(s):

dr.Pavka

Variables

Constants

Methods

Child classes:

UserEditor: Класс - редактор пользователей

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

DiscountsEditor: Редактор скидок

ProductEditor: Редактор продуктов

ManufacturersEditor: Редактор производителей

ProductStatusEditor: Редактор статусов продуктов

ParamValuesEditor: Редактор значений параметров продукта

CurrencyEditor: Класс предназначен для редактирования перечня валюты

OrderStatuses: Редактор статусов заказов

OrderHistory: История заказов

OrderDetails: Выводит детали заказа вызывается из OrderHistory

ProductTypeEditor: Редатор типов товаров

ProductParamsEditor: Редактор параметров типа продукта

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

FeedEditor: Класс для построения редакторов управляющихся из панели управления

FeedbackList: Спсиок сообщений поступивших с формы связи

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

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

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

Inherited Constants

Inherited Variables

Class: DBDataSet

DBDataSet::$filter
DBDataSet::$limit
DBDataSet::$order
DBDataSet::$pk
DBDataSet::$previousAction
DBDataSet::$translationTableName

Class: DataSet

DataSet::$data
DataSet::$dataDescription
DataSet::$js
DataSet::$pager
DataSet::$toolbar
DataSet::$type

Class: Component

Component::$action
Component::$actionParams
Component::$builder
Component::$config
Component::$doc
Component::$document
Component::$enabled
Component::$errors
Component::$module
Component::$name
Component::$params
Component::$properties
Component::$request
Component::$response
Component::$result
Component::$rights

Class: DBWorker

DBWorker::$dbh
DBWorker::$dbhInstance
DBWorker::$translations

Class: Object

Object::$executionTime
Object::$systemConfig
Object::$values

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 20]
Сетка

Tags:

author:

dr.Pavka

[ Top ]

Class Variables

$fileLibrary =

[line 51]

Компонент: библиотека изображений

Tags:

access:

private

Type:

FileLibrary

[ Top ]

$imageManager =

[line 43]

Компонент: менеджер изображений

Tags:

access:

private

Type:

ImageManager

[ Top ]

$orderColumn = false

[line 67]

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

Tags:

access:

private

Type:

string

[ Top ]

$saver =

[line 59]

сейвер

Tags:

access:

protected

Type:

Saver

[ Top ]

Class Methods

constructor __construct [line 79]

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

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

Parameters:

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

[ Top ]

method add [line 121]

void add(
)

Метод выводящий форму добавления

method addAttFilesField [line 990]

void addAttFilesField(

$tableName, [
$data = true])

Строит список дополнительных файлов Используется в тех случаях когда необходимо создать дополнительную вкладку с приаттачеными к записи файлами

Сохранение приаттаченных данных должно происходить в методе saveData на общих основаниях

Tags:

see:	DivisionEditor
see:	ProductEditor
access:	protected

Parameters:

	$tableName
	$data

[ Top ]

method addToolbarTranslations [line 967]

void addToolbarTranslations(
)

Добавляет переводы для WYSIWYG при необходимости

Tags:

access:

private

[ Top ]

method applyUserFilter [line 869]

void applyUserFilter(
)

Метод применеющий фильтр

Tags:

access:

protected

[ Top ]

method build [line 489]

void build(
)

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

method buildAttachedFiles [line 1016]

DOMNode buildAttachedFiles(
$data
$data)

Tags:

access:

private

Parameters:

$data

$data

Данные

[ Top ]

method changeOrder [line 789]

JSON changeOrder(
string
$direction)

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

Tags:

return:	String
access:	protected

Overridden in child classes as:

FeedEditor::changeOrder()

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

Parameters:

string

$direction

- направление

[ Top ]

method createDataDescription [line 347]

DataDescription createDataDescription(
)

Если поле OrderColumn присутствует в списке, убираем его

method defineParams [line 94]

int defineParams(
)

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

method delete [line 180]

mixed delete(
)

Внешний метод удаления

Tags:

see:	Grid::save()
access:	protected

[ Top ]

method deleteData [line 215]

void deleteData(
int
$id)

Внутренний метод удаления записи

Parameters:

int

$id

идентификаотр записи

[ Top ]

method down [line 775]

void down(
)

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

Tags:

access:

protected

[ Top ]

method edit [line 135]

void edit(
)

Метод выводящий форму редактирования

method exportCSV [line 909]

void exportCSV(
)

Выводит список в файл в формате CSV

Tags:

access:

protected

[ Top ]

method fileLibrary [line 687]

void fileLibrary(
)

Выводит компонент: библиотека изображений

Tags:

access:

protected

[ Top ]

method generateError [line 373]

void generateError(
string
$errorType, string
$errorMessage, [mixed
$errorCustomInfo = false])

Переписан родительский метод генерации ошибки, поскольку для AJAX такая не подходит

Tags:

access:

protected

Overrides Component::generateError() (Генерирует ошибку и добавляет её в список ошибок компонента.)

Parameters:

string	$errorType	тип ошибки
string	$errorMessage	сообщение об ошибке
mixed	$errorCustomInfo	необязательная дополнительная информация об ошибке

[ Top ]

method generateThumbnail [line 707]

имя generateThumbnail(
$sourceFileName
$sourceFileName, $destFieldName
$destFieldName, $width
$width, $height
$height, $filter
$filter, [$rewrite
$rewrite = true])

Метод генерящий thumbnail и сохраняющий его в БД

Tags:

return:	файла - превьюхи
access:	protected

Parameters:

$sourceFileName	$sourceFileName	string имя исходного файла
$destFieldName	$destFieldName	string имя поля
$width	$width	int ширина
$height	$height	int высота
$filter	$filter	array фильтр
$rewrite	$rewrite	boolean переписывать ли если уже существует

[ Top ]

method getDataLanguage [line 241]

int getDataLanguage(
)

переписан родительский метод

Tags:

access:

protected

Overrides DBDataSet::getDataLanguage() (Возвращает язык на которм берутся данные)

[ Top ]

method getOrderColumn [line 751]

string getOrderColumn(
)

Возвращает имя колонки для пользовательской сортировки

Tags:

access:

protected

[ Top ]

method getRawData [line 261]

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

Выводит данные в JSON формате для AJAX

Parameters:

$baseMethod

[ Top ]

method getSaver [line 387]

Saver getSaver(
)

Возвращает объект Saver Есть смысл вызывать эту функцию только внутри save/saveSata во всех остальных случаях она возвращает false

Tags:

final:
access:	protected

[ Top ]

method imageManager [line 675]

void imageManager(
)

Выводит компонент: менеджер изображений

Tags:

access:

protected

[ Top ]

method loadData [line 516]

mixed loadData(
)

Для действия main не выводим данные Для действия save определяем другой формат данных

method main [line 165]

void main(
)

Добавлены переводы для фильтра

method prepareCSVString [line 946]

string prepareCSVString(
$result
$result, 
$nextValue)

Формирует стоку в формате CSV из массива Callback для array_reduce

Tags:

see:	Grid::exportCSV()
access:	private

Parameters:

$result	$result	результирующая строка
$nextValue	$nextValue	array

[ Top ]

method printData [line 896]

void printData(
)

Метод выводящий данные для печати

Tags:

access:

protected

[ Top ]

method save [line 302]

void save(
)

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

method saveData [line 406]

mixed saveData(
)

Внутренний метод сохранения

method setOrderColumn [line 739]

void setOrderColumn(

$columnName)

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

Tags:

access:

protected

Parameters:

$columnName

[ Top ]

method setSaver [line 395]

void setSaver(
Saver
$saver)

Tags:

access:

protected

Parameters:

Saver

$saver

[ Top ]

method up [line 762]

void up(
)

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

Tags:

access:

protected

[ Top ]

method upload [line 609]

void upload(
)

Метод для заливки файла Вызывается в невидимом фрейме и должен отдать HTML страницу включающаю скрипт

Tags:

final:
access:	protected

[ Top ]

method uploadVideo [line 556]

void uploadVideo(
)

Tags:

access:

protected

[ Top ]

Class Constants

DIR_DOWN = '>'

[line 30]

Направление вниз

[ Top ]

DIR_UP = '<'

[line 25]

Направление вверх

[ Top ]

RECORD_PER_PAGE = 30

[line 35]

Количество записей в гриде по умолчанию

[ Top ]

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