Spec-Zone.ru › Laravel 4.2

Хранилище

класс Хранилище реализует 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()

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

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}

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|null $value = null)

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

void push(string $key, mixed $value)

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

void flash(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 $key)

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

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.

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 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 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|null $value = null)

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

Параметры

string|array $key
mixed|null $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 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 $key)

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

Параметры

string $key

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

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

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API