Зашифрованный магазин сессий
класс Зашифрованный магазин сессий расширяет Магазин сессий (Просмотреть исходный код)
Трейты
| Macroable |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищённая строка | $id | Идентификатор сессии. | из Магазин сессий |
| защищённая строка | $name | Имя сессии. | из Магазин сессий |
| защищённый массив | $attributes | Атрибуты сессии. | из Магазин сессий |
| защищённый SessionHandlerInterface | $handler | Реализация обработчика сессий. | из Магазин сессий |
| защищённая строка | $serialization | Стратегия сериализации магазина сессий. | из Магазин сессий |
| защищённый булевый тип | $started | Статус инициализации магазина сессий. | из Магазин сессий |
| защищённый 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()
Устареть данные flash сессии. | из Store |
| array | all()
Получить все данные сессии. | из Store |
| array | only(array $keys)
Получить подмножество данных сессии. | из Store |
| bool | exists(string|array $key)
Проверить наличие ключа. | из Store |
| bool | missing(string|array $key)
Определить, отсутствует ли указанный ключ в данных сессии. | из Store |
| bool | has(string|array $key)
Проверяет, существует ли ключ и не является ли он пустым. | из 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()
Обновить все данные флеш-сессии. | из Store |
| void | keep(array|mixed $keys = null)
Обновить подмножество текущих данных flash. | из Store |
| void | mergeNewFlashes(array $keys)
Объединить новые ключи флэша в новый массив флэша. | из Store |
| void | removeFromOldFlashData(array $keys)
Удалить заданные ключи из старых данных флэша. | из 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)
Сгенерировать новый идентификатор сессии для сессии. | из Store |
| bool | isStarted()
Определить, была ли начата сессия. | из Store |
| string | getName()
Получить имя сессии. | из Store |
| void | setName(string $name)
Установить имя сессии. | из Store |
| string | getId()
Получить текущий идентификатор сессии. | из Store |
| void | setId(string $id)
Установить идентификатор сессии. | из Store |
| bool | isValidId(string|null $id)
Определить, является ли это допустимым идентификатором сессии. | из Store |
| string | generateSessionId()
Получить новый случайный идентификатор сессии. | из 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)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрировано ли макро.
static void flushMacros()
Очистить существующие макросы.
static mixed __callStatic(string $method, array $parameters)
Динамически обработать вызовы к классу.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы к классу.
void __construct(string $name, SessionHandlerInterface $handler, Encrypter $encrypter, string|null $id = null, string $serialization = 'php')
Создаёт новый экземпляр сессии.
bool start()
Запускает сессию, считывая данные из обработчика.
protected void loadSession()
Загружает данные сессии из обработчика.
protected array readFromHandler()
Считывает данные сессии из обработчика.
protected string prepareForUnserialize(string $data)
Подготавливает сырые строковые данные сессии для сериализации.
protected void marshalErrorBag()
Маршалит ViewErrorBag при использовании JSON-сериализации для сессий.
void save()
Сохраняет данные сессии в хранилище.
protected void prepareErrorBagForSerialization()
Подготавливает экземпляр ViewErrorBag для JSON-сериализации.
protected string prepareForStorage(string $data)
Подготавливает сериализованные данные сессии для хранения.
void ageFlashData()
Устаревает данные флэша для сессии.
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()
Перезапустить все данные о сообщениях сессии.
void keep(array|mixed $keys = null)
Сохранить подмножество текущих данных сообщений.
protected void mergeNewFlashes(array $keys)
Объединить новые ключи сообщений в новый массив сообщений.
protected void removeFromOldFlashData(array $keys)
Удалить указанные ключи из старых данных сообщений.
void flashInput(array $value)
Сохранить массив ввода в сессии.
mixed remove(string $key)
Удалить элемент из сессии, вернув его значение.
void forget(string|array $keys)
Удалить один или несколько элементов из сессии.
void flush()
Удалить все элементы из сессии.
bool invalidate()
Очистить данные сессии и сгенерировать новый идентификатор.
bool regenerate(bool $destroy = false)
Сгенерировать новый идентификатор сессии.
bool migrate(bool $destroy = false)
Сгенерировать новый идентификатор сессии.
bool isStarted()
Определить, была ли начата сессия.
string getName()
Получить имя сессии.
void setName(string $name)
Установить имя сессии.
string getId()
Получить текущий идентификатор сессии.
void setId(string $id)
Установить идентификатор сессии.
bool isValidId(string|null $id)
Определить, является ли этот идентификатор сессии допустимым.
protected string generateSessionId()
Получить новый случайный идентификатор сессии.
void setExists(bool $value)
Установить наличие сессии в обработчике, если применимо.
string token()
Получить значение токена CSRF.
void regenerateToken()
Перегенерировать значение токена CSRF.
string|null previousUrl()
Получить предыдущий URL из сессии.
void setPreviousUrl(string $url)
Установить URL "предыдущий" в сессии.
void passwordConfirmed()
Указать, что пользователь подтвердил свой пароль.
SessionHandlerInterface getHandler()
Получить реализацию базового обработчика сессий.
SessionHandlerInterface setHandler(SessionHandlerInterface $handler)
Установить реализацию базового обработчика сессий.
bool handlerNeedsRequest()
Определить, требуется ли обработчику сессии запрос.
void setRequestOnHandler(Request $request)
Установить запрос в экземпляр обработчика.
Encrypter getEncrypter()
Получить экземпляр шифратора.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Session/EncryptedStore.html
