2 フォロワー

クラス yii\filters\auth\HttpHeaderAuth

すべてのクラス | プロパティ | メソッド
継承yii\filters\auth\HttpHeaderAuth » yii\filters\auth\AuthMethod » yii\base\ActionFilter » yii\base\Behavior » yii\base\BaseObject
実装yii\base\Configurable, yii\filters\auth\AuthInterface
サブクラスyii\filters\auth\HttpBearerAuth
利用可能なバージョン2.0.14
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/filters/auth/HttpHeaderAuth.php

HttpHeaderAuthは、HTTPヘッダーを通じてHTTP認証をサポートするアクションフィルターです。

次のように、コントローラーまたはモジュールにビヘイビアとしてアタッチすることでHttpHeaderAuthを使用できます。

public function behaviors()
{
    return [
        'basicAuth' => [
            'class' => \yii\filters\auth\HttpHeaderAuth::class,
        ],
    ];
}

HttpHeaderAuthのデフォルトの実装では、userアプリケーションコンポーネントのloginByAccessToken()メソッドを使用し、X-Api-Keyヘッダーの値を渡します。この実装は、APIクライアントの認証に使用されます。

公開プロパティ

継承されたプロパティを非表示

プロパティ 型 説明 定義元
$except array このフィルターを適用しないアクションIDのリスト。 yii\base\ActionFilter
$header string HTTPヘッダー名 yii\filters\auth\HttpHeaderAuth
$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\HttpHeaderAuth
$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

公開メソッド

継承されたメソッドを非表示

メソッド 説明 定義元
__call() クラスメソッドではない名前付きメソッドを呼び出します。 yii\base\BaseObject
__construct() コンストラクタ。 yii\base\BaseObject
__get() オブジェクトプロパティの値を返します。 yii\base\BaseObject
__isset() プロパティが設定されているか、つまり定義されており、nullでないかを確認します。 yii\base\BaseObject
__set() オブジェクトプロパティの値を設定します。 yii\base\BaseObject
__unset() オブジェクトプロパティをnullに設定します。 yii\base\BaseObject
afterAction() このメソッドは、アクションが実行された直後に呼び出されます。 yii\base\ActionFilter
afterFilter() yii\base\ActionFilter
attach() ビヘイビアオブジェクトをコンポーネントにアタッチします。 yii\base\ActionFilter
authenticate() 現在のユーザーを認証します。 yii\filters\auth\HttpHeaderAuth
beforeAction() このメソッドは、（可能なすべてのフィルターの後で）アクションが実行される直前に呼び出されます。このメソッドをオーバーライドして、アクションの直前準備を行うことができます。 yii\filters\auth\AuthMethod
beforeFilter() yii\base\ActionFilter
canGetProperty() プロパティが読み取り可能かどうかを示す値を返します。 yii\base\BaseObject
canSetProperty() プロパティが設定可能かどうかを示す値を返します。 yii\base\BaseObject
challenge() 認証失敗時にチャレンジを生成します。 yii\filters\auth\AuthMethod
className() このクラスの完全修飾名を返します。 yii\base\BaseObject
detach() ビヘイビアオブジェクトをコンポーネントからデタッチします。 yii\base\ActionFilter
events() $ownerのイベントのイベントハンドラーを宣言します。 yii\base\Behavior
handleFailure() 認証失敗を処理します。 yii\filters\auth\AuthMethod
hasMethod() メソッドが定義されているかどうかを示す値を返します。 yii\base\BaseObject
hasProperty() プロパティが定義されているかどうかを示す値を返します。 yii\base\BaseObject
init() オブジェクトを初期化します。 yii\base\BaseObject

保護メソッド

継承されたメソッドを非表示

メソッド 説明 定義元
getActionId() yii\base\Action::$uniqueIdをモジュールに対する相対IDに変換してアクションIDを返します。 yii\base\ActionFilter
isActive() 指定されたアクションに対してフィルターがアクティブかどうかを示す値を返します。 yii\base\ActionFilter
isOptional() 指定されたアクションに対して認証がオプションかどうかを確認します。 yii\filters\auth\AuthMethod

プロパティの詳細

継承されたプロパティを非表示

$header 公開プロパティ

HTTPヘッダー名

public string $header = 'X-Api-Key'
$pattern 公開プロパティ

HTTP認証値の抽出に使用するパターン

public string $pattern = null

メソッドの詳細

継承されたメソッドを非表示

__call() public メソッド

定義元: 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()");
}
__construct() public メソッド

定義元: 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();
}
__get() public メソッド

定義元: 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);
}
__isset() public メソッド

定義元: yii\base\BaseObject::__isset()

プロパティが設定されているか、つまり定義されており、nullでないかを確認します。

このメソッドは、isset($object->property)を実行したときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。

プロパティが定義されていない場合は、falseが返されることに注意してください。

参照: https://www.php.net/manual/en/function.isset.php。

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;
}
__set() public メソッド

定義元: 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);
    }
}
__unset() public メソッド

定義元: yii\base\BaseObject::__unset()

オブジェクトプロパティをnullに設定します。

このメソッドは、unset($object->property)を実行したときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。

プロパティが定義されていない場合、このメソッドは何もしないことに注意してください。プロパティが読み取り専用の場合、例外がスローされます。

参照: https://www.php.net/manual/en/function.unset.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);
    }
}
afterAction() public メソッド

定義元: yii\base\ActionFilter::afterAction()

このメソッドは、アクションが実行された直後に呼び出されます。

アクションの後処理を行うために、このメソッドをオーバーライドできます。

public mixed afterAction ( $action, $result )
$action yii\base\Action

実行されたばかりのアクション。
$result mixed

アクションの実行結果
return mixed

処理されたアクションの結果。

 

                public function afterAction($action, $result)
{
    return $result;
}
afterFilter() public メソッド

定義元: yii\base\ActionFilter::afterFilter()

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']);
}
attach() public メソッド

定義元: 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']);
}
authenticate() public メソッド

現在のユーザーを認証します。

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

認証されたユーザーの識別情報。認証情報が提供されていない場合は、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;
}
beforeAction() public メソッド

定義元: 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;
}
beforeFilter() public メソッド

定義元: yii\base\ActionFilter::beforeFilter()

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;
    }
}
canGetProperty() public メソッド

定義元: 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);
}
canSetProperty() public メソッド

定義元: 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);
}
challenge() public メソッド

定義元: yii\filters\auth\AuthMethod::challenge()

認証失敗時にチャレンジを生成します。

例えば、適切なHTTPヘッダーが生成されることがあります。

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

                public function challenge($response)
{
}
className() public static メソッド
2.0.14 以降非推奨。PHP 5.5 以上では、代わりに ::class を使用してください。

定義元: yii\base\BaseObject::className()

このクラスの完全修飾名を返します。

public static string className ( )
return string

このクラスの完全修飾名。

 

                public static function className()
{
    return get_called_class();
}
detach() public メソッド

定義元: 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;
    }
}
events() public メソッド

定義元: 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 [];
}
getActionId() protected メソッド (バージョン 2.0.7 から利用可能)

定義元: 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;
}
handleFailure() public メソッド

定義元: 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.');
}
hasMethod() public メソッド

定義元: 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);
}
hasProperty() public メソッド

定義元: 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);
}
init() public メソッド

定義元: yii\base\BaseObject::init()

オブジェクトを初期化します。

このメソッドは、オブジェクトが指定された構成で初期化された後、コンストラクターの最後に呼び出されます。

public void init ( )

                public function init()
{
}
isActive() protected メソッド

定義元: 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;
}
isOptional() protected メソッド (バージョン 2.0.7 以降)

定義元: 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;
}