Class admin_forms

[Строка 14]

Classes extended from admin_forms:

admin_forms_fields: Система управления сайтом HostCMS v. 5.xx

Размещен: /admin_forms/admin_forms.class.php

Описание

Система управления сайтом HostCMS v. 5.xx

Формы центра администрирования.

Файл: /modules/admin_forms/admin_forms.class.php

author

Hostmake LLC

version

5.x

Свойства класса

$AAction = ''
Значение AAction, переданное DoLoadAjax
$AAdditionalParams = ''
Значение AAdditionalParams, переданное DoLoadAjax
$CacheGetAdminFormsWord = array()
Массив-кэш для метода GetAdminFormsWord()
$CacheGetLanguage = array()
Массив кэш для GetLanguage()
$CacheGetLanguageByShortName = array()
Массив-кэш для GetLanguageByShortName()
$CallbackFunctionName = 'LoadAjaxData'
Наименование функции обратного вызова
$data_under_menu =
Код для вывода под меню
$debug =
Сообщения отладки
$export_csv = false
Флаг экспорта в CSV
$external_replaces = array()
Массив внешнех подстановок, применяется в DoReplaces()
$form_params = array()
Свойство с параметрами формы
$on_page = 0
Число элементов формы на страницу
$order_field_direction = 1
Направление сортировки: 1 - ASC, 2 - DESC.
$order_field_id = 0
Идентификатор поля сортировки.
$page_number = 0
Номер текущей страницы формы
$ShowBottom = true
Показывать нижнюю строку с действиями
$ShowFilter = true
Показывать фильтр
$ShowOperations = true
Показывать действия
$user_function_message = ''
Строка с суммарной строкой ошибок, произошедших в пользовательских событиях.
$user_function_result = ''
Строка с результатом выполнения пользовательской функции.
$window_id = NULL
Идентификатор окна

Константы класса

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

Унаследованные свойства класса

Методы

admin_forms admin_forms()
Конструктор, инициализирует значения свойств класса $this->AAction, $this->AAdditionalParams
void AddExternalReplace()
Добавление внешней подстановки
mixed AddLanguage()
Вставка/обновление информации о языке
void AddUserMessage()
Добавление текста, выводимого перед формой
void ApplyFormat()
Применяет формат отображения $format к строке $str.
array CreateForm()
Прорисовка формы центра администрирования.
void CreateMainMenu()
bool DeleteAdminForm()
Удаление формы центра администрирования
resource DeleteAdminFormsEvent()
Удаление события (дейтсвия) формы администрирования
resource DeleteAdminFormsField()
Удаление поля формы администрирования
boolean DeleteAdminLanguage()
Удаление языка центра администрирования
bool DeleteWord()
Удаление слова и всех его значений
string DoReplaces()
Подстановка стандартных значений полей
void ExecuteUsersEvents()
Вызов пользовательских ф-ций (событий)
array GetAdminForm()
Получение данных о форме центра управления.
mixed GetAdminFormsEvent()
Получение информации о событии (действии) формы центра администрирования
mixed GetAdminFormsEventByName()
Получение информации о событии (действии) формы центра администрирования по идентификатору формы и псевдониму действия
mixed GetAdminFormsField()
Извлечение информации о поле формы центра администрирования
mixed GetAdminFormsWord()
Получение названия и описания слова на выбранном языке
mixed GetAdminFormsWordOrDefaultLanguageWord()
Получение названия и описания слова на выбранном языке. Если для выбранного языка не найдено значение, получается значения для языка "по умолчанию".
array GetAllAdminFormEvents()
Получение списка всех событий формы администрирования
array GetAllAdminFormFields()
Получение списка всех полей формы администрирования
array GetAllEvents()
Получение списка всех событий формы центра администрирования
array GetAllLanguages()
Извлечение всех языков
array GetAllWordsByLanguage()
Извлечения списка слов определенного языка
string GetHtmlCallDoLoadAjax()
Получение кода вызова DoLoadAjax для атрибута href
string GetHtmlCallTrigerSingleAction()
Формирует ссылку действия для содержимого атрибута href тега a
mixed GetLanguage()
Получение информации о языке центра администрирования
mixed GetLanguageByShortName()
Получение информации о языке центра администрирования по его обозначени.
string GetOnClickCallDoLoadAjax()
Получение кода вызова DoLoadAjax для события onClick
string GetOnClickCallTrigerSingleAction()
Формирует ссылку действия для содержимого атрибута onclick тега a
int GetOnPageCount()
Получение числа элементов на страницу
mixed GetSettingsForForm()
Получение информации о настройках для формы у указанного пользователя.
void GetWindowId()
int InsertAdminForm()
Вставка/обновление формы центра управления
mixed InsertAdminFormsEvent()
Вставка/обновление информации о событии (дейтсвии) формы администрирования
int InsertAdminFormsField()
Вставка информации о поле формы центра администрирования
int InsertSettings()
Вставка/обновление информации о настройках формы для пользователя
int InsertWord()
Вставка/обновление слова
int InsertWordsValue()
Вставка информации о значении слова
bool ProcessAjax()
Обработчик вызывает обработку действий и построение формы
void setAAction()
Устанавливает значение AAction
void setAAdditionalParams()
Устанавливает значение AAdditionalParams
void ShowBreadCrumbs()
Отображение хлебных крошек.
array ShowForm()
Обрабатывает действия формы, вызывает построение формы
void ShowLink()
Показ строки ссылок
bool WordExists()
Проверка, существования идентификатора слова

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

Описания методов

admin_forms::admin_forms

admin_forms( );

Описание

Конструктор, инициализирует значения свойств класса $this->AAction, $this->AAdditionalParams

[ Наверх ]

admin_forms::AddExternalReplace

AddExternalReplace( string $name, string $value );

Описание

Добавление внешней подстановки

Принимаемые параметры

$name

навание подстановки

$value

значение подстановки

[ Наверх ]

admin_forms::AddLanguage

AddLanguage( array $param );

Описание

Вставка/обновление информации о языке

Принимаемые параметры

$param

массив параметров $param['admin_language_id'] идентификатор обновляемого языка $param['admin_language_name'] название языка $param['admin_language_active'] параметр, определяющий доступен язык или нет (1 - доступен (по умолчанию), 0 - не доступен ) $param['admin_language_order'] порядковый номер языка в списке языков $param['admin_language_short_name'] короткое обозначение языка

Возвращает

идентификатор вставленного/обновленного языка в случае успешного завершения, false - в противном случае

 <?php
 $admin_forms = new admin_forms();
 
 $param['admin_language_name'] = 'Французский';
 $param['admin_language_active'] = 0;
 $param['admin_language_order'] = 30;
 $param['admin_language_short_name'] = 'fr';
 
 $newid = $admin_forms->AddLanguage($param);
 
 // Распечатаем результат
 echo $newid;
 ?>

[ Наверх ]

admin_forms::AddUserMessage

AddUserMessage( string $message );

Описание

Добавление текста, выводимого перед формой

Принимаемые параметры

$message

текст сообщения

[ Наверх ]

admin_forms::ApplyFormat

ApplyFormat( string $str, string $format );

Описание

Применяет формат отображения $format к строке $str.

Если формат является пустой строкой - $str возвращается в исходном виде.

Принимаемые параметры

$str

исходная строка

$format

форма отображения. Строка формата состоит из директив: обычных символов (за исключением %), которые копируются в результирующую строку, и описатели преобразований, каждый из которых заменяется на один из параметров.

[ Наверх ]

admin_forms::CreateForm

CreateForm( int $admin_forms_id );

Описание

Прорисовка формы центра администрирования.

Принимаемые параметры

$admin_forms_id

идентификатор формы

Возвращает

данные о форме в массиве:
array(
'form_html' => Основной код,
'error' => Текст ошибки,
'title' => Заголовок страницы);

[ Наверх ]

admin_forms::CreateMainMenu

CreateMainMenu( $menu, [ $field_list = false], [ $first_level = true], [ $menu_id = false] );

Принимаемые параметры

$menu

$field_list

$first_level

$menu_id

[ Наверх ]

admin_forms::DeleteAdminForm

DeleteAdminForm( int $admin_forms_id );

Описание

Удаление формы центра администрирования

Принимаемые параметры

$admin_forms_id

идентификатор формы центра администрирования

Возвращает

результат выполнения запроса

 <?php
 $admin_forms = new admin_forms();
 
 $admin_forms_id = 1;
 
 $result = $admin_forms->DeleteAdminForm($admin_forms_id);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

[ Наверх ]

admin_forms::DeleteAdminFormsEvent

DeleteAdminFormsEvent( int $admin_forms_events_id );

Описание

Удаление события (дейтсвия) формы администрирования

Принимаемые параметры

$admin_forms_events_id

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

Возвращает

результат выполнения запроса

 <?php
 $admin_forms = new admin_forms();
 
 $admin_forms_events_id = 100001;
 
 $resource = $admin_forms->DeleteAdminFormsEvent($admin_forms_events_id);
 
 // Распечатаем результат
 echo $resource;
 ?>

[ Наверх ]

admin_forms::DeleteAdminFormsField

DeleteAdminFormsField( int $admin_forms_field_id );

Описание

Удаление поля формы администрирования

Принимаемые параметры

$admin_forms_field_id

идентификатор поля

Возвращает

результат выполнения запроса

 <?php
 $admin_forms = new admin_forms();
 
 $admin_forms_field_id = 100002;
 
 $resource = $admin_forms->DeleteAdminFormsField($admin_forms_field_id);
 
 // Распечатаем результат
 echo $resource;
 ?>

[ Наверх ]

admin_forms::DeleteAdminLanguage

DeleteAdminLanguage( int $admin_language_id );

Описание

Удаление языка центра администрирования

Принимаемые параметры

$admin_language_id

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

Возвращает

в случае успешного удаления, false - в противном случае

 <?php
 $admin_forms = new admin_forms();
 
 $admin_language_id = 100000;
 
 $result = $admin_forms->DeleteAdminLanguage($admin_language_id);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

[ Наверх ]

admin_forms::DeleteWord

DeleteWord( int $admin_words_id );

Описание

Удаление слова и всех его значений

Принимаемые параметры

$admin_words_id

идентификатор слова

Возвращает

результат выполнения запроса

 <?php
 $admin_forms = new admin_forms();
 
 $admin_words_id = 4;
 
 $result = $admin_forms->DeleteWord($admin_words_id);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

[ Наверх ]

admin_forms::DoReplaces

DoReplaces( [int $admin_forms_id = false], [array $field_list = false], string $subject );

Описание

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

Принимаемые параметры

$admin_forms_id

идентификатор формы, если указан - берется список полей данной формы.

$field_list

массив со списком полей, может быть false

$subject

строка, в которой необходимо произвести подстановки

Возвращает

строка с заменой подстановок

[ Наверх ]

admin_forms::ExecuteUsersEvents

ExecuteUsersEvents( int $admin_forms_id, $operation );

Описание

Вызов пользовательских ф-ций (событий)

Принимаемые параметры

$admin_forms_id

идентификатор формы центра управления

$operation

[ Наверх ]

admin_forms::GetAdminForm

GetAdminForm( int $admin_forms_id );

Описание

Получение данных о форме центра управления.

Принимаемые параметры

$admin_forms_id

идентификатор формы

Возвращает

массив с данными о форме

 <?php
 $admin_forms = new admin_forms();
 
 $admin_forms_id = 11;
 
 $row = $admin_forms->GetAdminForm($admin_forms_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

[ Наверх ]

admin_forms::GetAdminFormsEvent

GetAdminFormsEvent( int $admin_forms_events_id );

Описание

Получение информации о событии (действии) формы центра администрирования

Принимаемые параметры

$admin_forms_events_id

идентификатор события

Возвращает

массив с информацией о событии или false

 <?php
 $admin_forms = new admin_forms();
 
 $admin_forms_events_id = 1;
 
 $row = $admin_forms->GetAdminFormsEvent($admin_forms_events_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

[ Наверх ]

admin_forms::GetAdminFormsEventByName

GetAdminFormsEventByName( int $admin_forms_id, int $admin_forms_events_function );

Описание

Получение информации о событии (действии) формы центра администрирования по идентификатору формы и псевдониму действия

Принимаемые параметры

$admin_forms_id

идентификатор формы

$admin_forms_events_function

псевдоним действия (имя функции обработчика)

Возвращает

массив с информацией о событии или false

 <?php
 $admin_forms = new admin_forms();
 
 $admin_forms_id = 1;
 $admin_forms_events_function = 'edit_form';
 
 $row = $admin_forms->GetAdminFormsEvent($admin_forms_events_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

[ Наверх ]

admin_forms::GetAdminFormsField

GetAdminFormsField( int $admin_forms_field_id );

Описание

Извлечение информации о поле формы центра администрирования

Принимаемые параметры

$admin_forms_field_id

идентификатор поля

Возвращает

массив с информацией о поле или false

 <?php
 $admin_forms = new admin_forms();
 
 $admin_forms_field_id = 1;
 
 $row = $admin_forms->GetAdminFormsField($admin_forms_field_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

[ Наверх ]

admin_forms::GetAdminFormsWord

GetAdminFormsWord( int $admin_words_id, [int $admin_language_id = CURRENT_LANGUAGE_ID] );

Описание

Получение названия и описания слова на выбранном языке

Принимаемые параметры

$admin_words_id

идентификатор слова

$admin_language_id

идентификатор языка, по умолчанию - текущий

Возвращает

массив с результатом, ['name'] - имя, ['description'] - описание.

[ Наверх ]

admin_forms::GetAdminFormsWordOrDefaultLanguageWord

GetAdminFormsWordOrDefaultLanguageWord( int $admin_words_id, [int $admin_language_id = CURRENT_LANGUAGE_ID] );

Описание

Получение названия и описания слова на выбранном языке. Если для выбранного языка не найдено значение, получается значения для языка "по умолчанию".

Принимаемые параметры

$admin_words_id

идентификатор слова

$admin_language_id

идентификатор языка, по умолчанию - текущий

Возвращает

массив с результатом, ['name'] - имя, ['description'] - описание.

see

admin_forms::GetAdminFormsWord()

[ Наверх ]

admin_forms::GetAllAdminFormEvents

GetAllAdminFormEvents( [int $admin_forms_id = false] );

Описание

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

Принимаемые параметры

$admin_forms_id

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

Возвращает

с данными о полях или false

 <?php
 $admin_forms = new admin_forms();
 
 $admin_forms_id = false;
 
 $row = $admin_forms->GetAllAdminFormEvents($admin_forms_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

[ Наверх ]

admin_forms::GetAllAdminFormFields

GetAllAdminFormFields( [int $admin_forms_id = false] );

Описание

Получение списка всех полей формы администрирования

Принимаемые параметры

$admin_forms_id

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

Возвращает

со данными о полях или false

 <?php
 $admin_forms = new admin_forms();
 
 $admin_forms_id = false;
 
 $row = $admin_forms->GetAllAdminFormFields($admin_forms_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

[ Наверх ]

admin_forms::GetAllEvents

GetAllEvents( int $admin_forms_id, [int $users_id = false] );

Описание

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

Принимаемые параметры

$admin_forms_id

идентификатор формы центра администрирования

$users_id

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

Возвращает

массив со списком событий

 <?php
 $admin_forms = new admin_forms();
 
 $admin_forms_id = 11;
 
 $row = $admin_forms->GetAllEvents($admin_forms_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

[ Наверх ]

admin_forms::GetAllLanguages

GetAllLanguages( );

Описание

Извлечение всех языков

Возвращает

со списком языков или false

 <?php
 $admin_forms = new admin_forms();
 
 $rows = $admin_forms->GetAllLanguages();
 
 // Распечатаем результат
 print_r ($rows);
 ?>

[ Наверх ]

admin_forms::GetAllWordsByLanguage

GetAllWordsByLanguage( [int $admin_language_id = false] );

Описание

Извлечения списка слов определенного языка

Принимаемые параметры

$admin_language_id

идентификатор языка

Возвращает

массив с данными о словах

 <?php
 $admin_forms = new admin_forms();
 
 $admin_language_id = 1;
 
 $row = $admin_forms->GetAllWordsByLanguage($admin_language_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

[ Наверх ]

admin_forms::GetHtmlCallDoLoadAjax

GetHtmlCallDoLoadAjax( string $AAction, string $AAdditionalParams, int $AAdminFromsId, string $AOperation, [int $ALimit = 0], [int $AOnPage = 0], [mixed $AOrderFieldId = false], [mixed $AOrderDirection = false] );

Описание

Получение кода вызова DoLoadAjax для атрибута href

Принимаемые параметры

$AAction

адрес страницы для обращения, например, '/admin/admin_forms/admin_forms.php'

$AAdditionalParams

дополнительные параметры для передачи на страницу, например "&admin_forms_edit_id=$admin_forms_id"

$AAdminFromsId

идентификатор формы центра администрирования

$AOperation

наименование операции, например, 'load_data'

$ALimit

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

$AOnPage

количество записей на страницу. Необязательный параметр.

$AOrderFieldId

Идентификатор поля сортировки. Необязательный параметр.

$AOrderDirection

Направление сортировки (1 - ASC, 2 - DESC). Необязательный параметр.

Возвращает

строка кода вызова

[ Наверх ]

admin_forms::GetHtmlCallTrigerSingleAction

GetHtmlCallTrigerSingleAction( string $AOperation, string $AItemName, int $AAdminFromsId, [int $ALimit = 0], [int $AOnPage = 0], [mixed $AOrderFieldId = false], [mixed $AOrderDirection = false], [mixed $AAction = false], [mixed $AAdditionalParams = false] );

Описание

Формирует ссылку действия для содержимого атрибута href тега a

Принимаемые параметры

$AOperation

Наименование действия, например, 'edit_affiliate'

$AItemName

Наименование объекта с указанием источника и ID объекта по схеме check_{номер источника}_{код объекта}, например, 'check_0_10'

$AAdminFromsId

Идентификатор формы центра администрирования

$ALimit

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

$AOnPage

Количество записей на страницу. Необязательный параметр.

$AOrderFieldId

Идентификатор поля сортировки. Необязательный параметр.

$AOrderDirection

Направление сортировки (1 - ASC, 2 - DESC). Необязательный параметр.

$AAction

Адрес страницы для обращения, например, '/admin/admin_forms/admin_forms.php'.

$AAdditionalParams

Дополнительные параметры для передачи на страницу, например "&admin_forms_edit_id=$admin_forms_id"

Возвращает

строка кода вызова

[ Наверх ]

admin_forms::GetLanguage

GetLanguage( int $admin_language_id );

Описание

Получение информации о языке центра администрирования

Принимаемые параметры

$admin_language_id

идентификатор языка

Возвращает

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

 <?php
 $admin_forms = new admin_forms();
 
 $admin_language_id = 1;
 
 $row = $admin_forms->GetLanguage($admin_language_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

[ Наверх ]

admin_forms::GetLanguageByShortName

GetLanguageByShortName( $admin_language_short_name, int $admin_language_id );

Описание

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

Принимаемые параметры

$admin_language_id

идентификатор языка

$admin_language_short_name

Возвращает

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

 <?php
 $admin_forms = new admin_forms();
 
 $admin_language_short_name = 'ru';
 
 $row = $admin_forms->GetLanguageByShortName($admin_language_short_name);
 
 // Распечатаем результат
 print_r ($row);
 ?>

[ Наверх ]

admin_forms::GetOnClickCallDoLoadAjax

GetOnClickCallDoLoadAjax( string $AAction, string $AAdditionalParams, int $AAdminFromsId, string $AOperation, [int $ALimit = 0], [int $AOnPage = 0], [mixed $AOrderFieldId = false], [mixed $AOrderDirection = false] );

Описание

Получение кода вызова DoLoadAjax для события onClick

Принимаемые параметры

$AAction

адрес страницы для обращения, например, '/admin/admin_forms/admin_forms.php'

$AAdditionalParams

дополнительные параметры для передачи на страницу, например "&admin_forms_edit_id=$admin_forms_id"

$AAdminFromsId

идентификатор формы центра администрирования

$AOperation

наименование операции, например, 'load_data'

$ALimit

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

$AOnPage

количество записей на страницу. Необязательный параметр.

$AOrderFieldId

Идентификатор поля сортировки. Необязательный параметр.

$AOrderDirection

Направление сортировки (1 - ASC, 2 - DESC). Необязательный параметр.

Возвращает

строка кода вызова

[ Наверх ]

admin_forms::GetOnClickCallTrigerSingleAction

GetOnClickCallTrigerSingleAction( string $AOperation, string $AItemName, int $AAdminFromsId, [int $ALimit = 0], [int $AOnPage = 0], [mixed $AOrderFieldId = false], [mixed $AOrderDirection = false], [mixed $AAction = false], [mixed $AAdditionalParams = false] );

Описание

Формирует ссылку действия для содержимого атрибута onclick тега a

Принимаемые параметры

$AOperation

Наименование действия, например, 'edit_affiliate'

$AItemName

$AAdminFromsId

Идентификатор формы центра администрирования

$ALimit

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

$AOnPage

Количество записей на страницу. Необязательный параметр.

$AOrderFieldId

Идентификатор поля сортировки. Необязательный параметр.

$AOrderDirection

Направление сортировки (1 - ASC, 2 - DESC). Необязательный параметр.

$AAction

Адрес страницы для обращения, например, '/admin/admin_forms/admin_forms.php'.

$AAdditionalParams

Дополнительные параметры для передачи на страницу, например "&admin_forms_edit_id=$admin_forms_id"

Возвращает

строка кода вызова

[ Наверх ]

admin_forms::GetOnPageCount

GetOnPageCount( [mixed $admin_forms_id = false] );

Описание

Получение числа элементов на страницу

Принимаемые параметры

$admin_forms_id

идентификатор формы. Если не указан, берется из $_REQUEST['admin_forms_id']. по умолчанию false

Возвращает

число элементов на страницу

 <?php
 $admin_forms = new admin_forms();
 
 $result = $admin_forms->GetOnPageCount();
 
 // Распечатаем результат
 echo $result;
 ?>

[ Наверх ]

admin_forms::GetSettingsForForm

GetSettingsForForm( int $admin_forms_id, [int $users_id = false] );

Описание

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

Принимаемые параметры

$admin_forms_id

идентификтор формы центры администрирования

$users_id

идентификтор пользователя

Возвращает

массив с данными или false, если данные не найдены

 <?php
 $admin_forms = new admin_forms();
 
 $admin_forms_id = 11;
 
 $row = $admin_forms->GetSettingsForForm($admin_forms_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

[ Наверх ]

admin_forms::GetWindowId

GetWindowId( );

[ Наверх ]

admin_forms::InsertAdminForm

InsertAdminForm( array $param );

Описание

Вставка/обновление формы центра управления

Принимаемые параметры

$param

ассоциативный массив параметров
int $param['admin_forms_id'] идентификатор формы
int $param['admin_words_id'] идентификатор слова названия/описания формы
int $param['admin_forms_on_page'] количество строк, выводимых на страницу
string $param['admin_forms_key_field'] ключевое поле формы
int $param['admin_forms_show_operations'] отображать столбец действий
int $param['admin_forms_show_group_operations'] отображать групповые операции
string $param['admin_forms_default_order_field'] поле для сортировки по умолчанию
int $param['admin_forms_default_order_direction'] направление сортировки по умолчанию (1 - ASC, 2 - DESC)
int $param['users_id'] идентификатор пользователя, если false - берется текущий пользователь.

Возвращает

идентификатор вставленной/обновленной формы или false

see

InsertWordsValue() <code> <?php $admin_forms = new admin_forms(); $param['admin_words_id'] = 4; $param['admin_forms_on_page'] = 5; $param['admin_forms_key_field'] = ''; $param['admin_forms_show_operations'] = 1; $param['admin_forms_show_group_operations'] = 1; $param['admin_forms_default_order_field'] = ''; $param['admin_forms_default_order_direction'] = 1; $newid = $admin_forms->InsertAdminForm($param); // Распечатаем результат echo $newid; ?> </code>

see

admin_forms::InsertWord()

[ Наверх ]

admin_forms::InsertAdminFormsEvent

InsertAdminFormsEvent( array $param );

Описание

Вставка/обновление информации о событии (дейтсвии) формы администрирования

Принимаемые параметры

$param

массив с параметрами
int $param['admin_forms_events_id'] идентификатор события
int $param['admin_forms_id'] идентификатор формы центра администрирования
int $param['admin_words_id'] идентификатор слова с названием и описанием события
string $param['admin_forms_events_function'] функция вызываемая загрузчиком
string $param['admin_forms_events_picture'] путь к изображению
int $param['admin_forms_events_show_button'] отображать кнопку действия
int $param['admin_forms_events_group_operation'] отображать в групповых операциях
int $param['admin_forms_events_order'] порядок сортировки
int $param['users_id'] идентификатор пользователя, если false - берется текущий пользователь

Возвращает

идентификатор вставленной/обновленной записи или false

see

InsertWordsValue() <code> <?php $admin_forms = new admin_forms(); $param['admin_forms_id'] = 100000; $param['admin_words_id'] = 5; $param['admin_forms_events_function'] = ''; $param['admin_forms_events_picture'] = ''; $param['admin_forms_events_show_button'] = 1; $param['admin_forms_events_group_operation'] = 1; $param['admin_forms_events_order'] = 10; $newid = $admin_forms->InsertAdminFormsEvent($param); // Распечатаем результат echo $newid; ?> </code>

see

admin_forms::InsertWord()

[ Наверх ]

admin_forms::InsertAdminFormsField

InsertAdminFormsField( array $param );

Описание

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

Принимаемые параметры

$param

массив с параметрами
int $param['admin_forms_field_id'] идентификатор поля формы
int $param['admin_forms_id'] идентификатор формы
int $param['admin_words_id'] идентификатор слова названия/описания формы
string $param['admin_forms_field_name'] название поля БД
int $param['admin_forms_field_order'] порядок сортировки
int $param['admin_forms_field_type'] тип поля
string $param['admin_forms_field_format'] формат отображения данных
int $param['admin_forms_field_allow_order'] разрешить сортировку поля
int $param['admin_forms_field_allow_filter'] разрешить фильтр для поля
string $param['admin_forms_field_align_title'] выравнивание заголовка (left, center, right)
string $param['admin_forms_field_align'] выравнивание значения (left, center, right)
string $param['admin_forms_field_width'] ширина поля
string $param['admin_forms_field_style'] CSS-стиль
string $param['admin_forms_field_attrib'] список атрибутов
string $param['admin_forms_field_image'] путь к изображению с картинкой
string $param['admin_forms_field_list'] массив значений выпадающего списка
string $param['admin_forms_field_link'] адрес ссылки
int $param['users_id'] идентификатор пользователя, если false - берется текущий пользователь.

Возвращает

идентификатор вставленного поля

see

InsertWordsValue() <code> <?php $admin_forms = new admin_forms(); $param['admin_forms_id'] = 100000; $param['admin_words_id'] = 5; $param['admin_forms_field_name'] = 'New'; $param['admin_forms_field_order'] = 1; $param['admin_forms_field_type'] = 1; $param['admin_forms_field_allow_order'] = 1; $param['admin_forms_field_allow_filter'] = 1; $param['admin_forms_field_link'] = ''; $param['admin_forms_field_onclick'] = ''; $param['admin_forms_field_list'] = ''; $newid = $admin_forms->InsertAdminFormsField($param); // Распечатаем результат echo $newid; ?> </code>

see

admin_forms::InsertWord()

[ Наверх ]

admin_forms::InsertSettings

InsertSettings( array $param );

Описание

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

Принимаемые параметры

$param

массив параметров
int $param['admin_forms_settings_id'] идентификатор настройки, если не указан - производится вставка записи
int $param['users_id'] идентификатор пользователя
int $param['admin_forms_id'] идентификатор формы
int $param['admin_forms_settings_page_number'] номер страницы
int $param['admin_forms_settings_order_field_id'] идентификатор поля сортировки
int $param['admin_forms_settings_order_direction'] направление сортировки (1 - ASC, 2 - DESC)
string $param['admin_forms_settings_filter'] сериализованный массив с фильтром
int $param['admin_forms_settings_on_page'] число элементов на страницу

Возвращает

идентификтор вставленной/обновленной настройки или false

[ Наверх ]

admin_forms::InsertWord

InsertWord( array $param );

Описание

Вставка/обновление слова

Принимаемые параметры

$param

массив параметров

int $param['admin_words_id'] идентификатор слова
int $param['users_id'] идентификатор пользователя, если false - берется текущий пользователь

Возвращает

идентификатор вставленного/обновленного слова

see

admin_forms::InsertWordsValue()

[ Наверх ]

admin_forms::InsertWordsValue

InsertWordsValue( array $param );

Описание

Вставка информации о значении слова

Принимаемые параметры

$param

параметры

int $param['admin_words_value_id'] идентификатор значения слова
int $param['admin_words_id'] идентификатор слова (обязательный параметр)
int $param['admin_language_id'] идентификатор языка (обязательный параметр)
string $param['admin_words_value_name'] имя на указанном языке
string $param['admin_words_value_description'] описание на указанном языке

Возвращает

идентификатор вставленного значения слова

see

admin_forms::InsertWord()

[ Наверх ]

admin_forms::ProcessAjax

ProcessAjax( int $admin_forms_id );

Описание

Обработчик вызывает обработку действий и построение формы

Принимаемые параметры

$admin_forms_id

Идентификатор формы центра администрирования

[ Наверх ]

admin_forms::setAAction

setAAction( string $AAction );

Описание

Устанавливает значение AAction

Принимаемые параметры

$AAction

[ Наверх ]

admin_forms::setAAdditionalParams

setAAdditionalParams( string $AAdditionalParams );

Описание

Устанавливает значение AAdditionalParams

Принимаемые параметры

$AAdditionalParams

[ Наверх ]

admin_forms::ShowBreadCrumbs

ShowBreadCrumbs( );

Описание

Отображение хлебных крошек.

Используются данные $this->form_params['path_array'] и $this->form_params['path_separator']

[ Наверх ]

admin_forms::ShowForm

ShowForm( [int $admin_forms_id = 0], [mixed $operation = false] );

Overridden in child classes as:

admin_forms_fields::ShowForm(): Отображение формы центра администрирования

Описание

Обрабатывает действия формы, вызывает построение формы

Принимаемые параметры

$admin_forms_id

Идентификатор формы центра администрирования

$operation

наименование действия, если false - получается из $_GET['operation']. по умолчанию false

Возвращает

массив для передачи на отправку ProcessAjax, формат:
array(
'form_html' => Основной код,
'error' => Текст ошибки,
'title' => Заголовок страницы);

[ Наверх ]

admin_forms::ShowLink

ShowLink( int $total_count, int $count_on_page, int $current_page, [array $param = array()] );

Описание

Показ строки ссылок

Принимаемые параметры

$total_count

общее число записей

$count_on_page

число записей на страницу

$current_page

номер текущей страницы

$param

массив дополнительных параметров

$param['separator'] разделитель между ссылками
$param['count_num'] число ссылок перед и после текущей страницы, а также в окончании стороки ссылок
$param['first'] строка для отображения ссылки на первую страницу
$param['pred'] строка для отображения ссылки на предыдущую страницу
$param['last'] строка для отображения ссылки на последнюю страницу
$param['next'] строка для отображения ссылки на следующую страницу
$param['show_first'] параметр, определяющий показывать ссылку на первую страницу
$param['show_last'] параметр, определяющий показывать ссылку на последнюю страницу
$param['show_pred'] параметр, определяющий показывать ссылку на предыдущую страницу
$param['show_next'] параметр, определяющий показывать ссылку на следующую страницу
$param['admin_forms_id'] идентификатор формы центра администрирования

[ Наверх ]

admin_forms::WordExists

WordExists( int $admin_words_id );

Описание

Проверка, существования идентификатора слова

Принимаемые параметры

$admin_words_id

идентификатор слова

Возвращает

 <?php
 $admin_forms = new admin_forms();
 
 $admin_words_id = 60;
 
 $result = $admin_forms->WordExists($admin_words_id);
 
 if ($result)
 {
     echo "Слово существует";
 }
 else
 {
     echo "Слово не существует";
 }
 ?>

[ Наверх ]

Описания переменных

$AAction = '' [Строка 114]
Data type: str

Описание

Значение AAction, переданное DoLoadAjax

$AAdditionalParams = '' [Строка 121]
Data type: str

Описание

Значение AAdditionalParams, переданное DoLoadAjax

$CacheGetAdminFormsWord = array() [Строка 128]
Data type: array

Описание

Массив-кэш для метода GetAdminFormsWord()

$CacheGetLanguage = array() [Строка 142]
Data type: array

Описание

Массив кэш для GetLanguage()

$CacheGetLanguageByShortName = array() [Строка 135]
Data type: array

Описание

Массив-кэш для GetLanguageByShortName()

$CallbackFunctionName = 'LoadAjaxData' [Строка 148]
Data type: string

Описание

Наименование функции обратного вызова

$data_under_menu = [Строка 100]
Data type: string

Описание

Код для вывода под меню

$debug = [Строка 93]
Data type: string

Описание

Сообщения отладки

$export_csv = false [Строка 107]
Data type: boolean

Описание

Флаг экспорта в CSV

$external_replaces = array() [Строка 44]
Data type: array

Описание

Массив внешнех подстановок, применяется в DoReplaces()

$form_params = array() [Строка 37]
Data type: array

Описание

Свойство с параметрами формы

var

- $form_params['data'] - массив наборов данных

$form_params['limit'] - массив лимитов для источников данных по схеме [] = array('begin' => $x, 'count' => $y)
$form_params['error'] - тест ошибки, передаваемый из пользовательского обработчика
$form_params['total_count'] - массив с общим числом элементов на страницу для каждого набора данных
$form_params['redirect'] - адрес страницы, на которую необходимо осуществить редирект
$form_params['current_page'] - номер текущей страницы
$form_params['on_page'] - элементов на страницу
$form_params['menus'] - массив меню
$form_params['field_params'] - массив с перекрываемыми параметрами полей по наборам данных для каждого идентификатора набора данных
в виде $form_params['field_params'][<идентификатор набора данных>][<имя поля>] - массив параметров
$form_params['field_params'][<идентификатор набора данных>][<имя поля>]['callback_function'] - имя функции обратного вызова
$form_params['path_array'] - массив хлебных крошек, передается по форме
[x]['name'] - название ссылки
[x]['link'] - адрес ссылки
[x]['onclick'] - код события onclick
$form_params['path_separator'] - разделитель для строки навигации

$on_page = 0 [Строка 79]
Data type: int

Описание

Число элементов формы на страницу

$order_field_direction = 1 [Строка 72]
Data type: int

Описание

Направление сортировки: 1 - ASC, 2 - DESC.

$order_field_id = 0 [Строка 65]
Data type: int

Описание

Идентификатор поля сортировки.

$page_number = 0 [Строка 86]
Data type: int

Описание

Номер текущей страницы формы

$ShowBottom = true [Строка 166]
Data type: bool

Описание

Показывать нижнюю строку с действиями

$ShowFilter = true [Строка 154]
Data type: bool

Описание

Показывать фильтр

$ShowOperations = true [Строка 160]
Data type: bool

Описание

Показывать действия

$user_function_message = '' [Строка 51]
Data type: string

Описание

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

$user_function_result = '' [Строка 58]
Data type: string

Описание

Строка с результатом выполнения пользовательской функции.

$window_id = NULL [Строка 171]
Data type: mixed

Описание

Идентификатор окна

Class admin_forms

Свойства класса

Константы класса

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

Унаследованные свойства класса

Методы

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

Описания методов

admin_forms::admin_forms

admin_forms::AddExternalReplace

admin_forms::AddLanguage

admin_forms::AddUserMessage

admin_forms::ApplyFormat

admin_forms::CreateForm

admin_forms::CreateMainMenu

admin_forms::DeleteAdminForm

admin_forms::DeleteAdminFormsEvent

admin_forms::DeleteAdminFormsField

admin_forms::DeleteAdminLanguage

admin_forms::DeleteWord

admin_forms::DoReplaces

admin_forms::ExecuteUsersEvents

admin_forms::GetAdminForm

admin_forms::GetAdminFormsEvent

admin_forms::GetAdminFormsEventByName

admin_forms::GetAdminFormsField

admin_forms::GetAdminFormsWord

admin_forms::GetAdminFormsWordOrDefaultLanguageWord

admin_forms::GetAllAdminFormEvents

admin_forms::GetAllAdminFormFields

admin_forms::GetAllEvents

admin_forms::GetAllLanguages

admin_forms::GetAllWordsByLanguage

admin_forms::GetHtmlCallDoLoadAjax

admin_forms::GetHtmlCallTrigerSingleAction

admin_forms::GetLanguage

admin_forms::GetLanguageByShortName

admin_forms::GetOnClickCallDoLoadAjax

admin_forms::GetOnClickCallTrigerSingleAction

admin_forms::GetOnPageCount

admin_forms::GetSettingsForForm

admin_forms::GetWindowId

admin_forms::InsertAdminForm

admin_forms::InsertAdminFormsEvent

admin_forms::InsertAdminFormsField

admin_forms::InsertSettings

admin_forms::InsertWord

admin_forms::InsertWordsValue

admin_forms::ProcessAjax

admin_forms::setAAction

admin_forms::setAAdditionalParams

admin_forms::ShowBreadCrumbs

admin_forms::ShowForm

admin_forms::ShowLink

admin_forms::WordExists

Описания переменных

Описание констант класса