Docs For Class sbJustCategs

Описание

Класс, отвечающий за подгрузку дерева разделов.

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

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

Прямые потомки класса

Класс	Описание
sbCategs	Класс, отвечающий за вывод дерева разделов и связанного с разделом произвольного HTML-вывода
sbElements	Класс, отвечающий за вывод дерева разделов и списка связанных элементов

Переменные (список)

int $mCategsAddDlgHeight

int $mCategsAddDlgWidth

string $mCategsAddEvent

bool $mCategsAddMenu

int $mCategsAddMenuLevel

string $mCategsAddMenuTitle

string $mCategsAfterAddEvent

string $mCategsAfterAddFunc

string $mCategsAfterEditEvent

string $mCategsAfterEditFunc

string $mCategsAfterPasteEvent

bool $mCategsAutoloading

string $mCategsBeforeAddEvent

string $mCategsBeforeCheckEvent

string $mCategsBeforeEditEvent

string $mCategsBeforePasteEvent

bool $mCategsClosed

bool $mCategsCopyMenu

int $mCategsCopyMenuLevel

string $mCategsCopyMenuTitle

bool $mCategsCount

bool $mCategsCutMenu

int $mCategsCutMenuLevel

string $mCategsCutMenuTitle

bool $mCategsDad

int $mCategsDadMode

int $mCategsDadStartLevel

string $mCategsDeleteEvent

bool $mCategsDeleteMenu

int $mCategsDeleteMenuLevel

string $mCategsDeleteMenuTitle

int $mCategsEditDlgHeight

int $mCategsEditDlgWidth

string $mCategsEditEvent

bool $mCategsEditMenu

int $mCategsEditMenuLevel

string $mCategsEditMenuTitle

string $mCategsEvent

bool $mCategsFields

string $mCategsIdent

string $mCategsJavascriptStr

int $mCategsMaxDeep

bool $mCategsMenu

int $mCategsMenuLevel

bool $mCategsMultiSelect

array $mCategsNeverShowCats

array $mCategsNotAddable

array $mCategsNotCheckable

array $mCategsNotCopyable

array $mCategsNotDeletable

array $mCategsNotEditable

int $mCategsPasteCategsMenuLevel

string $mCategsPasteElemsMenu

int $mCategsPasteElemsMenuLevel

string $mCategsPasteElemsMenuTitle

bool $mCategsPasteLinksMenu

string $mCategsPasteLinksMenuTitle

string $mCategsPasteMenuTitle

bool $mCategsRefreshMenu

bool $mCategsRightsMenu

string $mCategsRootName

bool $mCategsRubrikator

bool $mCategsRubrikatorLevel

int $mCategsSelectedId

array $mCategsSelectedIds

boolean $mCategsUrl

bool $mCategsUseRights

string $mElemsAfterPasteEvent

string $mElemsBeforePasteEvent

string $mElemsIdField

string $mElemsTable

string $mElemsTitleField

Методы (список)

sbJustCategs __construct (string $ident)

void addCategsClosedDescr (string $ident, string $name)

void addCategsMenuItem (string $title, string $func, [int $level = 1])

void init ([ $show = true])

void showTree ([ $footer_str = ''], [ $header_str = ''], [ $on_click_func = ''], [ $echo = true])

Переменные

int $mCategsAddDlgHeight = 400 (строка 536)

Высота собственного окна добавления раздела

access: public

int $mCategsAddDlgWidth = 550 (строка 529)

Ширина собственного окна добавления раздела

access: public

string $mCategsAddEvent = '' (строка 522)

Событие, генерирующее вывод собственного окна добавления раздела

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

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

p_cat_id - ID родительского раздела, в который осуществялется добавление

access: public

bool $mCategsAddMenu = true (строка 194)

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

access: public

int $mCategsAddMenuLevel = 1 (строка 314)

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

access: public

string $mCategsAddMenuTitle = SB_CATEGS_ADD_MENU (строка 251)

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

access: public

string $mCategsAfterAddEvent = '' (строка 551)

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

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

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

p_cat_id - ID родительского раздела, в который осуществялется добавление
cat_id - ID добавленного раздела

access: public

string $mCategsAfterAddFunc = '' (строка 386)

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

access: public

string $mCategsAfterEditEvent = '' (строка 493)

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

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

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

cat_id - ID редактируемого раздела

access: public

string $mCategsAfterEditFunc = '' (строка 379)

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

access: public

string $mCategsAfterPasteEvent = '' (строка 602)

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

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

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

cat_id - ID раздела, в который производится вставка скопированного или вырезанного раздела
paste_cat_id - ID скопированного или вырезанного раздела
before_cat_id - ID раздела, находящегося в иерархии дерева непосредственно над разделом, в который производится вставка
action - CUT - раздел был вырезан, COPY - раздел был скопирован
new_cat_id - если раздел был скопирован, содержит ID копии раздела

access: public

bool $mCategsAutoloading = true (строка 138)

Использовать AJAX для подгрузки разделов или нет

access: public

string $mCategsBeforeAddEvent = '' (строка 508)

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

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

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

p_cat_id - ID родительского раздела, в который осуществялется добавление

access: public

string $mCategsBeforeCheckEvent = '' (строка 401)

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

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

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

cat_id - ID помечаемого раздела

access: public

string $mCategsBeforeEditEvent = '' (строка 451)

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

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

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

cat_id - ID редактируемого раздела

access: public

string $mCategsBeforePasteEvent = '' (строка 584)

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

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

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

cat_id - ID раздела, в который производится вставка скопированного или вырезанного раздела
paste_cat_id - ID скопированного или вырезанного раздела
before_cat_id - ID раздела, находящегося в иерархии дерева непосредственно над разделом, в который производится вставка
action - CUT - раздел был вырезан, COPY - раздел был скопирован

access: public

bool $mCategsClosed = true (строка 110)

Используются ли закрытые разделы

Для закрытых разделов есть возможность при редактировании выбрать группу пользователей, имеющих доступ к разделу.

access: public

bool $mCategsCopyMenu = true (строка 215)

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

access: public

int $mCategsCopyMenuLevel = 2 (строка 335)

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

access: public

string $mCategsCopyMenuTitle = SB_CATEGS_COPY_MENU (строка 272)

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

access: public

bool $mCategsCount = true (строка 131)

Показывать ли кол-во элементов в разделе рядом с названием раздела

access: public

bool $mCategsCutMenu = true (строка 222)

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

access: public

int $mCategsCutMenuLevel = 2 (строка 342)

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

access: public

string $mCategsCutMenuTitle = SB_CATEGS_CUT_MENU (строка 286)

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

access: public

bool $mCategsDad = true (строка 152)

Использовать или нет Drag And Drop для дерева разделов

access: public

int $mCategsDadMode = 2 (строка 159)

Режим Drag And Drop (0 - только вложения, 1 - только вниз и вверх, 2 - и то, и другое)

access: public

int $mCategsDadStartLevel = 0 (строка 166)

Уровень, с которого разрешено перетаскивание (Drag And Drop)

access: public

string $mCategsDeleteEvent = '' (строка 566)

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

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

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

cat_id - ID удаляемого раздела

access: public

bool $mCategsDeleteMenu = true (строка 208)

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

access: public

int $mCategsDeleteMenuLevel = 2 (строка 328)

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

access: public

string $mCategsDeleteMenuTitle = SB_CATEGS_DELETE_MENU (строка 265)

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

access: public

int $mCategsEditDlgHeight = 400 (строка 479)

Высота собственного окна редактирования раздела

access: public

int $mCategsEditDlgWidth = 550 (строка 472)

Ширина собственного окна редактирования раздела

access: public

string $mCategsEditEvent = '' (строка 465)

Cобытие, генерирующее вывод собственного окна редактирования раздела

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

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

cat_id - ID редактируемого раздела

access: public

bool $mCategsEditMenu = true (строка 201)

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

access: public

int $mCategsEditMenuLevel = 1 (строка 321)

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

access: public

string $mCategsEditMenuTitle = SB_CATEGS_EDIT_MENU (строка 258)

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

access: public

string $mCategsEvent = '' (строка 33)

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

access: protected

bool $mCategsFields = false (строка 124)

Используются ли пользовательские поля у разделов

access: public

string $mCategsIdent = '' (строка 26)

Уникальный идентификатор разделов модуля

access: protected

string $mCategsJavascriptStr = '' (строка 50)

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

access: public

int $mCategsMaxDeep = 999 (строка 71)

Максимальное кол-во уровней вложенности в дереве разделов

access: public

bool $mCategsMenu = true (строка 173)

Выводить или нет контекстное меню разделов

access: public

int $mCategsMenuLevel = 1 (строка 307)

Уровень дерева, с которого доступно контекстное меню

access: public

bool $mCategsMultiSelect = false (строка 145)

Использовать или нет множественный выбор у разделов (используется в некоторых диалоговых окнах)

access: public

array $mCategsNeverShowCats = array() (строка 78)

Массив идентификаторов разделов, которые не будут выводиться

access: public

array $mCategsNotAddable = array() (строка 429)

Массив, содержащий ID разделов, в которые нельзя добавлять подразделы

access: public

array $mCategsNotCheckable = array() (строка 408)

Массив, содержащий ID разделов, которые помечать нельзя

access: public

array $mCategsNotCopyable = array() (строка 436)

Массив, содержащий ID разделов, которые нельзя копировать

access: public

array $mCategsNotDeletable = array() (строка 415)

Массив, содержащий ID разделов, которые нельзя удалять

access: public

array $mCategsNotEditable = array() (строка 422)

Массив, содержащий ID разделов, которые нельзя редакитровать

access: public

int $mCategsPasteCategsMenuLevel = 1 (строка 356)

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

access: public

string $mCategsPasteElemsMenu = 'all' (строка 237)

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

Возможные значения:

none - не выводить
copy - выводить только для скопированных элементов
cut - выводить только для вырезанных элементов
all - выводить для всех элементов

access: public

int $mCategsPasteElemsMenuLevel = 1 (строка 349)

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

access: public

string $mCategsPasteElemsMenuTitle = SB_CATEGS_PASTE_MENU (строка 293)

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

access: public

bool $mCategsPasteLinksMenu = true (строка 244)

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

access: public

string $mCategsPasteLinksMenuTitle = SB_CATEGS_PASTE_LINKS_MENU (строка 300)

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

access: public

string $mCategsPasteMenuTitle = SB_CATEGS_PASTE_CATEGS_MENU (строка 279)

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

access: public

bool $mCategsRefreshMenu = true (строка 187)

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

access: public

bool $mCategsRightsMenu = true (строка 180)

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

access: public

string $mCategsRootName = '' (строка 43)

Название корневого раздела по умолчанию

Если пользователь запрашивает дерево разделов и корневого раздела нет, то он будет создан автоматически.

access: public

bool $mCategsRubrikator = true (строка 94)

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

access: public

bool $mCategsRubrikatorLevel = 0 (строка 101)

Уровень, с которого разрешен рубрикатор

access: public

int $mCategsSelectedId = -1 (строка 57)

ID выбранного раздела

access: public

array $mCategsSelectedIds = array() (строка 64)

ID выбранных разделов (если используется множественный выбор)

access: public

boolean $mCategsUrl = false (строка 117)

Выводить поле "Псевдостатический адрес" при редактировании и добавлении раздела

access: public

bool $mCategsUseRights = true (строка 87)

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

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

access: public

string $mElemsAfterPasteEvent = '' (строка 638)

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

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

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

new_cat_id - ID раздела, в который вставляются элементы
old_cat_id - ID раздела, из которого вставляются элементы
action - CUT - элемент был вырезан, copy - элемент был скопирован
e_.. - ID вставляемых элементов (.. - уникальный набор цифр)
ne_.. - если производится копирование элементов, то содержит ID копий элементов

access: public

string $mElemsBeforePasteEvent = '' (строка 620)

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

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

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

new_cat_id - ID раздела, в который вставляются элементы
old_cat_id - ID раздела, из которого вставляются элементы
action - CUT - элемент был вырезан, copy - элемент был скопирован
e_.. - ID вставляемых элементов (.. - уникальный набор цифр)

access: public

string $mElemsIdField = '' (строка 652)

Автоинкрементное поле таблицы элементов, содержащее уникальный идентификатор элемента

access: protected

string $mElemsTable = '' (строка 645)

Имя таблицы, содержащей связанные с разделом элементы (таблица элементов)

access: protected

string $mElemsTitleField = '' (строка 659)

Поле таблицы элементов, содержащее название элемента

access: protected

Методы

Конструктор __construct (строка 668)

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

В конструкторе класса проверяется, использует ли модуль рубрикатор или нет.

access: public

sbJustCategs __construct (string $ident)

string $ident: Уникальный идентификатор разделов модуля.

Переопределен в потомках как:

sbCategs::__construct() : Конструктор класса
sbElements::__construct() : Конструктор класса

addCategsClosedDescr (строка 698)

Добавляет права доступа к закрытому разделу

access: public

void addCategsClosedDescr (string $ident, string $name)

string $ident: Идентификатор права (например, read, write, delete и пр.). Реальный идентификатор - идентификатор раздела + знак подчеркивания + идентификатор права (например, pl_news_read или pl_users_write).
string $name: Описание права.

addCategsMenuItem (строка 710)

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

access: public

void addCategsMenuItem (string $title, string $func, [int $level = 1])

string $title: Название пункта меню.
string $func: JavaScript-функция, вызываемая при щелчке по пункту меню.
int $level: Уровень, начиная с которого будет показываться пункт меню.

init (строка 723)

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

access: public

void init ([ $show = true])

$show

Переопределен в потомках как:

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

showTree (строка 1069)

Выводит дерево разделов

access: public

void showTree ([ $footer_str = ''], [ $header_str = ''], [ $on_click_func = ''], [ $echo = true])

$footer_str
$header_str
$on_click_func
$echo

Техническая поддержка:

Сайт: http://www.sbuilder.ru/tec_support.php
E-mail: support@sbuilder.ru