Класс AuthComponent

__get()source public

__get( string $name )

Магический аксессор для обратной совместимости для свойства $sessionKey.

Параметры

строка $name

Имя свойства

Возвращает

mixed

Переопределяет

Cake\Controller\Component::__get()

__set()source public

__set( string $name , mixed $value )

Магический установщик для обратной совместимости для свойства $sessionKey.

Параметры

строка $name

Имя свойства.

смешанное $value

Значение для установки.

_getUrlToRedirectBackTo()source protected

_getUrlToRedirectBackTo( )

Возвращает URL для перенаправления обратно или / если это невозможно.

Этот метод учитывает referrer, если тип запроса не GET.

Возвращает

строка

_getUser()source protected

_getUser( )

Аналогично AuthComponent::user(), за исключением того, что если пользователь не найден в конфигурированном хранилище, будут вызваны методы getUser() подключенных объектов аутентификации.

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

Возвращает

булево
true Если пользователь найден, false если нет.

_isAllowed()source protected

_isAllowed( Cake\Controller\Controller $controller )

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

Параметры

Cake\Controller\Controller $controller

Ссылка на объект контроллера, который его вызвал

Возвращает

булево
True если действие доступно без аутентификации, иначе false

_isLoginAction()source protected

_isLoginAction( Cake\Controller\Controller $controller )

Нормализует конфигурацию loginAction и проверяет, совпадает ли текущий URL запроса с действием входа в систему.

Параметры

Cake\Controller\Controller $controller

Ссылка на объект контроллера.

Возвращает

булево
True если текущее действие - действие входа в систему, иначе false.

_loginActionRedirectUrl()source protected

_loginActionRedirectUrl( )

Возвращает URL действия входа в систему для перенаправления.

Включает строку запроса для перенаправления, если применимо.

Возвращает

массив|строка

_setDefaults()source protected

_setDefaults( )

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

_unauthenticated()source protected

_unauthenticated( Cake\Controller\Controller $controller )

Обрабатывает попытку доступа без авторизации. Сначала вызывается метод unauthenticated() последнего аутентификатора в цепочке. Аутентификатор может обработать отправку ответа или перенаправление, как необходимо, и вернуть true , чтобы указать, что дальнейших действий не требуется. Если аутентификатор возвращает null, этот метод перенаправляет пользователя на действие входа в систему. Если это AJAX-запрос и указана конфигурация ajaxLogin, то рендерится соответствующий элемент, иначе возвращается HTTP-код состояния 403.

Параметры

Cake\Controller\Controller $controller

Ссылка на объект контроллера.

Возвращает

Cake\Http\Response|null

Null, если текущее действие — действие входа в систему, иначе объект ответа, возвращённый объектом аутентификации или Controller::redirect().

Исключение

Cake\Core\Exception\Exception

_unauthorized()source protected

_unauthorized( Cake\Controller\Controller $controller )

Обработка попытки несанкционированного доступа

Параметры

Cake\Controller\Controller $controller

Ссылка на объект контроллера

Возвращает

Cake\Http\Response

Исключение

Cake\Http\Exception\ForbiddenException

allow()source public

allow( string|array|null $actions = null )

Принимает список действий в текущем контроллере, для которых не требуется аутентификация, или без параметров для разрешения всех действий.

Вы можете использовать allow с массивом или простой строкой.

$this->Auth->allow('view');
$this->Auth->allow(['edit', 'add']);

или для разрешения всех действий

$this->Auth->allow();

Параметры

string|array|null $actions optional null

Имя действия контроллера или массив действий

Ссылка

https://book.cakephp.org/3.0/ru/controllers/components/authentication.html#making-actions-public

authCheck()source public

authCheck( Cake\Event\Event $event )

Основной метод выполнения, обрабатывает начальную проверку аутентификации и перенаправление неавторизованных пользователей.

Проверка аутентификации выполняется, когда имя события совпадает с именем, настроенным в конфигурации checkAuthIn.

Параметры

Cake\Event\Event $event

Экземпляр события.

Возвращает

Cake\Http\Response|null

Исключение

ReflectionException

authenticationProvider()source public

authenticationProvider( )

Если во время этого запроса было вызвано login и пользователь успешно авторизован, эта функция вернёт экземпляр объекта аутентификации, который использовался для входа пользователя.

Возвращает

Cake\Auth\BaseAuthenticate|null

authorizationProvider()source public

authorizationProvider( )

Если для текущего запроса была выполнена обработка авторизации, эта функция вернёт экземпляр объекта авторизации, который предоставил пользователю доступ к текущему адресу.

Возвращает

Cake\Auth\BaseAuthorize|null

constructAuthenticate()source public

constructAuthenticate( )

Загружает настроенные объекты аутентификации.

Возвращает

array|null
Загруженные объекты авторизации, или null при пустом значении authenticate.

Исключение

Cake\Core\Exception\Exception

constructAuthorize()source public

constructAuthorize( )

Загружает настроенные объекты авторизации.

Возвращает

array|null
Загруженные объекты авторизации, или null, если authorize пуст.

Исключение

Cake\Core\Exception\Exception

deny()source public

deny( string|array|null $actions = null )

Удаляет элементы из списка разрешённых/не требующих аутентификации действий.

Вы можете использовать deny с массивом или простой строкой.

$this->Auth->deny('view');
$this->Auth->deny(['edit', 'add']);

или

$this->Auth->deny();

чтобы удалить все элементы из разрешённого списка

Параметры

string|array|null $actions optional null

Имя действия контроллера или массив действий

См. также

\Cake\Controller\Component\AuthComponent::allow()

Ссылка

https://book.cakephp.org/3.0/ru/controllers/components/authentication.html#making-actions-require-authorization

flash()source public

flash( string $message )

Устанавливает сообщение всплывающей подсказки. Использует компонент Flash со значениями из конфигурации flash.

Параметры

string $message

Сообщения для установки.

getAuthenticate()source public

getAuthenticate( string $alias )

Метод-получатель для объектов аутентификации. Вернёт конкретный объект аутентификации.

Параметры

string $alias

Псевдоним объекта аутентификации

Возвращает

Cake\Auth\BaseAuthenticate|null

getAuthorize()source public

getAuthorize( string $alias )

Метод-получатель для объектов авторизации. Вернёт конкретный объект авторизации.

Параметры

string $alias

Псевдоним объекта авторизации

Возвращает

Cake\Auth\BaseAuthorize|null

identify()source public

identify( )

Использует настроенные адаптеры аутентификации и пытается идентифицировать пользователя по данным авторизации, содержащимся в $request.

Вызывает событие Auth.afterIdentify, на которое могут подписываться классы аутентификации.

Возвращает

array|boolean
Данные записи пользователя или false, если пользователь не был идентифицирован.

implementedEvents()source public

implementedEvents( )

Поддерживаемые события этого компонента.

Возвращает

array

Переопределяет

Cake\Controller\Component::implementedEvents()

initialize()source public

initialize( array $config )

Инициализирует свойства.

Параметры

array $config

Данные конфигурации.

Переопределяет

Cake\Controller\Component::initialize()

isAuthorized()source public

isAuthorized( array|ArrayAccess|null $user = null , Cake\Http\ServerRequest $request = null )

Проверьте, авторизован ли предоставленный пользователь для запроса.

Использует настроенные адаптеры авторизации, чтобы проверить, авторизован ли пользователь. Каждый адаптер проверяется последовательно; если любой из них возвращает true, пользователь будет авторизован для запроса.

Параметры

массив|ArrayAccess|null $user необязательно null

Пользователь, авторизация которого должна быть проверена. Если пусто, будет использован пользователь, извлечённый из хранилища.

Cake\Http\ServerRequest $request необязательно null

Запрос, для которого необходимо выполнить аутентификацию. Если пусто, будет использован текущий запрос.

Возвращает

boolean
True, если $user авторизован, иначе false

logout()source public

logout( )

Выход пользователя.

Возвращает действие выхода для перенаправления. Вызывает событие Auth.logout, на которое могут подписываться классы аутентификации для выполнения пользовательской логики выхода.

Возвращает

string
Нормализованная конфигурация logoutRedirect

Ссылка

https://book.cakephp.org/3.0/ru/controllers/components/authentication.html#logging-users-out

redirectUrl()source public

redirectUrl( string|array|null $url = null )

Получить URL, на который пользователь должен быть перенаправлен после входа.

Передайте URL для установки назначения, на которое пользователь должен быть перенаправлен после входа.

Если параметр не передан, получает URL перенаправления аутентификации. Возвращаемый URL соответствует следующим правилам:

• Возвращает нормализованный URL перенаправления из хранилища, если он присутствует и для того же домена, на котором запущено текущее приложение.
• Если URL не возвращается из хранилища и есть конфигурация loginRedirect, возвращается значение loginRedirect.
• Если нет сессии и нет loginRedirect, возвращается /.

Параметры

строка|массив|null $url необязательно null

Необязательный URL для записи как URL перенаправления при входе.

Возвращает

string
URL перенаправления

setUser()source public

setUser( array|ArrayAccess $user )

Установить предоставленную информацию о пользователе в хранилище как вошедшего пользователя.

Класс хранилища настраивается с использованием ключа конфигурации storage или путём передачи экземпляра в AuthComponent::storage().

Параметры

массив|ArrayAccess $user

Данные пользователя.

Ссылка

https://book.cakephp.org/3.0/ru/controllers/components/authentication.html#identifying-users-and-logging-them-in

startup()source public

startup( Cake\Event\Event $event )

Обработчик события Controller.startup.

Параметры

Cake\Event\Event $event

Экземпляр события.

Возвращает

Cake\Http\Response|null

storage()source public

storage( Cake\Auth\Storage\StorageInterface $storage = null )

Получить/установить объект хранения записей пользователей.

Параметры

Cake\Auth\Storage\StorageInterface $storage необязательно null

Устанавливает предоставленный объект в качестве хранилища или, если null, возвращает настроенный объект хранилища.

Возвращает

Cake\Auth\Storage\StorageInterface|null

user()source public

user( string|null $key = null )

Получить текущего пользователя из хранилища.

Параметры

строка|null $key необязательно null

Поле для извлечения. Оставьте null, чтобы получить всю запись пользователя.

Возвращает

смешанный|null
Либо запись пользователя, либо null, если пользователь не вошёл в систему, или извлечённое поле, если ключ указан.

Ссылка

https://book.cakephp.org/3.0/ru/controllers/components/authentication.html#accessing-the-logged-in-user

__construct()source public

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

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry

A ComponentRegistry this component can use to lazy load its components

массив $config необязательно []

Массив настроек конфигурации.

__debugInfo()source public

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

массив

getController()source public

getController( )

Получить контроллер, к которому привязан этот компонент.

Возвращает

Cake\Controller\Controller
Связанный контроллер.

dispatchEvent()source public

dispatchEvent( string $name , array|null $data = null , object|null $subject = null )

Обёртка для создания и отправки событий.

Возвращает событие, которое было обработано.

Параметры

строка $name

Название события.

массив|null $data необязательно null

Любое значение, которое вы хотите передать вместе с этим событием, чтобы его могли прочитать слушатели.

объект|null $subject необязательно null

Объект, к которому относится это событие ($this по умолчанию).

Возвращает

Cake\Event\Event

eventManager()source public deprecated

eventManager( Cake\Event\EventManager $eventManager = null )

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов для событий объекта, или создавать собственные события и вызывать их по своему желанию.

Устарело

3.5.0 Используйте getEventManager()/setEventManager() вместо этого.

Параметры

Cake\Event\EventManager $eventManager необязательно null

устанавливаемый eventManager

Возвращает

Cake\Event\EventManager

getEventManager()source public

getEventManager( )

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов для событий объекта, или создавать собственные события и вызывать их по своему желанию.

Возвращает

Cake\Event\EventManager

setEventManager()source public

setEventManager( Cake\Event\EventManager $eventManager )

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов для событий объекта, или создавать собственные события и вызывать их по своему желанию.

Параметры

Cake\Event\EventManager $eventManager

устанавливаемый eventManager

Возвращает

$this

_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

Значение для записи.

boolean или строка $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

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

config()source public deprecated

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']);

Устаревшее

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

строка или массив или null $key необязательно null

Ключ для получения/установки или полный массив конфигураций.

смешанный тип или null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

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

Исключения

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

configShallow()source public

configShallow( string|array $key , mixed|null $value = null )

Объединить предоставленную конфигурацию с существующей. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

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

$this->configShallow('key', $value);

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

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

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

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

Параметры

строка или массив $key

Ключ для установки или полный массив конфигураций.

смешанный тип или null $value необязательно null

Значение для установки.

Возвращает

$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

строка или null $key необязательно null

Ключ для получения или null для всей конфигурации.

смешанный тип $default необязательно null

Значение по умолчанию, если ключ не существует.

Возвращает

смешанный тип
Значение конфигурации при чтении.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

Устанавливает конфигурацию.

Использование

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

$this->setConfig('key', $value);

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

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

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

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

Параметры

строка или массив $key

Ключ для установки или полный массив конфигураций.

смешанный тип или null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

$this

Исключения

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

log()source public

log( mixed $msg , integer|string $level = LogLevel::ERROR , string|array $context = [] )

Удобный метод для записи сообщения в журнал. Для получения дополнительной информации о записи в журналы, см. Log::write().

Параметры

смешанный тип $msg

Сообщение журнала.

целое число или строка $level необязательно LogLevel::ERROR

Уровень ошибки.

строка или массив $context необязательно []

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

boolean
Результат записи в журнал.

[]

[]

[
    'authenticate' => null,
    'authorize' => null,
    'ajaxLogin' => null,
    'flash' => null,
    'loginAction' => null,
    'loginRedirect' => null,
    'logoutRedirect' => null,
    'authError' => null,
    'unauthorizedRedirect' => true,
    'storage' => 'Session',
    'checkAuthIn' => 'Controller.startup'
]

[]

['RequestHandler', 'Flash']