From In-Portal Developers Guide

Revision as of 21:37, 19 April 2009

Unit Configs
Статьи в этой категории
Unit Configuration File Registration of Unit Classes Defining Database, Virtual and Calculated Fields Formatters Hooks Regular Events Using "TitlePresets" Option

Usually, each unit config is created to interact with one database table. For this, each field from the database table must be declared in the unit config. The Fields option exists for this purpose. This option is an associative array (almost all options in a unit config are associative arrays), in which the keys are the names of the table fields and the values are the options of these fields. This array can, for example, look like this:

'Fields' => Array (
	'ProductId' => Array('type' => 'int', 'not_null' => 1, 'default' => 0),
	'Name' => Array ('type' => 'string', 'formatter' => 'kMultiLanguage', 'required' => 1, 'max_len' => 255, 'default' => ''),
	'Description' => Array ('type' => 'string', 'formatter' => 'kMultiLanguage', 'default' => NULL),
),

From the above example it's not difficult to see that ProductId, Name and Description are fields, and the contents of the arrays are the sets of options for these fields. Fields options are divided into 3 groups:

• required - must always be there;
• validation - used to validate field values against the restrictions on the field values;
• formatter - used by the indicated formatter.

Required Options

Необязательные опции

Опции проверки соответствия

Все выше описанные опции можно объединить в группы по смыслу:

• интервалы (max_value_inc, min_value_inc, max_value_exc, min_value_exc) - опции, использующиеся для проверки принадлежности значения поля указанному интервалу (range);
• длинна (max_len, min_len) - опции, использующиеся для проверки длинны строки (length).

Если та, или иная опция не нужна, то можно просто убрать её определение из массива опций поля. В таком случае не надо будет ставить её значение в 0 или false.

Сообщения об ошибках

У каждого поля можно указать альтернативные тексты для всех ошибок используя опцию error_msgs (array). Ниже приведена таблица, в которой описаны все стандартные ошибки:

Эта опция задаётся в виде ассоциативного одномерного массива, в ключах которого указаны "pseudo" ошибок (см. приведённую выше таблицу), а в значениях соответствующие им тексты ошибок:

'error_msgs' => Array (
	'required' => '!la_error_CustomRequiredError!'
)

Если требуется чтобы перевод фразы стал текстом сообщения об ошибке, то нужно заключить её название в восклицательные знаки:

• "!la_error_ErrorPhrase!" - фраза (её перевод на текущем языке это текст ошибка);
• "Error Message" - текст (будет один для всех языков).

Опции форматера

Все оставшиеся опции обрабатываются указанным форматером. Вот, к примеру некоторые из них:

Автоматическое построение структуры

В K4 есть механизм, который автоматически выстраивает массив для опции Fields. Чтобы воспользоваться им следуйте приведённым шагам:

• пойти в секцию "Configuration -> System Tools" (в Platform) или "Tools -> System Tools" (в In-Portal);
• в поле "Table Structure" вписать имя таблицы (можно без TABLE_PREFIX) или префикс от unit config;
• нажать на кнопку "Go";
• откроется новое окно со структурой введённой таблицы:

Автоматически построенная структура таблицы

При добавлении новых полей в таблицу нужно повторить все выше описанные шаги, но из результата скопировать описание только нужных полей, а не всех как обычно. Не надо писать всё руками.

При построении структуры полям автоматически прописываются (если удаётся определить) следующие опции:

• type - php тип значения, которое будет храниться в поле;
• not_null - NULL или NOT NULL пометка;
• default - значение по умолчанию;
• formatter - класс форматера, пока только для дробный полей (float, double, decimal);
• max_len - ограничение по длине значения в поле, только для строковых полей (varchar).

Функциональность доступна начиная с Core v 4.1.0.