EncryptedStore

класс EncryptedStore расширяет Store (View source)

Трейты

Свойства

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

Методы

static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательский макрос.	from Macroable
static void	mixin(object $mixin, bool $replace = true) Включить другой объект в класс.	from Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрирован ли макрос.	from Macroable
static void	flushMacros() Очистить существующие макросы.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывать вызовы класса.	from Macroable
mixed	__call(string $method, array $parameters) Динамически обрабатывать вызовы класса.	from Macroable
void	__construct(string $name, SessionHandlerInterface $handler, Encrypter $encrypter, string\|null $id = null, string $serialization = 'php') Создать новый экземпляр сессии.
bool	start() Запустить сессию, читая данные из обработчика.	from Store
void	loadSession() Загрузить данные сессии из обработчика.	from Store
array	readFromHandler() Прочитать данные сессии из обработчика.	from Store
string	prepareForUnserialize(string $data) Подготовить необработанные строковые данные из сессии для десериализации.
void	marshalErrorBag() Маршалировать ViewErrorBag при использовании JSON-сериализации для сессий.	from Store
void	save() Сохранить данные сессии в хранилище.	from Store
void	prepareErrorBagForSerialization() Подготовить экземпляр ViewErrorBag для JSON-сериализации.	from Store
string	prepareForStorage(string $data) Подготовить сериализованные данные сессии для хранения.
void	ageFlashData() Устареть данные flash для сессии.	from Store
array	all() Получить все данные сессии.	from Store
array	only(array $keys) Получить подмножество данных сессии.	from Store
array	except(array $keys) Получить все данные сессии, кроме указанного массива элементов.	from Store
bool	exists(string\|array $key) Проверяет, существует ли ключ.	from Store
bool	missing(string\|array $key) Определить, отсутствует ли заданный ключ в данных сессии.	from Store
bool	has(string\|array $key) Проверяет, присутствует ли ключ и не является ли он нулевым.	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() Повторно всплыть все данные flash сессии.	from Store

void	keep(array\|mixed $keys = null) Обновить подмножество текущих данных flash.	из Store
void	mergeNewFlashes(array $keys) Объединить новые ключи flash с новым массивом flash.	из Store
void	removeFromOldFlashData(array $keys) Удалить заданные ключи из старых данных flash.	из Store
void	flashInput(array $value) Вставить массив ввода в сеанс.	из Store
mixed	remove(string $key) Удалить элемент из сеанса, возвращая его значение.	из Store
void	forget(string\|array $keys) Удалить один или несколько элементов из сеанса.	из Store
void	flush() Удалить все элементы из сеанса.	из Store
bool	invalidate() Очистить данные сеанса и сгенерировать новый ID.	из Store
bool	regenerate(bool $destroy = false) Сгенерировать новый идентификатор сеанса.	из Store
bool	migrate(bool $destroy = false) Сгенерировать новый ID сеанса.	из Store
bool	isStarted() Определить, был ли запущен сеанс.	из Store
string	getName() Получить имя сеанса.	из Store
void	setName(string $name) Установить имя сеанса.	из Store
string	getId() Получить текущий ID сеанса.	из Store
void	setId(string $id) Установить ID сеанса.	из Store
bool	isValidId(string\|null $id) Определить, является ли это допустимым ID сеанса.	из Store
string	generateSessionId() Получить новый, случайный ID сеанса.	из Store
void	setExists(bool $value) Установить существование сеанса в обработчике, если применимо.	из Store
string	token() Получить значение токена CSRF.	из Store
void	regenerateToken() Перегенерировать значение токена CSRF.	из Store
string\|null	previousUrl() Получить предыдущий URL из сеанса.	из Store
void	setPreviousUrl(string $url) Установить предыдущий URL в сеансе.	из Store
void	passwordConfirmed() Указать, что пользователь подтвердил свой пароль.	из Store
SessionHandlerInterface	getHandler() Получить базовую реализацию обработчика сеансов.	из Store
SessionHandlerInterface	setHandler(SessionHandlerInterface $handler) Установить базовую реализацию обработчика сеансов.	из Store
bool	handlerNeedsRequest() Определить, нужен ли обработчику сеансов запрос.	из Store
void	setRequestOnHandler(Request $request) Установить запрос в экземпляре обработчика.	из Store
Encrypter	getEncrypter() Получить экземпляр шифратора.

Подробности

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

Параметры

string	$name
object\|callable	$macro

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

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверить, зарегистрирован ли макрос.

Параметры

string

$name

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

bool

static void flushMacros()

Очистить существующие макросы.

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

void

END_OF_DOCUMENT_MARKER

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

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

Parameters

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

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

protected void marshalErrorBag()

Маршалирует ViewErrorBag при использовании JSON-сериализации для сессий.

Return Value

void

void save()

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

Return Value

void

protected void prepareErrorBagForSerialization()

Подготавливает экземпляр ViewErrorBag для JSON-сериализации.

Return Value

void

protected string prepareForStorage(string $data)

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

Parameters

string

$data

Return Value

string

void ageFlashData()

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

Return Value

void

array all()

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

Return Value

array

array only(array $keys)

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

Parameters

array

$keys

Return Value

array

array except(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)

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

Параметры

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 = true)

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

Параметры

string	$key
mixed	$value

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

void

void now(string $key, mixed $value)

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

Параметры

string	$key
mixed	$value

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

void

void reflash()

Обновить все временные данные сессии.

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

void

void keep(array|mixed $keys = null)

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

Параметры

array|mixed

$keys

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

void

protected void mergeNewFlashes(array $keys)

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

Параметры

array

$keys

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

void

protected void removeFromOldFlashData(array $keys)

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

Параметры

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()

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

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

bool

bool regenerate(bool $destroy = false)

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

Параметры

bool

$destroy

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

bool

bool migrate(bool $destroy = false)

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

Параметры

bool

$destroy

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

bool

bool isStarted()

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

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

bool

string getName()

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

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

string

void setName(string $name)

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

Параметры

string

$name

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

void

string getId()

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

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

string

void setId(string $id)

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

Параметры

string

$id

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

void

bool isValidId(string|null $id)

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

Parameters

string|null

$id

Return Value

bool

protected string generateSessionId()

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

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()

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

Return Value

void

SessionHandlerInterface getHandler()

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

Return Value

SessionHandlerInterface

SessionHandlerInterface setHandler(SessionHandlerInterface $handler)

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

Parameters

SessionHandlerInterface

$handler

Return Value

SessionHandlerInterface

bool handlerNeedsRequest()

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

Return Value

bool

void setRequestOnHandler(Request $request)

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

Parameters

Request

$request

Return Value

void

Encrypter getEncrypter()

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

Return Value

Encrypter

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