Класс yii\filters\auth\HttpBearerAuth
| Наследование | yii\filters\auth\HttpBearerAuth » yii\filters\auth\AuthMethod » yii\base\ActionFilter » yii\base\Behavior » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\filters\auth\AuthInterface |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/filters/auth/HttpBearerAuth.php |
HttpBearerAuth — это фильтр действий, поддерживающий метод аутентификации на основе токена HTTP Bearer.
Вы можете использовать HttpBearerAuth, подключив его как поведение к контроллеру или модулю, как показано ниже:
public function behaviors()
{
return [
'bearerAuth' => [
'class' => \yii\filters\auth\HttpBearerAuth::className(),
],
];
}
Публичные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $except | массив | Список идентификаторов действий, к которым этот фильтр не должен применяться. | yii\base\ActionFilter |
| $only | массив | Список идентификаторов действий, к которым этот фильтр должен применяться. | yii\base\ActionFilter |
| $optional | массив | Список идентификаторов действий, к которым фильтр будет применяться, но ошибка аутентификации не приведёт к ошибке. | yii\filters\auth\AuthMethod |
| $owner | yii\base\Component|null | Владелец этого поведения | yii\base\Behavior |
| $realm | строка | Область HTTP аутентификации | yii\filters\auth\HttpBearerAuth |
| $request | yii\web\Request | Текущий запрос. | yii\filters\auth\AuthMethod |
| $response | yii\web\Response | Ответ, который будет отправлен. | yii\filters\auth\AuthMethod |
| $user | yii\web\User | Объект пользователя, представляющий состояние аутентификации пользователя. | yii\filters\auth\AuthMethod |
Публичные методы
| Метод | Описание | Определено |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т. е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| afterAction() | Этот метод вызывается сразу после выполнения действия. | yii\base\ActionFilter |
| afterFilter() | yii\base\ActionFilter | |
| attach() | Прикрепляет объект поведения к компоненту. | yii\base\Behavior |
| authenticate() | Производит аутентификацию текущего пользователя. | yii\filters\auth\HttpBearerAuth |
| beforeAction() | Этот метод вызывается непосредственно перед выполнением действия (после всех возможных фильтров). Вы можете переопределить этот метод, чтобы выполнить последнюю подготовку к действию. | yii\filters\auth\AuthMethod |
| beforeFilter() | yii\base\ActionFilter | |
| canGetProperty() | Возвращает значение, указывающее, может ли свойство быть прочитано. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, может ли свойство быть установлено. | yii\base\Object |
| challenge() | Генерирует вызовы при ошибке аутентификации. | yii\filters\auth\HttpBearerAuth |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| detach() | Отсоединяет объект поведения от компонента. | yii\base\Behavior |
| events() | Объявляет обработчики событий для событий $owner. | yii\base\Behavior |
| handleFailure() | Обрабатывает ошибку аутентификации. | yii\filters\auth\AuthMethod |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
Защищённые методы
| Метод | Описание | Определено |
|---|---|---|
| getActionId() | Возвращает идентификатор действия, преобразуя yii\base\Action::$uniqueId в идентификатор, относящийся к модулю | yii\base\ActionFilter |
| isActive() | Возвращает значение, указывающее, активен ли фильтр для данного действия. | yii\base\ActionFilter |
| isOptional() | Проверяет, является ли аутентификация необязательной для данного действия. | yii\filters\auth\AuthMethod |
Подробное описание свойств
$realm публичное свойство
Область HTTP аутентификации
public string $realm = 'api'
Подробное описание методов
authenticate() public method
Проверяет аутентификацию текущего пользователя.
| public 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 method
Генерирует вызовы на аутентификацию при ее неудаче.
Например, могут быть сгенерированы соответствующие HTTP-заголовки.
| public void challenge ( $response ) | ||
|---|---|---|
| $response | yii\web\Response | |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-filters-auth-httpbearerauth.html
