0 フォロワー

クラス yii\filters\AccessRule

継承yii\filters\AccessRule » yii\base\Component » yii\base\BaseObject
実装yii\base\Configurable
利用可能なバージョン2.0
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/filters/AccessRule.php

このクラスは、yii\filters\AccessControlアクションフィルターによって定義されたアクセスルールを表します。

公開プロパティ

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

プロパティ タイプ 説明 定義元
$actions array|null このルールが適用されるアクションIDのリスト。 yii\filters\AccessRule
$allow boolean これが「許可」ルールか「拒否」ルールか。 yii\filters\AccessRule
$behaviors yii\base\Behavior[] このコンポーネントにアタッチされたビヘイビアのリスト。 yii\base\Component
$controllers array|null このルールが適用されるコントローラーIDのリスト。 yii\filters\AccessRule
$denyCallback callable|null このルールが現在のアクションへのアクセスを拒否する必要があると判断した場合に呼び出されるコールバック。 yii\filters\AccessRule
$ips array|null このルールが適用されるユーザーIPアドレスのリスト。 yii\filters\AccessRule
$matchCallback callable ルールを適用するかどうかを判断するために呼び出されるコールバック。 yii\filters\AccessRule
$permissions array|null このルールが適用されるRBAC(ロールベースアクセス制御)パーミッションのリスト。 yii\filters\AccessRule
$roleParams array|クロージャ $rolesでユーザーパーミッションを評価するために、yii\web\User::can()関数に渡すパラメーター。 yii\filters\AccessRule
$roles array|null このルールが適用されるロールのリスト(適切に構成されたUserコンポーネントが必要)。 yii\filters\AccessRule
$verbs array|null このルールが適用されるリクエストメソッド(例:GETPOST)のリスト。 yii\filters\AccessRule

公開メソッド

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

メソッド 説明 定義元
__call() クラスメソッドではない名前付きメソッドを呼び出します。 yii\base\Component
__clone() このメソッドは、既存のオブジェクトを複製してオブジェクトを作成した後に呼び出されます。 yii\base\Component
__construct() コンストラクター。 yii\base\BaseObject
__get() コンポーネントプロパティの値を返します。 yii\base\Component
__isset() プロパティが設定されている、つまり定義されていてnullではないかを確認します。 yii\base\Component
__set() コンポーネントプロパティの値を設定します。 yii\base\Component
__unset() コンポーネントプロパティをnullに設定します。 yii\base\Component
allows() Webユーザーが指定されたアクションを実行することが許可されているかどうかを確認します。 yii\filters\AccessRule
attachBehavior() このコンポーネントにビヘイビアをアタッチします。 yii\base\Component
attachBehaviors() コンポーネントにビヘイビアのリストをアタッチします。 yii\base\Component
behaviors() このコンポーネントが振る舞うべきビヘイビアのリストを返します。 yii\base\Component
canGetProperty() プロパティを読み取ることができるかどうかを示す値を返します。 yii\base\Component
canSetProperty() プロパティを設定できるかどうかを示す値を返します。 yii\base\Component
className() このクラスの完全修飾名を返します。 yii\base\BaseObject
detachBehavior() コンポーネントからビヘイビアをデタッチします。 yii\base\Component
detachBehaviors() コンポーネントからすべてのビヘイビアをデタッチします。 yii\base\Component
ensureBehaviors() behaviors()で宣言されたビヘイビアがこのコンポーネントにアタッチされていることを確認します。 yii\base\Component
getBehavior() 名前付きビヘイビアオブジェクトを返します。 yii\base\Component
getBehaviors() このコンポーネントにアタッチされたすべてのビヘイビアを返します。 yii\base\Component
hasEventHandlers() 指定されたイベントにハンドラーがアタッチされているかどうかを示す値を返します。 yii\base\Component
hasMethod() メソッドが定義されているかどうかを示す値を返します。 yii\base\Component
hasProperty() このコンポーネントにプロパティが定義されているかどうかを示す値を返します。 yii\base\Component
init() オブジェクトを初期化します。 yii\base\BaseObject
off() このコンポーネントから既存のイベントハンドラーをデタッチします。 yii\base\Component
on() イベントにイベントハンドラーをアタッチします。 yii\base\Component
trigger() イベントをトリガーします。 yii\base\Component

プロパティ詳細

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

$actions 公開プロパティ

このルールが適用されるアクションIDのリスト。比較は大文字と小文字を区別します。設定されていないか空の場合、このルールはすべてのアクションに適用されることを意味します。

public array|null $actions null
$allow 公開プロパティ

これが「許可」ルールか「拒否」ルールか。

public boolean $allow false
$controllers 公開プロパティ

このルールが適用されるコントローラーIDのリスト。

比較には、yii\base\Controller::$uniqueIdを使用するため、各コントローラーIDにはモジュールID(存在する場合)が接頭辞として付加されます。アプリケーションのproductコントローラーの場合、このプロパティを['product']のように指定し、そのコントローラーがshopモジュールにある場合は、['shop/product']になります。

比較は大文字と小文字を区別します。

設定されていないか空の場合、このルールはすべてのコントローラーに適用されることを意味します。

バージョン2.0.12以降、コントローラーIDはワイルドカードとして指定できます(例:module/*)。

public array|null $controllers null
$denyCallback public プロパティ

このルールが現在のアクションへのアクセスを拒否すべきだと判断した場合に呼び出されるコールバックです。これは、このルールが一致し、$allowfalse に設定されている場合に発生します。

設定されていない場合、動作は yii\filters\AccessControl によって決定され、yii\filters\AccessControl::denyAccess() または、設定されている場合は yii\filters\AccessControl::$denyCallback のいずれかを使用します。

コールバックのシグネチャは次のようになります。

function ($rule, $action)

ここで、$rule はこのルール、$action は現在の アクション オブジェクトです。

yii\filters\AccessControl::$denyCallback も参照してください。

public callable|null $denyCallback null
$ips public プロパティ

このルールが適用されるユーザーのIPアドレスのリストです。IPアドレスは、末尾にワイルドカード * を含めることができ、同じプレフィックスを持つIPアドレスと一致するようにできます。例えば、'192.168.*' は、セグメント '192.168.' のすべてのIPアドレスに一致します。また、RFC1918の20ビットプライベートネットワークブロックのすべてのIPに一致する '172.16.0.0/12' のようなパターン/マスクを含めることもできます。設定されていない場合、または空の場合、このルールはすべてのIPアドレスに適用されることを意味します。

参照

public array|null $ips null
$matchCallback public プロパティ

ルールを適用する必要があるかどうかを判断するために呼び出されるコールバックです。コールバックのシグネチャは次のようになります。

function ($rule, $action)

ここで、$rule はこのルール、$action は現在の アクション オブジェクトです。コールバックは、このルールを適用する必要があるかどうかを示すブール値を返す必要があります。

public callable $matchCallback null
$permissions public プロパティ (バージョン 2.0.12 以降利用可能)

このルールが適用されるRBAC(ロールベースアクセス制御)の権限のリストです。yii\web\User::can() がアクセスをチェックするために呼び出されます。

このプロパティが設定されていないか空の場合、このルールは権限に関係なく適用されることを意味します。

参照

public array|null $permissions null
$roleParams public プロパティ (バージョン 2.0.12 以降利用可能)

$rolesでユーザーパーミッションを評価するために、yii\web\User::can()関数に渡すパラメーター。

これが配列の場合、yii\web\User::can() に直接渡されます。例えば、現在のリクエストからIDを渡すには、次のように使用できます。

['postId' => Yii::$app->request->get('id')]

配列を返すクロージャを指定することもできます。これは、次のコードのようにモデルをロードする必要がある場合など、必要な場合にのみ配列値を評価するために使用できます。

'rules' => [
    [
        'allow' => true,
        'actions' => ['update'],
        'roles' => ['updatePost'],
        'roleParams' => function($rule) {
            return ['post' => Post::findOne(Yii::$app->request->get('id'))];
        },
    ],
],

yii\filters\AccessRule インスタンスへの参照が最初のパラメータとしてクロージャに渡されます。

$roles も参照してください。

$roles public プロパティ

このルールが適用されるロールのリストです(適切に設定されたUserコンポーネントが必要です)。2つの特別なロールが認識され、それらは yii\web\User::$isGuest を介してチェックされます。

  • ?: ゲストユーザー(まだ認証されていない)と一致します
  • @: 認証済みのユーザーと一致します

RBAC(ロールベースアクセス制御)を使用している場合は、ロール名を指定することもできます。この場合、yii\web\User::can() がアクセスをチェックするために呼び出されます。

権限をチェックすることが推奨されることに注意してください。

このプロパティが設定されていないか空の場合、このルールはロールに関係なく適用されることを意味します。

参照

public array|null $roles null
$verbs public プロパティ

このルールが適用されるリクエストメソッド(例:GETPOST)のリストです。設定されていないか空の場合、このルールはすべてのリクエストメソッドに適用されることを意味します。

yii\web\Request::$method も参照してください。

public array|null $verbs null

メソッドの詳細

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

__call() public メソッド

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

クラスメソッドではない名前付きメソッドを呼び出します。

このメソッドは、アタッチされた動作に指定された名前のメソッドがあるかどうかを確認し、利用可能な場合は実行します。

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

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

メソッド名

$params array

メソッドのパラメータ

return mixed

メソッドの戻り値

throws yii\base\UnknownMethodException

不明なメソッドを呼び出す場合

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() public メソッド

定義元: yii\base\Component::__clone()

このメソッドは、既存のオブジェクトを複製してオブジェクトを作成した後に呼び出されます。

古いオブジェクトにアタッチされているため、すべての動作を削除します。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__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\Component::__get()

コンポーネントプロパティの値を返します。

このメソッドは、次の順序でチェックを行い、それに応じて処理を行います。

  • ゲッターによって定義されたプロパティ: ゲッターの結果を返します
  • ビヘイビアのプロパティ: ビヘイビアのプロパティ値を返します

$value = $component->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)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (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\Component::__isset()

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

このメソッドは、次の順序でチェックを行い、それに応じて処理を行います。

  • セッターによって定義されたプロパティ: プロパティが設定されているかどうかを返します
  • ビヘイビアのプロパティ: プロパティが設定されているかどうかを返します
  • 存在しないプロパティの場合はfalseを返します

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

https://www.php.net/manual/en/function.isset.phpも参照してください。

public boolean __isset ( $name )
$name string

プロパティ名またはイベント名

return boolean

名前付きプロパティが設定されているかどうか

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() public メソッド

定義元: yii\base\Component::__set()

コンポーネントプロパティの値を設定します。

このメソッドは、次の順序でチェックを行い、それに応じて処理を行います。

  • セッターによって定義されたプロパティ: プロパティ値を設定します
  • "on xyz"の形式のイベント: イベント "xyz" にハンドラをアタッチします
  • "as xyz"の形式のビヘイビア: "xyz"という名前のビヘイビアをアタッチします
  • ビヘイビアのプロパティ: ビヘイビアのプロパティ値を設定します

$component->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)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() public メソッド

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

コンポーネントプロパティをnullに設定します。

このメソッドは、次の順序でチェックを行い、それに応じて処理を行います。

  • セッターによって定義されたプロパティ: プロパティ値をnullに設定します
  • ビヘイビアのプロパティ: プロパティ値をnullに設定します

unset($component->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);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
allows() public メソッド

Webユーザーが指定されたアクションを実行することが許可されているかどうかを確認します。

public boolean|null allows ( $action, $user, $request )
$action yii\base\Action

実行されるアクション

$user yii\web\User|false

ユーザーオブジェクト、または分離されたUserコンポーネントの場合はfalse

$request yii\web\Request
return boolean|null

ユーザーが許可されている場合はtrue、ユーザーが拒否されている場合はfalse、ルールがユーザーに適用されない場合はnull

                public function allows($action, $user, $request)
{
    if (
        $this->matchAction($action)
        && $this->matchRole($user)
        && $this->matchIP($request->getUserIP())
        && $this->matchVerb($request->getMethod())
        && $this->matchController($action->controller)
        && $this->matchCustom($action)
    ) {
        return $this->allow ? true : false;
    }
    return null;
}

            
attachBehavior() public メソッド

定義元: yii\base\Component::attachBehavior()

このコンポーネントにビヘイビアをアタッチします。

このメソッドは、指定された構成に基づいてビヘイビアオブジェクトを作成します。その後、yii\base\Behavior::attach()メソッドを呼び出すことによって、ビヘイビアオブジェクトがこのコンポーネントにアタッチされます。

detachBehavior()も参照してください。

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

ビヘイビアの名前。

$behavior string|array|yii\base\Behavior

ビヘイビアの構成。以下を指定できます

  • yii\base\Behaviorオブジェクト
  • ビヘイビアクラスを指定する文字列
  • Yii::createObject()に渡してビヘイビアオブジェクトを作成するオブジェクト構成配列。
return yii\base\Behavior

ビヘイビアオブジェクト

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public メソッド

定義元: yii\base\Component::attachBehaviors()

コンポーネントにビヘイビアのリストをアタッチします。

各ビヘイビアはその名前でインデックスが付けられており、yii\base\Behaviorオブジェクト、ビヘイビアクラスを指定する文字列、またはビヘイビアを作成するための構成配列である必要があります。

attachBehavior()も参照してください。

public void attachBehaviors ( $behaviors )
$behaviors array

コンポーネントにアタッチされるビヘイビアのリスト

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
behaviors() public メソッド

定義元: yii\base\Component::behaviors()

このコンポーネントが振る舞うべきビヘイビアのリストを返します。

子クラスは、このメソッドをオーバーライドして、それらがどのように動作するかを指定できます。

このメソッドの戻り値は、ビヘイビア名でインデックス付けされたビヘイビアオブジェクトまたは構成の配列である必要があります。ビヘイビア構成は、ビヘイビアクラスを指定する文字列、または次の構造の配列にすることができます。

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

ビヘイビアクラスはyii\base\Behaviorから拡張する必要があることに注意してください。ビヘイビアは、名前を使用するか、匿名でアタッチできます。名前が配列キーとして使用されている場合、この名前を使用して、後でgetBehavior()を使用してビヘイビアを取得したり、detachBehavior()を使用してデタッチしたりできます。匿名ビヘイビアは、取得またはデタッチできません。

このメソッドで宣言されたビヘイビアは、コンポーネントに自動的に(必要に応じて)アタッチされます。

public array behaviors ( )
return array

ビヘイビアの設定。

                public function behaviors()
{
    return [];
}

            
canGetProperty() public method

定義元: yii\base\Component::canGetProperty()

プロパティを読み取ることができるかどうかを示す値を返します。

プロパティは、以下の場合に読み取り可能です。

  • クラスが、指定された名前に関連付けられたgetterメソッドを持っている場合(この場合、プロパティ名は大文字小文字を区別しません)。
  • クラスが、指定された名前のメンバー変数を持っている場合($checkVars が true の場合)。
  • アタッチされたビヘイビアが、指定された名前の読み取り可能なプロパティを持っている場合($checkBehaviors が true の場合)。

参照: canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

プロパティ名

$checkVars boolean

メンバー変数をプロパティとして扱うかどうか

$checkBehaviors boolean

ビヘイビアのプロパティを、このコンポーネントのプロパティとして扱うかどうか

return boolean

プロパティが読み取り可能かどうか

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() public method

定義元: yii\base\Component::canSetProperty()

プロパティを設定できるかどうかを示す値を返します。

プロパティは、以下の場合に書き込み可能です。

  • クラスが、指定された名前に関連付けられたsetterメソッドを持っている場合(この場合、プロパティ名は大文字小文字を区別しません)。
  • クラスが、指定された名前のメンバー変数を持っている場合($checkVars が true の場合)。
  • アタッチされたビヘイビアが、指定された名前の書き込み可能なプロパティを持っている場合($checkBehaviors が true の場合)。

参照: canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

プロパティ名

$checkVars boolean

メンバー変数をプロパティとして扱うかどうか

$checkBehaviors boolean

ビヘイビアのプロパティを、このコンポーネントのプロパティとして扱うかどうか

return boolean

プロパティが書き込み可能かどうか

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() public static method
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();
}

            
detachBehavior() public method

定義元: yii\base\Component::detachBehavior()

コンポーネントからビヘイビアをデタッチします。

ビヘイビアの yii\base\Behavior::detach() メソッドが呼び出されます。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

ビヘイビアの名前。

return yii\base\Behavior|null

デタッチされたビヘイビア。ビヘイビアが存在しない場合は Null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public method

定義元: yii\base\Component::detachBehaviors()

コンポーネントからすべてのビヘイビアをデタッチします。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() public method

定義元: yii\base\Component::ensureBehaviors()

behaviors()で宣言されたビヘイビアがこのコンポーネントにアタッチされていることを確認します。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() public method

定義元: yii\base\Component::getBehavior()

名前付きビヘイビアオブジェクトを返します。

public yii\base\Behavior|null getBehavior ( $name )
$name string

ビヘイビア名

return yii\base\Behavior|null

ビヘイビアオブジェクト。ビヘイビアが存在しない場合は null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

定義元: yii\base\Component::getBehaviors()

このコンポーネントにアタッチされたすべてのビヘイビアを返します。

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

このコンポーネントにアタッチされたビヘイビアのリスト

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
hasEventHandlers() public method

定義元: yii\base\Component::hasEventHandlers()

指定されたイベントにハンドラーがアタッチされているかどうかを示す値を返します。

public boolean hasEventHandlers ( $name )
$name string

イベント名

return boolean

イベントにハンドラーがアタッチされているかどうか。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

定義元: yii\base\Component::hasMethod()

メソッドが定義されているかどうかを示す値を返します。

メソッドは、以下の場合に定義されています。

  • クラスが、指定された名前のメソッドを持っている場合。
  • アタッチされたビヘイビアが、指定された名前のメソッドを持っている場合($checkBehaviors が true の場合)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

プロパティ名

$checkBehaviors boolean

ビヘイビアのメソッドを、このコンポーネントのメソッドとして扱うかどうか

return boolean

メソッドが定義されているかどうか

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

定義元: yii\base\Component::hasProperty()

このコンポーネントにプロパティが定義されているかどうかを示す値を返します。

プロパティは、以下の場合に定義されています。

  • クラスが、指定された名前に関連付けられたgetterまたはsetterメソッドを持っている場合(この場合、プロパティ名は大文字小文字を区別しません)。
  • クラスが、指定された名前のメンバー変数を持っている場合($checkVars が true の場合)。
  • アタッチされたビヘイビアが、指定された名前のプロパティを持っている場合($checkBehaviors が true の場合)。

参照

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

プロパティ名

$checkVars boolean

メンバー変数をプロパティとして扱うかどうか

$checkBehaviors boolean

ビヘイビアのプロパティを、このコンポーネントのプロパティとして扱うかどうか

return boolean

プロパティが定義されているかどうか

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public メソッド

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

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

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

public void init ( )

                public function init()
{
}

            
matchAction() protected メソッド

protected boolean matchAction ( $action )
$action yii\base\Action

アクション

return boolean

ルールがアクションに適用されるかどうか

                protected function matchAction($action)
{
    return empty($this->actions) || in_array($action->id, $this->actions, true);
}

            
matchController() protected メソッド

protected boolean matchController ( $controller )
$controller yii\base\Controller

コントローラ

return boolean

ルールがコントローラに適用されるかどうか

                protected function matchController($controller)
{
    if (empty($this->controllers)) {
        return true;
    }
    $id = $controller->getUniqueId();
    foreach ($this->controllers as $pattern) {
        if (StringHelper::matchWildcard($pattern, $id)) {
            return true;
        }
    }
    return false;
}

            
matchCustom() protected メソッド

protected boolean matchCustom ( $action )
$action yii\base\Action

実行されるアクション

return boolean

ルールを適用する必要があるかどうか

                protected function matchCustom($action)
{
    return empty($this->matchCallback) || call_user_func($this->matchCallback, $this, $action);
}

            
matchIP() protected メソッド

protected boolean matchIP ( $ip )
$ip string|null

IPアドレス

return boolean

ルールがIPアドレスに適用されるかどうか

                protected function matchIP($ip)
{
    if (empty($this->ips)) {
        return true;
    }
    foreach ($this->ips as $rule) {
        if (
            $rule === '*'
            || $rule === $ip
            || (
                $ip !== null
                && ($pos = strpos($rule, '*')) !== false
                && strncmp($ip, $rule, $pos) === 0
            )
            || (
                strpos($rule, '/') !== false
                && IpHelper::inRange($ip, $rule) === true
            )
        ) {
            return true;
        }
    }
    return false;
}

            
matchRole() protected メソッド

protected boolean matchRole ( $user )
$user yii\web\User

ユーザーオブジェクト

return boolean

ルールがロールに適用されるかどうか

throws yii\base\InvalidConfigException

Userコンポーネントがデタッチされている場合

                protected function matchRole($user)
{
    $items = empty($this->roles) ? [] : $this->roles;
    if (!empty($this->permissions)) {
        $items = array_merge($items, $this->permissions);
    }
    if (empty($items)) {
        return true;
    }
    if ($user === false) {
        throw new InvalidConfigException('The user application component must be available to specify roles in AccessRule.');
    }
    foreach ($items as $item) {
        if ($item === '?') {
            if ($user->getIsGuest()) {
                return true;
            }
        } elseif ($item === '@') {
            if (!$user->getIsGuest()) {
                return true;
            }
        } else {
            if (!isset($roleParams)) {
                $roleParams = !is_array($this->roleParams) && is_callable($this->roleParams) ? call_user_func($this->roleParams, $this) : $this->roleParams;
            }
            if ($user->can($item, $roleParams)) {
                return true;
            }
        }
    }
    return false;
}

            
matchVerb() protected メソッド

protected boolean matchVerb ( $verb )
$verb string

リクエストメソッド。

return boolean

ルールがリクエストに適用されるかどうか

                protected function matchVerb($verb)
{
    return empty($this->verbs) || in_array(strtoupper($verb), array_map('strtoupper', $this->verbs), true);
}

            
off() public メソッド

定義元: yii\base\Component::off()

このコンポーネントから既存のイベントハンドラーをデタッチします。

このメソッドは、on() の反対です。

注意: イベント名にワイルドカードパターンが渡された場合、そのワイルドカードで登録されたハンドラのみが削除され、このワイルドカードに一致するプレーン名で登録されたハンドラは残ります。

on()も参照してください。

public boolean off ( $name, $handler null )
$name string

イベント名

$handler callable|null

削除するイベントハンドラ。nullの場合、名前付きイベントにアタッチされたすべてのハンドラが削除されます。

return boolean

ハンドラが見つかり、デタッチされた場合

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public メソッド

定義元: yii\base\Component::on()

イベントにイベントハンドラーをアタッチします。

イベントハンドラは、有効なPHPコールバックである必要があります。以下にいくつかの例を示します。

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

イベントハンドラは、次の署名で定義する必要があります。

function ($event)

ここで、$event は、イベントに関連付けられたパラメータを含むyii\base\Event オブジェクトです。

2.0.14以降、イベント名をワイルドカードパターンとして指定できます

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

off()も参照してください。

public void on ( $name, $handler, $data null, $append true )
$name string

イベント名

$handler callable

イベントハンドラ

$data mixed

イベントがトリガーされたときにイベントハンドラに渡されるデータ。イベントハンドラが呼び出されると、このデータは yii\base\Event::$data を介してアクセスできます。

$append boolean

既存のハンドラリストの最後に新しいイベントハンドラを追加するかどうか。falseの場合、新しいハンドラは既存のハンドラリストの先頭に挿入されます。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
trigger() public メソッド

定義元: yii\base\Component::trigger()

イベントをトリガーします。

このメソッドは、イベントの発生を表します。クラスレベルのハンドラを含む、イベントにアタッチされたすべてのハンドラを呼び出します。

public void trigger ( $name, yii\base\Event $event null )
$name string

イベント名

$event yii\base\Event|null

イベントインスタンス。設定しない場合は、デフォルトの yii\base\Event オブジェクトが作成されます。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}