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