Хранилище
класс Хранилище реализует Session (Просмотреть исходный код)
Трейты
| Macroable |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищённая строка | $id | Идентификатор сеанса. | |
| защищённая строка | $name | Имя сеанса. | |
| защищённый массив | $attributes | Атрибуты сеанса. | |
| защищённый SessionHandlerInterface | $handler | Реализация обработчика сеанса. | |
| защищённая строка | $serialization | Стратегия сериализации хранилища сеансов. | |
| защищённый булево значение | $started | Статус запуска хранилища сеанса. |
Методы
| 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, 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)
Получить подмножество данных сессии. | |
| array | except(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()
Вновь всплыть все данные 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() Получить текущий идентификатор сессии. | |
| 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) Установить запрос в экземпляр обработчика. |
Details
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)
Получить подмножество данных сессии.
array except(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)
Установить запрос в экземпляр обработчика.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Session/Store.html
