3.2.1. Конфигурационные файлы

Data Source Eng Data Source

Эта статья еще не закончена!

Вы видите это сообщение, поскольку текущая статья еще не закончена или содержит непроверенную информацию. Как написать статью.

Unit config - это файл в котором находится информация об одной таблице в базе данных и параметры, связанные с отображением и изменением данных в ней содержащихся. Файл из себя представляет ассоциативный массив в котором каждый ключ является отдельной опцией (сам массив находиться в переменной $config). Значение каждой опции может быть любого, доступного в php, типа. Опции могут быть взаимосвязаны между собой, однако их связь не возможно проследить анализируя только сам файл с unit config. Это лучше всего делать выполнив поиск названий этих опций в php коде K4.

Все стандартные опции

название опции

описание опции

Prefix (string)

Префикс этого unit config (должен быть уникальным среди всех unit configs). Содержание данной опции должно соответствовать правилу назначения имён.

ItemClass (array)

(использование)

Регистрирует в системе связку между префиксом и классом, для работы с одной записью в базе.

ListClass (array)

(использование)

Регистрирует в системе связку между префиксом и классом для отображения содержания таблицы из базы (фильтрация, per-page и т.п.).

EventHandlerClass (array)

(использование)

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

TagProcessorClass (array)

(использование)

Регистрирует в системе связку между префиксом и классом для обработки стандартных тэгов, использующихся для вывода информации.

RegisterClasses (array)

(использование)

Регистрирует в системе любые пользовательские классы.

AutoLoad (boolean)

Обеспечивает автоматическую загрузку (load) item объекта по ID, найденному в $_REQUEST.

CheckSimulatniousEdit (boolean)

Добавлено в версии 5.0.0.

Указывает на то, что для таблицы, указанной в данном конфигурационном файле должна производиться проверка на двойное редактирование записей. Данная проверка работает следующим образом: если один пользователь открывает на редактирование запись, которую уже редактирует другой пользователь, то первому пользователю будет показано предупреждение о том, что открытую им запись уже редактирует другой пользователь. В предупреждении будет указано имя пользователя и его IP-адрес.

QueryString (array)
RegularEvents (array)

(использование)

Выполняет указанные события с требуемым интервалом.

PortalStyleEnv (boolean)

Влияет на то, как переменные данного префикса будут выглядеть в переменной окружения Если задать в true, то не будет дефиса между префиксом и значением его первой переменной, т.е. будет m5, вместо m-5 как обычно.

CatalogItem (boolean)
AdminTemplatePath (string)
AdminTemplatePrefix (string)
SearchConfigPostfix (string)
ConfigPriority (integer)
PassPriority (integer)

Добавлено в версии 5.0.0.

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

Hooks (array)

(использование)

Позволяет добавлять новые hooks в систему.

ItemType (integer)
ViewMenuPhrase (string)
ItemPropertyMappings (array)
TitlePhrase (string)
IDField (string)

Название колонки в таблице, содержащей первичный ключ (primary key). Обычно это числовая колонка с опцией autoincrement.

StatusField (array)

Список колонок в таблице (обычно одна, напр. Array ('Status') или Array ('Enabled')), которые влияют на пиктограмму в каждой строке grid в In-Portal. Так же значение этой опции используется в событиях OnMassApprove и OnMassDecline.

OrderField (string)

Название поля, использующегося в событиях OnMassMoveUp и OnMassMoveDown для изменения порядка отображения записей в списке. Если опция не задана, то её значение будет равно Priority.

TitleField (string)

Название колонки в таблице, содержание которой будет использовано в заголовке формы редактирования этого item. Используется в опции TitlePresets.

TableName (string)

Название таблицы в базе данных для которой будет использоваться данный unit config, напр. TABLE_PREFIX.'Tests'.

SubItems (array)
TitlePresets (array)

Набор заголовков над grid и формами редактирования (текст на синем фоне), напр. «Editing Order 000554-002 - General», «Orders (5 of 17)».

EditTabPresets (array)
PermItemPrefix (string)
PermTabText (string)
PermSection (array)

Название секции (в дереве секций в левом frame), которая отвечает за проверку прав доступа к этому unit config, напр. Array('main' => 'custom:tests').

Sections (array)

(использование)

Набор секций в дереве из левого frame в административной консоли.

FilterMenu (array)
PopulateMlFields (boolean)

Указывает на то, должны ли сохраняться значения переводимых полей (напр. пришедших с формы) на языках, отличных от текущего.

ListSQLs (array)
ListSortings (array)
ItemSQLs (array)
CalculatedFields (array)

Вычисляемые поля в grid/item.

Fields (array)

(использование)

Описание полей из таблицы в базе данных (тип данных, форматер и т. п.).

VirtualFields (array)

(использование)

По структуре это такой же массив, как и в опции Fields. Единственное отличие в том, что значения этих полей не будут сохранены в базе данных.

Grids (array)
ConfigMapping (array)
AggregatedCalculatedFields (array)
AutoClone (boolean)
AutoDelete (boolean)
CacheModRewrite (boolean)
CatalogTabIcon (string)
Clones (array)
Constrain (string)
CustomFields (array)
FileCount (integer)
ForceDontLogChanges (boolean)
ForeignKey (string/array)
ImageCount (integer)
ImportKeys (array)
LogChanges (boolean)
ModuleFolder (string)
OwnerField (string)
ParentPrefix (string)
ParentTableKey (string/array)
RewritePriority (float)
SectionAdjustments (array)
SectionPrefix (string)
SiteConfigProcessed (boolean)
StatisticsInfo (array)
ReplacementTemplates (array)
UsePendingEditing (boolean)
DownloadHelperClass (string)