Класс SessionStorage

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

Пространство имён: Cake\Auth\Storage

Краткое описание свойств

$_config protected

array

Конфигурация выполнения
$_configInitialized protected

bool

Установлена ли конфигурация с параметрами по умолчанию?
$_defaultConfig protected

array

Настройка по умолчанию для данного класса.
$_session protected

Cake\Http\Session

Объект сеанса.
$_user protected

ArrayAccess|array|false|null

Запись пользователя.

Краткое описание методов

__construct() public

Конструктор.
_configDelete() protected

Удаляет один ключ конфигурации.
_configRead() protected

Читает ключ конфигурации.
_configWrite() protected

Записывает ключ конфигурации.
configShallow() public

Объединяет предоставленную конфигурацию с существующей. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
delete() public

Удаляет запись пользователя из сессии.
getConfig() public

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для данного ключа.
read() public

Читает запись пользователя из сессии.
redirectUrl() public

Получить/установить URL перенаправления.
setConfig() public

Устанавливает конфигурацию.
write() public

Записывает запись пользователя в сессию.

Подробное описание методов

__construct() public

__construct(Cake\Http\ServerRequest $request, Cake\Http\Response $response, array $config = [])

Конструктор.

Параметры

Cake\Http\ServerRequest $request: Экземпляр запроса.
Cake\Http\Response $response: Экземпляр ответа.
array $config optional: Список конфигурации.

_configDelete() protected

_configDelete(string $key): void

Удаляет один ключ конфигурации.

Параметры

string $key: Ключ для удаления.

Возвращает

void

Исключения

Cake\Core\Exception\CakeException
при попытке перезаписи существующей конфигурации

_configRead() protected

_configRead(string|null $key): mixed

Читает ключ конфигурации.

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Записывает ключ конфигурации.

Параметры

string|array $key: Ключ для записи.
mixed $value: Значение для записи.
bool|string $merge optional: true для рекурсивного объединения, 'shallow' для простого объединения, false для перезаписи, по умолчанию false.

Возвращает

void

Исключения

Cake\Core\Exception\CakeException
при попытке перезаписи существующей конфигурации

configShallow() public

configShallow(string|array $key, mixed|null $value = null): $this

Объединяет предоставленную конфигурацию с существующей. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

Установка определенного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.

Возвращает

$this

delete() public

delete(): void

Удаляет запись пользователя из сессии.

Идентификатор сессии также обновляется для снижения проблем с повторением сессий.

Возвращает

void

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Значение возврата, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

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

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Исключения

InvalidArgumentException

read() public

read(): ArrayAccess|array|null

Читает запись пользователя из сессии.

Возвращает

ArrayAccess|array|null

redirectUrl() public

redirectUrl(mixed $url = null): string|array|null

Получить/установить URL перенаправления.

Параметры

mixed $url optional

Возвращает

string|array|null

setConfig() public

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Использование

Установка определенного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.
bool $merge optional: Выполнять ли рекурсивное объединение или перезапись существующей конфигурации, по умолчанию true.

Возвращает

$this

Исключения

Cake\Core\Exception\CakeException
При попытке установить недопустимый ключ.

write() public

write(mixed $user): void

Записывает запись пользователя в сессию.

Идентификатор сессии также обновляется для снижения проблем с повторением сессий.

Параметры

mixed $user: Запись пользователя.

Возвращает

void

Подробное описание свойств

`$_config` protected

Конфигурация во время выполнения

Тип

array

`$_configInitialized` protected

Указывает, была ли свойству конфигурации задана конфигурация по умолчанию.

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию для данного класса.

Ключи:

key - Ключ сессии, используемый для хранения записи пользователя.
redirect - Ключ сессии, используемый для хранения URL перенаправления.

Тип

array

`$_session` protected

Объект сессии.

Тип

Cake\Http\Session

`$_user` protected

Запись пользователя.

Хранит массив записи пользователя, если он получен из сессии, или false, если сессия не содержит запись пользователя.

Тип

ArrayAccess|array|false|null

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Auth.Storage.SessionStorage.html

Класс SessionStorage

Краткое описание свойств

Краткое описание методов

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

configShallow() public

delete() public

getConfig() public

getConfigOrFail() public

read() public

redirectUrl() public

setConfig() public

write() public

Подробное описание методов

__construct() public

Параметры

_configDelete() protected

Параметры

Возвращает

Исключения

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

Исключения

configShallow() public

Параметры

Возвращает

delete() public

Возвращает

getConfig() public

Использование

Параметры

Возвращает

getConfigOrFail() public

Параметры

Возвращает

Исключения

read() public

Возвращает

redirectUrl() public

Параметры

Возвращает

setConfig() public

Использование

Параметры

Возвращает

Исключения

write() public

Параметры

Возвращает

Подробное описание свойств

$_config protected

Тип

$_configInitialized protected

Тип

$_defaultConfig protected

Тип

$_session protected

Тип

$_user protected

Тип

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected

`$_session` protected

`$_user` protected