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