Класс SessionStorage
Постоянное хранилище данных на основе сеанса для аутентифицированных пользователей.
- Cake\Auth\Storage\SessionStorage реализует Cake\Auth\Storage\StorageInterface использует Cake\Core\InstanceConfigTrait
Краткое описание свойств
-
$_defaultConfigprotectedЗначения по умолчанию для этого класса.array - Объект сеанса.
$_sessionprotected -
$_userprotectedЗапись пользователя.array|boolean
Унаследованные свойства
Краткое описание методов
- __construct() publicКонструктор.
- delete() publicУдалить запись пользователя из сеанса.
- read() publicПрочитать запись пользователя из сеанса.
- redirectUrl() publicПолучить/установить URL перенаправления.
- write() publicЗаписать запись пользователя в сеанс.
Подробное описание методов
__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 $user )
Записать запись пользователя в сеанс.
Идентификатор сеанса также обновляется для снижения проблем с повторным использованием сеанса.
Параметры
- массив
$user - Запись пользователя.
Реализация
Cake\Auth\Storage\StorageInterface::write() Методы, используемые из Cake\Core\InstanceConfigTrait
_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 Истина для рекурсивного слияния, '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 - Значение для установки.
- логическое значение
$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 Объект самого себя.
Подробное описание свойств
$_defaultConfigsource
protected массив
Значения по умолчанию для этого класса.
Ключи:
-
key- Ключ сеанса, используемый для хранения записи пользователя. -
redirect- Ключ сеанса, используемый для хранения URL перенаправления.
[
'key' => 'Auth.User',
'redirect' => 'Auth.redirect'
] $_usersource
protected массив|логическое значение
Запись пользователя.
Массив с записью пользователя, если получен из сеанса, или ложь, если в сеансе нет записи пользователя.
© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Auth.Storage.SessionStorage.html