SessionInterface — интерфейс сессии

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

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

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

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

Интерфейс SessionInterface описывает сессию пользователя. Метод Application::getInstance()->getSession() возвращает объект сессии, через который код читает и записывает значения вместо массива $_SESSION.

Интерфейс содержит три основные группы методов.

  • get, set, has и remove работают со значениями по ключу.
  • start и save запускают и сохраняют сессию.
  • getId и regenerateId работают с идентификатором сессии.

Объекты сессии реализуют и интерфейс \ArrayAccess, поэтому значение можно прочитать как $session['key'].

Подробнее — в статье Сессии.

Методы интерфейса

Метод Описание С версии
get Возвращает значение по ключу
set Записывает значение по ключу
has Проверяет, есть ли ключ
remove Удаляет значение по ключу
clear Удаляет все значения
start Запускает сессию
isStarted Проверяет, запущена ли сессия
isAccessible Проверяет, можно ли запустить сессию
save Сохраняет данные и закрывает сессию
destroy Уничтожает сессию
getId Возвращает идентификатор сессии
setId Задает идентификатор сессии до запуска
regenerateId Меняет идентификатор сессии с сохранением данных
getName Возвращает имя cookie сессии
setName Задает имя cookie сессии до запуска
getSessionHandler Возвращает обработчик хранения сессии

Реализации

Класс Назначение
Bitrix\Main\Session\Session Сессия PHP. Хранит данные в $_SESSION через обработчик из .settings.php, например файлы, Redis или базу данных. Объект возвращает Application::getSession
Bitrix\Main\Session\KernelSession Сессия ядра в разделенном режиме. Хранит данные в зашифрованной cookie. Методы setId, getName и setName выбрасывают NotSupportedException, regenerateId ничего не делает
Bitrix\Main\Session\KernelSessionProxy Сессия ядра в обычном режиме. Передает вызовы объекту Session

Метод Application::getKernelSession возвращает объект сессии ядра. В обычном режиме это KernelSessionProxy, в разделенном — KernelSession. Секция session файла .settings.php задает режим. В разделенном режиме ядро запускает сессию Session лениво, при первом обращении к данным.

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