Class admin_forms_fields

---

[Строка 14]

admin_forms
   |
   --admin_forms_fields

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

---

Описание

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

Copyright © 2005-2010 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

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

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

author

Hostmake LLC

version

5.x

---

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

• $buttons = array()
  
• $external_html =  ''
  Свойство, содержащее html-код, дописываемый после отображения формы
• $fields = array()
  
• $form_params = array()
  Свойство с параметрами формы
• $menus = array()
  
• $SelectFilterCount =  0
  
• $tabs = array()
  

---

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

---

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

---

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

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

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

---

Методы

• admin_forms_fields admin_forms_fields()
  Конструктор класса
• int AddButton()
  Вставка кнопки в форму
• void AddExternalHtml()
  Добавить внешний HTML для формы
• int AddField()
  Добавление элемента на форму.
• int AddMenu()
  Добавление верхнего меню
• void AddSeparator()
  Вставка разделителя
• return AddTab()
  Вставка новой закладки
• mixed CopyAdminFormEvent()
  Копирование события формы центра администрирования
• mixed CopyAdminFormField()
  Копирование поля формы центра администрирования
• void CreateOptions()
  Создание тегов <option> для каждого элемента ассоциативного массива
• str GetExternalHtml()
  Получить установленный внешний HTML для формы
• void SetExternalHtml()
  Установить внешний HTML для формы
• void ShowForm()
  Отображение формы центра администрирования

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

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

• admin_forms::admin_forms()
  Конструктор, инициализирует значения свойств класса $this->AAction, $this->AAdditionalParams
• admin_forms::AddExternalReplace()
  Добавление внешней подстановки
• admin_forms::AddLanguage()
  Вставка/обновление информации о языке
• admin_forms::AddUserMessage()
  Добавление текста, выводимого перед формой
• admin_forms::ApplyFormat()
  Применяет формат отображения $format к строке $str.
• 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()
  Получение кода вызова DoLoadAjax для атрибута href
• admin_forms::GetHtmlCallTrigerSingleAction()
  Формирует ссылку действия для содержимого атрибута href тега a
• admin_forms::GetLanguage()
  Получение информации о языке центра администрирования
• admin_forms::GetLanguageByShortName()
  Получение информации о языке центра администрирования по его обозначени.
• admin_forms::GetOnClickCallDoLoadAjax()
  Получение кода вызова DoLoadAjax для события onClick
• admin_forms::GetOnClickCallTrigerSingleAction()
  Формирует ссылку действия для содержимого атрибута onclick тега a
• 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()
  Устанавливает значение AAction
• admin_forms::setAAdditionalParams()
  Устанавливает значение AAdditionalParams
• admin_forms::ShowBreadCrumbs()
  Отображение хлебных крошек.
• admin_forms::ShowForm()
  Обрабатывает действия формы, вызывает построение формы
• admin_forms::ShowLink()
  Показ строки ссылок
• admin_forms::WordExists()
  Проверка, существования идентификатора слова

---

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

admin_forms_fields::admin_forms_fields

admin_forms_fields( [array $form_params = array()] );

Описание

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

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

$form_params

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

• string $form_params['form_attribs'] атрибуты формы

[ Наверх ]




admin_forms_fields::AddButton

AddButton( array $param );

Описание

Вставка кнопки в форму

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

$param

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

• $param['name']
• $param['caption']
• $param['image']
• $param['type']

Возвращает

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

[ Наверх ]




admin_forms_fields::AddExternalHtml

AddExternalHtml( str $external_html );

Описание

Добавить внешний HTML для формы

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

$external_html

код

[ Наверх ]




admin_forms_fields::AddField

AddField( array $param );

Описание

Добавление элемента на форму.

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

$param

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

• int $param['tab_id'] идентификатор закладки
• int $param['type'] тип поля:
• 0 - Поле ввода (input).
• 1 - Флажок (checkbox).
• 2 - Выпадающий список (select).
• 3 - Зарезервировано для разделителя.
• 4 - Скрытое поле.
• 5 - Большое текстовое поле (textarea).
• 6 - Пароль.
• 7 - Визуальный редактор.
• 8 - Текст.
• 9 - Поле загрузки файла.
• 10 - Дата.
• 11 - Дата-время.
• 12 - Оценка-радиогруппа со звездочками.
• 13 - Радиогруппа.
• 14 - Компонент импорта из CSV-файла.
• 15 - Как есть. Используется при необходимости добавить в форму HTML-код.
• string $param['caption'] тестовое название поля
• string $param['name'] name-элемента
• string $param['lable'] пояснение для checkbox
• string $param['html_id'] id-элемента
• array $param['items'] массив элементов по форме:
  $param['items'][1] = 'Значение 1';
  $param['items'][2] = 'Значение 2';
• bool $param['apply_filter'] выводить для поля типа "Выпадающий список" поля фильтра, по умолчанию false
• array $param['attributes'] дополнительные атрибуты поля, например $param['attributes']['class'] = 'large';
• string $params['separator'] разделитель для радиогрупп, по умолчанию используется тег br
• array $param['options'] - дополнительные параметры формы:
• - $param['options']['make_small_image_from_big_show'] - отображать ли checkbox с подписью "Создать малое изображение из большого" (1 - отображать (по умолчанию), 0 - не отображать);
• - $param['options']['make_small_image_from_big_checked'] - вид ображения checkbox'а с подписью "Создать малое изображение из большого" выбранным (1 - отображать выбранным (по умолчанию), 0 - невыбранным);
• - $param['options']['load_small_image_show'] - отображать ли поле загрузки малого изображения (1 - отображать (по умолчанию), 0 - не отображать);
• - $param['options']['image_big_max_width'] - значение максимальной ширины большого изображения;
• - $param['options']['image_big_max_height'] - значение максимальной высоты большого изображения;
• - $param['options']['image_small_max_width'] - значение максимальной ширины малого изображения;
• - $param['options']['image_small_max_height'] - значение максимальной высоты малого изображения;
• - $param['options']['used_watermark_big_image_show'] - отображать ли checkbox с подписью "Наложить водяной знак на большое изображение" (1 - отображать (по умолчанию), 0 - не отображать);
• - $param['options']['used_watermark_big_image_checked'] - вид ображения checkbox'а с подписью "Наложить водяной знак на большое изображение" (1 - отображать выбранным (по умолчанию), 0 - невыбранным);
• - $param['options']['watermark_position_x'] - значение поля ввода с подписью "По оси X"
• - $param['options']['watermark_position_y'] - значение поля ввода с подписью "По оси Y"
• - $param['options']['used_big_image_preserve_aspect_ratio'] - отображать ли checkbox с подписью "Сохранять пропорции изображения" (1 - отображать (по умолчанию), 0 - не отображать);
• - $param['options']['used_big_image_preserve_aspect_ratio_checked'] - вид ображения checkbox'а с подписью "Сохранять пропорции изображения" (1 - отображать выбранным (по умолчанию), 0 - невыбранным);
• - $param['options']['used_watermark_small_image_show'] - отображать ли checkbox с подписью "Наложить водяной знак на малое изображение" (1 - отображать (по умолчанию), 0 - не отображать);
• - $param['options']['used_watermark_small_image_checked'] - вид ображения checkbox'а с подписью "Наложить водяной знак на малое изображение" (1 - отображать выбранным (по умолчанию), 0 - невыбранным);
• - $param['options']['big_image_path'] - адрес большого загруженного изображения
• - $param['options']['small_image_path'] - адрес малого загруженного изображения
• - $param['options']['show_big_image_params'] - параметр, определяющий отображать ли настройки большого изображения
• - $param['options']['show_small_image_params'] - параметр, определяющий отображать ли настройки малого изображения
• - $param['options']['used_small_image_preserve_aspect_ratio'] - отображать ли checkbox с подписью "Сохранять пропорции малого изображения" (1 - отображать (по умолчанию), 0 - не отображать);
• - $param['options']['used_small_image_preserve_aspect_ratio_checked'] - вид ображения checkbox'а с подписью "Сохранять пропорции малого изображения" (1 - отображать выбранным (по умолчанию), 0 - невыбранным);
• - $param['options']['onclick_delete_big_image'] - значение onclick для удаления большой картинки
• - $param['options']['href_delete_big_image'] - значение href для удаления большой картинки
• - $param['options']['onclick_delete_small_image'] - значение onclick для удаления малой картинки
• - $param['options']['href_delete_small_image'] - значение href для удаления малой картинки
• - $field['format']['minlen']['value'] минимальная длина содержимого поля
• - $field['format']['minlen']['message'] сообщение о несоответствии длины. Необязательное поле.
• - $field['format']['maxlen']['value'] максимальная длина содержимого поля
• - $field['format']['maxlen']['message'] сообщение о несоответствии длины. Необязательное поле.
• - $field['format']['reg']['value'] регулярное выражение для контроля содержимого поля
• - $field['format']['reg']['message'] сообщение о несоответствии длины.
• - $field['format']['fieldEquality']['value'] идентификатор поля в DOM-модели, которому должно соответствовать это поле.
• - $param['format']['fieldEquality']['message'] сообщение о несоответствии поля.
• - $field['format']['lib']['value'] название типового шаблона контроля содержимого поля
• int $param['template'] идентификатор макета (используется в визуальном редакторе)
• array $param['div_attributes'] - дополнительные атрибуты div-а, в который вложено поле с заголовом, например $param['div_attributes']['style'] = 'float: left;';
• mixed $param['value'] значение поля

Возвращает

индекс добавленного поля

[ Наверх ]




admin_forms_fields::AddMenu

AddMenu( [array $menu = array()] );

Описание

Добавление верхнего меню

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

$menu

массив с элементами меню

Возвращает

индекс добавленного меню

[ Наверх ]




admin_forms_fields::AddSeparator

AddSeparator( $tab_id );

Описание

Вставка разделителя

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

$tab_id

[ Наверх ]




admin_forms_fields::AddTab

AddTab( string $tab_caption, [ $tab_id = false] );

Описание

Вставка новой закладки

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

$tab_caption

название закладки

• string $param['name'] название закладки

$tab_id

Возвращает

int индекс закладки

[ Наверх ]




admin_forms_fields::CopyAdminFormEvent

CopyAdminFormEvent( int $admin_form_event_id );

Описание

Копирование события формы центра администрирования

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

$admin_form_event_id

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

Возвращает

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

 <?php
 $admin_forms_fields = new admin_forms_fields();
 
 $admin_form_event_id = 399;
 
 $newid = $admin_forms_fields->CopyAdminFormEvent($admin_form_event_id);
 
 // Распечатаем результат
 echo $newid;
 ?>

[ Наверх ]




admin_forms_fields::CopyAdminFormField

CopyAdminFormField( int $admin_form_field_id );

Описание

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

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

$admin_form_field_id

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

Возвращает

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

 <?php
 $admin_forms_fields = new admin_forms_fields();
 
 $admin_form_field_id = 683;
 
 $newid = $admin_forms_fields->CopyAdminFormField($admin_form_field_id);
 
 // Распечатаем результат
 echo $newid;
 ?>

[ Наверх ]




admin_forms_fields::CreateOptions

CreateOptions( $aOptions $aOptions, $sCurrentValue $sCurrentValue );

Описание

Создание тегов <option> для каждого элемента ассоциативного массива

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

$aOptions

массив значений

$sCurrentValue

текущее значение

[ Наверх ]




admin_forms_fields::GetExternalHtml

GetExternalHtml( );

Описание

Получить установленный внешний HTML для формы

[ Наверх ]




admin_forms_fields::SetExternalHtml

SetExternalHtml( str $external_html );

Описание

Установить внешний HTML для формы

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

$external_html

код

[ Наверх ]




admin_forms_fields::ShowForm

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

Overrides admin_forms::ShowForm() (Обрабатывает действия формы, вызывает построение формы)

Описание

Отображение формы центра администрирования

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

$admin_forms_id

$operation

[ Наверх ]

---

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

• $buttons = array() [Строка 18]
• Data type: mixed


• $external_html =  '' [Строка 28]
• Data type: string

Описание

Свойство, содержащее html-код, дописываемый после отображения формы



• $fields = array() [Строка 17]
• Data type: mixed


• $form_params = array() [Строка 39]
• Data type: arrayOverrides: Array
  

Описание

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

var

- массив хлебных крошек, передается по форме
[x]['name'] - название ссылки
[x]['link'] - адрес ссылки

• $form_params['path_separator'] - разделитель для хлебных крошек


• $menus = array() [Строка 19]
• Data type: mixed


• $SelectFilterCount =  0 [Строка 21]
• Data type: mixed


• $tabs = array() [Строка 16]
• Data type: mixed

---

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

---