Магазин

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

Свойства

protected string	$id	Идентификатор сессии.
protected string	$name	Имя сессии.
protected array	$attributes	Атрибуты сессии.
protected array	$bags	Мешки сессии.
protected MetadataBag	$metaBag	Экземпляр мешка метаданных.
protected array	$bagData	Локальные копии данных мешка сессии.
protected SessionHandlerInterface	$handler	Реализация обработчика сессии.
protected bool	$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()

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

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)

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

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

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)

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

Параметры

string\|array	$key
mixed	$value

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

void

void push(string $key, mixed $value)

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

Параметры

string	$key
mixed	$value

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

void

смешанный increment(строка $key, целое $amount = 1)

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

Параметры

строка	$key
целое	$amount

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

смешанный

целое decrement(строка $key, целое $amount = 1)

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

Параметры

строка	$key
целое	$amount

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

целое

пустое flash(строка $key, смешанный $value)

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

Параметры

строка	$key
смешанный	$value

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

пустое

пустое now(строка $key, смешанный $value)

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

Параметры

строка	$key
смешанный	$value

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

пустое

пустое flashInput(массив $value)

Добавить массив ввода в сессию.

Параметры

массив

$value

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

пустое

пустое reflash()

Обновить все данные сессии flash.

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

пустое

пустое keep(массив|смешанный $keys = null)

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

Параметры

массив|смешанный

$keys

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

пустое

защищенный пустое mergeNewFlashes(массив $keys)

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

Параметры

массив

$keys

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

пустое

защищенный пустое removeFromOldFlashData(массив $keys)

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

Параметры

массив

$keys

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

пустое

all()

{@inheritdoc}

replace(массив $attributes)

{@inheritdoc}

Параметры

массив

$attributes

remove($name)

{@inheritdoc}

Параметры

$name

пустое forget(строка|массив $keys)

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

Параметры

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

$keys

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

пустое

clear()

{@inheritdoc}

пустое flush()

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

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

пустое

isStarted()

{@inheritdoc}

registerBag(SessionBagInterface $bag)

{@inheritdoc}

Параметры

SessionBagInterface

$bag

getBag($name)

{@inheritdoc}

Параметры

$name

getMetadataBag()

{@inheritdoc}

массив getBagData(строка $name)

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

Параметры

строка

$name

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

массив

строка token()

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

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

строка

строка getToken()

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

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

строка

пустое regenerateToken()

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

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

пустое

строка|null previousUrl()

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

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

строка|null

пустое setPreviousUrl(строка $url)

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

Параметры

строка

$url

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

пустое

пустое setExists(булево $value)

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

Параметры

булево

$value

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

пустое

SessionHandlerInterface getHandler()

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

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

SessionHandlerInterface

булево handlerNeedsRequest()

Определить, нужен ли обработчику сессии запрос.

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

булево

void setRequestOnHandler(Request $request)

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

Параметры

Запрос

$request

Значение возврата

void

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