Документация для разработчиков

Специальные переменные


Имя переменной Тип Описание
APPLICATION Г Глобальный объект класса CMain, предназначен для выполнения большинства общих стандартных операций (вывод заголовка, навигационной цепочки, меню и т.д.).
USER Г Глобальный объект класса CUser, хранит в себе данные авторизации текущего пользователя, предназначен для манипуляции параметрами текущего пользователя.
DB Г Глобальный объект класса CDataBase, предназначен для работы с базой данных.
DBType С Тип базы: "mysql", "mssql" или "oracle".

Пример:
$DBType = "mysql";
DBHost С Для следующих типов базы данных:
  • MySQL - адрес сервера базы данных, например, - "localhost"
  • Oracle - не используется
Пример:
$DBHost = "localhost";
$DBHost = "localhost:3307";
DBName С Для следующих типов базы данных:
  • MySQL - имя базы
  • Oracle - строка соединения
Пример для MySQL:
$DBName = "bitrix";
Пример для Oracle:
$DBName = "
    (DESCRIPTION = 
        (ADDRESS_LIST = 
            (ADDRESS = 
                (PROTOCOL = TCP)
                (HOST = 192.168.0.1)
                (PORT = 1521)
            )
        )
        (CONNECT_DATA = 
            (SERVICE_NAME = BX)
        )
    )
";
DBLogin С Логин пользователя для доступа в базу данных.

Пример:
$DBLogin = "root";
DBPassword С Пароль пользователя для доступа в базу данных.

Пример:
$DBPassword = "123456";
DBDebug С
И
Если данная переменная будет равна "true", то в случае ошибки при создании соединения с базой или в любом SQL запросе, сообщение об ошибке и полный текст этой ошибки будет отображаться в браузере. В противном случае - полный текст ошибки будет показан только администратору сайта.

Пример:
$DBDebug = true;
DBDebugToFile С
И
Если данная переменная будет равна "true", то все SQL запросы к базе данных и время их выполнения будут записываться в лог-файл /mysql_debug.sql (или /oracle_debug.sql). Данная возможность используется как правило для получения данных о скорости выполнения SQL запросов к базе данных.

Ведение подобного лога может серьезно замедлить работу сайта, поэтому пользоваться этим стоит кратковременно.

Пример:
$DBDebugToFile = true;
clear_cache Т Если значение данной переменной - "Y", то это отключает кеширование на текущей странице.

Примечание. Только для пользователей авторизованных с административными правами.

Пример:
http://www.site.ru/?clear_cache=Y
clear_cache_session Т Если значение данной переменной - "Y", то это отключает кеширование в рамках сессии. Для включения кэширования - достаточно один раз присвоить этой переменной значение "N".

Примечание. Только для пользователей авторизованных с административными правами.

Пример:
http://site.ru/?clear_cache_session=Y
http://site.ru/?clear_cache_session=N
compress Т Если значение данной переменной - "Y", то внизу страницы в рамках сессии будет выведена рамка показывающая информацию по сжатию данной страницы модулем "Компрессия": размер страницы до сжатия, размер страницы после сжатия, коэфициент сжатия. Для отключения вывода данной информации - достаточно один раз присвоить этой переменной значение "N".

Пример:
http://www.site.ru/?compress=Y
http://www.site.ru/?compress=N
show_page_exec_time Т Если значение данной переменной - "Y", то внизу страницы будет выводиться время выполнения данной страницы на сервере. Данная информация будет выводиться в рамках сессии. Для отключения ее вывода - достаточно один раз присвоить этой переменной значение "N".

Данная переменная позволяет получить объективную информацию о скорости работы сайта.

Пример:
http://site.ru/?show_page_exec_time=Y
http://site.ru/?show_page_exec_time=N
show_include_exec_time Т Если значение данной переменной - "Y", то на странице будет показано время выполнения всех функций CMain::IncludeFile, подключающей как компоненты так и обычные файлы. Данная информация будет выводиться в рамках сессии. Для отключения ее вывода - достаточно один раз присвоить этой переменной значение "N".

Примечание. Только для пользователей авторизованных с административными правами.

Пример:
http://site.ru/?show_include_exec_time=Y
http://site.ru/?show_include_exec_time=N
show_lang_files Т Если значение данной переменной - "Y", то внизу страницы будет выводиться список используемых на данной странице языковых файлов с возможностью поиска по ним. Данная информация будет выводиться в рамках сессии. Для отключения ее вывода - достаточно один раз присвоить этой переменной значение "N".

Данная переменная позволяет быстро найти ту или иную языковую фразу.

Пример:
http://www.site.ru/?show_lang_files=Y
http://www.site.ru/?show_lang_files=N
no_keep_statistic_KEY Т Если значение данной переменной - "Y", то это позволит отключить сбор статистики в рамках сессии. Для включения сбора статистики - достаточно один раз присвоить этой переменной значение "N". Как правило данную переменную используют для отключения сбора статистики в момент захода на сайт администратора.

KEY - лицензионный ключ хранимый в файле /bitrix/license_key.php

Пример:
http://site.ru/?no_keep_statistic_SM4-ML-PZDIO7TUMT3WP7H=Y
http://site.ru/?no_keep_statistic_SM4-ML-PZDIO7TUMT3WP7H=N
no_agent_statistic_KEY Т Если значение данной переменной - "Y", то это позволит отключить отработку агентов статистики в рамках сессии. Для включения отработки агентов в данной сесси - достаточно один раз присвоить этой переменной значение "N".

KEY - лицензионный ключ хранимый в файле /bitrix/license_key.php

Пример:
http://site.ru/?no_agent_statistic_SM4-ML-PZDIO7TUMT3WP7H=Y
http://site.ru/?no_agent_statistic_SM4-ML-PZDIO7TUMT3WP7H=N
key   Данную переменную можно использовать только при вызове скрипта /bitrix/admin/phpinfo.php. Если ее значение будет равным лицензионному ключу, то вышеупомянутый скрипт отрабатает без подключения административного пролога.

Пример:
http://site.ru/bitrix/admin/phpinfo.php?key=SM4-ML-PZDIRTH


Обозначения типов переменных:

  • Г (глобальная) - переменная автоматически создаётся в служебной части пролога
  • С (соединение с базой) - переменную можно определить только в файле хранящим параметры соединения к базе: /bitrix/php_interface/dbconn.php
  • И (инициализация) - переменную можно определить в одном из следующих файлов:
    • /bitrix/php_interface/init.php - дополнительные параметры портала
    • /bitrix/php_interface/ID сайта/init.php - дополнительные параметры сайта
  • Ттраница) - переменную можно задать в параметрах страницы при открытии ее в браузере


Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2018, «1С-Битрикс», 2018
Наверх