Spec-Zone.ru › Laravel 6

DatabaseSessionHandler

класс DatabaseSessionHandler реализует ExistenceAwareInterface, SessionHandlerInterface (Просмотреть исходный код)

Свойства

InteractsWithTime

Свойства

protected ConnectionInterface $connection

Экземпляр подключения к базе данных.

protected string $table

Имя таблицы сеансов.

protected int $minutes

Количество минут, в течение которых сеанс должен быть действительным.

protected Container $container

Экземпляр контейнера.

protected bool $exists

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

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

Получить метку времени UNIX "доступно в" (available at).

из InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int currentTime()

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

из 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)

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

$this addUserInformation(array $payload)

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

mixed userId()

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

$this addRequestInformation(array $payload)

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

string ipAddress()

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

string userAgent()

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

destroy($sessionId)

{@inheritdoc}

gc($lifetime)

{@inheritdoc}

Строитель 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}

Parameters

$sessionId

protected bool expired(stdClass $session)

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

Parameters

stdClass $session

Return Value

bool

write($sessionId, $data)

{@inheritdoc}

Parameters

$sessionId
$data

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

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

Parameters

string $sessionId
string $payload

Return Value

bool|null

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

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

Parameters

string $sessionId
string $payload

Return Value

int

protected array getDefaultPayload(string $data)

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

Parameters

string $data

Return Value

array

protected $this addUserInformation(array $payload)

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

Parameters

array $payload

Return Value

$this

protected mixed userId()

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

Return Value

mixed

protected $this addRequestInformation(array $payload)

Добавить информацию о запросе в данные сессии.

Parameters

array $payload

Return Value

$this

protected string ipAddress()

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

Return Value

string

protected string userAgent()

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

Return Value

string

destroy($sessionId)

{@inheritdoc}

Parameters

$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/6.x/Illuminate/Session/DatabaseSessionHandler.html

Spec-Zone.ru

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