Spec-Zone.ru › Laravel 11

EncryptedStore

class EncryptedStore extends Store (View source)

Трейты

Macroable

Свойства

static protected array $macros

Зарегистрированные строковые макросы.

 from Macroable
protected string $id

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

 from Store
protected string $name

Имя сессии.

 from Store
protected array $attributes

Атрибуты сессии.

 from Store
protected SessionHandlerInterface $handler

Реализация обработчика сессии.

 from Store
protected string $serialization

Стратегия сериализации хранилища сессии.

 from Store
protected bool $started

Статус начала работы хранилища сессии.

 from Store
protected Encrypter $encrypter

Экземпляр шифровальщика.

Методы

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

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

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

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

 из Macroable
static bool hasMacro(string $name)

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

 из Macroable
static void flushMacros()

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

 из Macroable
static mixed __callStatic(string $method, array $parameters)

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

 из Macroable
mixed __call(string $method, array $parameters)

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

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

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

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

 из Store
void loadSession()

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

 из Store
array readFromHandler()

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

 из Store
string prepareForUnserialize(string $data)

Подготовить данные исходной строки сессии для десериализации.
void marshalErrorBag()

Скомпоновать ViewErrorBag при использовании JSON-сериализации для сессий.

 из Store
void save()

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

 из Store
void prepareErrorBagForSerialization()

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

 из Store
string prepareForStorage(string $data)

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

Устареть данные флэша для сессии.

 из Store
array all()

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

 из Store
array only(array $keys)

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

 из Store
array except(array $keys)

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

 из Store
bool exists(string|array $key)

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

 из Store
bool missing(string|array $key)

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

 из Store
bool has(string|array $key)

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

 из Store
bool hasAny(string|array $key)

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

 из Store
mixed get(string $key, mixed $default = null)

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

 из Store
mixed pull(string $key, mixed $default = null)

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

 из Store
bool hasOldInput(string|null $key = null)

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

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

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

 из Store
void replace(array $attributes)

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

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

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

 из Store
mixed remember(string $key, Closure $callback)

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

 из Store
void push(string $key, mixed $value)

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

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

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

 из Store
int decrement(string $key, int $amount = 1)

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

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

Зафлэшить пару ключ / значение в сессию.

 из Store
void now(string $key, mixed $value)

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

 из Store
void reflash()

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

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

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

 из 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 id()

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

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

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

Details

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

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

Parameters

string $name
object|callable $macro

Return Value

void

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

Добавить другой объект в класс.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

static void flushMacros()

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

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

void

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

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

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

Параметры

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

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

void

bool start()

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

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

bool

protected void loadSession()

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

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

void

protected array readFromHandler()

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

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

array

protected string prepareForUnserialize(string $data)

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

Параметры

string $data

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

string

protected void marshalErrorBag()

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

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

void

void save()

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

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

void

protected void prepareErrorBagForSerialization()

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

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

void

protected string prepareForStorage(string $data)

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

Параметры

string $data

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

string

void ageFlashData()

Установить срок действия данных flash для сессии.

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

void

array all()

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

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

array

array only(array $keys)

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

Параметры

array $keys

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

array

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

bool hasAny(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
END_OF_DOCUMENT_MARKER

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)

Сгенерировать новый 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 id()

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

Return Value

string

строка getId()

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

Значение возврата

строка

пусто setId(строка $id)

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

Параметры

строка $id

Значение возврата

пусто

логическое значение isValidId(строка|null $id)

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

Параметры

строка|null $id

Значение возврата

логическое значение

защищённый строка generateSessionId()

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

Значение возврата

строка

пусто setExists(логическое значение $value)

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

Параметры

логическое значение $value

Значение возврата

пусто

строка token()

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

Значение возврата

строка

пусто regenerateToken()

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

Значение возврата

пусто

строка|null previousUrl()

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

Значение возврата

строка|null

пусто setPreviousUrl(строка $url)

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

Параметры

строка $url

Значение возврата

пусто

пусто passwordConfirmed()

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

Значение возврата

пусто

SessionHandlerInterface getHandler()

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

Значение возврата

SessionHandlerInterface

SessionHandlerInterface setHandler(SessionHandlerInterface $handler)

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

Параметры

SessionHandlerInterface $handler

Значение возврата

SessionHandlerInterface

логическое значение handlerNeedsRequest()

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

Значение возврата

логическое значение

пусто setRequestOnHandler(Запрос $request)

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

Параметры

Запрос $request

Значение возврата

пусто

Encrypter getEncrypter()

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

Значение возврата

Encrypter

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API