Context — контекст запроса
Пространство имен: Bitrix\Main
Модуль: main — подключать отдельно не нужно
Доступно с версии: 12.0.7
Когда использовать
Класс Context хранит запрос, ответ, сервер, сайт, язык и региональные настройки текущего запроса. Метод getCurrent возвращает контекст текущего запроса. Вызов Application::getInstance()->getContext() возвращает тот же объект. Для текущего запроса создавать объект конструктором не нужно.
Ядро заполняет контекст в начале запроса, когда подключает prolog_before.php:
- метод initialize задает запрос, ответ, сервер и переменные окружения,
- метод
HttpContext::initializeCultureзадает язык и региональные настройки, а в публичной части еще и сайт.
В публичной части ядро определяет сайт по домену и пути страницы. Если до подключения ядра задана константа SITE_ID или LANG, ядро берет сайт из нее. Константы SITE_ID и LANGUAGE_ID, которые не задали заранее, ядро задает из контекста. Эти константы и глобальный объект $APPLICATION — аналоги контекста в классическом API.
Подробнее — в разделе «Контекст» статьи Приложение и контекст.
Методы класса
| Метод | Описание | С версии |
|---|---|---|
| getCurrent | Возвращает контекст текущего запроса | |
| getRequest | Возвращает запрос | |
| getResponse | Возвращает ответ | |
| setResponse | Заменяет ответ | |
| getServer | Возвращает данные сервера | |
| getEnvironment | Возвращает переменные окружения | |
| getApplication | Возвращает приложение | |
| getSite | Возвращает идентификатор сайта | 14.0.0 |
| getSiteObject | Возвращает объект сайта | |
| setSite | Задает сайт | 14.0.0 |
| getLanguage | Возвращает идентификатор языка | |
| getLanguageObject | Возвращает объект языка | |
| setLanguage | Задает язык | |
| getCulture | Возвращает региональные настройки | |
| setCulture | Задает региональные настройки | |
| initialize | Задает запрос, ответ, сервер и переменные окружения |
Наследование
Реализации
| Класс | Собственные методы |
|---|---|
Bitrix\Main\HttpContext |
Методы выбора сайта и языка и смены адреса запроса — initializeCulture, rewriteUri, transferUri |
В HTTP-запросе метод getCurrent возвращает объект HttpContext.