EncryptedStore

class EncryptedStore extends Store (View source)

Свойства

protected string	$id	Идентификатор сессии.	from Store
protected string	$name	Имя сессии.	from Store
protected array	$attributes	Атрибуты сессии.	from Store
protected SessionHandlerInterface	$handler	Реализация обработчика сессии.	from Store
protected bool	$started	Статус инициализации хранилища сессии.	from 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) Подготовить необработанные строковые данные сессии для рассериализации.
bool	save() Сохранить данные сессии в хранилище.	from Store
string	prepareForStorage(string $data) Подготовить сериализованные данные сессии для хранения.
void	ageFlashData() Устареть данные flash для сессии.	from Store
array	all() Получить все данные сессии.	from Store
bool	exists(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, string $default = null) Получить значение заданного ключа и затем забыть его.	from Store
bool	hasOldInput(string $key = null) Определить, содержит ли сессия старый ввод.	from Store
mixed	getOldInput(string $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) Всплыть пару ключ/значение в сессии.	from Store
void	now(string $key, mixed $value) Всплыть пару ключ/значение в сессии для немедленного использования.	from Store
void	reflash() Повторно всплыть все данные flash сессии.	from Store
void	keep(array\|mixed $keys = null) Повторно всплыть подмножество текущих данных flash.	from Store
void	mergeNewFlashes(array $keys) Объединить новые ключи flash с новым массивом flash.	from Store
void	removeFromOldFlashData(array $keys) Удалить заданные ключи из старых данных flash.	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() Очистить данные сессии и сгенерировать новый ID.	from Store
bool	regenerate(bool $destroy = false) Сгенерировать новый идентификатор сессии.	from Store
bool	migrate(bool $destroy = false) Сгенерировать новый ID сессии.	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
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

bool save()

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

Return Value

bool

protected string prepareForStorage(string $data)

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

Parameters

string

$data

Return Value

string

void ageFlashData()

Устареть данные flash для сессии.

Return Value

void

array all()

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

Return Value

array

bool exists(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, string $default = null)

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

Parameters

string	$key
string	$default

Return Value

mixed

bool hasOldInput(string $key = null)

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

Parameters

string

$key

Return Value

bool

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

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

Параметры

string	$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)

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

Параметры

string	$key
int	$amount

Значение результата

int

void flash(string $key, mixed $value)

Внести пару ключ/значение в сессию.

Параметры

string	$key
mixed	$value

Значение результата

void

void now(string $key, mixed $value)

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

Параметры

string	$key
mixed	$value

Значение результата

void

void reflash()

Передать все данные сессии flash.

Значение результата

void

void keep(array|mixed $keys = null)

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

Параметры

array|mixed

$keys

Значение результата

void

protected void mergeNewFlashes(array $keys)

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

Параметры

array

$keys

Значение результата

void

protected void removeFromOldFlashData(array $keys)

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

Параметры

array

$keys

Значение результата

void

void flashInput(array $value)

Внести массив введённых данных в сессию.

Параметры

array

$value

Значение результата

void

mixed remove(string $key)

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

Параметры

string

$key

Значение результата

mixed

void forget(string|array $keys)

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

Параметры

string|array

$keys

Значение результата

void

void flush()

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

Значение результата

void

bool invalidate()

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

Значение результата

bool

bool regenerate(bool $destroy = false)

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

Параметры

bool

$destroy

Значение результата

bool

bool migrate(bool $destroy = false)

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

Параметры

bool

$destroy

Значение результата

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

SessionHandlerInterface getHandler()

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

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

SessionHandlerInterface

bool handlerNeedsRequest()

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

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

bool

void setRequestOnHandler(Request $request)

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

Параметры

Request

$request

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

void

Encrypter getEncrypter()

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

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

Encrypter

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