Абстрактный класс yii\filters\auth\AuthMethod

Все классы | Свойства | Методы

Наследование	yii\filters\auth\AuthMethod » yii\base\ActionFilter » yii\base\Behavior » yii\base\Object
Реализует	yii\base\Configurable, yii\filters\auth\AuthInterface
Подклассы	yii\filters\auth\CompositeAuth, yii\filters\auth\HttpBasicAuth, yii\filters\auth\HttpBearerAuth, yii\filters\auth\QueryParamAuth
Доступно с версии	2.0
Исходный код	https://github.com/yiisoft/yii2/blob/master/framework/filters/auth/AuthMethod.php

AuthMethod — это базовый класс, реализующий интерфейс yii\filters\auth\AuthInterface.

Публичные свойства

Свойство	Тип	Описание	Определено в
$except	массив	Список идентификаторов действий, к которым данный фильтр не должен применяться.	yii\base\ActionFilter
$only	массив	Список идентификаторов действий, к которым данный фильтр должен применяться.	yii\base\ActionFilter
$optional	массив	Список идентификаторов действий, к которым будет применяться фильтр, но ошибка аутентификации не приведёт к ошибке.	yii\filters\auth\AuthMethod
$owner	yii\base\Component\|null	Владелец данного поведения	yii\base\Behavior
$request	yii\web\Request	Текущий запрос.	yii\filters\auth\AuthMethod
$response	yii\web\Response	Ответ, который должен быть отправлен.	yii\filters\auth\AuthMethod
$user	yii\web\User	Объект пользователя, представляющий статус аутентификации пользователя.	yii\filters\auth\AuthMethod

Публичные методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Object
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства объекта.	yii\base\Object
__isset()	Проверяет, установлено ли свойство, т.е. определено и не равно null.	yii\base\Object
__set()	Устанавливает значение свойства объекта.	yii\base\Object
__unset()	Устанавливает свойство объекта в null.	yii\base\Object
afterAction()	Этот метод вызывается сразу после выполнения действия.	yii\base\ActionFilter
afterFilter()		yii\base\ActionFilter
attach()	Прикрепляет объект поведения к компоненту.	yii\base\Behavior
authenticate()	Проверяет текущего пользователя.	yii\filters\auth\AuthInterface
beforeAction()	Этот метод вызывается непосредственно перед выполнением действия (после всех возможных фильтров). Вы можете переопределить этот метод, чтобы выполнить подготовку действия в последний момент.	yii\filters\auth\AuthMethod
beforeFilter()		yii\base\ActionFilter
canGetProperty()	Возвращает значение, указывающее, можно ли прочитать свойство.	yii\base\Object
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Object
challenge()	Генерирует вызовы при неудачной аутентификации.	yii\filters\auth\AuthMethod
className()	Возвращает полное имя этого класса.	yii\base\Object
detach()	Отсоединяет объект поведения от компонента.	yii\base\Behavior
events()	Объявляет обработчики событий для событий $owner.	yii\base\Behavior
handleFailure()	Обрабатывает неудачную аутентификацию.	yii\filters\auth\AuthMethod
hasMethod()	Возвращает значение, указывающее, определён ли метод.	yii\base\Object
hasProperty()	Возвращает значение, указывающее, определено ли свойство.	yii\base\Object
init()	Инициализирует объект.	yii\base\Object

Защищённые методы

Метод	Описание	Определено в
getActionId()	Возвращает идентификатор действия, преобразуя yii\base\Action::$uniqueId в идентификатор, относящийся к модулю	yii\base\ActionFilter
isActive()	Возвращает значение, указывающее, активен ли фильтр для данного действия.	yii\base\ActionFilter
isOptional()	Проверяет, является ли аутентификация необязательной для данного действия.	yii\filters\auth\AuthMethod

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

$optional публичное свойство (доступно с версии 2.0.7)

Список идентификаторов действий, к которым будет применяться фильтр, но ошибка аутентификации не приведёт к ошибке. Может использоваться для действий, разрешённых для публичного доступа, но возвращающих дополнительную информацию для авторизованных пользователей. По умолчанию пусто, что означает, что аутентификация не является необязательной ни для какого действия. С версии 2.0.10 идентификаторы действий могут указываться с подстановкой, например site/*.

См. также isOptional().

public array $optional = []

$request публичное свойство

Текущий запрос. Если не задан, будет использоваться компонент приложения request.

public yii\web\Request $request = null

$response публичное свойство

Ответ, который должен быть отправлен. Если не задан, будет использоваться компонент приложения response.

public yii\web\Response $response = null

$user публичное свойство

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

public yii\web\User $user = null

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

beforeAction() общедоступный метод

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

public boolean beforeAction ( $action )
$action	yii\base\Action	Действие, которое должно быть выполнено.
return	boolean	Следует ли продолжить выполнение действия.

challenge() общедоступный метод

Генерирует вызовы при ошибке аутентификации.

Например, могут быть сгенерированы соответствующие HTTP-заголовки.

public void challenge ( $response )
$response	yii\web\Response

handleFailure() общедоступный метод

Обрабатывает ошибку аутентификации.

Реализация обычно должна выбрасывать UnauthorizedHttpException, чтобы указать ошибку аутентификации.

public void handleFailure ( $response )
$response	yii\web\Response
throws	yii\web\UnauthorizedHttpException

isOptional() защищённый метод (доступен с версии 2.0.7)

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

См. также $optional.

protected boolean isOptional ( $action )
$action	yii\base\Action	Действие, которое нужно проверить.
return	boolean	Является ли аутентификация необязательной.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-filters-auth-authmethod.html