K4:Configuration
From In-Portal Developers Guide
Path to article:
| Line 46: | Line 46: | ||
| 0 | | 0 | ||
|- | |- | ||
| - | | {{ConfigProperty|ForceImageMagickResize|int}} || | + | | {{ConfigProperty|ForceImageMagickResize|int}} || This configuration variable says that image scaling must be done using the [http://www.imagemagick.org/script/index.php ImageMagicк] program, even if the <code>GD</code> library is available in <code>в PHP</code>. Available since [[K4:Core v 4.3.1|Core v 4.3.1]]. |
| 0 | | 0 | ||
|- | |- | ||
| - | | {{ConfigProperty|Email_As_Login|int}} || | + | | {{ConfigProperty|Email_As_Login|int}} || This configuration variable indicates the field that's used for authentication on the front-end. 1 - Email. 0 - Login. Available since [[K4:Core v 1.1.0|Core v 1.1.0]]. |
| 0 | | 0 | ||
|- | |- | ||
| - | | {{ConfigProperty|RegistrationCaptcha|int}} || | + | | {{ConfigProperty|RegistrationCaptcha|int}} || This configuration variable determines whether it's required for new users on the front end to enter an alphanumeric code, as proof that they are an actual person and not a robot. Values: 1 - required. 0 - not required. Available since [[K4:Core v 4.0.1|Core v 4.0.1]]. |
| 0 | | 0 | ||
|- | |- | ||
| - | | {{ConfigProperty|User_Allow_New|int}} || | + | | {{ConfigProperty|User_Allow_New|int}} || This configuration variable determines whether it's possible to register new users on the front-end. Values: |
| - | *1 - | + | *1 - registration is enabled, status of new users - active |
| - | *2 - | + | *2 - registration is disabled |
| - | *3 - | + | *3 - registration is enabled, status of new users - pending approval by the administrator |
| - | + | Available since version [[K4:Core v 1.0.0|Core v 1.0.0]]. | |
| 3 | | 3 | ||
|- | |- | ||
| - | | {{ConfigProperty|User_NewGroup|int}} || | + | | {{ConfigProperty|User_NewGroup|int}} || This configuration variable determines the user group, to which a new user is assigned if one was not specifically set. |
<source lang="php"> | <source lang="php"> | ||
$this->Application->GetVar('user_group') | $this->Application->GetVar('user_group') | ||
</source> | </source> | ||
| - | + | For security reasons, the variable <code>user_group</code> works only in the administrative console - so that users registering on the front end can't choose a group for themselves. Available since version [[K4:Core v 1.0.0|Core v 1.0.0]]. | |
| - | + | ||
| 13 (Member) | | 13 (Member) | ||
|- | |- | ||
| - | | {{ConfigProperty|User_MembershipExpirationReminder|int}} || | + | | {{ConfigProperty|User_MembershipExpirationReminder|int}} || In K4, users can be in user groups (Member, Subscribers, etc). Membership in a group can be constant or temporary. In the case where membership is temporary, this variable determines how many days before the end of the membership to send the [[K4:Отсылка почтового извещения|e-mail notice]] (event <code>USER.MEMBERSHIP.EXPIRATION.NOTICE</code>) to those whose membership is ending soon and the administrator. Available since version [[K4:Core v 1.0.0|Core v 1.0.0]]. |
| - | + | ||
| 10 | | 10 | ||
|- | |- | ||
| - | | {{ConfigProperty|User_Password_Auto|int}} || | + | | {{ConfigProperty|User_Password_Auto|int}} || This variable determines whether the system should automatically generate a password for a user when the new user is created. Values: 1 - yes, 0 - no. If this option is turned on, then on the registration form on the front-end, there's no need to show the user the password field. Available since version [[K4:Core v 1.0.0|Core v 1.0.0]]. |
| - | + | ||
| 0 | | 0 | ||
|- | |- | ||
| - | | {{ConfigProperty|FirstDayOfWeek|int}} || | + | | {{ConfigProperty|FirstDayOfWeek|int}} || This configuration variable determines the day of the week on which the week should start and affects how the calendar looks. Typical values: 1 - Monday, 0 - Sunday. Available since version [[K4:Core v 1.1.2|Core v 1.1.2]]. |
| 1 | | 1 | ||
|- | |- | ||
Revision as of 13:32, 17 March 2009
| ||
|---|---|---|
| Статьи в этой категории | ||
|
Described here are all available configuration variables in K4. Each variable is a record in 2 tables:
- ConfigurationAdmin - visual representation of the variable in the administrative console;
- ConfigurationValues - value of the variable in the administrative console.
Contents |
Configuration Variables
Core
| name | description | default setting | ||
|---|---|---|---|---|
UseCronForRegularEvent (int) | Indicates how regular events are to be carried out. If turned on, then all scheduled events will be carried out only through cron. | 0 | ||
UseChangeLog (int) | Indicates that database changes must be written to the log file. Available since version Core v 4.3.0. | 0 | ||
KeepSessionOnBrowserClose (int) | Indicates that the session must NOT expire when the browser is closed. Turned off by default, i.e. when the browser is closed the session EXPIRES. Available since version Core v 4.2.2.
| 0 | ||
AutoRefreshIntervals (string) | The available intervals of automatically refreshing grids. Comma separated values in minutes. Available in "View Menu" for grids. Available since version Core v 4.3.0. | 1,5,15,30,60,120,240 | ||
RememberLastAdminTemplate (int) | Indicates that after authentication the user should not be redirected to the last template they were on. Only for the administrative console. Available since version Core v 4.3.1.
| 0 | ||
SSL_URL (string) | Indicates the URL, where the site is accessible when using SSL. The address must always start with "https://" and must not end with "/". Available since version Core v 1.1.2.
| |||
AdminSSL_URL (string) | Indicates the URL, where the site's administrative console is accessible through SSL (it's not necessary to include ("/admin"). The URL must always start with "https://" and must not end with "/". If the field for this configuration variable is left blank, the the value for the SSL_URL variable will be used. Available since version Core v 4.3.1.
| |||
Require_AdminSSL (int) | Indicates that access to the administrative console is only through SSL. Available since version Core v 4.1.0. | 0 | ||
Require_SSL (int) | This configuration variable indicates that on templates with the tag m_CheckSSL with parameter condition="Require_SSL", the site must automatically switch into SSL-mode (obviously if the site is not already in SSL-mode). <inp2:m_CheckSSL mode="required" condition="Require_SSL"/> | 0 | ||
Force_HTTP_When_SSL_Not_Required (int) | If this configuration variable is turned on, then when the site user, while in SSL-mode, enters a template that doesn't require SSL, he will be automatically redirected to an equivalent http:// template (for example the address "https://www.test.com/no_ssl.html" will become "http://www.test.com/no_ssl.html").
| 1 | ||
UseModRewriteWithSSL (int) | If this configuration variable is turned on and SSL is turned on for the front-end, then URLs in SSL-mode will also be built using mod_rewrite technology (just like when not in SSL-mode).
| 0 | ||
AllowSelectGroupOnFront (int) | This configuration variable allows the site user, on the Front-End, to choose for him or herself, the permissions group that he or she wants (virtual field UserGroup). It will only be possible to choose from those groups that allow this (see field FrontRegistration). Available since version Core v 4.3.1.
| 0 | ||
ForceImageMagickResize (int) | This configuration variable says that image scaling must be done using the ImageMagicк program, even if the GD library is available in в PHP. Available since Core v 4.3.1.
| 0 | ||
Email_As_Login (int) | This configuration variable indicates the field that's used for authentication on the front-end. 1 - Email. 0 - Login. Available since Core v 1.1.0. | 0 | ||
RegistrationCaptcha (int) | This configuration variable determines whether it's required for new users on the front end to enter an alphanumeric code, as proof that they are an actual person and not a robot. Values: 1 - required. 0 - not required. Available since Core v 4.0.1. | 0 | ||
User_Allow_New (int) | This configuration variable determines whether it's possible to register new users on the front-end. Values:
Available since version Core v 1.0.0. | 3 | ||
User_NewGroup (int) | This configuration variable determines the user group, to which a new user is assigned if one was not specifically set.
$this->Application->GetVar('user_group') For security reasons, the variable | 13 (Member) | ||
User_MembershipExpirationReminder (int) | In K4, users can be in user groups (Member, Subscribers, etc). Membership in a group can be constant or temporary. In the case where membership is temporary, this variable determines how many days before the end of the membership to send the e-mail notice (event USER.MEMBERSHIP.EXPIRATION.NOTICE) to those whose membership is ending soon and the administrator. Available since version Core v 1.0.0.
| 10 | ||
User_Password_Auto (int) | This variable determines whether the system should automatically generate a password for a user when the new user is created. Values: 1 - yes, 0 - no. If this option is turned on, then on the registration form on the front-end, there's no need to show the user the password field. Available since version Core v 1.0.0. | 0 | ||
FirstDayOfWeek (int) | This configuration variable determines the day of the week on which the week should start and affects how the calendar looks. Typical values: 1 - Monday, 0 - Sunday. Available since version Core v 1.1.2. | 1 | ||
NoPermissionTemplate (string) | Эта переменная конфигурации задаёт шаблон, на который происходит перенаправление в случае несоответствия прав доступа пользователя требованиям, предъявляемым для отображения исходной страницы пользовательской части сайта. Доступна с версии Core v 1.2.0. | no_permission | ||
SessionCookieName (string) | Эта переменная конфигурации задаёт имя cookie, хранящей идентификатор сессии пользователя. Доступна с версии Core v 1.1.4. | sid | ||
SessionReferrerCheck (int) | Эта переменная конфигурации определяет, должна ли происходить проверка переменной $_SERVER['HTTP_REFERER'], когда идентификатор сессии пользователя может передаваться в обход cookies. Проверка даёт дополнительные гарантии что система не обработает ложные POST-запросы, сгенерированные вне системы. Доступна с версии Core v 1.1.4.
| 1 | ||
SessionTimeout (int) | Эта переменная конфигурации определяет как долго будет продолжаться сессия пользователя в случае отсутствия какой-либо активности с его стороны. Время задаётся в секундах. Время сохранения сессии ограничивается в целях безопасности. Доступна с версии Core v 1.0.0. | 3600 | ||
Site_Name (string) | Эта переменная конфигурации задаёт название сайта, отображаемое в заголовках страниц, в электронных сообщениях, посылаемых с сайта. Доступна с версии Core v 1.0.0. | KernelX | ||
Site_Path (string) | Эта переменная конфигурации задаёт путь к сайту относительно корневого каталога, соответствующего домену, используемому для доступа к сайту ($_SERVER['DOCUMENT_ROOT']). Например, если сайт находится в подкаталоге dev, значение этой переменной должно быть /dev/. Доступна с версии Core v 1.0.0.
| / | ||
Smtp_AdminMailFrom (string) | Эта переменная конфигурации задаёт обратный адрес электронной почты, используемый по умолчанию в сообщениях электронной почты, отправляемых с сайта. Доступна с версии Core v 1.0.0. | portal@domain, где domain - домен, указанный при инсталляции сайта
| ||
Smtp_Authenticate (int) | Эта переменная конфигурации определяет нужна ли авторизация при обращению к серверу электронной почты. Значения: 1 - нужна, 0 - не нужна. Доступна с версии Core v 1.0.0. | 0 | ||
Smtp_User (int) | Эта переменная конфигурации определяет имя пользователя для доступа к почтовому серверу, в случае когда требуется авторизация. Доступна с версии Core v 1.0.0. | |||
Smtp_Pass (int) | Эта переменная конфигурации определяет пароль для доступа к почтовому серверу, в случае когда требуется авторизация. Доступна с версии Core v 1.0.0. | |||
Smtp_Server (int) | Эта переменная конфигурации позволяет задать домен или IP почтового сервера в случае, если не годится почтовый сервер по умолчанию, задаваемый конфигурацией PHP. Доступна с версии Core v 1.0.0.
| |||
UseModRewrite (int) | Эта переменная конфигурации определяет способ адресации страниц на пользовательской части сайта. Значения: 0 - mod-rewrite выключен, 1 - mod-rewrite включен. Если mod-rewrite выключен, то при адресации страницы её положение в структуре сайта задаётся в переменной env.
Если же
что бывает предпочтительно в смысле индексации сайта поисковыми роботами. Доступна с версии Core v 1.1.4. | 0 | ||
UseToolbarLabels (int) | Эта переменная конфигурации определяет будут ли в административной консоли, в Toolbar-ах показываться текстовые надписи под кнопками. Значения: 1 - будут, 0 - не будут. Это значение используется в JavaScript-функциях, генерирующих кнопки. Доступна с версии Core v 4.2.0. | 1 | ||
YahooApplicationId (string) | Эта переменная конфигурации позволяет задать Yahoo Application ID, которая в последствии будет использована для интеграции с возможностями, которые предоставляет сервис Yahoo. На данный момент она используется для осуществления орфографических подсказок на форме поиска. Доступна с версии Core v 4.3.2.
| |||
FilenameSpecialCharReplacement (string) | Эта переменная конфигурации позволяет символ, использующийся для замены запрещённых символов в названиях элементов, использующихся при построении ссылок в mod-rewrite режиме. До появления этой конфигурационной переменной использовался только символ "_", но теперь его можно заменить на "-". Доступна с версии Core v 4.3.2.
| _
|
In-Portal
| название | описание | по умолчанию |
|---|---|---|
RecycleBinFolder (int) | Если указать, то все записи из каталога после удаления будут попадать в категорию с ID, указанным здесь. Доступна с Core v 4.2.2. | |
UsePageHitCounter (int) | Указывать на то, что нужно считать общее количество посещений сайта (т.е. захода на каждую страницу на Front-End). Доступна с Core v 4.3.0. | 0 |
PageHitCounter (int) | Хранит в себе общее количество посещений сайта. Используется совместно с UsePageHitCounter. Доступна с Core v 4.3.0. | 0 |
RootPass (string) | Эта переменная конфигурации хранит hash пароля главного администратора сайта и используется для проверки пароля при входе главного администратора в администраторскую часть сайта. Доступна с версии Core v 1.0.0. | Задаётся администратором при инсталляции системы |
Root_Name (string) | Эта переменная содержит фразу, переводимую как название корневой категории системы (категории с номером 0). Используется для отображения элементов навигации. Доступна с версии Core v 1.0.0. | lu_rootcategory_name |
Proj-Base
| название | описание | по умолчанию | ||||
|---|---|---|---|---|---|---|
UseSmallHeader (int) | Позволяет убрать заголовок на grid.
Будет работать только при использовании блока | 0 | ||||
UsePopups (int) | Начинать создание/редактирование записей из grid в новом окне (popup). | 1 | ||||
TrimRequiredFields (int) | Указывает на то, что перед проверкой на наличие данных в обязательных полях к ним применяется функция trim(). Доступна с версии Core v 4.2.2.
| 0 | ||||
MenuFrameWidth (int) | Позволяет задать ширину фрэйма c деревом (в пикселях), по умолчанию 200. Доступна только в Platform с версии Core v 4.2.2. | 200 | ||||
DefaultSettingsUserId (int) | Пользователь, который используется когда новый администратор (у которого еще нет данных PersistentSession) первый раз заходит на любой список. Такому администратору проставляются значения PersistentSession от пользователя с указанным в этой переменной ID, а именно данные:
Таким образом если красиво настроить все списки (включая ширины колонок, т.к. они теперь тоже хранятся в PersistentSession) для root'а или другого пользователя (указав его Id), то эти настройки будут работать для новых пользователей по умолчанию. Также в раздел "
| -1 | ||||
AdvancedUserManagement (int) | Включает дополнительные возможности управления правами пользователей (администраторов) через группы. По умолчанию выключена. После включения необходимо очистить Sections Cache и перезагрузить фрейм с деревом. Параметр включает секцию Groups, в которой можно создавать группы по смыслу, а также просматривать и добавлять/удалять пользователей в этих группах. В редактировании администраторов добавляется закладка со списком групп в которых состоит пользователь. Для управления правами пользователей используется следующая схема: стандартной группе admin запрещается все, кроме права ADMIN.LOGIN, далее создаются группы по смыслу, которым разрешается доступ в нужные секции. Все администраторы автоматически добавляются в основную группу admin (при создании через соответствующую секцию). Далее их надо добавлять в нужные смысловые группы, НЕ УБИРАЯ из группы admin и НЕ МЕНЯЯ основную (primary) группу, т.к. в секции Administrators показываются пользователи, у которых основная группа - admin. Доступна только в Platform с версии Core v 4.2.2.
| 0 | ||||
UseDoubleSorting (int) | Эта переменная конфигурации определяет как меняется сортировка в списках. Сортировка меняется при выполнении события OnSetSorting - например, когда мышкой нажимают на заголовок столбца с данными. При UseDoubleSorting = 0 (значение по умолчанию) в итоге получается фильтр только по одному столбцу, на заголовок которого нажали. Если же UseDoubleSorting = 1, и мышкой поочерёдно нажимали на заголовки разных столбцов, то фильтр будет по двум столбцам - вначале по столбцу, нажатому последним, а затем - по столбцу, нажатому предпоследним.
| 0 |
Proj-CMS
| название | описание | по умолчанию |
|---|---|---|
ProjCMSAllowManualFilenames (int) | Эта переменная конфигурации разрешает пользователю редактировать название файла для mod-rewrite (галочка "Auto-filename" и само название файла). Доступна с версии Core v 4.0.1. | 0 |
In-Commerce
Переменные вида Comm_Shipping*** задают адрес с которого происходит доставка заказов и могут использоваться для расчёта стоимости доставки заказа.
| название | описание | по умолчанию |
|---|---|---|
Comm_RequireLoginBeforeCheckout (int) | Эта переменная конфигурации определяет должен ли покупатель авторизоваться на пользовательской части сайта для окончательного оформления заказа. 1 - должен авторизоваться. 0 - не должен. Доступна с версии In-Commerce v 1.0.0. | 0 |
Comm_Shipping_AddressLine1 (string) | Эта переменная конфигурации задаёт первую строку адреса с которого происходит доставка заказов. Доступна с версии In-Commerce v 1.0.0. | |
Comm_Shipping_AddressLine2 (string) | Эта переменная конфигурации задаёт вторую строку адреса с которого происходит доставка заказов. Доступна с версии In-Commerce v 1.0.0. | |
Comm_Shipping_City (string) | Эта переменная конфигурации задаёт город из которого происходит доставка заказов. Доступна с версии In-Commerce v 1.0.0. | |
Comm_Shipping_Country (string) | Эта переменная конфигурации задаёт страну из которой происходит доставка заказов. Выбирается одно из значений DestAbbr таблицы StdDestinations. Доступна с версии In-Commerce v 1.0.0.
| |
Comm_Shipping_State (string) | Эта переменная конфигурации задаёт штат или провинцию откуда происходит доставка заказов. Доступна с версии In-Commerce v 1.0.0. | |
Comm_Shipping_ZIP (string) | Эта переменная конфигурации задаёт почтовый индекс с которого происходит доставка заказов. Доступна с версии In-Commerce v 1.0.0. |
