Магазин

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

Свойства

защищённая строка	$id	Идентификатор сессии.
защищённая строка	$name	Имя сессии.
защищённый массив	$attributes	Атрибуты сессии.
защищённый массив	$bags	Мешки сессии.
защищённый MetadataBag	$metaBag	Экземпляр мешка метаданных.
защищённый массив	$bagData	Локальные копии данных мешка сессии.
защищённый SessionHandlerInterface	$handler	Реализация обработчика сессии.
защищённый булево значение	$started	Статус запуска магазина сессий.

Методы

void	__construct(string $name, SessionHandlerInterface $handler, string\|null $id = null) Создать новый экземпляр сессии.
start() {@inheritdoc}
void	loadSession() Загрузить данные сессии из обработчика.
array	readFromHandler() Прочитать данные сессии из обработчика.
string	prepareForUnserialize(string $data) Подготовить необработанные строковые данные сессии для десериализации.
void	initializeLocalBag(SessionBagInterface $bag) Инициализировать пакет в хранилище, если он не существует.
getId() {@inheritdoc}
setId($id) {@inheritdoc}
bool	isValidId(string $id) Определить, является ли данный идентификатор сессии допустимым.
string	generateSessionId() Получить новый случайный идентификатор сессии.
getName() {@inheritdoc}
setName($name) {@inheritdoc}
invalidate($lifetime = null) {@inheritdoc}
migrate($destroy = false, $lifetime = null) {@inheritdoc}
bool	regenerate(bool $destroy = false) Сгенерировать новый идентификатор сессии.
save() {@inheritdoc}
string	prepareForStorage(string $data) Подготовить данные сессии, сериализованные для хранения.
void	addBagDataToSession() Объединить все данные пакета в сессию.
void	ageFlashData() Установить срок действия данных флеш-сообщения для сессии.
bool	exists(string\|array $key) Проверяет, существует ли атрибут.
has($name) {@inheritdoc}
get($name, $default = null) {@inheritdoc}
mixed	pull(string $key, string $default = null) Получить значение заданного ключа и затем удалить его.
bool	hasOldInput(string $key = null) Определить, содержит ли сессия старые входные данные.
mixed	getOldInput(string $key = null, mixed $default = null) Получить запрашиваемый элемент из массива сохраненных входных данных.
set($name, $value) {@inheritdoc}
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	flashInput(array $value) Сохранить массив входных данных во временной памяти сессии.
void	reflash() Пересохранить все данные временной памяти сессии.
void	keep(array\|mixed $keys = null) Пересохранить подмножество текущих данных временной памяти.
void	mergeNewFlashes(array $keys) Объединить новые ключи временной памяти в новый массив.
void	removeFromOldFlashData(array $keys) Удалить указанные ключи из старых данных временной памяти.
all() {@inheritdoc}
replace(array $attributes) {@inheritdoc}
remove($name) {@inheritdoc}
void	forget(string\|array $keys) Удалить один или несколько элементов из сессии.
clear() {@inheritdoc}
void	flush() Удалить все элементы из сессии.
isStarted() {@inheritdoc}
registerBag(SessionBagInterface $bag) {@inheritdoc}
getBag($name) {@inheritdoc}
getMetadataBag() {@inheritdoc}
array	getBagData(string $name) Получить массив необработанных данных пакета для заданного пакета.
string	token() Получить значение токена CSRF.
string	getToken() Получить значение токена CSRF.
void	regenerateToken() Перегенерировать значение токена CSRF.
string\|null	previousUrl() Получить предыдущий URL из сессии.
void	setPreviousUrl(string $url) Установить "предыдущий" URL в сессии.
void	setExists(bool $value) Установить существование сессии в обработчике, если применимо.
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

start()

{@inheritdoc}

protected void loadSession()

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

Значение результата

void

protected array readFromHandler()

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

Значение результата

array

protected string prepareForUnserialize(string $data)

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

Параметры

string

$data

Значение результата

string

protected void initializeLocalBag(SessionBagInterface $bag)

Инициализировать пакет в хранилище, если он не существует.

Параметры

SessionBagInterface

$bag

Значение результата

void

getId()

{@inheritdoc}

setId($id)

{@inheritdoc}

Параметры

$id

bool isValidId(string $id)

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

Параметры

string

$id

Значение результата

bool

protected string generateSessionId()

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

Значение результата

string

getName()

{@inheritdoc}

setName($name)

{@inheritdoc}

Параметры

$name

invalidate($lifetime = null)

{@inheritdoc}

Параметры

$lifetime

migrate($destroy = false, $lifetime = null)

{@inheritdoc}

Параметры

	$destroy
	$lifetime

bool regenerate(bool $destroy = false)

Сгенерировать новый идентификатор сессии.

Параметры

bool

$destroy

Значение результата

bool

save()

{@inheritdoc}

protected string prepareForStorage(string $data)

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

Параметры

string

$data

Значение результата

string

protected void addBagDataToSession()

Объединить все данные пакета в сессию.

Значение результата

void

void ageFlashData()

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

Значение результата

void

bool exists(string|array $key)

Проверяет существование атрибута.

Параметры

string|array

$key

Значение результата

bool

has($name)

{@inheritdoc}

Параметры

$name

get($name, $default = null)

{@inheritdoc}

Параметры

	$name
	$default

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

set($name, $value)

{@inheritdoc}

Параметры

	$name
	$value

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)

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

Parameters

string	$key
mixed	$value

Return Value

void

void now(string $key, mixed $value)

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

Parameters

string	$key
mixed	$value

Return Value

void

void flashInput(array $value)

Сохранить массив ввода в сессию.

Parameters

array

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

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

Parameters

array

$keys

Return Value

void

protected void removeFromOldFlashData(array $keys)

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

Parameters

array

$keys

Return Value

void

all()

{@inheritdoc}

replace(array $attributes)

{@inheritdoc}

Parameters

array

$attributes

remove($name)

{@inheritdoc}

Parameters

$name

void forget(string|array $keys)

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

Parameters

string|array

$keys

Return Value

void

clear()

{@inheritdoc}

void flush()

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

Return Value

void

isStarted()

{@inheritdoc}

registerBag(SessionBagInterface $bag)

{@inheritdoc}

Parameters

SessionBagInterface

$bag

getBag($name)

{@inheritdoc}

Parameters

$name

getMetadataBag()

{@inheritdoc}

array getBagData(string $name)

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

Parameters

string

$name

Return Value

array

string token()

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

Return Value

string

string getToken()

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

Return Value

string

void regenerateToken()

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

Return Value

void

string|null previousUrl()

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

Return Value

string|null

END_OF_DOCUMENT_MARKER

void setPreviousUrl(string $url)

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

Параметры

string

$url

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

void

void setExists(bool $value)

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

Параметры

bool

$value

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

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