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 14: Line 14:
|-
|-
-
| [[K4:Регистрация классов|{{ConfigProperty|TagProcessorClass|Array}}]] || Регистрирует в системе связку между [[#Prefix|префиксом]] и классом для обработки стандартных тэгов, использующихся для вывода информации.
+
| [[K4:Регистрация классов|{{ConfigProperty|TagProcessorClass|Array}}]] || Registers a connection in the system between a [[#Prefix|prefix]] and class for processing standard tags, used for displaying information.
|-
|-
-
| [[K4:Регистрация классов|{{ConfigProperty|RegisterClasses|Array}}]] || Регистрирует в системе любые пользовательские классы.
+
| [[K4:Регистрация классов|{{ConfigProperty|RegisterClasses|Array}}]] || Registers any user classes in the system.
|-
|-
-
| {{ConfigProperty|AutoLoad|boolean}} || Обеспечивает автоматическую загрузку (load) <code>item</code> объекта по ID, найденному в <code>$_REQUEST</code>.
+
| {{ConfigProperty|AutoLoad|boolean}} || Automatically loads an <code>item</code> object by ID, which is found in <code>$_REQUEST</code>.
|-
|-
-
| {{ConfigProperty|CheckSimulatniousEdit|boolean}} || Указывает на то, что для таблицы, указанной в данном конфигурационном файле должна производиться проверка на двойное редактирование записей. Данная проверка работает следующим образом:<br>если один пользователь открывает на редактирование запись, которую уже редактирует другой пользователь, то первому пользователю будет показано предупреждение о том, что открытую им запись уже редактирует другой пользователь. В предупреждении будет указано имя пользователя и его IP-адрес. Доступна начиная с [[K4:Core v 5.0.0|Core v 5.0.0]].
+
| {{ConfigProperty|CheckSimulatniousEdit|boolean}} || Indicates that there must be a check for dual editing for the table that's declared in the configuration file. The check works in the following way:<br />If one user opens a record for edit, which is already being edited by another user, then the user will be shown a warning that the record he or she has opened is already being edited by another user. The warning will show the user's name and IP address. Available since [[K4:Core v 5.0.0|Core v 5.0.0]].
|-
|-
| {{ConfigProperty|QueryString|array}} ||
| {{ConfigProperty|QueryString|array}} ||
|-
|-
-
| [[K4:Regular Events|{{ConfigProperty|RegularEvents|array}}]] || Выполняет указанные события с требуемым интервалом.
+
| [[K4:Regular Events|{{ConfigProperty|RegularEvents|array}}]] || Executes the indicated events at the required interval.
|-
|-
-
| {{ConfigProperty|PortalStyleEnv|bool}} || Влияет на то, как переменные данного префикса будут выглядеть в [[K4:Переменная окружения|переменной окружения]]. Если задать в "<code>true</code>", то не будет дефиса между префиксом и значением его первой переменной, т.е. будет "<code>m5</code>", вместо "<code>m-5</code>" как обычно.
+
| {{ConfigProperty|PortalStyleEnv|bool}} || Controls how a prefix's variable will look in an [[K4:Переменная окружения|environment variable]]. If set to "<code>true</code>", then there won't be a hyphen between the prefix and the value of its first variable, i.e. it will be "<code>m5</code>", instead of "<code>m-5</code>" as usual.
|-
|-
| {{ConfigProperty|CatalogItem|bool}} ||
| {{ConfigProperty|CatalogItem|bool}} ||
Line 38: Line 38:
| {{ConfigProperty|ConfigPriority|int}} ||
| {{ConfigProperty|ConfigPriority|int}} ||
|-
|-
-
| {{ConfigProperty|PassPriority|int}} || Позволяет указать порядок, в котором данный префикс будет показываться среди остальных префиксов при построении значения [[K4:Environment|переменной окружения]]. Доступна начиная с [[K4:Core v 5.0.0|Core v 5.0.0]].
+
| {{ConfigProperty|PassPriority|int}} || Позволяет указать порядок, в котором данный префикс будет показываться среди остальных префиксов при построении значения [[K4:Environment|переменной окружения]]. Доступна начиная с [[K4:Core v 5.0.0|Core v 5.0.0]]. Allows setting the order in which a prefix will be shown amongst other prefixes in putting together the value of an [[K4:Переменная окружения|environment variable]]. Available since [[K4:Core v 5.0.0|Core v 5.0.0]].
|-
|-
-
| [[K4:Hooks|{{ConfigProperty|Hooks|array}}]] || Позволяет добавлять новые hooks в систему.
+
| [[K4:Hooks|{{ConfigProperty|Hooks|array}}]] || Allows adding new hooks to the system.
|-
|-
| {{ConfigProperty|ItemType|int}} ||
| {{ConfigProperty|ItemType|int}} ||
Line 50: Line 50:
| {{ConfigProperty|TitlePhrase|string}} ||
| {{ConfigProperty|TitlePhrase|string}} ||
|-
|-
-
| {{ConfigProperty|IDField|string}} || Название колонки в таблице, содержащей первичный ключ (primary key). Обычно это числовая колонка с опцией autoincrement.
+
| {{ConfigProperty|IDField|string}} || Name of the column in the table that holds the primary key. This is usually an integer column using autoincrement.
|-
|-
| {{ConfigProperty|StatusField|array}} || Список колонок в таблице (обычно одна, напр. '''<code>Array ('Status')</code>''' или '''<code>Array ('Enabled')</code>'''), которые влияют на пиктограмму в каждой строке grid в In-Portal. Так же значение этой опции используется в событиях [[EventHandler:OnMassApprove|OnMassApprove]] и [[EventHandler:OnMassDecline|OnMassDecline]].
| {{ConfigProperty|StatusField|array}} || Список колонок в таблице (обычно одна, напр. '''<code>Array ('Status')</code>''' или '''<code>Array ('Enabled')</code>'''), которые влияют на пиктограмму в каждой строке grid в In-Portal. Так же значение этой опции используется в событиях [[EventHandler:OnMassApprove|OnMassApprove]] и [[EventHandler:OnMassDecline|OnMassDecline]].

Revision as of 22:59, 1 April 2010

 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) Registers a connection in the system between a prefix and class for processing standard tags, used for displaying information.
RegisterClasses (Array) Registers any user classes in the system.
AutoLoad (boolean) Automatically loads an item object by ID, which is found in $_REQUEST.
CheckSimulatniousEdit (boolean) Indicates that there must be a check for dual editing for the table that's declared in the configuration file. The check works in the following way:
If one user opens a record for edit, which is already being edited by another user, then the user will be shown a warning that the record he or she has opened is already being edited by another user. The warning will show the user's name and IP address. Available since Core v 5.0.0.
QueryString (array)
RegularEvents (array) Executes the indicated events at the required interval.
PortalStyleEnv (bool) Controls how a prefix's variable will look in an environment variable. If set to "true", then there won't be a hyphen between the prefix and the value of its first variable, i.e. it will be "m5", instead of "m-5" as usual.
CatalogItem (bool)
AdminTemplatePath (string)
AdminTemplatePrefix (string)
SearchConfigPostfix (string)
ConfigPriority (int)
PassPriority (int) Позволяет указать порядок, в котором данный префикс будет показываться среди остальных префиксов при построении значения переменной окружения. Доступна начиная с Core v 5.0.0. Allows setting the order in which a prefix will be shown amongst other prefixes in putting together the value of an environment variable. Available since Core v 5.0.0.
Hooks (array) Allows adding new hooks to the system.
ItemType (int)
ViewMenuPhrase (string)
ItemPropertyMappings (array)
TitlePhrase (string)
IDField (string) Name of the column in the table that holds the primary key. This is usually an integer column using 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"