Магазин

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

Трейты

Свойства

статический защищенный массив	$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.
bool	hasAny(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) Получить запрашиваемый элемент из массива flash-данных.
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() Очистить данные сессии и сгенерировать новый идентификатор.
bool	regenerate(bool $destroy = false) Сгенерировать новый идентификатор сессии.
bool	migrate(bool $destroy = false) Сгенерировать новый ID сессии для сессии.
bool	isStarted() Определить, была ли запущена сессия.

string	getName() Получить имя сессии.
void	setName(string $name) Установить имя сессии.
string	id() Получить текущий идентификатор сессии.
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)

Зарегистрировать пользовательское макро.

Parameters

string	$name
object\|callable	$macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Добавить другой объект в класс.

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверка на наличие зарегистрированного макро.

Parameters

string

$name

Return Value

bool

static void flushMacros()

Очистить существующие макросы.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

Динамическая обработка вызовов класса.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамическая обработка вызовов класса.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

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

Parameters

string	$name
SessionHandlerInterface	$handler
string\|null	$id
string	$serialization

Return Value

void

bool start()

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

Return Value

bool

protected void loadSession()

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

Return Value

void

protected array readFromHandler()

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

Return Value

array

protected string prepareForUnserialize(string $data)

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

Parameters

string

$data

Return Value

string

protected void marshalErrorBag()

Маршалить ViewErrorBag при использовании JSON-сериализации для сессий.

Return Value

void

void save()

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

Return Value

void

protected void prepareErrorBagForSerialization()

Подготовить экземпляр ViewErrorBag для JSON-сериализации.

Return Value

void

protected string prepareForStorage(string $data)

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

Parameters

string

$data

Return Value

string

void ageFlashData()

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

Return Value

void

array all()

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

Return Value

array

array only(array $keys)

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

Parameters

array

$keys

Return Value

array

array except(array $keys)

Получить все данные сессии, за исключением указанного массива элементов.

Parameters

array

$keys

Return Value

array

bool exists(string|array $key)

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

Parameters

string|array

$key

Return Value

bool

bool missing(string|array $key)

Определить, отсутствует ли указанный ключ в данных сессии.

Parameters

string|array

$key

Return Value

bool

bool has(string|array $key)

Определить, присутствует ли ключ и не равен ли он null.

Parameters

string|array

$key

Return Value

bool

bool hasAny(string|array $key)

Определить, присутствуют ли какие-либо из заданных ключей и не равны ли они null.

Parameters

string|array

$key

Return Value

bool

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

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

Parameters

string	$key
mixed	$default

Return Value

mixed

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

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

Parameters

string	$key
mixed	$default

Return Value

mixed

bool hasOldInput(string|null $key = null)

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

Parameters

string|null

$key

Return Value

bool

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

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

Parameters

string\|null	$key
mixed	$default

Return Value

mixed

void replace(array $attributes)

Полностью заменить заданные атрибуты сессии.

Parameters

array

$attributes

Return Value

void

void put(string|array $key, mixed $value = null)

Поместить пару ключ/значение или массив пар ключ/значение в сессию.

Parameters

string\|array	$key
mixed	$value

Return Value

void

mixed remember(string $key, Closure $callback)

Получить элемент из сессии или сохранить значение по умолчанию.

Parameters

string	$key
Closure	$callback

Return Value

mixed

void push(string $key, mixed $value)

Добавить значение в массив сессии.

Parameters

string	$key
mixed	$value

Return Value

void

mixed increment(string $key, int $amount = 1)

Увеличить значение элемента в сессии.

Parameters

string	$key
int	$amount

Return Value

mixed

int decrement(string $key, int $amount = 1)

Уменьшить значение элемента в сессии.

Parameters

string	$key
int	$amount

Return Value

int

void flash(string $key, mixed $value = true)

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

Parameters

string	$key
mixed	$value

Return Value

void

void now(string $key, mixed $value)

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

Parameters

string	$key
mixed	$value

Return Value

void

void reflash()

Обновить все данные вспышки сессии.

Return Value

void

void keep(array|mixed $keys = null)

Обновить подмножество текущих данных вспышки.

Parameters

array|mixed

$keys

Return Value

void

protected void mergeNewFlashes(array $keys)

Объединить новые ключи флэша в новый массив флэша.

Параметры

массив

$keys

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

void

protected void removeFromOldFlashData(array $keys)

Удалить заданные ключи из старых данных флэша.

Параметры

массив

$keys

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

void

void flashInput(array $value)

Передать массив ввода в сессию.

Параметры

массив

$value

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

void

mixed remove(string $key)

Удалить элемент из сессии, вернув его значение.

Параметры

строка

$key

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

смешанный тип

void forget(string|array $keys)

Удалить один или несколько элементов из сессии.

Параметры

строка|массив

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

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

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

строка

void setName(string $name)

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

Параметры

строка

$name

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

void

string id()

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

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

строка

string getId()

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

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

строка

void setId(string $id)

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

Параметры

строка

$id

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

void

bool isValidId(string|null $id)

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

Параметры

строка|null

$id

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

bool

protected string generateSessionId()

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

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

строка

void setExists(bool $value)

Установить существование сессии в обработчике, если применимо.

Параметры

bool

$value

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

void

string token()

Получить значение токена CSRF.

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

строка

void regenerateToken()

Перегенерировать значение токена CSRF.

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

void

string|null previousUrl()

Получить предыдущий URL из сессии.

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

строка|null

void setPreviousUrl(string $url)

Установить URL "предыдущий" в сессии.

Параметры

строка

$url

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

void

void passwordConfirmed()

Указать, что пользователь подтвердил свой пароль.

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

void

SessionHandlerInterface getHandler()

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

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

SessionHandlerInterface

SessionHandlerInterface setHandler(SessionHandlerInterface $handler)

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

Параметры

SessionHandlerInterface

$handler

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

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/11.x/Illuminate/Session/Store.html