0 关注者

接口 yii\filters\auth\AuthInterface

实现于yii\filters\auth\AuthMethodyii\filters\auth\CompositeAuthyii\filters\auth\HttpBasicAuthyii\filters\auth\HttpBearerAuthyii\filters\auth\HttpHeaderAuthyii\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 yii\web\IdentityInterface|null authenticate ( $user$request$response )
$user yii\web\User
$request yii\web\Request
$response yii\web\Response
返回值 yii\web\IdentityInterface|null

已认证的用户身份。如果未提供认证信息,则返回 null。

抛出 yii\web\UnauthorizedHttpException

如果提供了认证信息但无效。

                public function authenticate($user, $request, $response);

            
challenge() 公共抽象方法

在认证失败时生成挑战。

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

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

                public function challenge($response);

            
handleFailure() 公共抽象方法

处理认证失败。

实现通常应该抛出 UnauthorizedHttpException 以指示认证失败。

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

                public function handleFailure($response);