没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

Interface yii\filters\auth\AuthInterface

实现yii\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/yiichina/yii2/blob/api/framework/filters/auth/AuthInterface.php

AuthInterface 是应该由 Auth 方法类实现的接口。

公共方法

隐藏继承的方法

方法描述被定义在
authenticate() 对当前用户进行身份验证。 yii\filters\auth\AuthInterface
challenge() 在身份验证失败时产生质询。 例如,一些适当的 HTTP headers 可能会生成。 yii\filters\auth\AuthInterface
handleFailure() 处理身份验证失败。 该实现通常应抛出未经授权的 UnauthorizedHttpException 异常以指示身份验证失败。 yii\filters\auth\AuthInterface

方法详情

authenticate() 公共 抽象 方法

对当前用户进行身份验证。

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

已验证的用户标识。如果不提供身份验证信息,则返回空。

throws yii\web\UnauthorizedHttpException

如果提供的身份验证信息无效。

challenge() 公共 抽象 方法

在身份验证失败时产生质询。 例如,一些适当的 HTTP headers 可能会生成。

public abstract void challenge($response)
$response yii\web\Response
handleFailure() 公共 抽象 方法

处理身份验证失败。 该实现通常应抛出未经授权的 UnauthorizedHttpException 异常以指示身份验证失败。

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