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:Unit Configuration File

From In-Portal Developers Guide

(Difference between revisions)
Jump to: navigation, search
(дополнение)
Line 1: Line 1:
-
{{NotFinished}}{{toc | category = Unit Configs | sortkey = 000.001}}'''Unit config''' - это файл в котором находится информация об '''одной''' таблице в базе данных и параметры, связанные с отображением и изменением данных в ней содержащихся. Файл из себя представляет ассоциативный массив в котором каждый ключ является отдельной опцией (сам массив находиться в переменной '''<code>$config</code>'''). Значение каждой опции может быть любого, [http://php.prod.intechnic.lv/manual/en/language.types.php доступного в php], типа. Опции могут быть взаимосвязаны между собой, однако их связь не возможно проследить анализируя только сам файл с unit config. Это лучше всего делать выполнив поиск названий этих опций в php коде K4.
+
{{NotFinished}}{{toc | category = Unit Configs | sortkey = 000.001}}'''Unit config''' - '''Unit config''' - this is a file, which containts information about '''one''' table in the database and the parameters that are associated with displaying and changing the data that's contained in it. The file is an associative array in which each key is a separate option (the array itself is located in the variable '''<code>$config</code>'''). The value of each option can be type available [http://php.prod.intechnic.lv/manual/en/language.types.php доступного in PHP]. The options can be interconnected with one another and their connections can't be determined by analyzing just the unit config file. This is better done by searching the names of these options in the PHP code of K4.
-
== Все стандартные опции ==
+
== All Standard Options ==
{| class="prettytable"
{| class="prettytable"
-
! название опции || описание опции
+
! Option Names || Option Descriptions
|-
|-
-
| {{ConfigProperty|Prefix|string}} || Префикс этого unit config (должен быть уникальным среди всех unit configs). Содержание данной опции должно соответствовать правилу [[K4:Назначение имён|названачения имён]].
+
| {{ConfigProperty|Prefix|string}} || The prefix of this unit config (must be unique amongst all unit configs). The contents of this option must follow [[K4:Назначение имён|naming conventions]] rules.
|-
|-
-
| [[K4:Регистрация классов|{{ConfigProperty|ItemClass|Array}}]] || Регистрирует в системе связку между [[#Prefix|префиксом]] и классом, для работы с одной записью в базе.
+
| [[K4:Регистрация классов|{{ConfigProperty|ItemClass|Array}}]] || Registers in the system a connection between a [[#Prefix|prefix]] and class for working with the one record in the database.
|-
|-
-
| [[K4:Регистрация классов|{{ConfigProperty|ListClass|Array}}]] || Регистрирует в системе связку между [[#Prefix|префиксом]] и классом для отображения содержания таблицы из базы (фильтрация, per-page и т.п.).
+
| [[K4:Регистрация классов|{{ConfigProperty|ListClass|Array}}]] || Registers the connection between a [[#Prefix|prefix]] and class in the system for the purposes of displaying the contents of a table in the database (filtering, per-page, etc.).
|-
|-
-
| [[K4:Регистрация классов|{{ConfigProperty|EventHandlerClass|Array}}]] || Регистрирует в системе связку между [[#Prefix|префиксом]] и классом для обработки стандартных событий из grid и форм редактирования.
+
| [[K4:Регистрация классов|{{ConfigProperty|EventHandlerClass|Array}}]] || Registers in the system the connection between a [[#Prefix|prefix]] and class for the purpose of processing standard events from grids and edit forms.
 +
 
|-
|-
| [[K4:Регистрация классов|{{ConfigProperty|TagProcessorClass|Array}}]] || Регистрирует в системе связку между [[#Prefix|префиксом]] и классом для обработки стандартных тэгов, использующихся для вывода информации.
| [[K4:Регистрация классов|{{ConfigProperty|TagProcessorClass|Array}}]] || Регистрирует в системе связку между [[#Prefix|префиксом]] и классом для обработки стандартных тэгов, использующихся для вывода информации.

Revision as of 00:08, 7 November 2009

 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 Unit Configs
Статьи в этой категории
Unit config - Unit config - this is a file, which containts information about one table in the database and the parameters that are associated with displaying and changing the data that's contained in it. The file is an associative array in which each key is a separate option (the array itself is located in the variable $config). The value of each option can be type available доступного in PHP. The options can be interconnected with one another and their connections can't be determined by analyzing just the unit config file. This is better done by searching the names of these options in the PHP code of K4.

All Standard Options

Option Names Option Descriptions
Prefix (string) The prefix of this unit config (must be unique amongst all unit configs). The contents of this option must follow naming conventions rules.
ItemClass (Array) Registers in the system a connection between a prefix and class for working with the one record in the database.
ListClass (Array) Registers the connection between a prefix and class in the system for the purposes of displaying the contents of a table in the database (filtering, per-page, etc.).
EventHandlerClass (Array) Registers in the system the connection between a prefix and class for the purpose of processing standard events from grids and edit forms.
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)
Retrieved from "http://guide.in-portal.org/eng/index.php/K4:Unit_Configuration_File"