Класс 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( )

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

Возвращает

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

Реализация

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

redirectUrl()source public

redirectUrl( mixed $url = null )

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

Параметры

mixed $url необязательно null

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

Возвращает

mixed

Реализация

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

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

Возвращает

mixed

_configWrite()source protected

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

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

Параметры

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

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

mixed $value

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

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

True для рекурсивного объединения, 'shallow' для простого объединения, false для перезаписи, по умолчанию false.

Исключения

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

config()source public deprecated

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

Deprecated

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

Параметры

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

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

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

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

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

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

Возвращает

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

Исключения

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

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

Возвращает

mixed
Считываемое значение конфигурации.

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

Параметры

string|array $key

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

mixed|null $value необязательно null

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

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

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

Возвращает

$this

Выбрасывает

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

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