Хранилище

класс Хранилище реализует Session (Просмотреть исходный код)

Свойства

protected string	$id	Идентификатор сессии.
protected string	$name	Имя сессии.
protected array	$attributes	Атрибуты сессии.
protected SessionHandlerInterface	$handler	Реализация обработчика сессий.
protected bool	$started	Статус начала работы хранилища сессий.

Методы

void	__construct(string $name, SessionHandlerInterface $handler, string\|null $id = null) Создать новый экземпляр сессии.
bool	start() Запустить сессию, прочитав данные из обработчика.
void	loadSession() Загрузить данные сессии из обработчика.
array	readFromHandler() Прочитать данные сессии из обработчика.
string	prepareForUnserialize(string $data) Подготовить необработанные строковые данные из сессии для распаковки.
void	save() Сохранить данные сессии в хранилище.
string	prepareForStorage(string $data) Подготовить сериализованные данные сессии для хранения.
void	ageFlashData() Устареть данные flash для сессии.
array	all() Получить все данные сессии.
array	only(array $keys) Получить подмножество данных сессии.
bool	exists(string\|array $key) Проверить, существует ли ключ.
bool	missing(string\|array $key) Определить, отсутствует ли данный ключ в данных сессии.
bool	has(string\|array $key) Проверить, присутствует ли ключ и не равен ли он null.
mixed	get(string $key, mixed $default = null) Получить элемент из сессии.
mixed	pull(string $key, mixed $default = null) Получить значение данного ключа и затем забыть его.
bool	hasOldInput(string\|null $key = null) Определить, содержит ли сессия старый ввод.
mixed	getOldInput(string\|null $key = null, mixed $default = null) Получить запрашиваемый элемент из массива всплывающих данных ввода.
void	replace(array $attributes) Полностью заменить заданные атрибуты сессии.
void	put(string\|array $key, mixed $value = null) Поместить пару ключ/значение или массив пар ключ/значение в сессию.
mixed	remember(string $key, Closure $callback) Получить элемент из сессии или сохранить значение по умолчанию.
void	push(string $key, mixed $value) Добавить значение в массив сессии.
mixed	increment(string $key, int $amount = 1) Увеличить значение элемента в сессии.
int	decrement(string $key, int $amount = 1) Уменьшить значение элемента в сессии.
void	flash(string $key, mixed $value = true) Всплыть пару ключ/значение в сессии.
void	now(string $key, mixed $value) Всплыть пару ключ/значение в сессии для немедленного использования.
void	reflash() Вновь всплыть все данные flash сессии.
void	keep(array\|mixed $keys = null) Вновь всплыть подмножество текущих данных flash.
void	mergeNewFlashes(array $keys) Объединить новые ключи flash в новый массив flash.
void	removeFromOldFlashData(array $keys) Удалить заданные ключи из старых данных flash.
void	flashInput(array $value) Всплыть массив ввода в сессию.
mixed	remove(string $key) Удалить элемент из сессии, вернув его значение.
void	forget(string\|array $keys) Удалить один или несколько элементов из сессии.
void	flush() Удалить все элементы из сессии.
bool	invalidate() Очистить данные сессии и перегенерировать ID.
bool	regenerate(bool $destroy = false) Сгенерировать новый идентификатор сессии.
bool	migrate(bool $destroy = false) Сгенерировать новый ID сессии.
bool	isStarted() Определить, была ли запущена сессия.
string	getName() Получить имя сессии.
void	setName(string $name) Установить имя сессии.
string	getId() Получить текущий ID сессии.
void	setId(string $id) Установить ID сессии.
bool	isValidId(string $id) Определить, является ли это допустимым ID сессии.
string	generateSessionId() Получить новый, случайный ID сессии.
void	setExists(bool $value) Установить существование сессии в обработчике, если применимо.
string	token() Получить значение токена CSRF.
void	regenerateToken() Перегенерировать значение токена CSRF.
string\|null	previousUrl() Получить предыдущий URL из сессии.
void	setPreviousUrl(string $url) Установить предыдущий URL в сессии.
void	passwordConfirmed() Указать, что пользователь подтвердил свой пароль.
SessionHandlerInterface	getHandler() Получить базовую реализацию обработчика сессии.
bool	handlerNeedsRequest() Определить, нужен ли обработчику сессии запрос.

void

setRequestOnHandler(Request $request)

Установить запрос в экземпляре обработчика.

Подробности

void __construct(string $name, SessionHandlerInterface $handler, string|null $id = null)

Создать новый экземпляр сессии.

Параметры

string	$name
SessionHandlerInterface	$handler
string\|null	$id

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

void

bool start()

Запустить сессию, считывая данные из обработчика.

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

bool

protected void loadSession()

Загрузить данные сессии из обработчика.

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

void

protected array readFromHandler()

Считать данные сессии из обработчика.

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

array

protected string prepareForUnserialize(string $data)

Подготовить необработанные строковые данные сессии для десериализации.

Параметры

string

$data

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

string

void save()

Сохранить данные сессии в хранилище.

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

void

protected string prepareForStorage(string $data)

Подготовить данные сессии после сериализации для хранения.

Параметры

string

$data

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

string

void ageFlashData()

Устареть данные вспышки для сессии.

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

void

array all()

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

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

array

array only(array $keys)

Получить подмножество данных сессии.

Параметры

array

$keys

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

array

bool exists(string|array $key)

Проверяет существование ключа.

Параметры

string|array

$key

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

bool

bool missing(string|array $key)

Определить, отсутствует ли указанный ключ в данных сессии.

Параметры

string|array

$key

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

bool

bool has(string|array $key)

Проверяет, присутствует ли ключ и не равен ли null.

Параметры

string|array

$key

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

bool

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

Получить элемент из сессии.

Параметры

string	$key
mixed	$default

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

mixed

mixed pull(string $key, mixed $default = null)

Получить значение заданного ключа и затем удалить его.

Параметры

string	$key
mixed	$default

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

mixed

bool hasOldInput(string|null $key = null)

Определить, содержит ли сессия старые данные ввода.

Параметры

string|null

$key

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

bool

mixed getOldInput(string|null $key = null, mixed $default = null)

Получить запрошенный элемент из массива данных, которые были переданы в качестве вспышки.

Параметры

string\|null	$key
mixed	$default

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

mixed

void replace(array $attributes)

Полностью заменить заданные атрибуты сессии.

Параметры

array

$attributes

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

void

void put(string|array $key, mixed $value = null)

Добавить пару ключ/значение или массив пар ключ/значение в сессию.

Параметры

string\|array	$key
mixed	$value

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

void

mixed remember(string $key, Closure $callback)

Получить элемент из сессии или сохранить значение по умолчанию.

Параметры

string	$key
Closure	$callback

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

mixed

void push(string $key, mixed $value)

Добавить значение в массив сессии.

Параметры

string	$key
mixed	$value

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

void

mixed increment(string $key, int $amount = 1)

Увеличить значение элемента в сессии.

Параметры

string	$key
int	$amount

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

mixed

int decrement(string $key, int $amount = 1)

Уменьшить значение элемента в сессии.

Parameters

string	$key
int	$amount

Return Value

int

void flash(string $key, mixed $value = true)

Сохранить пару ключ/значение в сессии.

Parameters

string	$key
mixed	$value

Return Value

void

void now(string $key, mixed $value)

Сохранить пару ключ/значение в сессию для немедленного использования.

Parameters

string	$key
mixed	$value

Return Value

void

void reflash()

Перезаписать все данные вспышки сессии.

Return Value

void

void keep(array|mixed $keys = null)

Перезаписать подмножество текущих данных вспышки.

Parameters

array|mixed

$keys

Return Value

void

protected void mergeNewFlashes(array $keys)

Объединить новые ключи вспышки в новый массив вспышек.

Parameters

array

$keys

Return Value

void

protected void removeFromOldFlashData(array $keys)

Удалить заданные ключи из старых данных вспышки.

Parameters

array

$keys

Return Value

void

void flashInput(array $value)

Сохранить массив ввода в сессию.

Parameters

array

$value

Return Value

void

mixed remove(string $key)

Удалить элемент из сессии, вернув его значение.

Parameters

string

$key

Return Value

mixed

void forget(string|array $keys)

Удалить один или несколько элементов из сессии.

Parameters

string|array

$keys

Return Value

void

void flush()

Удалить все элементы из сессии.

Return Value

void

bool invalidate()

Очистить данные сессии и сгенерировать новый идентификатор.

Return Value

bool

bool regenerate(bool $destroy = false)

Сгенерировать новый идентификатор сессии.

Parameters

bool

$destroy

Return Value

bool

bool migrate(bool $destroy = false)

Сгенерировать новый ID сессии для сессии.

Parameters

bool

$destroy

Return Value

bool

bool isStarted()

Определить, была ли начата сессия.

Return Value

bool

string getName()

Получить имя сессии.

Return Value

string

void setName(string $name)

Установить имя сессии.

Parameters

string

$name

Return Value

void

string getId()

Получить текущий ID сессии.

Return Value

string

void setId(string $id)

Установить ID сессии.

Parameters

string

$id

Return Value

void

bool isValidId(string $id)

Определить, является ли это допустимым ID сессии.

Parameters

string

$id

Return Value

bool

protected string generateSessionId()

Получить новый случайный ID сессии.

Return Value

string

void setExists(bool $value)

Установить существование сессии в обработчике, если применимо.

Parameters

bool

$value

Return Value

void

string token()

Получить значение CSRF-токен.

Return Value

string

void regenerateToken()

Перегенерировать значение CSRF-токен.

Return Value

void

string|null previousUrl()

Получить предыдущий URL из сессии.

Return Value

string|null

void setPreviousUrl(string $url)

Установить URL "предыдущий" в сессии.

Parameters

string

$url

Return Value

void

void passwordConfirmed()

Указать, что пользователь подтвердил свой пароль.

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

void

SessionHandlerInterface getHandler()

Получить реализацию обработчика сессий.

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

SessionHandlerInterface

bool handlerNeedsRequest()

Определить, нужен ли обработчику запрос.

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

bool

void setRequestOnHandler(Request $request)

Установить запрос в экземпляре обработчика.

Параметры

Request

$request

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

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Session/Store.html