Описание
[ Описание ]   [ Переменные ]   [ Методы ]

Класс, отвечающий за вывод дерева разделов и списка связанных элементов

  • author: Казбек Елекоев <elekoev@binn.ru>
  • version: 4.0
  • copyright: Copyright (c) 2007, OOO "СИБИЭС Групп"

Располагается в /lib/sbElements.inc.php (строка 24) 

sbJustCategs
   |
   --sbElements
Переменные (список)
[ Описание ]   [ Переменные ]   [ Методы ]
int $mElemsAddDlgHeight
int $mElemsAddDlgWidth
string $mElemsAddEvent
bool $mElemsAddMenu
int $mElemsAddMenuLevel
bool $mElemsAddMenuTitle
string $mElemsAfterAddEvent
string $mElemsAfterAddFunc
string $mElemsAfterEditEvent
string $mElemsAfterEditFunc
string $mElemsAfterLoadFunc
string $mElemsBeforeAddEvent
string $mElemsBeforeDeleteFunc
string $mElemsBeforeEditEvent
string $mElemsClickFunc
bool $mElemsCopyMenu
int $mElemsCopyMenuLevel
bool $mElemsCopyMenuTitle
bool $mElemsCutMenu
int $mElemsCutMenuLevel
bool $mElemsCutMenuTitle
string $mElemsDeleteEvent
bool $mElemsDeleteMenu
int $mElemsDeleteMenuLevel
bool $mElemsDeleteMenuTitle
int $mElemsEditDlgHeight
int $mElemsEditDlgWidth
string $mElemsEditEvent
bool $mElemsEditMenu
int $mElemsEditMenuLevel
bool $mElemsEditMenuTitle
string $mElemsFooterStr
string $mElemsHeaderStr
string $mElemsIcon
string $mElemsIconLink
string $mElemsJavascriptStr
bool $mElemsMenu
int $mElemsMenuLevel
int $mElemsPanelWidth
int $mElemsPerPage
bool $mElemsSelectAllMenu
int $mElemsSelectedId
string $mElemsSortField
bool $mElemsUseLinks
string $mFooterStr
string $mHeaderStr
bool $mShowIcons
Методы (список)
[ Описание ]   [ Переменные ]   [ Методы ]
sbElements __construct (string $table, string $id_field, string $title_field, string $get_func, string $event, [string $ident = ''])
void addElemsMenuItem (string $name, string $func, [bool $hide = true], [int $level = 1])
void addField (string $field)
void addFilter (string $name, string $field, string $type, [array $values = array()])
void addSorting (string $name, string $field)
void init ()
Переменные
[ Описание ]   [ Переменные ]   [ Методы ]
int $mElemsAddDlgHeight = 400 (строка 488)

Высота окна добавления элементов

  • access: public
int $mElemsAddDlgWidth = 500 (строка 481)

Ширина окна добавления элементов

  • access: public
string $mElemsAddEvent = '' (строка 474)

Событие, вызываемое при добавлении элемента

Данное событие генерирует окно добавления элемента.

Получаемые GET-параметры:

  • cat_id - ID раздела, в который добавляется элемент
  • cat_level - уровень раздела, в который добавляется элемент
  • cat_closed - закрытый или открытый раздел (1 - закрытый, 0 - открытый)

  • access: public
bool $mElemsAddMenu = true (строка 292)

Выводить или нет пункт меню "Добавить элемент"

  • access: public
int $mElemsAddMenuLevel = 1 (строка 369)

Уровень разделов, начиная с которого выводится пункт меню "Добавить элемент"

  • access: public
bool $mElemsAddMenuTitle = SB_ELEMS_ADD_MENU (строка 327)

Название пункта меню "Добавить элемент"

  • access: public
string $mElemsAfterAddEvent = '' (строка 505)

Событие, вызываемое после добавления элемента

Если возвращает не пустую строку, то возвращенное значение показывается пользователю.

Получаемые GET-параметры:

  • id - ID добавленного элемента
  • cat_id - ID раздела, в который добавляется элемент
  • cat_level - уровень раздела, в который добавляется элемент
  • cat_closed - закрытый или открытый раздел (1 - закрытый, 0 - открытый)

  • access: public
string $mElemsAfterAddFunc = '' (строка 221)

JavaScript-функция, вызываемая после добавления элемента

  • access: public
string $mElemsAfterEditEvent = '' (строка 442)

Cобытие, вызываемое после редактирования элемента

Если возвращает не пустую строку, то возвращенное значение показывается пользователю.

Получаемые GET-параметры:

  • id - ID редактируемого элемента
  • cat_id - ID раздела, в котором располагается редактируемый элемент
  • cat_level - уровень раздела, в котором располагается редактируемый элемент
  • cat_closed - закрытый или открытый раздел (1 - закрытый, 0 - открытый)

  • access: public
string $mElemsAfterEditFunc = '' (строка 214)

JavaScript-функция, вызываемая после редактирования элемента

  • access: public
string $mElemsAfterLoadFunc = '' (строка 207)

JavaScript-функция, вызываемая после загрузки списка элементов

  • access: public
string $mElemsBeforeAddEvent = '' (строка 458)

Cобытие, вызываемое перед добавлением элемента

Если возвращает не пустую строку, то возвращенное значение показывается пользователю и окно добавления не вызывается.

Получаемые GET-параметры:

  • cat_id - ID раздела, в который добавляется элемент
  • cat_level - уровень раздела, в который добавляется элемент
  • cat_closed - закрытый или открытый раздел (1 - закрытый, 0 - открытый)

  • access: public
string $mElemsBeforeDeleteFunc = '' (строка 231)

JavaScript-функция, вызываемая перед удалением элемента

В качестве аргумента получает ID раздела, из которого производится удаление. Массив удаляемых элементов хранится в глобальном массиве sbSelectedEls.

  • access: public
string $mElemsBeforeEditEvent = '' (строка 394)

Событие, вызываемое перед редактированием элемента

Если возвращает не пустую строку, то возвращенное значение показывается пользователю и окно редактирование не вызывается.

Получаемые GET-параметры:

  • id - ID редактируемого элемента
  • cat_id - ID раздела, в котором располагается редактируемый элемент
  • cat_level - уровень раздела, в котором располагается редактируемый элемент
  • cat_closed - закрытый или открытый раздел (1 - закрытый, 0 - открытый)

  • access: public
string $mElemsClickFunc = '' (строка 158)

JavaScript-функция, вызываемая при клике по элементу

  • access: public
bool $mElemsCopyMenu = true (строка 271)

Выводить или нет пункт меню "Копировать элементы"

  • access: public
int $mElemsCopyMenuLevel = 1 (строка 355)

Уровень разделов, начиная с которого выводится пункт меню "Копировать элементы"

  • access: public
bool $mElemsCopyMenuTitle = SB_ELEMS_COPY_MENU (строка 313)

Название пункта меню "Копировать элементы"

  • access: public
bool $mElemsCutMenu = true (строка 264)

Выводить или нет пункт меню "Вырезать элементы"

  • access: public
int $mElemsCutMenuLevel = 1 (строка 348)

Уровень разделов, начиная с которого выводится пункт меню "Вырезать элементы"

  • access: public
bool $mElemsCutMenuTitle = SB_ELEMS_CUT_MENU (строка 306)

Название пункта меню "Вырезать элементы"

  • access: public
string $mElemsDeleteEvent = '' (строка 523)

Дополнительное событие, вызываемое при удалении элемента

Используется для удаления связанных с элементами записей из других таблиц, удалять сами элементы в этом событии не надо. Если возвращает не пустую строку, то возвращенное значение показывается пользователю и элемент не удаляется.

Получаемые GET-параметры:

  • id - ID удаляемого элемента
  • cat_id - ID раздела, из которого удаляется элемент
  • cat_level - уровень раздела, из которого удаляется элемент
  • cat_closed - закрытый или открытый раздел (1 - закрытый, 0 - открытый)

  • access: public
bool $mElemsDeleteMenu = true (строка 299)

Выводить или нет пункт меню "Удалить элементы"

  • access: public
int $mElemsDeleteMenuLevel = 1 (строка 376)

Уровень разделов, начиная с которого выводится пункт меню "Удалить элементы"

  • access: public
bool $mElemsDeleteMenuTitle = SB_ELEMS_DELETE_MENU (строка 334)

Название пункта меню "Удалить элементы"

  • access: public
int $mElemsEditDlgHeight = 400 (строка 425)

Высота окна редактирования элементов

  • access: public
int $mElemsEditDlgWidth = 500 (строка 418)

Ширина окна редактирования элементов

  • access: public
string $mElemsEditEvent = '' (строка 411)

Событие, вызываемое при редактировании элемента

Данное событие генерирует вывод окна редактирования.

Получаемые GET-параметры:

  • id - ID редактируемого элемента
  • cat_id - ID раздела, в котором располагается редактируемый элемент
  • cat_level - уровень раздела, в котором располагается редактируемый элемент
  • cat_closed - закрытый или открытый раздел (1 - закрытый, 0 - открытый)

  • access: public
bool $mElemsEditMenu = true (строка 285)

Выводить или нет пункт меню "Редактировать элемент"

  • access: public
int $mElemsEditMenuLevel = 1 (строка 362)

Уровень разделов, начиная с которого выводится пункт меню "Редактировать элемент"

  • access: public
bool $mElemsEditMenuTitle = SB_ELEMS_EDIT_MENU (строка 320)

Название пункта меню "Редактировать элемент"

  • access: public
string $mElemsFooterStr = '' (строка 200)

HTML-код, выводимый под списком элементов

  • access: public
string $mElemsHeaderStr = '' (строка 193)

HTML-код, выводимый над списком элементов

  • access: public
string $mElemsIcon = '' (строка 127)

URL иконки элемента

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

  • access: public
string $mElemsIconLink = '' (строка 137)

URL иконки ссылки на элемент

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

  • access: public
string $mElemsJavascriptStr = '' (строка 172)

JavaScript-код, выводимый перед инициализацией списка элементов

  • access: public
bool $mElemsMenu = true (строка 257)

Выводить или нет контекстное меню элементов

  • access: public
int $mElemsMenuLevel = 1 (строка 341)

Уровень разделов, начиная с которого выводится контекстное меню элементов

  • access: public
int $mElemsPanelWidth = '300' (строка 165)

Ширина панели разделов по умолчанию

  • access: public
int $mElemsPerPage = 15 (строка 108)

Кол-во элементов на странице (для постраничного вывода)

Считывается из настроек интерфейса системы, может быть переопределено после вызова конструктора класса.

  • access: public
bool $mElemsSelectAllMenu = true (строка 278)

Выводить или нет пункт меню "Выделить все"

  • access: public
int $mElemsSelectedId = -1 (строка 151)

ID выбранного элемента по умолчанию

  • access: public
string $mElemsSortField = '' (строка 144)

Поле таблицы элементов, используемое для сортировки по умолчанию

  • access: public
bool $mElemsUseLinks = false (строка 98)

Возможно ли создание ссылок на элементы

TRUE - возможно, FALSE - нет.

  • access: public
string $mFooterStr = '' (строка 186)

HTML-код, выводимый под списком элементов и панелью с деревом разделов

  • access: public
string $mHeaderStr = '' (строка 179)

HTML-код, выводимый над списком элементов и панелью с деревом разделов

  • access: public
bool $mShowIcons = true (строка 117)

Отображать или нет иконки элементов

TRUE - отображать, FALSE - нет.

  • access: public

Унаследованые переменные

Унаследованы от sbJustCategs

sbJustCategs::$mCategsAddDlgHeight
 sbJustCategs::$mCategsAddDlgWidth
 sbJustCategs::$mCategsAddEvent
 sbJustCategs::$mCategsAddMenu
 sbJustCategs::$mCategsAddMenuLevel
 sbJustCategs::$mCategsAddMenuTitle
 sbJustCategs::$mCategsAfterAddEvent
 sbJustCategs::$mCategsAfterAddFunc
 sbJustCategs::$mCategsAfterEditEvent
 sbJustCategs::$mCategsAfterEditFunc
 sbJustCategs::$mCategsAfterPasteEvent
 sbJustCategs::$mCategsAutoloading
 sbJustCategs::$mCategsBeforeAddEvent
 sbJustCategs::$mCategsBeforeCheckEvent
 sbJustCategs::$mCategsBeforeEditEvent
 sbJustCategs::$mCategsBeforePasteEvent
 sbJustCategs::$mCategsClosed
 sbJustCategs::$mCategsCopyMenu
 sbJustCategs::$mCategsCopyMenuLevel
 sbJustCategs::$mCategsCopyMenuTitle
 sbJustCategs::$mCategsCount
 sbJustCategs::$mCategsCutMenu
 sbJustCategs::$mCategsCutMenuLevel
 sbJustCategs::$mCategsCutMenuTitle
 sbJustCategs::$mCategsDad
 sbJustCategs::$mCategsDadMode
 sbJustCategs::$mCategsDadStartLevel
 sbJustCategs::$mCategsDeleteEvent
 sbJustCategs::$mCategsDeleteMenu
 sbJustCategs::$mCategsDeleteMenuLevel
 sbJustCategs::$mCategsDeleteMenuTitle
 sbJustCategs::$mCategsEditDlgHeight
 sbJustCategs::$mCategsEditDlgWidth
 sbJustCategs::$mCategsEditEvent
 sbJustCategs::$mCategsEditMenu
 sbJustCategs::$mCategsEditMenuLevel
 sbJustCategs::$mCategsEditMenuTitle
 sbJustCategs::$mCategsEvent
 sbJustCategs::$mCategsFields
 sbJustCategs::$mCategsIdent
 sbJustCategs::$mCategsJavascriptStr
 sbJustCategs::$mCategsMaxDeep
 sbJustCategs::$mCategsMenu
 sbJustCategs::$mCategsMenuLevel
 sbJustCategs::$mCategsMultiSelect
 sbJustCategs::$mCategsNeverShowCats
 sbJustCategs::$mCategsNotAddable
 sbJustCategs::$mCategsNotCheckable
 sbJustCategs::$mCategsNotCopyable
 sbJustCategs::$mCategsNotDeletable
 sbJustCategs::$mCategsNotEditable
 sbJustCategs::$mCategsPasteCategsMenuLevel
 sbJustCategs::$mCategsPasteElemsMenu
 sbJustCategs::$mCategsPasteElemsMenuLevel
 sbJustCategs::$mCategsPasteElemsMenuTitle
 sbJustCategs::$mCategsPasteLinksMenu
 sbJustCategs::$mCategsPasteLinksMenuTitle
 sbJustCategs::$mCategsPasteMenuTitle
 sbJustCategs::$mCategsRefreshMenu
 sbJustCategs::$mCategsRightsMenu
 sbJustCategs::$mCategsRootName
 sbJustCategs::$mCategsRubrikator
 sbJustCategs::$mCategsRubrikatorLevel
 sbJustCategs::$mCategsSelectedId
 sbJustCategs::$mCategsSelectedIds
 sbJustCategs::$mCategsUrl
 sbJustCategs::$mCategsUseRights
 sbJustCategs::$mElemsAfterPasteEvent
 sbJustCategs::$mElemsBeforePasteEvent
 sbJustCategs::$mElemsIdField
 sbJustCategs::$mElemsTable
 sbJustCategs::$mElemsTitleField
Методы
[ Описание ]   [ Переменные ]   [ Методы ]
Конструктор __construct (строка 538)

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

  • access: public
sbElements __construct (string $table, string $id_field, string $title_field, string $get_func, string $event, [string $ident = ''])
  • string $table: Имя таблицы, содержащей связанные с разделом элементы (таблица элементов).
  • string $id_field: Название поля таблицы элементов, в котором хранятся ID элементов (обязательно AUTO_INCREMENT).
  • string $title_field: Название поля таблицы элементов, в котором хранятся названия элементов.
  • string $get_func: Имя функции, которая вызывается для получения HTML-текста каждого из элементов. Первые два параметра функци всегда ID элемента и его название, остальные параметры задаются в методе класса addField().
  • string $event: Событие, вызываемое при клике по разделу. В связанной с этим событием функции происходит создание класса sbElements.
  • string $ident: Идентификатор разделов (обычно имя модуля).
Переопределение:
sbJustCategs::__construct()
Конструктор класса
addElemsMenuItem (строка 619)

Добавляет доп. пункт в контекстное меню списка элементов

void addElemsMenuItem (string $name, string $func, [bool $hide = true], [int $level = 1])
  • string $name: Название пункта меню.
  • string $func: JavaScript-функция, вызываемая при щелчке по пункту меню.
  • bool $hide: TRUE Скрывать пункт из списка, если меню вызывается не для конкретного элемента, FALSE - показывать пункт всегда.
  • int $level: Уровень разделов, начиная с которого виден пункт меню.
addField (строка 606)

Добавление полей, передаваемых в функцию $mElemsGetFunc, отвечающую за вывод каждого элемента

  • access: public
void addField (string $field)
  • string $field
addFilter (строка 574)

Добавление полей фильтра

  • access: public
void addFilter (string $name, string $field, string $type, [array $values = array()])
  • string $name: Выводимое название поля.
  • string $field: Поле таблицы элементов, для которого будет установлен фильтр.
  • string $type: Тип поля (NUMBER, STRING, BOOL, DATE, SELECT, MULTYSELECT, CHECKBOX).
  • array $values: Для типов SELECT, MULTYSELECT двумерный массив значений (значение - описание).
addSorting (строка 561)

Добавление пунктов меню сортировки

  • access: public
void addSorting (string $name, string $field)
  • string $name: Название пункта меню.
  • string $field: Имя поля таблицы элементов, по которому будет вестись сортировка.
init (строка 636)

Вывод списка элементов, инициализация списка элементов и разделов, вывод всего необходимого JavaScript-кода

Вызывается каждый раз при подгрузке списка. Осуществляет пейджирование элементов в списке. JavaScript-код выводится только при первом обращении к списку элементов.

  • access: public
void init ()
Переопределение:
sbJustCategs::init()
Инициализация переменных класса и вывод JavaScript-кода для работы с разделами

Унаследованые методы

Унаследованы от sbJustCategs

sbJustCategs::__construct()
sbJustCategs::addCategsClosedDescr()
sbJustCategs::addCategsMenuItem()
sbJustCategs::init()
sbJustCategs::showTree()
Техническая поддержка:
Сайт: http://www.sbuilder.ru/tec_support.php
E-mail: support@sbuilder.ru
Copyright © 2001-2008, ООО "СИБИЭС Групп"
Документация сгенерирована с использованием phpDocumentor