Сессия

интерфейс Сессия (Просмотреть исходный код)

Методы

строка

getName()

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

строка

getId()

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

void

setId(строка $id)

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

bool

start()

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

void

save()

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

массив

all()

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

bool

exists(строка|массив $ключ)

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

bool

has(строка|массив $ключ)

Проверяет, присутствует ли ключ и не равен ли он null.

смешанный

get(строка $ключ, смешанный $значениеПоУмолчанию = null)

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

void

put(строка|массив $ключ, смешанный $значение = null)

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

строка

token()

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

смешанный

remove(строка $ключ)

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

void

forget(строка|массив $ключи)

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

void

flush()

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

bool

migrate(bool $удалить = false)

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

bool

isStarted()

Определить, была ли начата сессия.

строка|null

previousUrl()

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

void

setPreviousUrl(строка $url)

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

SessionHandlerInterface

getHandler()

Получить экземпляр обработчика сессии.

bool

handlerNeedsRequest()

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

void

setRequestOnHandler(Запрос $запрос)

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

Подробности

строка getName()

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

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

строка

строка getId()

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

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

строка

void setId(строка $id)

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

Параметры

строка

$id

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

void

bool start()

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

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

bool

void save()

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

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

void

массив all()

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

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

массив

bool exists(string|array $key)

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

Параметры

string|array

$key

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

bool

bool has(string|array $key)

Проверяет, присутствует ли ключ и не равен ли он null.

Параметры

string|array

$key

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

bool

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

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

Параметры

string	$key
mixed	$default

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

mixed

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

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

Параметры

string\|array	$key
mixed	$value

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

void

string token()

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

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

string

mixed remove(string $key)

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

Параметры

string

$key

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

mixed

void forget(string|array $keys)

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

Параметры

string|array

$keys

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

void

void flush()

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

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

void

bool migrate(bool $destroy = false)

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

Параметры

bool

$destroy

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

bool

bool isStarted()

Определить, была ли начата сессия.

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

bool

string|null previousUrl()

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

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

string|null

void setPreviousUrl(string $url)

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

Параметры

string

$url

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

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