Магазин

класс Store реализует 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)

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

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

void flash(string $key, mixed $value)

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

Параметры

string	$key
mixed	$value

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

void

void now(string $key, mixed $value)

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

Параметры

string	$key
mixed	$value

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

void

void flashInput(array $value)

Внести массив ввода в сессию.

Параметры

array

$value

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

void

void reflash()

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

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

void

void keep(array|mixed $keys = null)

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

Параметры

array|mixed

$keys

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

void

protected void mergeNewFlashes(array $keys)

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

Параметры

array

$keys

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

void

protected void removeFromOldFlashData(array $keys)

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

Параметры

array

$keys

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

void

all()

{@inheritdoc}

replace(array $attributes)

{@inheritdoc}

Параметры

array

$attributes

remove($name)

{@inheritdoc}

Параметры

$name

void forget(string|array $keys)

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

Параметры

string|array

$keys

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

void

clear()

{@inheritdoc}

void flush()

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

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

void

isStarted()

{@inheritdoc}

registerBag(SessionBagInterface $bag)

{@inheritdoc}

Параметры

SessionBagInterface

$bag

getBag($name)

{@inheritdoc}

Параметры

$name

getMetadataBag()

{@inheritdoc}

array getBagData(string $name)

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

Параметры

string

$name

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

array

string token()

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

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

string

string getToken()

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

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

string

void regenerateToken()

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

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

void

string|null previousUrl()

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

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

string|null

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