From In-Portal Developers Guide

Revision as of 16:19, 28 February 2009 (view source) Root (Talk | contribs) m (1 версия) ← Previous diff		Current revision (01:24, 28 November 2010) (view source) Dmitry (Talk | contribs) (Side-box)
(One intermediate revision not shown.)
Line 18:		Line 18:
	|-		|-
	| {{ConfigProperty|AutoLoad|boolean}} || Обеспечивает автоматическую загрузку (load) <code>item</code> объекта по ID, найденному в <code>$_REQUEST</code>.		| {{ConfigProperty|AutoLoad|boolean}} || Обеспечивает автоматическую загрузку (load) <code>item</code> объекта по ID, найденному в <code>$_REQUEST</code>.
		+	|-
		+	| {{ConfigProperty|CheckSimulatniousEdit|boolean}} || Указывает на то, что для таблицы, указанной в данном конфигурационном файле должна производиться проверка на двойное редактирование записей. Данная проверка работает следующим образом:<br>если один пользователь открывает на редактирование запись, которую уже редактирует другой пользователь, то первому пользователю будет показано предупреждение о том, что открытую им запись уже редактирует другой пользователь. В предупреждении будет указано имя пользователя и его IP-адрес. Доступна начиная с [[K4:Core v 5.0.0|Core v 5.0.0]].
	|-		|-
	| {{ConfigProperty|QueryString|array}} ||		| {{ConfigProperty|QueryString|array}} ||
Line 34:		Line 36:
	|-		|-
	| {{ConfigProperty|ConfigPriority|int}} ||		| {{ConfigProperty|ConfigPriority|int}} ||
		+	|-
		+	| {{ConfigProperty|PassPriority|int}} || Позволяет указать порядок, в котором данный префикс будет показываться среди остальных префиксов при построении значения [[K4:Environment|переменной окружения]]. Доступна начиная с [[K4:Core v 5.0.0|Core v 5.0.0]].
	|-		|-
	| [[K4:Hooks|{{ConfigProperty|Hooks|array}}]] || Позволяет добавлять новые hooks в систему.		| [[K4:Hooks|{{ConfigProperty|Hooks|array}}]] || Позволяет добавлять новые hooks в систему.
Line 89:		Line 93:
	| {{ConfigProperty|ConfigMapping|array}} ||		| {{ConfigProperty|ConfigMapping|array}} ||
	|}		|}
		+
		+	[[ru:{{FULLPAGENAME}}]]
		+	[[en:K4:Unit Configuration File]]

---

Current revision

This article is not finished yet! You see this message because current Article is finished yet or contains unverified information. How to write an Article.

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

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)	Указывает на то, что для таблицы, указанной в данном конфигурационном файле должна производиться проверка на двойное редактирование записей. Данная проверка работает следующим образом: если один пользователь открывает на редактирование запись, которую уже редактирует другой пользователь, то первому пользователю будет показано предупреждение о том, что открытую им запись уже редактирует другой пользователь. В предупреждении будет указано имя пользователя и его IP-адрес. Доступна начиная с Core v 5.0.0.
QueryString (array)
RegularEvents (array)	Выполняет указанные события с требуемым интервалом.
PortalStyleEnv (bool)	Влияет на то, как переменные данного префикса будут выглядеть в переменной окружения. Если задать в "true", то не будет дефиса между префиксом и значением его первой переменной, т.е. будет "m5", вместо "m-5" как обычно.
CatalogItem (bool)
AdminTemplatePath (string)
AdminTemplatePrefix (string)
SearchConfigPostfix (string)
ConfigPriority (int)
PassPriority (int)	Позволяет указать порядок, в котором данный префикс будет показываться среди остальных префиксов при построении значения переменной окружения. Доступна начиная с Core v 5.0.0.
Hooks (array)	Позволяет добавлять новые hooks в систему.
ItemType (int)
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)