Класс SessionStorage

__construct()source public

__construct( Cake\Network\Request $request , Cake\Network\Response $response , array $config [] )

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

Параметры

Cake\Network\Request $request

Экземпляр запроса.

Cake\Network\Response $response

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

массив $config необязательно []

Список конфигурации.

delete()source public

delete( )

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

Идентификатор сессии также обновляется, чтобы помочь снизить вероятность проблем с повторным использованием сессии.

Реализация

Cake\Auth\Storage\StorageInterface::delete()

read()source public

read( )

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

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

массив|null
Запись пользователя, если доступна, иначе null.

Реализация

Cake\Auth\Storage\StorageInterface::read()

redirectUrl()source public

redirectUrl( mixed $url null )

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

Параметры

смешанный $url необязательно null

URL перенаправления. Если null возвращает текущий URL. Если false удаляет текущий заданный URL.

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

смешанный

Реализация

Cake\Auth\Storage\StorageInterface::redirectUrl()

write()source public

write( array|ArrayAccess $user )

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

Идентификатор сессии также обновляется, чтобы помочь снизить вероятность проблем с повторным использованием сессии.

Параметры

массив|ArrayAccess $user

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

Реализация

Cake\Auth\Storage\StorageInterface::write()

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

Ключ для удаления.

Исключения

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

_configRead()source protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key

Ключ для чтения.

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

смешанный

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись переменной конфигурации

Параметры

строка|массив $key

Ключ для записи.

смешанный $value

Значение для записи.

boolean|строка $merge необязательно false

Истинно, чтобы выполнить рекурсивное слияние, 'shallow' для простого слияния, ложно для перезаписи, по умолчанию ложно.

Исключения

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

config()source public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

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

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

$this->config();

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

$this->config('key');

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

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

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

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

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

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

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

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

Параметры

строка|массив|null $key необязательно null

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

смешанный|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

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

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

смешанный
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключения

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

строка|массив $key

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

смешанный|null $value необязательно null

Значение для установки.

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

$this Сам объект.

[
    'key' => 'Auth.User',
    'redirect' => 'Auth.redirect'
]