Spec-Zone.ru › CakePHP 3.1

Класс BaseAuthorize

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

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

Непосредственные известные подклассы

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

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

__constructsource public

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

Конструктор

Параметры

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

authorizesource абстрактный public

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

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

Параметры

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

Возвращает

boolean
bool

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

_configDeletesource protected

_configDelete( string $key )

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

Параметры

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

Исключения

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

_configReadsource protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

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

Возвращает

mixed
mixed

_configWritesource protected

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

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

Параметры

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

Исключения

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

configsource 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
При попытке установить недопустимый ключ.

configShallowsource 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 Сам объект.

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

$_defaultConfigsource

protected массив

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

[]

$_registrysource

protected Cake\Controller\ComponentRegistry

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

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

$_configsource

protected массив

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

[]

$_configInitializedsource

protected boolean

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

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

Spec-Zone.ru

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