Spec-Zone.ru › Laravel 5.4

Магазин

класс Магазин реализует Сессию (Просмотреть исходный код)

Свойства

защищенная строка $id Идентификатор сессии.
защищенная строка $name Имя сессии.
защищенный массив $attributes Атрибуты сессии.
защищенный SessionHandlerInterface $handler Реализация обработчика сессии.
защищенный логический $started Статус начала работы магазина сессий.

Методы

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

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

bool start()

Начать сессию, читая данные из обработчика.

void loadSession()

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

array readFromHandler()

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

string prepareForUnserialize(string $data)

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

bool save()

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

string prepareForStorage(string $data)

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

void ageFlashData()

Устареть данные всплывающей информации для сессии.

array all()

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

bool exists(string|array $key)

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

bool has(string|array $key)

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

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

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

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

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

bool hasOldInput(string $key = null)

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

mixed getOldInput(string $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)

Всплывающая пара ключ/значение в сессию.

void now(string $key, mixed $value)

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

void reflash()

Передать все данные всплывающей информации сессии.

void keep(array|mixed $keys = null)

Передать подмножество текущих данных всплывающей информации.

void mergeNewFlashes(array $keys)

Объединить новые ключи всплывающей информации в новый массив всплывающей информации.

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)

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

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)

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

Подробности

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

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

Параметры

string $name
SessionHandlerInterface $handler
string|null $id

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

void

bool start()

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

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

bool

protected void loadSession()

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

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

void

protected array readFromHandler()

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

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

array

protected string prepareForUnserialize(string $data)

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

Параметры

string $data

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

string

bool save()

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

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

bool

protected string prepareForStorage(string $data)

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

Параметры

string $data

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

string

void ageFlashData()

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

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

void

array all()

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

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

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

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

Параметры

string $key
string $default

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

mixed

bool hasOldInput(string $key = null)

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

Параметры

string $key

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

bool

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

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

Параметры

string $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)

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

Параметры

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

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

Spec-Zone.ru

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