Spec-Zone.ru › Laravel 5.8

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)

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

void save()

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

from Store
string prepareForStorage(string $data)

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

void ageFlashData()

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

from Store
array all()

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

from Store
array only(array $keys)

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

from Store
bool exists(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, string|null $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.

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

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

из Store
void setName(string $name)

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

из Store
string getId()

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

из Store
void setId(string $id)

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

из Store
bool isValidId(string $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
SessionHandlerInterface getHandler()

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

из Store
bool handlerNeedsRequest()

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

из Store
void setRequestOnHandler(Request $request)

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

из Store
Encrypter getEncrypter()

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

Подробности

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

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

Параметры

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

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

void

bool start()

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

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

bool

protected void loadSession()

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

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

void

protected array readFromHandler()

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

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

array

protected string prepareForUnserialize(string $data)

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

Параметры

string $data

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

string

void save()

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

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

void

protected string prepareForStorage(string $data)

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

Параметры

string $data

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

string

void ageFlashData()

Устареть данные вспышки для сессии.

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

void

array all()

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

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

array

array only(array $keys)

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

Параметры

array $keys

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

array

bool exists(string|array $key)

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

Параметры

string|array $key

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

bool

bool has(string|array $key)

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

Параметры

string|array $key

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

bool

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

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

Параметры

string $key
mixed $default

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

mixed

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

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

Параметры

string $key
string|null $default

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

mixed
END_OF_DOCUMENT_MARKER

bool hasOldInput(string|null $key = null)

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

Параметры

string|null $key

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

bool

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

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

Параметры

string|null $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 = 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()

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

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

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.8/Illuminate/Session/EncryptedStore.html

Spec-Zone.ru

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