Docs For Class sbLayout

Описание

Класс, отвечающий за вывод форм и таблиц в системе

Поля формы могут быть разбиты на закладки. Каждое поле формы представлено своим классом. См. соотв. документацию.

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

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

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

bool $mShowColon

boolean $mShowInfo

bool $mShowTitle

string $mTableWidth

string $mTabsOnLoad

string $mTabsOnLoadTab

string $mTitleWidth

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

static void getPluginFieldsFilter (array $pd_fields, &$i, array $cols, array $values, array $i)

static string getPluginFieldsInfo (string $plugin_ident, array $values)

static array parsePluginFields (array $fields, array $values, array $temps, [array $dop_tags = array()], [array $dop_values = array()], [string $lang = 'ru'])

sbLayout __construct ([string $action = ''], [string $target = 'thisDialog'], [string $method = 'post'], [string $on_submit = 'checkValues()'], [string $id = ''], [string $dop_str = ''])

void addButton ([string $type = 'submit'], string $value, [string $name = ''], [string $id = ''], [string $dop_str = ''])

void addField (string $title, &$field, [string $th_str = ''], [string $td_str = ''], [string $tr_str = ''], mixed $field)

void addHeader ($title $title)

void addPluginFieldsTemps (string $ident, array $values, string $prefix, [ $tags = array()], [ $tags_values = array()], [bool $categs = false], [ $sufix = ''])

void addTab (string $title, [bool $show = true])

mixed checkPluginFields (string $ident, [int $id = -1], [string $id_name = ''], [bool $categs = false])

void deletePluginFieldsFiles ()

bool getPluginFields (string $ident, [int $id = -1], [string $id_name = ''], [bool $categs = false])

void getPluginFieldsTags (string $ident, &$tags, &$tags_values, [bool $categs = false], array $tags, array $tags_values)

int getTabCount ()

void setAutoLoading (string $url)

string show ([bool $echo = true])

Переменные

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

Отображать или нет двоеточие в столбце заголовков полей

access: public

boolean $mShowInfo = false (строка 110)

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

access: public

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

Отображать или нет столбец заголовков полей

access: public

string $mTableWidth = '98%' (строка 117)

Ширина основной таблицы

access: public

string $mTabsOnLoad = '' (строка 92)

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

access: public

string $mTabsOnLoadTab = '' (строка 85)

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

access: public

string $mTitleWidth = '150' (строка 124)

Ширина столбца заголовков полей

access: public

Методы

статичный метод getPluginFieldsFilter (строка 1039)

Выводит фильтр по пользовательским полям внутри класса sbElements

static void getPluginFieldsFilter (array $pd_fields, &$i, array $cols, array $values, array $i)

array $pd_fields: Массив с описанием пользовательских полей.
array $i: Инкремент.
array $cols: Кол-во столбцов в таблице с фильтром.
array $values: Массив, содержащий значения пользовательских полей.
&$i

статичный метод getPluginFieldsInfo (строка 912)

Выводит список значений пользовательских полей

return: Отформатированный список значений пользовательских полей.

static string getPluginFieldsInfo (string $plugin_ident, array $values)

string $plugin_ident: Уникальный идентификатор модуля, для которого получаем список полей.
array $values: Значения пользовательских полей.

статичный метод parsePluginFields (строка 1390)

Функция для парсинга пользовательских полей

return: Массив распарсенных значений пользовательских полей.

static array parsePluginFields (array $fields, array $values, array $temps, [array $dop_tags = array()], [array $dop_values = array()], [string $lang = 'ru'])

array $fields: Массив пользовательских полей.
array $values: Массив значений пользовательских полей.
array $temps: Массив макетов дизайна пользовательских полей.
array $dop_tags: Массив доп. тегов, использующихся в макете дизайна элемента.
array $dop_values: Массив значений доп. тегов, использующихся в макете дизайна элемента.
string $lang: Язык (используется для парсинга полей типа "Дата".

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

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

access: public

sbLayout __construct ([string $action = ''], [string $target = 'thisDialog'], [string $method = 'post'], [string $on_submit = 'checkValues()'], [string $id = ''], [string $dop_str = ''])

string $action: Атрибут action формы.
string $target: Атрибут target формы.
string $method: Атрибут method формы.
string $on_submit: JavaScript функция, вызываемая перед отправкой данных формы.
string $id: Атрибут id формы.
string $dop_str: Дополнительные св-ва формы (например, стили).

addButton (строка 203)

Добавляет новую кнопку в форму

Кнопки выводятся внизу формы.

access: public

void addButton ([string $type = 'submit'], string $value, [string $name = ''], [string $id = ''], [string $dop_str = ''])

string $type: Тип кнопки (значение атрибута type).
string $value: Текст кнопки (значение атрибута value).
string $name: Имя кнопки (значение атрибута name).
string $id: Идентификатор кнопки (значение атрибута id).
string $dop_str: Дополнительные св-ва кнопки (например, стили).

addField (строка 231)

Добавляет новое поле в форму

access: public

void addField (string $title, &$field, [string $th_str = ''], [string $td_str = ''], [string $tr_str = ''], mixed $field)

string $title: Заголовок поля.
mixed $field: Поле (объект типа sbLayoutText, sbLayoutTextarea и т.д.).
string $th_str: Доп. свойства тегов th.
string $td_str: Доп. свойства тегов td.
string $tr_str: Доп. свойства тегов tr.
&$field

addHeader (строка 242)

Добавляет новый заголовок в форму

access: public

void addHeader ($title $title)

$title $title: Текст заголовка.

addPluginFieldsTemps (строка 1178)

Выводит макеты дизайна пользовательских полей, настраиваемых в Макетах данных модулей

access: public

void addPluginFieldsTemps (string $ident, array $values, string $prefix, [ $tags = array()], [ $tags_values = array()], [bool $categs = false], [ $sufix = ''])

string $ident: Уникальный идентификатор модуля.
array $values: Массив, содержащий значения для каждого поля.
string $prefix: Префикс, использующийся для массива;
bool $categs: Выводить макеты дизайна полей разделов (TRUE) или элементов (FALSE).
$tags
$tags_values
$sufix

addTab (строка 214)

Добавляет новую закладку в форму и запоминает ее индекс (для последующего добавления полей)

access: public

void addTab (string $title, [bool $show = true])

string $title: Заголовок закладки.
bool $show: Показывать закладку (TRUE) или нет (FALSE).

checkPluginFields (строка 577)

Проверяет пользовательские поля на корректность заполнения.

return: Ассоциативный массив для вставки в базу, если проверка прошла успешно, FALSE - в ином случае.
access: public

mixed checkPluginFields (string $ident, [int $id = -1], [string $id_name = ''], [bool $categs = false])

string $ident: Уникальный идентификатор модуля.
int $id: Уникальный идентификатор элемента, если элемент редактируется, или раздела, если раздел редактируется.
string $id_name: Наименование поля таблицы, где хранится уникальный идентификатор элемента.
bool $categs: Выводить поля разделов (TRUE) или элементов (FALSE).

deletePluginFieldsFiles (строка 893)

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

access: public

void deletePluginFieldsFiles ()

getPluginFields (строка 258)

Выводит пользовательские поля, настраиваемые в Макетах данных модулей

return: TRUE, если пользовательские поля найдены, FALSE - в ином случае.
access: public

bool getPluginFields (string $ident, [int $id = -1], [string $id_name = ''], [bool $categs = false])

string $ident: Уникальный идентификатор модуля.
int $id: Уникальный идентификатор элемента, если элемент редактируется, или раздела, если раздел редактируется.
string $id_name: Наименование поля таблицы, где хранится уникальный идентификатор элемента. Для разделов '';
bool $categs: Выводить поля разделов (TRUE) или элементов (FALSE).

getPluginFieldsTags (строка 1338)

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

access: public

void getPluginFieldsTags (string $ident, &$tags, &$tags_values, [bool $categs = false], array $tags, array $tags_values)

string $ident: Уникальный идентификатор модуля.
array $tags: Ссылка на массив тегов.
array $tags_values: Ссылка на массив описаний.
bool $categs: Выводить поля разделов (TRUE) или элементов (FALSE).
&$tags
&$tags_values

getTabCount (строка 1570)

Функция возвращает кол-во закладок

return: Кол-во закладок
access: public

int getTabCount ()

setAutoLoading (строка 1560)

Устанавливает событие и параметры, вызываемое для подгрузки закладок через AJAX

Данное событие должно возвращать HTML-код подгружаемой закладки. ID закладки передается событию через $_GET['tab_id'].

access: public

void setAutoLoading (string $url)

string $url: Событие и параметры.

show (строка 1582)

Выводит форму (если параметр $echo установлен в false, то возвращает HTML-код формы

return: HTML-код формы.
access: public

string show ([bool $echo = true])

bool $echo: Выводить форму в браузер пользователя или нет

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

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