DatabaseSessionHandler

class DatabaseSessionHandler implements ExistenceAwareInterface, SessionHandlerInterface (View source)

Свойства

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

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

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

Получить UNIX-метку времени «доступно в».

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

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

bool

open($savePath, $sessionName)

{@inheritdoc}

bool

close()

{@inheritdoc}

string|false

read($sessionId)

{@inheritdoc}

bool

expired(stdClass $session)

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

bool

write($sessionId, $data)

{@inheritdoc}

bool|null

performInsert(string $sessionId, array<string,mixed> $payload)

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

int

performUpdate(string $sessionId, array<string,mixed> $payload)

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

array

getDefaultPayload(string $data)

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

$this

addUserInformation(array $payload)

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

mixed

userId()

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

$this

addRequestInformation(array $payload)

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

string|null

ipAddress()

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

string

userAgent()

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

bool

destroy($sessionId)

{@inheritdoc}

int

gc($lifetime)

{@inheritdoc}

Builder

getQuery()

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

$this

setContainer(Application $container)

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

SessionHandlerInterface

setExists(bool $value)

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

Получить UNIX-метку времени «доступно в».

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

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

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

Параметры

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

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

void

bool open($savePath, $sessionName)

{@inheritdoc}

Параметры

	$savePath
	$sessionName

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

bool

bool close()

{@inheritdoc}

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

bool

string|false read($sessionId)

{@inheritdoc}

Параметры

$sessionId

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

string|false

protected bool expired(stdClass $session)

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

Параметры

stdClass

$session

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

bool

bool write($sessionId, $data)

{@inheritdoc}

Параметры

	$sessionId
	$data

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

bool

protected bool|null performInsert(string $sessionId, array<string,mixed> $payload)

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

Параметры

string	$sessionId
array<string,mixed>	$payload

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

bool|null

protected int performUpdate(string $sessionId, array<string,mixed> $payload)

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

Параметры

string	$sessionId
array<string,mixed>	$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|null ipAddress()

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

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

string|null

protected string userAgent()

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

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

string

bool destroy($sessionId)

{@inheritdoc}

Параметры

$sessionId

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

bool

int gc($lifetime)

{@inheritdoc}

Параметры

$lifetime

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

int

protected Builder getQuery()

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

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

Builder

$this setContainer(Application $container)

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

Параметры

Application

$container

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

$this

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