0 フォロワー

クラス yii\filters\auth\CompositeAuth

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

CompositeAuthは、複数の認証方法を同時にサポートするアクションフィルタです。

CompositeAuthに含まれる認証方法は、$authMethodsで設定され、これはサポートされている認証クラス設定のリストです。

次の例は、3つの認証方法をサポートする方法を示しています。

public function behaviors()
{
    return [
        'compositeAuth' => [
            'class' => \yii\filters\auth\CompositeAuth::class,
            'authMethods' => [
                \yii\filters\auth\HttpBasicAuth::class,
                \yii\filters\auth\QueryParamAuth::class,
            ],
        ],
    ];
}

パブリックプロパティ

継承されたプロパティを隠す

プロパティ タイプ 説明 定義元
$authMethods 配列 サポートされている認証方法。 yii\filters\auth\CompositeAuth
$except 配列 このフィルタを適用しないアクションIDのリスト。 yii\base\ActionFilter
$only 配列 このフィルタを適用するアクションIDのリスト。 yii\base\ActionFilter
$optional 配列 このフィルタが適用されるアクションIDのリストですが、認証の失敗はエラーにはつながりません。 yii\filters\auth\AuthMethod
$owner yii\base\Component|null このビヘイビアのオーナー yii\base\Behavior
$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\CompositeAuth
beforeAction() このメソッドは、アクションが実行される直前（可能なすべてのフィルタの後）に呼び出されます。このメソッドをオーバーライドして、アクションの直前の準備を行うことができます。 yii\filters\auth\CompositeAuth
beforeFilter() yii\base\ActionFilter
canGetProperty() プロパティが読み取り可能かどうかを示す値を返します。 yii\base\BaseObject
canSetProperty() プロパティが設定可能かどうかを示す値を返します。 yii\base\BaseObject
challenge() 認証失敗時にチャレンジを生成します。 yii\filters\auth\CompositeAuth
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

プロパティの詳細

継承されたプロパティを隠す

$authMethods public プロパティ

サポートされている認証メソッド。このプロパティは、サポートされている認証メソッドのリストを受け取る必要があります。各メソッドは認証クラスまたは構成によって表されます。

このプロパティが空の場合、認証は実行されません。

認証メソッドのクラスは、yii\filters\auth\AuthInterfaceインターフェースを実装する必要があります。

public array $authMethods = []

メソッドの詳細

継承されたメソッドを隠す

__call() public メソッド

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

クラスメソッドではない指定された名前のメソッドを呼び出します。

不明なメソッドが呼び出されるときに暗黙的に呼び出されるPHPのマジックメソッドであるため、このメソッドを直接呼び出さないでください。

public mixed __call ( $name, $params )
$name string

メソッド名
$params 配列

メソッドのパラメータ
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 配列

オブジェクトのプロパティを初期化するために使用される名前と値のペア

 

                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

認証されたユーザーID。認証情報が提供されない場合は、nullが返されます。
throws yii\web\UnauthorizedHttpException

認証情報が提供されているが無効な場合。

 

                public function authenticate($user, $request, $response)
{
    foreach ($this->authMethods as $i => $auth) {
        if (!$auth instanceof AuthInterface) {
            $this->authMethods[$i] = $auth = Yii::createObject($auth);
            if (!$auth instanceof AuthInterface) {
                throw new InvalidConfigException(get_class($auth) . ' must implement yii\filters\auth\AuthInterface');
            }
        }
        if (
            $this->owner instanceof Controller
            && (
                !isset($this->owner->action)
                || (
                    $auth instanceof ActionFilter
                    && !$auth->isActive($this->owner->action)
                )
            )
        ) {
            continue;
        }
        $identity = $auth->authenticate($user, $request, $response);
        if ($identity !== null) {
            return $identity;
        }
    }
    return null;
}
beforeAction() public メソッド

このメソッドは、アクションが実行される直前（可能なすべてのフィルタの後）に呼び出されます。このメソッドをオーバーライドして、アクションの直前の準備を行うことができます。

public boolean beforeAction ( $action )
$action yii\base\Action

実行されるアクション。
return boolean

アクションが実行を継続すべきかどうか。

 

                public function beforeAction($action)
{
    return empty($this->authMethods) ? true : parent::beforeAction($action);
}
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()

プロパティが読み取り可能かどうかを示す値を返します。

プロパティが読み取り可能になるのは、

  • クラスが指定された名前に関連付けられたgetterメソッドを持っている場合（この場合、プロパティ名は大文字と小文字を区別しません）。
  • クラスが指定された名前のメンバー変数を持っている場合（$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()

プロパティが設定可能かどうかを示す値を返します。

プロパティが書き込み可能になるのは、

  • クラスが指定された名前に関連付けられたsetterメソッドを持っている場合（この場合、プロパティ名は大文字と小文字を区別しません）。
  • クラスが指定された名前のメンバー変数を持っている場合（$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 メソッド

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

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

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

                public function challenge($response)
{
    foreach ($this->authMethods as $method) {
        /** @var AuthInterface $method */
        $method->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 配列

イベント（配列キー）と、対応するイベントハンドラーメソッド（配列値）。

 

                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;
}