Spec-Zone.ru › CakePHP 3.1

Класс SessionStorage

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

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

Подробное описание методов

__constructисходный код public

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

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

Параметры

Cake\Network\Request $request
Экземпляр запроса.
Cake\Network\Response $response
Экземпляр ответа.
массив $config необязательно []
Список конфигураций.

deleteисходный код public

delete( )

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

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

Реализация

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

readисходный код public

read( )

Прочитать запись пользователя из сеанса.

Возвращает

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

Реализация

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

redirectUrlисходный код public

redirectUrl( mixed $url null )

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

Параметры

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

Возвращает

mixed
смешанный

Реализация

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

writeисходный код public

write( array $user )

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

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

Параметры

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

Реализация

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

Методы, используемые из Cake\Core\InstanceConfigTrait

_configDeleteисходный код protected

_configDelete( string $key )

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

Параметры

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

Исключения

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

_configReadисходный код protected

_configRead( string|null $key )

Прочитать переменную конфигурации

Параметры

строка|null $key
Ключ для чтения.

Возвращает

mixed
смешанный

_configWriteисходный код protected

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

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

Параметры

строка|массив $key
Ключ для записи.
смешанный $value
Значение для записи.
булево|строка $merge необязательно false
True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

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

configисходный код 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
Необходимо ли рекурсивно сливать или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

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

Исключения

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

configShallowисходный код 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
Значение для установки.

Возвращает

mixed
$this Объект сам по себе.

Резюме свойств

$_defaultConfigисходный код

protected массив

Значения по умолчанию для этого класса.

Ключи:

  • key - Ключ сеанса, используемый для хранения записи пользователя.
  • redirect - Ключ сеанса, используемый для хранения URL перенаправления.
[
    'key' => 'Auth.User',
    'redirect' => 'Auth.redirect'
]

$_sessionисходный код

protected Cake\Network\Session

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

$_userисходный код

protected массив|булево

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

Хранит массив записи пользователя, если он получен из сеанса, или false, если сеанс не содержит записи пользователя.

Свойства, используемые из Cake\Core\InstanceConfigTrait

$_configисходный код

protected массив

Конфигурация во время выполнения

[]

$_configInitializedисходный код

protected булево

Указывает, была ли конфигурация свойств уже настроена по умолчанию

false

© 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.1/class-Cake.Auth.Storage.SessionStorage.html

Spec-Zone.ru

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