Класс SessionStorage

__construct()source public

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

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

Параметры

Cake\Http\ServerRequest $request

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

Cake\Http\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

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

булево|строка $merge необязательный false

Истина для рекурсивного слияния, «поверхностное» для простого слияния, ложь для перезаписи, по умолчанию ложь.

Возможные исключения

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']);

Устаревшее

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

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

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

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

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

булево $merge необязательный true

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

Возвращает

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

Возможные исключения

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

Возвращает

$this

getConfig()source public

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

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

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

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

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

Параметры

строка|null $key необязательный null

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

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

Возвращаемое значение, когда ключ не существует.

Возвращает

смешанный
Значение конфигурации, которое считывается.

setConfig()source public

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

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

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

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

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

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

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

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

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

Параметры

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

Ключ для установки или массив настроек.

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

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

логическое значение $merge необязательно true

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

Возвращает

$this

Выбрасывает

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

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