In-Portal Developers Guide

This is a wiki-based Developers Guide for In-Portal Open Source CMS. The purpose of this guide is to provide advanced users, web developers and programmers with documentation on how to expand, customize and improve the functionality and the code the In-Portal software. Please consider contributing to our documentation writing effort.

K4:ConfigurationAdmin

From In-Portal Developers Guide

Jump to: navigation, search
Структура таблиц Структура таблиц
Статьи в этой категории

В данной таблице находятся правила оформления форм редактирования конфигурации и порядок отображения данных конфигурационных переменных в пределах каждой формы.

название описание
VariableName (string) Название переменной конфигурации. В последствии любую из переменных конфигурации можно будет получить именно по этому имени используя метод Application::ConfigValue.
heading (string) Название группы (фраза, согласно правилу назначения имён), в которой состоит данная переменная конфигурации. Название фразы должно начинаться с "la_section_", напр. "la_section_General". Все переменные, показываемые на шаблоне со списком конфигурационных переменных ("config/config_universal") сгруппированы по значению этого поля.
prompt (string) Текст (фраза, согласно правилу назначения имён), который будет показываться перед значением данной переменной конфигурации в списке переменных конфигурации.
element_type (string) Тип элемента на форме, который будет использоваться для ввода и отображения значения данной переменной конфигурации. Доступны следующие типы элементов:
  • select, multiselect, radio, checkbox - элементы ввода с ограниченным выбором;
  • text, textarea, password - элементы со свободным вводом.

Список возможных значений для элементов ввода с ограниченным выбором берётся из поля ValueList.

validation (string) Это поле не используется.
ValueList (string) Список возможных значений для элементов ввода с ограниченным выбором. Имеется возможность задавать статический список значений (заданный в этом поле) и динамический список значений (получаемый в результате sql запроса). Все указанные опции разделяются запятой (","). Можно комбинировать статические и динамические значения. Применяемые форматы значений:
  • key=title_phrase;
  • key=+title_text;
  • <SQL+>SELECT IdField AS OptionValue, TitleField AS OptionName FROM <PREFIX>TableName</SQL>;
  • <SQL>SELECT IdField AS OptionValue, TitlePhraseField AS OptionName FROM <PREFIX>TableName</SQL>.

Описание форматов значений:

  • key - значение опции, будет получено через метод kApplication::ConfigValue;
  • title_phrase - фраза, перевод которой увидит пользователь, выбравший данную опцию;
  • title_text - текст, которой увидит пользователь, выбравший данную опцию;
  • <PREFIX> - префикс таблиц в базе данных, который будет заменён на значение константы TABLE_PREFIX;
  • <SQL+> - в результате SQL запроса будут названия опций (title_text);
  • <SQL> - в результате SQL запроса будут названия фраз (title_phrase).
Image:Infobox Icon.gif Для элементов типа text и textarea здесь указываются дополнительные HTML-атрибуты (напр. size, rows и т.п.).
DisplayOrder (float) Ключ для сортировки опций, в пределах одной группы опций, перед отображением. Рекомендуется ставить значение данного поля, полученное по этой формуле: 
<порядковый номер группы> * 10 + <порядковый номер переменной конфигурации в группе> / 100

Например 2-я по порядку переменная конфигурация в 1-ой группе переменных будет иметь следующее значение данного поля: 10.02 (1 * 10 + 2 / 100).

GroupDisplayOrder (int) Если требуется чтобы 2 или более переменных конфигурации находились в одной строке, то нужно им указать одинаковое значение в поле DisplayOrder, а в этом поле поставить фактический порядок этих опций.
Install (int) Показывать эту опцию при инсталляции In-Portal.

См. также

Retrieved from "http://guide.in-portal.org/eng/index.php/K4:ConfigurationAdmin"