You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
41 lines
1.2 KiB
41 lines
1.2 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\rest; |
|
|
|
use yii\web\User; |
|
use yii\web\Request; |
|
use yii\web\Response; |
|
use yii\web\IdentityInterface; |
|
use yii\web\UnauthorizedHttpException; |
|
|
|
/** |
|
* AuthInterface is the interface required by classes that support user authentication. |
|
* |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
interface AuthInterface |
|
{ |
|
/** |
|
* Authenticates the current user. |
|
* |
|
* @param User $user |
|
* @param Request $request |
|
* @param Response $response |
|
* @return IdentityInterface the authenticated user identity. If authentication information is not provided, null will be returned. |
|
* @throws UnauthorizedHttpException if authentication information is provided but is invalid. |
|
*/ |
|
public function authenticate($user, $request, $response); |
|
/** |
|
* Handles authentication failure. |
|
* The implementation should normally throw UnauthorizedHttpException to indicate authentication failure. |
|
* @param Response $response |
|
* @throws UnauthorizedHttpException |
|
*/ |
|
public function handleFailure($response); |
|
}
|
|
|