Interface yii\filters\auth\AuthInterface

Implemented byyii\filters\auth\AuthMethod, yii\filters\auth\CompositeAuth, yii\filters\auth\HttpBasicAuth, yii\filters\auth\HttpBearerAuth, yii\filters\auth\HttpHeaderAuth, yii\filters\auth\QueryParamAuth
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/filters/auth/AuthInterface.php

AuthInterface 是应该由 auth 方法类实现的接口.

公共方法

隐藏继承的方法

方法描述定义在
authenticate() 验证当前用户. yii\filters\auth\AuthInterface
challenge() 身份验证失败时产生的挑战. yii\filters\auth\AuthInterface
handleFailure() 处理身份验证失败. yii\filters\auth\AuthInterface

方法详情

authenticate() public abstract 方法

验证当前用户.

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 方法

身份验证失败时产生的挑战.

例如, 可能会生成一些适当的 HTTP 表头.

public abstract void challenge ( $response )
$response yii\web\Response
handleFailure() public abstract 方法

处理身份验证失败.

该实现通常应抛出 UnauthorizedHttpException 来指示认证失败.

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