Spec-Zone.ru › CakePHP 3.2

Класс SessionStorage

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

Cake\Auth\Storage\SessionStorage реализует Cake\Auth\Storage\StorageInterface использует Cake\Core\InstanceConfigTrait
Пространство имён: Cake\Auth\Storage
Расположение: Auth/Storage/SessionStorage.php

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

  • $_defaultConfig protected
    array
    Значения по умолчанию для этого класса.
  • $_session protected
    Cake\Network\Session
    Объект сеанса.
  • $_user protected
    array|boolean
    Запись пользователя.

Унаследованные свойства

  • _config, _configInitialized

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

  • __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'
]

$_sessionsource

protected Cake\Network\Session

Объект сеанса.

$_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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API