Интерфейс yii\filters\auth\AuthInterface
AuthInterface — это интерфейс, который должны реализовывать классы методов аутентификации.
Публичные методы
| Метод | Описание | Определено |
|---|---|---|
| authenticate() | Проверяет аутентификацию текущего пользователя. | yii\filters\auth\AuthInterface |
| challenge() | Генерирует вызовы при неудачной аутентификации. | yii\filters\auth\AuthInterface |
| handleFailure() | Обрабатывает неудачную аутентификацию. | yii\filters\auth\AuthInterface |
Подробное описание методов
authenticate() public abstract method
Проверяет аутентификацию текущего пользователя.
| public abstract yii\web\IdentityInterface authenticate ( $user, $request, $response ) | ||
|---|---|---|
| $user | yii\web\User | |
| $request | yii\web\Request | |
| $response | yii\web\Response | |
| return | yii\web\IdentityInterface |
Объект аутентифицированного пользователя. Если информация об аутентификации не предоставлена, возвращается null. |
| throws | yii\web\UnauthorizedHttpException |
если информация об аутентификации предоставлена, но неверна. |
challenge() public abstract method
Генерирует вызовы при неудачной аутентификации.
Например, могут быть сгенерированы соответствующие HTTP-заголовки.
| public abstract void challenge ( $response ) | ||
|---|---|---|
| $response | yii\web\Response | |
handleFailure() public abstract method
Обрабатывает неудачную аутентификацию.
Реализация обычно должна вызывать UnauthorizedHttpException, чтобы указать неудачную аутентификацию.
| public abstract void handleFailure ( $response ) | ||
|---|---|---|
| $response | yii\web\Response | |
| throws | yii\web\UnauthorizedHttpException | |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-filters-auth-authinterface.html