Spec-Zone.ru › CakePHP 3.2

Класс BaseAuthorize

Абстрактный базовый адаптер авторизации для AuthComponent.

Cake\Auth\BaseAuthorize использует Cake\Core\InstanceConfigTrait

Прямые подклассы

  • Cake\Auth\ControllerAuthorize
Абстрактный
Пространство имен: Cake\Auth
См.: \Cake\Controller\Component\AuthComponent::$authenticate
Расположение: Auth/BaseAuthorize.php

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

  • $_defaultConfig protected
    array
    Значение по умолчанию для конфигурации объектов авторизации.
  • $_registry protected
    Cake\Controller\ComponentRegistry
    Экземпляр ComponentRegistry для получения дополнительных компонентов.

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

  • _config, _configInitialized

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

  • __construct() public
    Конструктор
  • authorize() abstract public
    Проверка авторизации пользователя.

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

__construct()source public

__construct( Cake\Controller\ComponentRegistry $registry , array $config [] )

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry
Контроллер для этого запроса.
массив $config необязательно []
Массив конфигурации. Этот класс не использует никакую конфигурацию.

authorize()source abstract public

authorize( array $user , Cake\Network\Request $request )

Проверка авторизации пользователя.

Параметры

массив $user
Данные активного пользователя
Cake\Network\Request $request
Экземпляр запроса.

Возвращает

boolean

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

_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
Ключ для записи.
смешанное $value
Значение для записи.
булево|строка $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию 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']);

Параметры

строка|массив|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->config('key', $value);

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

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

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

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

Параметры

строка|массив $key
Ключ для установки или весь массив конфигураций.
смешанное|null $value необязательно null
Значение для установки.

Возвращает


$this Сам объект.

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

$_defaultConfigsource

protected массив

Значение по умолчанию для конфигурации объектов авторизации.

[]

$_registrysource

protected Cake\Controller\ComponentRegistry

Экземпляр ComponentRegistry для получения дополнительных компонентов.

© 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.BaseAuthorize.html

Spec-Zone.ru

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