From In-Portal Developers Guide

Revision as of 08:51, 25 February 2009

Unit Configs
Статьи в этой категории
Конфигурационные файлы Регистрация классов Описание полей таблицы Formatters Hooks Regular Events Работа с опцией TitlePresets

Обычно каждый unit config создаётся для взаимодействия с одной таблицей в базе данных. Для этого в нём необходимо объявить каждое поле из связанной таблицы в базе данных. Для этого существует опция Fields. Эта опция является ассоциативным массивом (почти все опции в unit config это ассоциативные массивы) , в котором ключи это названия полей в таблице, а значения это опции этих полей. Это массив может быть например таким:

'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),
),

Из приведённого примера несложно заметить, что ProductId, Name и Description это поля, а содержание остальных массивов это набор опций этих полей. Опции поля делятся на 3 группы:

• обязательные - должны всегда присутствовать;
• проверки соответствия (validation) - используются при проверки соответствия значения в поле с наложенными ограничениями на значение в поле;
• форматера - используются указанным форматером.

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

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

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

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

• интервалы (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.