EncryptedStore

class EncryptedStore extends Store (View source)

Свойства

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

Методы

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

bool	isStarted() Определить, была ли начата сессия.	from Store
string	getName() Получить имя сессии.	from Store
void	setName(string $name) Установить имя сессии.	from Store
string	getId() Получить текущий идентификатор сессии.	from Store
void	setId(string $id) Установить идентификатор сессии.	from Store
bool	isValidId(string $id) Определить, является ли данный идентификатор сессии допустимым.	from Store
string	generateSessionId() Получить новый случайный идентификатор сессии.	from Store
void	setExists(bool $value) Установить существование сессии в обработчике, если применимо.	from Store
string	token() Получить значение токена CSRF.	from Store
void	regenerateToken() Перегенерировать значение токена CSRF.	from Store
string\|null	previousUrl() Получить предыдущий URL из сессии.	from Store
void	setPreviousUrl(string $url) Установить "предыдущий" URL в сессии.	from Store
void	passwordConfirmed() Указать, что пользователь подтвердил свой пароль.	from Store
SessionHandlerInterface	getHandler() Получить реализацию базового обработчика сессий.	from Store
bool	handlerNeedsRequest() Определить, требует ли обработчик сессий запрос.	from Store
void	setRequestOnHandler(Request $request) Установить запрос в экземпляр обработчика.	from Store
Encrypter	getEncrypter() Получить экземпляр шифрования.

Details

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

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

Parameters

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

Return Value

void

bool start()

Начать сессию, читая данные из обработчика.

Return Value

bool

protected void loadSession()

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

Return Value

void

protected array readFromHandler()

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

Return Value

array

protected string prepareForUnserialize(string $data)

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

Parameters

string

$data

Return Value

string

void save()

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

Return Value

void

protected string prepareForStorage(string $data)

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

Parameters

string

$data

Return Value

string

void ageFlashData()

Устареть данные всплывающих сообщений для сессии.

Return Value

void

array all()

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

Return Value

array

array only(array $keys)

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

Parameters

array

$keys

Return Value

array

bool exists(string|array $key)

Проверить, существует ли ключ.

Parameters

string|array

$key

Return Value

bool

bool missing(string|array $key)

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

Parameters

string|array

$key

Return Value

bool

bool has(string|array $key)

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

Parameters

string|array

$key

Return Value

bool

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

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

Parameters

string	$key
mixed	$default

Return Value

mixed

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

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

Parameters

string	$key
mixed	$default

Return Value

mixed

bool hasOldInput(string|null $key = null)

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

Parameters

string|null

$key

Return Value

bool

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

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

Parameters

string\|null	$key
mixed	$default

Return Value

mixed

void replace(array $attributes)

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

Parameters

array

$attributes

Return Value

void

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

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

Parameters

string\|array	$key
mixed	$value

Return Value

void

mixed remember(string $key, Closure $callback)

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

Parameters

string	$key
Closure	$callback

Return Value

mixed

void push(string $key, mixed $value)

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

Parameters

string	$key
mixed	$value

Return Value

void

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

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

Parameters

string	$key
int	$amount

Return Value

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)

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

Parameters

bool

$destroy

Return Value

bool

bool isStarted()

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

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

bool

string getName()

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

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

string

void setName(string $name)

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

Параметры

string

$name

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

void

string getId()

Получить текущий идентификатор сессии.

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

string

void setId(string $id)

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

Параметры

string

$id

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

void

bool isValidId(string $id)

Определить, является ли этот идентификатор сессии допустимым.

Параметры

string

$id

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

bool

protected string generateSessionId()

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

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

string

void setExists(bool $value)

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

Параметры

bool

$value

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

void

string token()

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

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

string

void regenerateToken()

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

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

void

string|null previousUrl()

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

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

string|null

void setPreviousUrl(string $url)

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

Параметры

string

$url

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

void

void passwordConfirmed()

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

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

void

SessionHandlerInterface getHandler()

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

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

SessionHandlerInterface

bool handlerNeedsRequest()

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

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

bool

void setRequestOnHandler(Request $request)

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

Параметры

Request

$request

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

void

Encrypter getEncrypter()

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

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

Encrypter

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