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

From In-Portal Developers Guide

(Difference between revisions)
Jump to: navigation, search
m (категория)
m (1 версия)

Revision as of 16:14, 28 February 2009

Настройка системы Настройка системы
Статьи в этой категории

Здесь описаны все доступные переменные конфигурации K4. Каждая переменная представляет из себя запись в 2-х таблицах:

  • ConfigurationAdmin - визуальное представление переменной в административной консоли;
  • ConfigurationValues - значение переменной в административной консоли.

Contents

Переменные конфигурации

Core

название описание по умолчанию
UseCronForRegularEvent (int) Указывает на способ выполнения регулярных событий. Если включить данную переменную, то все регулярные события будут выполняться только из cron. 0
UseChangeLog (int) Указывает на то, что изменения в базе должны писаться в журнал изменений. Доступна с Core v 4.3.0. 0
KeepSessionOnBrowserClose (int) Указывает на то, что при закрытии браузера НЕ должна теряться (expire) его сессия. По умолчанию выключена, т.е. при закрытии браузера сессия ТЕРЯЕТСЯ. Доступна с версии Core v 4.2.2.
Image:Tipbox Icon.gif Ранее сессия пользователя была доступна и при повторном открытии браузера.
0
AutoRefreshIntervals (string) Возможные интервалы автоматического обновления списков. Указывается через запятую, задаётся в минутах. Доступно из "View Menu" у списков. Доступна с версии Core v 4.3.0. 1,5,15,30,60,120,240
RememberLastAdminTemplate (int) Указывает на то, что после прохождения идентификации пользователь не должен быть перенаправлен на последний посещённый им шаблон. Только для административной консоли. Доступна с версии Core v 4.3.1.
Image:Tipbox Icon.gif Ранее последний шаблон в административной консоли всегда восстанавливался после прохождения идентификации.
0
SSL_URL (string) Здесь указывается адрес сайта, по которому он доступен при использовании в SSL режиме. Адрес всегда должен начинаться с "https://" и не заканчиваться на "/". Доступна с версии Core v 1.1.2.
AdminSSL_URL (string) Здесь указывается адрес сайта, по которому будет доступна его административная консоль при использовании в SSL режиме ("/admin" указывать не нужно). Адрес всегда должен начинаться с "https://" и не заканчиваться на "/". Если значение данной конфигурационной переменной не указано, то будет использовано значение переменной SSL_URL. Доступна с версии Core v 4.3.1.
Require_AdminSSL (int) Эта переменная конфигурации говорит о том, что в административную консоль можно заходить только используя защищённое соединение, т.е. SSL. Доступна с версии Core v 4.1.0. 0
Require_SSL (int) Эта переменная конфигурации говорит о том, что при посещении шаблонов, на которых установлен тэг m_CheckSSL с параметром condition="Require_SSL" должен автоматически осуществляться переход в SSL-режим (конечно если сайт в таком уже не находиться). 
<inp2:m_CheckSSL mode="required" condition="Require_SSL"/>
 0
Force_HTTP_When_SSL_Not_Required (int) Если эта конфигурационная переменная включена, то если пользователь находясь в SSL-режиме заходит на шаблон, который не требует наличия SSL-режима, то он будет автоматически перенаправлен на эквивалентный http:// шаблон (напр. адрес "https://www.test.com/no_ssl.html" станет "http://www.test.com/no_ssl.html"). 1
UseModRewriteWithSSL (int) Если данная переменная конфигурации включена и для пользовательской части сайта включён режим mod-rewrite, то ссылки в SSL-режиме тоже будут строиться используя mod-rewrite технологию (как и не в SSL-режиме).
Image:Infobox Icon.gif Перед включением данной конфигурационной переменной нужно убедиться, что для сайта, указанного в конфигурационной переменной SSL_URL включена поддержка mod-rewrite (в настройках сервера).
0
AllowSelectGroupOnFront (int) Эта переменная разрешает пользователю на Front-End выбрать себе группу прав, которую он пожелает (виртуальное поле UserGroup). Можно выбирать только те группы, у которых это разрешено (см. поле FrontRegistration). Доступна с версии Core v 4.3.1. 0
ForceImageMagickResize (int) Эта переменная которая говорит, что изображения масштабировать нужно при помощи программы ImageMagicк, даже если библиотека GD доступна в PHP. Доступна с версии Core v 4.3.1. 0
Email_As_Login (int) Эта переменная конфигурации задаёт поле, используемое при авторизации на пользовательской части сайта. 1 - Email. 0 - Login. Доступна с версии Core v 1.1.0. 0
RegistrationCaptcha (int) Эта переменная конфигурации определяет, требуется ли при регистрации новых пользователей с пользовательской части сайта ввод буквенно-числового кода, подтверждающего что системой намерен пользоваться человек а не робот. Значения: 1 - требуется. 0 - не требуется. Доступна с версии Core v 4.0.1. 0
User_Allow_New (int) Эта переменная определяет возможность регистрации новых пользователей с пользовательской части сайта. Значения:
  • 1 - регистрация возможна, статус новых пользователей - активный
  • 2 - регистрация не возможна
  • 3 - регистрация возможна, статус новых пользователей - ожидают подтверждения со стороны администратора

Доступна с версии Core v 1.0.0.

3
User_NewGroup (int) Эта переменная определяет группу пользователей, к которой новый пользователь приписывается если не была задана явно другая группа. 
$this->Application->GetVar('user_group')

По соображениям безопасности переменная user_group таким образом работает только в административной консоли - чтобы посетители сайта не могли при регистрации назначить себе группу. Доступна с версии Core v 1.0.0.

13 (Member)
User_MembershipExpirationReminder (int) В K4 пользователи могут состоять в группах пользователей (Member, Subscribers и.т.п.). Членство в группе может быть постоянным или временным. В случае временного членства, эта переменная определяет за сколько дней до окончания членства в группе пользователю, чьё членство должно скоро прекратиться, и администратору сайта, будет высылаться почтовое извещение (событие USER.MEMBERSHIP.EXPIRATION.NOTICE).

Доступна с версии Core v 1.0.0.

10
User_Password_Auto (int) Эта переменная определяет должна ли система при создании нового пользователя автоматически сгенерировать пароль для этого пользователя. Значения: 1 - должна, 0 - не должна. Если эта опция включена, то в форме регистрации пользователя не надо показывать поля для ввода пароля.

Доступна с версии Core v 1.0.0.

0
FirstDayOfWeek (int) Эта переменная конфигурации определяет день недели, с которого начинается неделя и влияет на отображение календаря. Типичные значения: 1 - понедельник, 0 - воскресенье. Доступна с версии 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.

http://www.somedomain.com/index.php?env=-in-commerce/product/details:m304-1-1-3-s-:p-41----

Если же mod-rewrite включен, то положение страницы в структуре сайта отображается в виде каталогов-подкаталогов, именованных в соответствии с названиями категорий сайта и названием текущего объекта когда таковой представлен на странице,

http://www.somedomain.com/products/bikes/incredi_bike.html

что бывает предпочтительно в смысле индексации сайта поисковыми роботами. Доступна с версии 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.
до после

Будет работать только при использовании блока combined_header. Доступна с Core v 4.2.0.

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, а именно данные:
  • ColumnPicker'а;
  • PerPage;
  • Filters.

Таким образом если красиво настроить все списки (включая ширины колонок, т.к. они теперь тоже хранятся в PersistentSession) для root'а или другого пользователя (указав его Id), то эти настройки будут работать для новых пользователей по умолчанию. Также в раздел "Users Management -> Admins" добавлена кнопка Reset (только в Platform), которая стирает персональные настройки выбранным пользователям (только те, что берутся от пользователя по умолчанию) и таким образом пользователю можно принудительно выставить настройки списков (правда сразу всех) по умолчанию. Переменная по умолчанию имеет значение -1, т.е. "root". Доступна с версии Core v 4.2.2.

Image:Tipbox Icon.gif Если не ввести значение, то всё равно будет интерпретировано, как "-1" :(. Чтобы выключить данную функциональность нужно написать любое ID несуществующего пользователя, напр. 999999999999.
-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.

См. также

Retrieved from "http://guide.in-portal.org/eng/index.php/K4:Configuration"