SessionLocalStorage — данные сессии по имени
Пространство имен: Bitrix\Main\Data\LocalStorage
Модуль: main — подключать отдельно не нужно
Когда использовать
Класс SessionLocalStorage хранит данные текущей сессии под отдельным именем, например временные настройки или список выбранных записей. Модули не делят общий массив $_SESSION, а получают каждый свое хранилище.
Метод Application::getInstance()->getLocalSession($name) возвращает хранилище с указанным именем. Создавать объект конструктором не нужно. Объект работает как массив. Код читает и записывает значения по ключу, проверяет ключ через isset, считает элементы через count и перебирает их в foreach.
Подробнее — в разделе «Сессионный кеш» статьи Сессии.
Как менеджер хранилищ сохраняет данные
- Менеджер хранилищ
SessionLocalStorageManagerзагружает данные при первом вызовеgetLocalSessionс этим именем. Повторный вызов в том же запросе возвращает тот же объект. - Менеджер сохраняет данные всех открытых хранилищ в обработчике события
OnAfterEpilog. Ядро отправляет событие при завершении приложения методомApplication::terminate, в том числе после эпилога страницы и после ответа контроллера. Если скрипт завершился черезexitбезterminate, менеджер не сохраняет изменения. - Менеджер хранит данные в кеше, если механизм кеша из
.settings.phpэто поддерживает, например Redis или Memcache. При файловом кеше менеджер хранит данные в сессии. Срок хранения в кеше по умолчанию — 86 400 секунд, его задает ключttlсекцииsession_local_storageконфигурации ядра. - Ключ хранения — идентификатор сессии ядра и имя хранилища через
_. Когда сессия получает новый идентификатор, менеджер загружает все хранилища сессии, меняет им ключ и при сохранении записывает данные под новым ключом. Под старыми ключами менеджер записывает пустые массивы.
Методы класса
| Метод | Описание | С версии |
|---|---|---|
| __construct | Создает хранилище с ключом хранения и именем | |
| getName | Возвращает имя хранилища | |
| getUniqueName | Возвращает ключ хранения | |
| setUniqueName | Задает ключ хранения | |
| get | Возвращает значение по ключу | |
| set | Записывает значение по ключу | |
| getData | Возвращает все данные | |
| setData | Заменяет все данные | |
| clear | Удаляет все данные | |
| offsetExists | Проверяет ключ при вызове isset |
|
| offsetGet | Возвращает значение при чтении $storage['key'] |
|
| offsetSet | Записывает значение при присваивании $storage['key'] = $value |
|
| offsetUnset | Удаляет значение при вызове unset |
|
| count | Возвращает число элементов | |
| getIterator | Возвращает итератор для foreach |
Наследование
Класс финальный и реализует интерфейсы PHP \ArrayAccess, \Countable и \IteratorAggregate. Методы offsetExists, offsetGet, offsetSet, offsetUnset, count и getIterator реализуют эти интерфейсы, код приложения вызывает их через синтаксис массива, функцию count и цикл foreach.