0 フォロワー

クラス yii\rbac\Item

継承	yii\rbac\Item » yii\base\BaseObject
実装	yii\base\Configurable
サブクラス	yii\rbac\Permission, yii\rbac\Role
利用可能なバージョン	2.0
ソースコード	https://github.com/yiisoft/yii2/blob/master/framework/rbac/Item.php

Item の詳細と使用法については、セキュリティ認証に関するガイド記事をご覧ください。

公開プロパティ

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

プロパティ	型	説明	定義元
$createdAt	integer	アイテムの作成時刻を表す UNIX タイムスタンプ	yii\rbac\Item
$data	mixed	このアイテムに関連付けられた追加データ	yii\rbac\Item
$description	string	アイテムの説明	yii\rbac\Item
$name	string	アイテムの名前。これはグローバルに一意である必要があります。	yii\rbac\Item
$ruleName	string	このアイテムに関連付けられたルールの名前	yii\rbac\Item
$type	integer	アイテムの種類。	yii\rbac\Item
$updatedAt	integer	アイテムの更新時刻を表す UNIX タイムスタンプ	yii\rbac\Item

公開メソッド

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

メソッド	説明	定義元
__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
canGetProperty()	プロパティが読み取り可能かどうかを示す値を返します。	yii\base\BaseObject
canSetProperty()	プロパティを設定できるかどうかを示す値を返します。	yii\base\BaseObject
className()	このクラスの完全修飾名を返します。	yii\base\BaseObject
hasMethod()	メソッドが定義されているかどうかを示す値を返します。	yii\base\BaseObject
hasProperty()	プロパティが定義されているかどうかを示す値を返します。	yii\base\BaseObject
init()	オブジェクトを初期化します。	yii\base\BaseObject

定数

継承された定数を隠す

定数	値	説明	定義元
TYPE_PERMISSION	2		yii\rbac\Item
TYPE_ROLE	1		yii\rbac\Item

プロパティの詳細

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

$createdAt public property

アイテムの作成時刻を表す UNIX タイムスタンプ

public integer $createdAt = null

$data public property

このアイテムに関連付けられた追加データ

public mixed $data = null

$description public property

アイテムの説明

public string $description = null

$name public property

アイテムの名前。これはグローバルに一意である必要があります。

public string $name = null

$ruleName public property

このアイテムに関連付けられたルールの名前

public string $ruleName = null

$type public プロパティ

アイテムのタイプ。これはTYPE_ROLEまたはTYPE_PERMISSIONのいずれかである必要があります。

public integer $type = null

$updatedAt public プロパティ

アイテムの更新時刻を表す UNIX タイムスタンプ

public integer $updatedAt = 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);
    }
}

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

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

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