Получить локальное хранилище сессии Application::getLocalSession

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

Метод Application::getLocalSession возвращает локальное хранилище сессии по имени. Хранилище хранит данные одного пользователя, например состояние мастера или фильтра. В отличие от getSession, данные хранилища могут находиться в кеше и не увеличивают сессию PHP.

Сигнатура метода в классе Bitrix\Main\Application:

final public function getLocalSession($name): Data\LocalStorage\SessionLocalStorage

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
name* string Задает имя хранилища, например vendor_units

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

Возвращаемое значение

Метод возвращает объект SessionLocalStorage. Повторный вызов с тем же именем возвращает тот же объект.

Особенности

Метод — короткая запись для getSessionLocalStorageManager()->get($name).

Примеры

Пример. Код сохраняет значение в хранилище и читает его:

<?php
use Bitrix\Main\Application;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$storage = Application::getInstance()->getLocalSession('vendor_units');
$storage->set('last', 'kg');

echo Application::getInstance()->getLocalSession('vendor_units')->get('last');
$storage->clear();

Код выведет kg.

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