Spec-Zone.ru › Yii 2.0

Интерфейс yii\filters\auth\AuthInterface

Все классы | Методы
Реализуется yii\filters\auth\AuthMethod, 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/AuthInterface.php

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

Spec-Zone.ru

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