クラス yii\filters\auth\HttpBearerAuth
HttpBearerAuth は、HTTP Bearer トークンに基づく認証メソッドをサポートするアクションフィルターです。
以下のように、コントローラーまたはモジュールにビヘイビアとしてアタッチすることで HttpBearerAuth を使用できます。
public function behaviors()
{
return [
'bearerAuth' => [
'class' => \yii\filters\auth\HttpBearerAuth::class,
],
];
}
公開プロパティ
プロパティ | 型 | 説明 | 定義元 |
---|---|---|---|
$except | array | このフィルターを適用しないアクション ID のリスト。 | yii\base\ActionFilter |
$header | string | HTTP ヘッダー名 | yii\filters\auth\HttpBearerAuth |
$only | array | このフィルターを適用するアクション ID のリスト。 | yii\base\ActionFilter |
$optional | array | このフィルターが適用されるアクション ID のリストですが、認証に失敗してもエラーにはなりません。 | yii\filters\auth\AuthMethod |
$owner | yii\base\Component|null | このビヘイビアのオーナー | yii\base\Behavior |
$pattern | string | HTTP 認証値を抽出するために使用するパターン | yii\filters\auth\HttpBearerAuth |
$realm | string | HTTP 認証レルム | yii\filters\auth\HttpBearerAuth |
$request | yii\web\Request|null | 現在のリクエスト。 | yii\filters\auth\AuthMethod |
$response | yii\web\Response|null | 送信されるレスポンス。 | yii\filters\auth\AuthMethod |
$user | yii\web\User|null | ユーザー認証状態を表すユーザーオブジェクト。 | yii\filters\auth\AuthMethod |
公開メソッド
保護メソッド
メソッド | 説明 | 定義元 |
---|---|---|
getActionId() | yii\base\Action::$uniqueId をモジュールに対する相対 ID に変換して、アクション ID を返します。 | yii\base\ActionFilter |
isActive() | フィルターが指定されたアクションに対してアクティブかどうかを示す値を返します。 | yii\base\ActionFilter |
isOptional() | 指定されたアクションに対して認証がオプションかどうかを確認します。 | yii\filters\auth\AuthMethod |
プロパティの詳細
メソッド詳細
定義元: yii\base\BaseObject::__call()
クラスメソッドではない名前付きメソッドを呼び出します。
このメソッドは、不明なメソッドが呼び出されたときに暗黙的に呼び出される PHP のマジックメソッドであるため、直接呼び出さないでください。
public mixed __call ( $name, $params ) | ||
$name | string |
メソッド名 |
$params | array |
メソッドのパラメータ |
return | mixed |
メソッドの戻り値 |
---|---|---|
throws | yii\base\UnknownMethodException |
不明なメソッドを呼び出した場合 |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
定義元: yii\base\BaseObject::__construct()
コンストラクター。
デフォルトの実装では、次の 2 つの処理を行います。
- 指定された構成
$config
を使用してオブジェクトを初期化します。 - init() を呼び出します。
このメソッドが子クラスでオーバーライドされている場合は、次の推奨事項に従ってください。
- コンストラクタの最後のパラメータは、ここでの
$config
のように、構成配列であること。 - コンストラクタの最後に親の実装を呼び出すこと。
public void __construct ( $config = [] ) | ||
$config | array |
オブジェクトのプロパティを初期化するために使用される名前と値のペア |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定義元: yii\base\BaseObject::__get()
オブジェクトプロパティの値を返します。
このメソッドは、$value = $object->property;
を実行したときに暗黙的に呼び出される PHP のマジックメソッドであるため、直接呼び出さないでください。
__set() も参照してください。
public mixed __get ( $name ) | ||
$name | string |
プロパティ名 |
return | mixed |
プロパティ値 |
---|---|---|
throws | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
throws | yii\base\InvalidCallException |
プロパティが書き込み専用の場合 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
定義元: yii\base\BaseObject::__isset()
プロパティが設定されているか、つまり定義されていて null でないかを確認します。
このメソッドは、isset($object->property)
を実行したときに暗黙的に呼び出される PHP のマジックメソッドであるため、直接呼び出さないでください。
プロパティが定義されていない場合は、false が返されることに注意してください。
public boolean __isset ( $name ) | ||
$name | string |
プロパティ名またはイベント名 |
return | boolean |
名前付きプロパティが設定されているかどうか (null ではない)。 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
定義元: yii\base\BaseObject::__set()
オブジェクトプロパティの値を設定します。
このメソッドは、$object->property = $value;
を実行したときに暗黙的に呼び出される PHP のマジックメソッドであるため、直接呼び出さないでください。
__get() も参照してください。
public void __set ( $name, $value ) | ||
$name | string |
プロパティ名またはイベント名 |
$value | mixed |
プロパティ値 |
throws | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
---|---|---|
throws | yii\base\InvalidCallException |
プロパティが読み取り専用の場合 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
定義元: yii\base\BaseObject::__unset()
オブジェクトプロパティを null に設定します。
このメソッドは、unset($object->property)
を実行したときに暗黙的に呼び出される PHP のマジックメソッドであるため、直接呼び出さないでください。
プロパティが定義されていない場合、このメソッドは何もしないことに注意してください。プロパティが読み取り専用の場合は、例外がスローされます。
public void __unset ( $name ) | ||
$name | string |
プロパティ名 |
throws | yii\base\InvalidCallException |
プロパティが読み取り専用の場合。 |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
定義元: yii\base\ActionFilter::afterAction()
このメソッドは、アクションが実行された直後に呼び出されます。
アクションの後処理を行うために、このメソッドをオーバーライドできます。
public mixed afterAction ( $action, $result ) | ||
$action | yii\base\Action |
実行されたアクション。 |
$result | mixed |
アクションの実行結果 |
return | mixed |
処理されたアクションの結果。 |
---|
public function afterAction($action, $result)
{
return $result;
}
public void afterFilter ( $event ) | ||
$event | yii\base\ActionEvent |
public function afterFilter($event)
{
$event->result = $this->afterAction($event->action, $event->result);
$this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
}
定義元: yii\base\ActionFilter::attach()
ビヘイビアオブジェクトをコンポーネントにアタッチします。
デフォルトの実装では、$owner プロパティを設定し、events() で宣言されているイベントハンドラをアタッチします。このメソッドをオーバーライドする場合は、親の実装を必ず呼び出してください。
public void attach ( $owner ) | ||
$owner | yii\base\Component |
このビヘイビアがアタッチされるコンポーネント。 |
public function attach($owner)
{
$this->owner = $owner;
$owner->on(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
}
定義元: yii\filters\auth\HttpHeaderAuth::authenticate()
現在のユーザーを認証します。
public yii\web\IdentityInterface|null authenticate ( $user, $request, $response ) | ||
$user | yii\web\User | |
$request | yii\web\Request | |
$response | yii\web\Response | |
return | yii\web\IdentityInterface|null |
認証されたユーザーのID。認証情報が提供されていない場合は、nullが返されます。 |
---|---|---|
throws | yii\web\UnauthorizedHttpException |
認証情報が提供されているが、無効な場合。 |
public function authenticate($user, $request, $response)
{
$authHeader = $request->getHeaders()->get($this->header);
if ($authHeader !== null) {
if ($this->pattern !== null) {
if (preg_match($this->pattern, $authHeader, $matches)) {
$authHeader = $matches[1];
} else {
return null;
}
}
$identity = $user->loginByAccessToken($authHeader, get_class($this));
if ($identity === null) {
$this->challenge($response);
$this->handleFailure($response);
}
return $identity;
}
return null;
}
定義元: yii\filters\auth\AuthMethod::beforeAction()
このメソッドは、アクションが実行される直前(可能なすべてのフィルターの後)に呼び出されます。このメソッドをオーバーライドして、アクションの直前準備を行うことができます。
public boolean beforeAction ( $action ) | ||
$action | yii\base\Action |
実行されるアクション。 |
return | boolean |
アクションの実行を継続すべきかどうか。 |
---|
public function beforeAction($action)
{
$response = $this->response ?: Yii::$app->getResponse();
try {
$identity = $this->authenticate(
$this->user ?: Yii::$app->getUser(),
$this->request ?: Yii::$app->getRequest(),
$response
);
} catch (UnauthorizedHttpException $e) {
if ($this->isOptional($action)) {
return true;
}
throw $e;
}
if ($identity !== null || $this->isOptional($action)) {
return true;
}
$this->challenge($response);
$this->handleFailure($response);
return false;
}
public void beforeFilter ( $event ) | ||
$event | yii\base\ActionEvent |
public function beforeFilter($event)
{
if (!$this->isActive($event->action)) {
return;
}
$event->isValid = $this->beforeAction($event->action);
if ($event->isValid) {
// call afterFilter only if beforeFilter succeeds
// beforeFilter and afterFilter should be properly nested
$this->owner->on(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter'], null, false);
} else {
$event->handled = true;
}
}
定義元: yii\base\BaseObject::canGetProperty()
プロパティが読み取り可能かどうかを示す値を返します。
プロパティが読み取り可能であるのは、
- クラスが指定された名前に関連付けられたゲッターメソッドを持っている場合 (この場合、プロパティ名は大文字小文字を区別しません)。
- クラスが指定された名前のメンバー変数を持っている場合 (
$checkVars
が true の場合)。
参考: canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name | string |
プロパティ名 |
$checkVars | boolean |
メンバー変数をプロパティとして扱うかどうか |
return | boolean |
プロパティを読み取れるかどうか |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
定義元: yii\base\BaseObject::canSetProperty()
プロパティが設定可能かどうかを示す値を返します。
プロパティが書き込み可能であるのは、
- クラスが指定された名前に関連付けられたセッターメソッドを持っている場合 (この場合、プロパティ名は大文字小文字を区別しません)。
- クラスが指定された名前のメンバー変数を持っている場合 (
$checkVars
が true の場合)。
参考: canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name | string |
プロパティ名 |
$checkVars | boolean |
メンバー変数をプロパティとして扱うかどうか |
return | boolean |
プロパティを書き込めるかどうか |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
認証失敗時にチャレンジを生成します。
例えば、適切なHTTPヘッダーが生成される可能性があります。
public void challenge ( $response ) | ||
$response | yii\web\Response |
public function challenge($response)
{
$response->getHeaders()->set('WWW-Authenticate', "Bearer realm=\"{$this->realm}\"");
}
::class
を使用してください。
定義元: yii\base\BaseObject::className()
このクラスの完全修飾名を返します。
public static string className ( ) | ||
return | string |
このクラスの完全修飾名。 |
---|
public static function className()
{
return get_called_class();
}
定義元: yii\base\ActionFilter::detach()
ビヘイビアオブジェクトをコンポーネントからデタッチします。
デフォルトの実装では、$owner プロパティのunsetと、events() で宣言されたイベントハンドラーのデタッチを行います。このメソッドをオーバーライドする場合は、必ず親の実装を呼び出してください。
public void detach ( ) |
public function detach()
{
if ($this->owner) {
$this->owner->off(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
$this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
$this->owner = null;
}
}
定義元: yii\base\Behavior::events()
$owner のイベントのイベントハンドラーを宣言します。
子クラスは、このメソッドをオーバーライドして、$owner コンポーネントのイベントにアタッチする必要があるPHPコールバックを宣言できます。
コールバックは、ビヘイビアがオーナーにアタッチされると、$owner のイベントにアタッチされ、ビヘイビアがコンポーネントからデタッチされると、イベントからデタッチされます。
コールバックは、次のいずれかになります。
- このビヘイビアのメソッド:
'handleClick'
、[$this, 'handleClick']
と同等 - オブジェクトメソッド:
[$object, 'handleClick']
- 静的メソッド:
['Page', 'handleClick']
- 匿名関数:
function ($event) { ... }
以下に例を示します。
[
Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( ) | ||
return | array |
イベント (配列キー) と対応するイベントハンドラーメソッド (配列値)。 |
---|
public function events()
{
return [];
}
定義元: yii\base\ActionFilter::getActionId()
yii\base\Action::$uniqueId をモジュールに対する相対 ID に変換して、アクション ID を返します。
protected string getActionId ( $action ) | ||
$action | yii\base\Action |
protected function getActionId($action)
{
if ($this->owner instanceof Module) {
$mid = $this->owner->getUniqueId();
$id = $action->getUniqueId();
if ($mid !== '' && strpos($id, $mid) === 0) {
$id = substr($id, strlen($mid) + 1);
}
} else {
$id = $action->id;
}
return $id;
}
定義元: yii\filters\auth\AuthMethod::handleFailure()
認証失敗を処理します。
通常、実装では、認証の失敗を示すために UnauthorizedHttpException をスローする必要があります。
public void handleFailure ( $response ) | ||
$response | yii\web\Response | |
throws | yii\web\UnauthorizedHttpException |
---|
public function handleFailure($response)
{
throw new UnauthorizedHttpException('Your request was made with invalid credentials.');
}
定義場所: yii\base\BaseObject::hasMethod()
メソッドが定義されているかどうかを示す値を返します。
デフォルトの実装は、PHP関数のmethod_exists()
の呼び出しです。PHPのマジックメソッド__call()
を実装した場合、このメソッドをオーバーライドできます。
public boolean hasMethod ( $name ) | ||
$name | string |
メソッド名 |
return | boolean |
メソッドが定義されているかどうか |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
定義場所: yii\base\BaseObject::hasProperty()
プロパティが定義されているかどうかを示す値を返します。
プロパティは以下の場合に定義されます
- クラスが、指定された名前に関連付けられたゲッターまたはセッターメソッドを持っている場合(この場合、プロパティ名は大文字小文字を区別しません)。
- クラスが指定された名前のメンバー変数を持っている場合 (
$checkVars
が true の場合)。
参照
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name | string |
プロパティ名 |
$checkVars | boolean |
メンバー変数をプロパティとして扱うかどうか |
return | boolean |
プロパティが定義されているかどうか |
---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
public void init ( ) |
public function init()
{
}
定義場所: yii\base\ActionFilter::isActive()
フィルターが指定されたアクションに対してアクティブかどうかを示す値を返します。
protected boolean isActive ( $action ) | ||
$action | yii\base\Action |
フィルタリングされるアクション |
return | boolean |
指定されたアクションに対してフィルターがアクティブかどうか。 |
---|
protected function isActive($action)
{
$id = $this->getActionId($action);
if (empty($this->only)) {
$onlyMatch = true;
} else {
$onlyMatch = false;
foreach ($this->only as $pattern) {
if (StringHelper::matchWildcard($pattern, $id)) {
$onlyMatch = true;
break;
}
}
}
$exceptMatch = false;
foreach ($this->except as $pattern) {
if (StringHelper::matchWildcard($pattern, $id)) {
$exceptMatch = true;
break;
}
}
return !$exceptMatch && $onlyMatch;
}
定義場所: yii\filters\auth\AuthMethod::isOptional()
指定されたアクションに対して認証がオプションかどうかを確認します。
$optionalも参照してください。
protected boolean isOptional ( $action ) | ||
$action | yii\base\Action |
チェックするアクション。 |
return | boolean |
認証がオプションかどうか。 |
---|
protected function isOptional($action)
{
$id = $this->getActionId($action);
foreach ($this->optional as $pattern) {
if (StringHelper::matchWildcard($pattern, $id)) {
return true;
}
}
return false;
}
コメントするには、サインアップまたはログインしてください。