K4:Constants

From In-Portal Developers Guide

Path to article:

Сообщество > Документация > Структура приложения
Код требующий реорганизации

(Difference between revisions)

Jump to: navigation, search

You need to have JavaScript enabled to use this page.

Revision as of 00:18, 29 March 2009

Структура приложения

Статьи в этой категории

В К4 константы делятся по смыслу исходя из места их определения на: In K4, constants are separated based on their meaning, separated into:

system - defined in "core/kernel/startup.php"
general application - defined in "core/kernel/constants.php"
modular - defined in the not required file "<module_name>/constants.php"

System constants

name	description
`FULL_PATH`	Full path to the site in the file system of the server.
`BASE_PATH`	Directory where the site is located (relative to $_SERVER['DOCUMENT_ROOT'])
`REL_PATH`	Path from the root of the project to the PHP-file (usually that's "`index.php`"), that the site user enters. Defining this constant must be done before or right after defining the constant FULL_PATH in this PHP file. This constant must be defined in all cases, when the PHP-file is not in the root of the project or in its "`admin`" directory. Examples: file: testing/folder/index.php - constant: "testing/folder" file: sub_folder/index.php - constant "sub_folder" This constant is used only to correctly determine the value of the constant BASE_PATH. If this constant isn't defined in time, then links built with the help of the method "`kApplicaton::HREF`" will be incorrect.
`SERVER_NAME`	The name of the Virtual Host, which is running the site (the contents of the variable $_SERVER['SERVER_NAME']).
`WRITEABLE`	The contents of the variables FULL_PATH and WRITEABLE_BASE together.
`MAX_UPLOAD_SIZE`	The maximum size of the file that can be uploaded to the server (in bytes).

Example:

http://alex.prod.intechnic.lv/test_project - path to the web browser
FULL_PATH - "/home/sites/alex/web/test_project"
BASE_PATH - "/test_project"
SERVER_NAME - "alex.prod.intechnic.lv"
WRITEBALE_BASE - "/system"
WRITEBALE - "/home/sites/alex/web/test_project/system"

General application constants

common types of records (statuses) in the database:

name	description	value
`STATUS_ACTIVE`	Active record.	1
`STATUS_DISABLED`	Inactive record.	0
`STATUS_PENDING`	Record is awaiting approval by the administrator.	-2

status of sections in the navigation tree in the administrative console:

name	description
`stTREE`	Section is present only in the navigation tree (almost all sections).
`stTAB`	Section is present only as a tab (see In-Commerce:Discounts & Coupons).

status of finished events in K4:

name	description
`erSUCCESS`	Event finished working successfully. После выполнения события будет сделано перенаправление, выполняемое для того, чтобы пользователь перезагрузив страницу (F5) повторно не вызвал это событие. Once the event finishes, there is an automatic redirect so that the event isn't called again in case the user refreshes the page (F5).
`erFAIL`	Event finished working, but didn't accomplish one or more of the requested tasks. There won't be a redirect.
`erFATAL`	The event didn't accomplish any part of its task (хуки won't continue). There won't be a redirect.
`erPERM_FAIL`	Checking прав доступа wasn't successful. There will be an automatic redirect to a template letting the user know that he doesn't have the required permissions for the event.
`erSTOP`	The event returns a response to an AJAX request. The template won't be parsed after running the event, debugger code won't be added either.

константы, использующиеся при редактировании содержания сайта через административную консоль.

название	описание
`EDITING_MODE`	Данная константа, начиная с Core v 5.0.0, заменяет собой методы `EditMode` в обработчике событий и тэгов префикса "`st`" и "`cms`". Значение этой константы может быть равно значению описанных ниже 3 констант или нулю, что будет означать, что пользователь не находиться в режиме редактирования содержания сайта. В независимости от режима редактирования содержания сайта оранжевые кнопки "`Edit`" будут появляться над теми фрагментами содержания страницы, которые можно изменить. Данная константа доступна начиная с Core v 5.0.0.
`EDITING_MODE_CMS`	Режим редактирования сайта, при котором изменяться может только содержание cms-блоков (это был единственный возможный режим редактирования сайта до Core v 5.0.0). Данная константа доступна начиная с Core v 5.0.0.
`EDITING_MODE_LAYOUT`	Режим редактирования сайта, при котором изменяться может изменяться только содержание блоков, при подключении которых был передан параметр "`layout_view`": <inp2:m_RenderElement name="block_name" layout_view="1"/> В теме "`default2007`" это блоки "`sidebar`" и "`content`" из текущего шаблона. Данная константа доступна начиная с Core v 5.0.0.
`EDITING_MODE_DESIGN`	Режим редактирования сайта, при котором изменяться может только дизайн показываемых на шаблоне блоков, т.е. блоков, которые были указаны в параметре "`design`" (в примере это "`design_block_name`") при подключении других (в примере это "`element_name`") блоков. Например: <inp2:m_RenderElement name="element_name" design="design_block_name"/> В теме "`default2007`" это блоки "`blue_box`" и "`content_box`". Данная константа доступна начиная с Core v 5.0.0.

разное:

название	описание	значение
`ENV_VAR_NAME`	Значение данной константы используется для определения названия переменной окружения в запросе к серверу.	`env`
`VALUE_LIST_SEPARATOR`	Значение, которое будет использоваться для объединения возможных опций в полях `ValueList` (во всех таблицах, кроме таблицы ConfigurationAdmin).	`\|\|`
`REGEX_EMAIL_USER`	Регулярное выражение, которое проверяет части с именем пользователя в адресе электронной почты (`email`). Используя константы REGEX_EMAIL_USER и REGEX_EMAIL_DOMAIN можно составить регулярное выражение для проверки адреса электронной почты: $regexp = '/^(' . REGEX_EMAIL_USER . '@' . REGEX_EMAIL_DOMAIN . ')$/i'; Константа доступна начиная с Core v 4.0.1.	[-a-zA-Z0-9!\#$%&*+\/=?^_`{\|}~.]+
`REGEX_EMAIL_DOMAIN`	Регулярное выражение, которое проверяет части с доменом (`domain`) в адресе электронной почты (`email`). Используя константы REGEX_EMAIL_USER и REGEX_EMAIL_DOMAIN можно составить регулярное выражение для проверки адреса электронной почты: $regexp = '/^(' . REGEX_EMAIL_USER . '@' . REGEX_EMAIL_DOMAIN . ')$/i'; Константа доступна начиная с Core v 4.0.1.	[a-zA-Z0-9]{1}[-.a-zA-Z0-9_]*\.[a-zA-Z]{2,6}

Константы это идентификаторы значений, которые не могут изменяться по ходу выполнения скрипта.

Константы из config.php

В базовой директории проекта (той, что в FULL_PATH константе) находиться файл config.php, который содержит настройки для подключения к базе данных и ряд других параметров, которые при инициализации K4 превращаются в константы. На данный файл нельзя, не в коем случае, делать commit. По своему формату этот файл похож на обычный ini файл. Единственное отличие это расширение файла и защитная php конструкция в его начале.

название константы	название опции	описание
`SQL_TYPE`	`DBType`	Тип сервера баз данных. Пока поддерживается только MySQL.
`SQL_SERVER`	`DBHost`	IP адрес или имя сервера баз данных.
`SQL_USER`	`DBUser`	Имя пользователя, для подключения к базе данных.
`SQL_PASS`	`DBUserPassword`	Пароль, для подключения к базе данных.
`SQL_DB`	`DBName`	Название базы данных.
`SQL_COLLATION`	`DBCollation`	Тип сопоставления строк, используемый при работе базой данных (напр. "`utf8_general_ci`").
`SQL_CHARSET`	`DBCharset`	Кодировка данных, используемая при работе базой данных (напр. "`utf8`").
`TABLE_PREFIX`	`TablePrefix`	Префикс таблиц проекта в базе данных.
`DOMAIN`	`Domain`	Домен, на котором сайт находиться. Используется для выхода из SSL-режима, а также для проверки лицензии в `In-Portal`.
`ADMIN_DIRECTORY`	`AdminDirectory`	Расположение директории с административной консолью относительно FULL_PATH. Доступна, начиная с Core v 4.3.0.
`EDITOR_PATH`	`EditorPath`	Расположение директории с `FCKEditor` относительно FULL_PATH (обычно "`/core/editor/`"). Доступна, начиная с Core v 4.3.2.
`WRITEABLE_BASE`	`WriteablePath`	Директория, в которую имеет право писать сервер (обычно "`/system`").
`APPLICATION_CLASS`	`ApplicationClass`	Класс, который используется для создания объекта Application, например "`EApplication`".
`APPLICATION_PATH`	`ApplicationPath`	Расположение файла с классом, указанным в APPLICATION_CLASS относительно корня сайта (с указанием "`/`" спереди), например. "`/custom/units/sections/e_application.php`".

@@ Line 3: / Line 3: @@
 In K4, constants are separated based on their meaning, separated into:
 * '''system''' - defined in "<code>core/kernel/startup.php</code>"
-* '''general use''' - defined in "<code>core/kernel/constants.php</code>"
+* '''general application''' - defined in "<code>core/kernel/constants.php</code>"
 * '''modular''' - defined in the not required file "<code><module_name>/constants.php</code>"
@@ Line 30: / Line 30: @@
 {{ambox | type = refactoring | text = Constants [[#WRITEABLE|WRITEABLE]] and [[#WRITEBALE_BASE|WRITEBALE_BASE]] are incorrectly named (misspelled). In English obviously, the correct names would be <code>'''WRITABLE'''</code> and <code>'''WRITABLE_BASE'''</code> respectively.}}
-Пример:
+Example:
-  http://alex.prod.intechnic.lv/test_project - путь в web browser
+  http://alex.prod.intechnic.lv/test_project - path to the web browser
   FULL_PATH - "/home/sites/alex/web/test_project"
   BASE_PATH - "/test_project"
@@ Line 38: / Line 38: @@
   WRITEBALE - "/home/sites/alex/web/test_project/system"
-== Константы общего применения ==
+== General application constants ==
-* распространённые типы записей (статусы) в базе данных:
+* common types of records (statuses) in the database:
 {| class="prettytable"
-! название || описание || значение
+! name || description || value
 |-
-| {{ConfigProperty|STATUS_ACTIVE}} || Запись активна. || <center>1</center>
+| {{ConfigProperty|STATUS_ACTIVE}} || Active record. || <center>1</center>
 |-
-| {{ConfigProperty|STATUS_DISABLED}} || Запись не активна. || <center>0</center>
+| {{ConfigProperty|STATUS_DISABLED}} || Inactive record. || <center>0</center>
 |-
-| {{ConfigProperty|STATUS_PENDING}} || Запись требует подтверждения администратора. || <center>-2</center>
+| {{ConfigProperty|STATUS_PENDING}} || Record is awaiting approval by the administrator. || <center>-2</center>
 |}
-* статусы секций в дереве в административной консоли:
+* status of sections in the navigation tree in the administrative console:
 {| class="prettytable"
-! название || описание
+! name || description
 |-
-| {{ConfigProperty|stTREE}} || Секция присутствует только в дереве (почти все секции).
+| {{ConfigProperty|stTREE}} || Section is present only in the navigation tree (almost all sections).
 |-
-| {{ConfigProperty|stTAB}} || Секция присутствует только как закладка (см. в [[In-Commerce:Discounts & Coupons]]).
+| {{ConfigProperty|stTAB}} || Section is present only as a tab (see [[In-Commerce:Discounts & Coupons]]).
 |}
-* статусы завершения [[K4:Events|событий]] в K4:
+* status of finished [[K4:Events|events]] in K4:
 {| class="prettytable"
-! название || описание
+! name || description
 |-
-| {{ConfigProperty|erSUCCESS}} || Событие успешно завершило своё выполнение. После выполнения события будет сделано перенаправление, выполняемое для того, чтобы пользователь перезагрузив страницу (F5) повторно не вызвал это событие.
+| {{ConfigProperty|erSUCCESS}} || Event finished working successfully. После выполнения события будет сделано перенаправление, выполняемое для того, чтобы пользователь перезагрузив страницу (F5) повторно не вызвал это событие. Once the event finishes, there is an automatic redirect so that the event isn't called again in case the user refreshes the page (F5).
 |-
-| {{ConfigProperty|erFAIL}} || Событие завершило свою работу, но не выполнило одну или более требуемых задач. Перенаправление происходить не будет.
+| {{ConfigProperty|erFAIL}} || Event finished working, but didn't accomplish one or more of the requested tasks. There won't be a redirect.
 |-
-| {{ConfigProperty|erFATAL}} || Событие полностью не сделало свою работу ([[K4:Hooks|хуки]] не будут выполняться). Перенаправление происходить не будет.
+| {{ConfigProperty|erFATAL}} || The event didn't accomplish any part of its task ([[K4:Hooks|хуки]] won't continue). There won't be a redirect.
 |-
-| {{ConfigProperty|erPERM_FAIL}} || Проверка [[К4:Permissions|прав доступа]] не прошла успешно. Автоматически будет выполнено перенаправление на шаблон сообщающий пользователю об отсутствии у него прав на данное событие.
+| {{ConfigProperty|erPERM_FAIL}} || Checking [[К4:Permissions|прав доступа]] wasn't successful. There will be an automatic redirect to a template letting the user know that he doesn't have the required permissions for the event.
 |-
-| {{ConfigProperty|erSTOP}} || Событие возвращает ответ в [[K4:Ajax|AJAX]] запрос. Шаблон не будет обработан после выполнения события, код отладчика тоже добавлен не будет.
+| {{ConfigProperty|erSTOP}} || The event returns a response to an [[K4:Ajax|AJAX]] request. The template won't be parsed after running the event, debugger code won't be added either.
 |}

In-Portal Developers Guide

K4:Constants

From In-Portal Developers Guide

Revision as of 00:18, 29 March 2009

System constants

General application constants

Константы из config.php

Search

Navigation

Toolbox

Personal tools