1 フォロワー

クラス yii\filters\AccessControl

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

AccessControl は、一連のルールに基づいたシンプルなアクセス制御を提供します。

AccessControl はアクションフィルターです。現在のコンテキスト変数(ユーザーの IP アドレス、ユーザーロールなど)に一致する最初のルールを見つけるために、$rules を確認します。一致するルールによって、リクエストされたコントローラーアクションへのアクセスを許可するか拒否するかが決定されます。ルールが一致しない場合、アクセスは拒否されます。

AccessControl を使用するには、コントローラークラスの behaviors() メソッドで宣言します。たとえば、次の宣言では、認証済みのユーザーが「create」アクションと「update」アクションにアクセスすることを許可し、他のすべてのユーザーがこれらの 2 つのアクションにアクセスすることを拒否します。

public function behaviors()
{
    return [
        'access' => [
            'class' => \yii\filters\AccessControl::class,
            'only' => ['create', 'update'],
            'rules' => [
                // deny all POST requests
                [
                    'allow' => false,
                    'verbs' => ['POST']
                ],
                // allow authenticated users
                [
                    'allow' => true,
                    'roles' => ['@'],
                ],
                // everything else is denied
            ],
        ],
    ];
}

パブリックプロパティ

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

プロパティ 説明 定義元
$denyCallback callable|null 現在のユーザーへのアクセスを拒否する必要がある場合に呼び出されるコールバック。 yii\filters\AccessControl
$except array このフィルターを適用しないアクション ID のリスト。 yii\base\ActionFilter
$only array このフィルターを適用する必要があるアクション ID のリスト。 yii\base\ActionFilter
$owner yii\base\Component|null このビヘイビアのオーナー yii\base\Behavior
$ruleConfig array アクセスルールのデフォルト構成。 yii\filters\AccessControl
$rules array アクセスルールオブジェクトのリスト、またはルールオブジェクトを作成するための構成配列。 yii\filters\AccessControl
$user yii\web\User|array|string|false 認証ステータスを表すユーザーオブジェクト、またはユーザーアプリケーションコンポーネントの ID。 yii\filters\AccessControl

パブリックメソッド

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

メソッド 説明 定義元
__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
beforeAction() このメソッドは、アクションが実行される直前(すべての可能なフィルターの後)に呼び出されます。アクションの直前の準備のために、このメソッドをオーバーライドできます。 yii\filters\AccessControl
beforeFilter() yii\base\ActionFilter
canGetProperty() プロパティを読み取ることができるかどうかを示す値を返します。 yii\base\BaseObject
canSetProperty() プロパティを設定できるかどうかを示す値を返します。 yii\base\BaseObject
className() このクラスの完全修飾名を返します。 yii\base\BaseObject
detach() ビヘイビアオブジェクトをコンポーネントからデタッチします。 yii\base\ActionFilter
events() $owner のイベントのイベントハンドラーを宣言します。 yii\base\Behavior
hasMethod() メソッドが定義されているかどうかを示す値を返します。 yii\base\BaseObject
hasProperty() プロパティが定義されているかどうかを示す値を返します。 yii\base\BaseObject
init() 構成からルールオブジェクトをインスタンス化することにより、$rules 配列を初期化します。 yii\filters\AccessControl

保護されたメソッド

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

メソッド 説明 定義元
denyAccess() ユーザーのアクセスを拒否します。 yii\filters\AccessControl
getActionId() yii\base\Action::$uniqueId をモジュールに対する相対 ID に変換して、アクション ID を返します。 yii\base\ActionFilter
isActive() フィルターが指定されたアクションに対してアクティブかどうかを示す値を返します。 yii\base\ActionFilter

プロパティの詳細

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

$denyCallback パブリックプロパティ

現在のユーザーへのアクセスを拒否する必要がある場合に呼び出されるコールバック。これは、ルールが一致しない場合、または $allowfalse に設定されたルールが一致する場合に発生します。設定されていない場合、denyAccess() が呼び出されます。

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

function ($rule, $action)

ここで、$rule はユーザーを拒否するルールであり、$action は現在の アクション オブジェクトです。アクセスが拒否された理由がどのルールにも一致しなかった場合、$rulenull になります。

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

アクセスルールのデフォルト設定。 $rules を介して指定された個々のルール設定は、ルールの同じプロパティが設定されている場合、優先されます。

public array $ruleConfig = [
    
'class' => 'yii\filters\AccessRule',
]
$rules public プロパティ

アクセスルールオブジェクト、またはルールオブジェクトを作成するための設定配列のリスト。ルールが設定配列で指定されている場合、ルールオブジェクトの作成に使用する前に、最初に $ruleConfig とマージされます。

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

public array $rules = []
$user public プロパティ

認証ステータスを表すユーザーオブジェクト、またはユーザーアプリケーションコンポーネントのID。バージョン2.0.2以降、オブジェクトを作成するための設定配列にすることもできます。バージョン2.0.12以降では、フィルターのこのコンポーネントサポートを明示的にオフにするために、false に設定できます。

メソッド詳細

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

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

            
beforeAction() public メソッド

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

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

実行されるアクション。

return boolean

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

                public function beforeAction($action)
{
    $user = $this->user;
    $request = Yii::$app->getRequest();
    /* @var $rule AccessRule */
    foreach ($this->rules as $rule) {
        if ($allow = $rule->allows($action, $user, $request)) {
            return true;
        } elseif ($allow === false) {
            if (isset($rule->denyCallback)) {
                call_user_func($rule->denyCallback, $rule, $action);
            } elseif ($this->denyCallback !== null) {
                call_user_func($this->denyCallback, $rule, $action);
            } else {
                $this->denyAccess($user);
            }
            return false;
        }
    }
    if ($this->denyCallback !== null) {
        call_user_func($this->denyCallback, null, $action);
    } else {
        $this->denyAccess($user);
    }
    return false;
}

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

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

            
denyAccess() protected メソッド

ユーザーのアクセスを拒否します。

デフォルトの実装では、ユーザーがゲストである場合はログインページにリダイレクトし、ユーザーがすでにログインしている場合は、403 HTTP例外がスローされます。

protected void denyAccess ( $user )
$user yii\web\User|false

現在のユーザー、またはデタッチされたUserコンポーネントの場合はブール値の false

throws yii\web\ForbiddenHttpException

ユーザーがすでにログインしている場合、またはデタッチされたUserコンポーネントの場合。

                protected function denyAccess($user)
{
    if ($user !== false && $user->getIsGuest()) {
        $user->loginRequired();
    } else {
        throw new ForbiddenHttpException(Yii::t('yii', 'You are not allowed to perform this action.'));
    }
}

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

            
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()

プロパティが定義されているかどうかを示す値を返します。

プロパティが定義されているのは、次の場合です。

  • クラスが、指定された名前に関連付けられたゲッターまたはセッターメソッドを持っている場合(この場合、プロパティ名はcase-insensitiveです)。
  • クラスが、指定された名前のメンバー変数を持っている場合($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 メソッド

構成からルールオブジェクトをインスタンス化することにより、$rules 配列を初期化します。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->user !== false) {
        $this->user = Instance::ensure($this->user, User::className());
    }
    foreach ($this->rules as $i => $rule) {
        if (is_array($rule)) {
            $this->rules[$i] = Yii::createObject(array_merge($this->ruleConfig, $rule));
        }
    }
}

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