Application — объект приложения

Пространство имен: Bitrix\Main

Модуль: main — подключать отдельно не нужно

Доступно с версии: 12.0.7

Когда использовать

Класс Application — точка входа ядра. Объект приложения один на весь запрос, его возвращает метод getInstance. Через объект код получает контекст запроса, соединение с базой данных, кеш, сессии и добавляет фоновые задачи.

use Bitrix\Main\Application;

$application = Application::getInstance();
$request = $application->getContext()->getRequest();
$connection = Application::getConnection();

Класс абстрактный. Для запросов через браузер и AJAX ядро создает наследника Bitrix\Main\HttpApplication. Пролог ядра готовит приложение по шагам.

  1. Метод getInstance создает объект. Конструктор регистрирует сервисы из глобальных настроек, подключает обработчик ошибок, читает параметры кеша из адреса, добавляет фоновую задачу обработки очередей сообщений, если очереди не обрабатываются из консоли, и создает пул соединений с базой данных.
  2. Метод initialize создает контекст запроса, добавляет системные фоновые задачи и регистрирует сервисы модуля main.
  3. Метод start завершает подготовку запроса.
  4. Метод end отправляет ответ, а terminate выполняет фоновые задачи и завершает скрипт.

Подробнее — в статьях Объект приложения и контекст и Фоновые задачи.

Методы initializeBasicKernel, initializeExtendedKernel и isUtfMode устарели. Метод initializeBasicKernel ничего не делает, initializeExtendedKernel вызывает initializeContext, isUtfMode всегда возвращает true.

Методы класса

Объект и жизненный цикл

Метод Описание С версии
getInstance Возвращает объект приложения
hasInstance Проверяет, создан ли объект приложения
initialize Подготавливает ядро к обработке запроса
isInitialized Проверяет, подготовлено ли ядро
initializeContext Создает контекст запроса
start Завершает подготовку запроса
run Выполняет контроллер и отправляет ответ
end Отправляет ответ и завершает приложение
terminate Выполняет фоновые задачи и завершает скрипт
addBackgroundJob Добавляет фоновую задачу 20.5.0

Контекст и маршрутизация

Метод Описание С версии
getContext Возвращает контекст запроса
setContext Заменяет контекст запроса
getRouter Возвращает маршрутизатор
setRouter Заменяет маршрутизатор
getCurrentRoute Возвращает маршрут запроса
hasCurrentRoute Проверяет, задан ли маршрут запроса
setCurrentRoute Задает маршрут запроса

База данных и кеш

Метод Описание С версии
getConnection Возвращает соединение с базой данных 14.0.0
getConnectionPool Возвращает пул соединений 14.0.0
getCache Создает объект кеша
getManagedCache Возвращает управляемый кеш
getTaggedCache Возвращает тегированный кеш 14.0.18

Сессии

Метод Описание С версии
getSession Возвращает сессию
getKernelSession Возвращает сессию ядра
getCompositeSessionManager Возвращает менеджер обеих сессий
getSessionLocalStorageManager Возвращает менеджер локальных хранилищ сессии
getLocalSession Возвращает локальное хранилище сессии по имени

Обработка ошибок

Метод Описание С версии
getExceptionHandler Возвращает обработчик ошибок и исключений
createExceptionHandlerLog Создает журнал ошибок по настройкам
createExceptionHandlerOutput Создает вывод ошибок на экран

Окружение

Метод Описание С версии
getLicense Возвращает объект лицензии
getUserTypeManager Возвращает менеджер пользовательских полей
getDocumentRoot Возвращает корневой каталог сайта
getPersonalRoot Возвращает каталог /bitrix от корня сайта
resetAccelerator Сбрасывает кеш OPcache

Константы

Константа Значение Описание
JOB_PRIORITY_NORMAL 100 Приоритет фоновой задачи по умолчанию для addBackgroundJob
JOB_PRIORITY_LOW 50 Низкий приоритет фоновой задачи. С ним ядро запускает агенты

Смотрите также

Предыдущая
Следующая