SessionInterface

bool start()

Инициализирует хранилище сессии.

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

bool	True, если сессия начата

Исключения

RuntimeException

Если сессия не может быть начата

string getId()

Возвращает идентификатор сессии.

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

string

Идентификатор сессии

setId(string $id)

Устанавливает идентификатор сессии.

Параметры

string

$id

mixed getName()

Возвращает имя сессии.

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

mixed

Имя сессии

setName(string $name)

Устанавливает имя сессии.

Параметры

string

$name

bool invalidate(int $lifetime = null)

Деактивирует текущую сессию.

Очищает все атрибуты сессии и флэши, перегенерирует сессию и удаляет старую сессию из хранилища.

Параметры

int

$lifetime

Устанавливает срок действия cookie сессии. Значение null оставит системные настройки без изменений, 0 задаст истечение срока действия cookie вместе с сессией браузера. Время в секундах, не является Unix timestamp.

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

bool	True, если сессия деактивирована, false в случае ошибки

bool migrate(bool $destroy = false, int $lifetime = null)

Переносит текущую сессию в новый идентификатор сессии, сохраняя все атрибуты сессии.

Параметры

bool	$destroy	Удалить старую сессию или оставить для сбора мусора
int	$lifetime	Устанавливает срок действия cookie сессии. Значение null оставит системные настройки без изменений, 0 задаст истечение срока действия cookie вместе с сессией браузера. Время в секундах, не является Unix timestamp.

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

bool	True, если сессия перенесена, false в случае ошибки

save()

Принудительно сохраняет и закрывает сессию.

Этот метод обычно не требуется для реальных сессий, так как сессия автоматически сохраняется в конце выполнения кода.

bool has(string $name)

Проверяет, определён ли атрибут.

Параметры

string

$name

Имя атрибута

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

bool	true, если атрибут определён, иначе false

mixed get(string $name, mixed $default = null)

Возвращает атрибут.

Параметры

string	$name	Имя атрибута
mixed	$default	Значение по умолчанию, если не найдено

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

mixed

set(string $name, mixed $value)

Устанавливает атрибут.

Параметры

string	$name
mixed	$value

array all()

Возвращает атрибуты.

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

array

Атрибуты

replace(array $attributes)

Устанавливает атрибуты.

Параметры

array

$attributes

Атрибуты

mixed remove(string $name)

Удаляет атрибут.

Параметры

string

$name

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

mixed

Удалённое значение или null, если оно не существует

clear()

Очищает все атрибуты.

bool isStarted()

Проверяет, была ли начата сессия.

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

bool

registerBag(SessionBagInterface $bag)

Регистрирует SessionBagInterface в сессии.

Параметры

SessionBagInterface

$bag

SessionBagInterface getBag(string $name)

Получает экземпляр пакета по имени.

Параметры

string

$name

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

SessionBagInterface

MetadataBag getMetadataBag()

Получает метаданные сессии.

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

MetadataBag