Spec-Zone.ru › Laravel 5.8

DatabaseSessionHandler

class DatabaseSessionHandler implements SessionHandlerInterface, ExistenceAwareInterface (View source)

Свойства

InteractsWithTime

Свойства

protected ConnectionInterface $connection Экземпляр подключения к базе данных.
protected string $table Имя таблицы сессий.
protected int $minutes Количество минут, в течение которых сессия должна быть действительной.
protected Container $container Экземпляр контейнера.
protected bool $exists Состояние существования сессии.

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени "доступно в" в формате UNIX timestamp.

from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.

from InteractsWithTime
int currentTime()

Получить текущее системное время в формате UNIX timestamp.

from InteractsWithTime
void __construct(ConnectionInterface $connection, string $table, int $minutes, Container $container = null)

Создать новый обработчик сессии базы данных.

open($savePath, $sessionName)

{@inheritdoc}

close()

{@inheritdoc}

read($sessionId)

{@inheritdoc}

bool expired(stdClass $session)

Определить, истек ли срок действия сессии.

write($sessionId, $data)

{@inheritdoc}

bool|null performInsert(string $sessionId, string $payload)

Выполнить операцию вставки для идентификатора сессии.

int performUpdate(string $sessionId, string $payload)

Выполнить операцию обновления для идентификатора сессии.

array getDefaultPayload(string $data)

Получить стандартную нагрузку для сессии.

$this addUserInformation(array $payload)

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

mixed userId()

Получить идентификатор текущего аутентифицированного пользователя.

$this addRequestInformation(array $payload)

Добавить информацию о запросе в нагрузку сессии.

string ipAddress()

Получить IP-адрес для текущего запроса.

string userAgent()

Получить User-Agent для текущего запроса.

destroy($sessionId)

{@inheritdoc}

gc($lifetime)

{@inheritdoc}

Builder getQuery()

Получить новый экземпляр билдера запросов для таблицы.

SessionHandlerInterface setExists(bool $value)

Установить состояние существования сессии.

Подробности

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени "доступно в" в формате UNIX timestamp.

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.

Параметры

DateTimeInterface|DateInterval|int $delay

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

DateTimeInterface|int

protected int currentTime()

Получить текущее системное время в формате Unix-timestamp.

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

int

void __construct(ConnectionInterface $connection, string $table, int $minutes, Container $container = null)

Создать новый обработчик сеанса базы данных.

Параметры

ConnectionInterface $connection
string $table
int $minutes
Container $container

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

void

open($savePath, $sessionName)

{@inheritdoc}

Параметры

$savePath
$sessionName

close()

{@inheritdoc}

read($sessionId)

{@inheritdoc}

Параметры

$sessionId

protected bool expired(stdClass $session)

Определить, истек ли срок действия сеанса.

Параметры

stdClass $session

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

bool

write($sessionId, $data)

{@inheritdoc}

Параметры

$sessionId
$data

protected bool|null performInsert(string $sessionId, string $payload)

Выполнить операцию вставки для идентификатора сеанса.

Параметры

string $sessionId
string $payload

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

bool|null

protected int performUpdate(string $sessionId, string $payload)

Выполнить операцию обновления для идентификатора сессии.

Параметры

string $sessionId
string $payload

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

int

protected array getDefaultPayload(string $data)

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

Параметры

string $data

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

array

protected $this addUserInformation(array $payload)

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

Параметры

array $payload

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

$this

protected mixed userId()

Получить ID текущего аутентифицированного пользователя.

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

mixed

protected $this addRequestInformation(array $payload)

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

Параметры

array $payload

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

$this

protected string ipAddress()

Получить IP-адрес текущего запроса.

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

string

protected string userAgent()

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

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

string

destroy($sessionId)

{@inheritdoc}

Параметры

$sessionId

gc($lifetime)

{@inheritdoc}

Параметры

$lifetime

protected Builder getQuery()

Получить новый экземпляр билдера запросов для таблицы.

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

Builder

SessionHandlerInterface setExists(bool $value)

Установить состояние существования сессии.

Параметры

bool $value

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

SessionHandlerInterface

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

Spec-Zone.ru

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