0 フォロワー

クラス yii\base\Component

すべてのクラス | プロパティ | メソッド
継承yii\base\Component » yii\base\BaseObject
実装yii\base\Configurable
サブクラスyii\base\Action、yii\base\Application、yii\base\Controller、yii\base\DynamicModel、yii\base\ErrorHandler、yii\base\InlineAction、yii\base\Model、yii\base\Module、yii\base\Request、yii\base\Response、yii\base\Security、yii\base\Theme、yii\base\View、yii\base\ViewRenderer、yii\base\Widget、yii\caching\ApcCache、yii\caching\ArrayCache、yii\caching\Cache、yii\caching\DbCache、yii\caching\DummyCache、yii\caching\FileCache、yii\caching\MemCache、yii\caching\WinCache、yii\caching\XCache、yii\caching\ZendDataCache、yii\captcha\Captcha、yii\captcha\CaptchaAction、yii\captcha\CaptchaValidator、yii\console\Application、yii\console\Controller、yii\console\ErrorHandler、yii\console\Request、yii\console\Response、yii\console\controllers\AssetController、yii\console\controllers\BaseMigrateController、yii\console\controllers\CacheController、yii\console\controllers\FixtureController、yii\console\controllers\HelpController、yii\console\controllers\MessageController、yii\console\controllers\MigrateController、yii\console\controllers\ServeController、yii\console\widgets\Table、yii\data\ActiveDataFilter、yii\data\ActiveDataProvider、yii\data\ArrayDataProvider、yii\data\BaseDataProvider、yii\data\DataFilter、yii\data\SqlDataProvider、yii\db\ActiveQuery、yii\db\ActiveRecord、yii\db\BaseActiveRecord、yii\db\BatchQueryResult、yii\db\Command、yii\db\Connection、yii\db\Migration、yii\db\Query、yii\db\SqlTokenizer、yii\db\oci\Command、yii\db\sqlite\Command、yii\db\sqlite\SqlTokenizer、yii\di\Container、yii\di\ServiceLocator、yii\filters\AccessRule、yii\grid\GridView、yii\i18n\DbMessageSource、yii\i18n\Formatter、yii\i18n\GettextFile、yii\i18n\GettextMessageSource、yii\i18n\GettextMoFile、yii\i18n\GettextPoFile、yii\i18n\I18N、yii\i18n\Locale、yii\i18n\MessageFormatter、yii\i18n\MessageSource、yii\i18n\PhpMessageSource、yii\log\DbTarget、yii\log\Dispatcher、yii\log\EmailTarget、yii\log\FileTarget、yii\log\Logger、yii\log\SyslogTarget、yii\log\Target、yii\mail\BaseMailer、yii\mutex\DbMutex、yii\mutex\FileMutex、yii\mutex\Mutex、yii\mutex\MysqlMutex、yii\mutex\OracleMutex、yii\mutex\PgsqlMutex、yii\rbac\BaseManager、yii\rbac\DbManager、yii\rbac\PhpManager、yii\rest\Action、yii\rest\ActiveController、yii\rest\Controller、yii\rest\CreateAction、yii\rest\DeleteAction、yii\rest\IndexAction、yii\rest\OptionsAction、yii\rest\Serializer、yii\rest\UpdateAction、yii\rest\ViewAction、yii\test\ActiveFixture、yii\test\ArrayFixture、yii\test\BaseActiveFixture、yii\test\DbFixture、yii\test\Fixture、yii\test\InitDbFixture、yii\validators\BooleanValidator、yii\validators\CompareValidator、yii\validators\DateValidator、yii\validators\DefaultValueValidator、yii\validators\EachValidator、yii\validators\EmailValidator、yii\validators\ExistValidator、yii\validators\FileValidator、yii\validators\FilterValidator、yii\validators\ImageValidator、yii\validators\InlineValidator、yii\validators\IpValidator、yii\validators\NumberValidator、yii\validators\RangeValidator、yii\validators\RegularExpressionValidator、yii\validators\RequiredValidator、yii\validators\SafeValidator、yii\validators\StringValidator、yii\validators\TrimValidator、yii\validators\UniqueValidator、yii\validators\UrlValidator、yii\validators\Validator、yii\web\Application、yii\web\AssetConverter、yii\web\AssetManager、yii\web\CacheSession、yii\web\Controller、yii\web\DbSession、yii\web\ErrorAction、yii\web\ErrorHandler、yii\web\HtmlResponseFormatter、yii\web\JsonResponseFormatter、yii\web\MultiFieldSession、yii\web\Request、yii\web\Response、yii\web\Session、yii\web\UrlManager、yii\web\User、yii\web\View、yii\web\ViewAction、yii\web\XmlResponseFormatter、yii\widgets\ActiveField、yii\widgets\ActiveForm、yii\widgets\BaseListView、yii\widgets\Block、yii\widgets\Breadcrumbs、yii\widgets\ContentDecorator、yii\widgets\DetailView、yii\widgets\FragmentCache、yii\widgets\InputWidget、yii\widgets\LinkPager、yii\widgets\LinkSorter、yii\widgets\ListView、yii\widgets\MaskedInput、yii\widgets\Menu、yii\widgets\Pjax、yii\widgets\Spaceless
対応バージョン2.0
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/base/Component.php

Componentは、プロパティ、イベント、ビヘイビア機能を実装する基底クラスです。

Componentは、親クラスであるBaseObjectで実装されているプロパティ機能に加え、イベントとビヘイビア機能を提供します。

イベントは、特定の箇所にカスタムコードを「注入」するための方法です。例えば、コメントオブジェクトは、ユーザーがコメントを追加したときに「add」イベントをトリガーできます。カスタムコードを作成し、このイベントにアタッチすることで、イベントがトリガーされたとき（つまり、コメントが追加されるとき）、カスタムコードが実行されます。

イベントは、定義されているクラス内で一意である必要がある名前で識別されます。イベント名は大文字と小文字が区別されます。

1つまたは複数のPHPコールバック（イベントハンドラーと呼ばれる）をイベントにアタッチできます。trigger()を呼び出してイベントを発生させることができます。イベントが発生すると、イベントハンドラーはアタッチされた順に自動的に呼び出されます。

イベントハンドラーをイベントにアタッチするには、on()を呼び出します。

$post->on('update', function ($event) {
    // send email notification
});

上記では、匿名関数が投稿の「update」イベントにアタッチされています。以下のタイプのイベントハンドラーをアタッチできます。

  • 匿名関数: function ($event) { ... }
  • オブジェクトメソッド: [$object, 'handleAdd']
  • 静的クラスメソッド: ['Page', 'handleAdd']
  • グローバル関数: 'handleAdd'

イベントハンドラーのシグネチャは以下のようになります。

function foo($event)

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

コンポーネントを構成する設定配列を使用して、イベントにハンドラーをアタッチすることもできます。構文は以下のようになります。

[
    'on add' => function ($event) { ... }
]

ここで、on addはaddイベントにイベントをアタッチすることを意味します。

イベントにアタッチするときに、イベントハンドラーに追加のデータを関連付け、ハンドラーが呼び出されたときにアクセスしたい場合があります。以下のように行うことができます。

$post->on('update', function ($event) {
    // the data can be accessed via $event->data
}, $data);

ビヘイビアは、yii\base\Behaviorまたはその子クラスのインスタンスです。コンポーネントには、1つまたは複数のビヘイビアをアタッチできます。ビヘイビアがコンポーネントにアタッチされると、その公開プロパティとメソッドは、コンポーネントがそれらのプロパティとメソッドを所有しているかのように、コンポーネントを介して直接アクセスできます。

ビヘイビアをコンポーネントにアタッチするには、behaviors()で宣言するか、attachBehavior()を明示的に呼び出します。behaviors()で宣言されたビヘイビアは、対応するコンポーネントに自動的にアタッチされます。

設定配列を使用してコンポーネントを構成するときにも、ビヘイビアをコンポーネントにアタッチできます。構文は以下のようになります。

[
    'as tree' => [
        'class' => 'Tree',
    ],
]

ここで、as treeはtreeという名前のビヘイビアをアタッチすることを意味し、配列はYii::createObject()に渡され、ビヘイビアオブジェクトが作成されます。

Componentの詳細と使用方法については、コンポーネントに関するガイド記事を参照してください。

公開プロパティ

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

プロパティ 型 説明 定義元
$behaviors yii\base\Behavior[] このコンポーネントにアタッチされているビヘイビアのリスト。 yii\base\Component

公開メソッド

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

メソッド 説明 定義元
__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
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

プロパティの詳細

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

$behaviors public property

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

public yii\base\Behavior[] $behaviors = null

メソッドの詳細

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

__call() public method

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

このメソッドは、アタッチされたビヘイビアに名前付きメソッドが存在するかどうかをチェックし、存在する場合は実行します。

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

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

メソッド名
$params array

メソッドパラメータ
戻り値 mixed

メソッドの戻り値
例外 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 method

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

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

public void __clone ( )

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

定義されている場所: 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 method

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

このメソッドは、以下の順序でチェックし、それに応じて動作します。

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

これはPHPのマジックメソッドであり、`$value = $component->property;` を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。

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

public mixed __get ( $name )
$name string

プロパティ名
戻り値 mixed

プロパティ値またはビヘイビアのプロパティの値
例外 yii\base\UnknownPropertyException

プロパティが定義されていない場合
例外 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 method

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

このメソッドは、以下の順序でチェックし、それに応じて動作します。

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

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

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

public boolean __isset ( $name )
$name string

プロパティ名またはイベント名
戻り値 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 method

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

このメソッドは、以下の順序でチェックし、それに応じて動作します。

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

これはPHPのマジックメソッドであり、`$component->property = $value;` を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。

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

public void __set ( $name, $value )
$name string

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

プロパティ値
例外 yii\base\UnknownPropertyException

プロパティが定義されていない場合
例外 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 method

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

このメソッドは、以下の順序でチェックし、それに応じて動作します。

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

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

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

public void __unset ( $name )
$name string

プロパティ名
例外 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);
}
attachBehavior() public method

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

このメソッドは、指定された設定に基づいてビヘイビアオブジェクトを作成します。その後、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()に渡されるオブジェクト設定配列。
戻り値 yii\base\Behavior

ビヘイビアオブジェクト

 

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}
attachBehaviors() publicメソッド

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

各ビヘイビアは、その名前でインデックス付けされ、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メソッド

このコンポーネントが動作するビヘイビアのリストを返します。

子クラスはこのメソッドをオーバーライドして、振る舞わせたいビヘイビアを指定できます。

このメソッドの戻り値は、ビヘイビア名でインデックス付けされたビヘイビアオブジェクトまたはコンフィグレーションの配列である必要があります。ビヘイビアコンフィグレーションは、ビヘイビアクラスを指定する文字列、または以下の構造の配列のいずれかです。

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

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

このメソッドで宣言されたビヘイビアは、コンポーネントに自動的に（オンデマンドで）アタッチされます。

public array behaviors ( )
戻り値 array

ビヘイビアコンフィグレーション。

 

                public function behaviors()
{
    return [];
}
canGetProperty() publicメソッド

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

プロパティは、以下の場合に読み取ることができます。

  • クラスに指定された名前と関連付けられたゲッターメソッドがある場合（この場合、プロパティ名はケースインセンシティブです）。
  • クラスに指定された名前のメンバ変数がある場合（$checkVarsがtrueの場合）。
  • アタッチされたビヘイビアに、指定された名前の読み取り可能なプロパティがある場合（$checkBehaviorsがtrueの場合）。

こちらも参照してください canSetProperty()。

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

プロパティ名
$checkVars boolean

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

ビヘイビアのプロパティをこのコンポーネントのプロパティとして扱うかどうか
戻り値 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メソッド

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

プロパティは、以下の場合に書き込むことができます。

  • クラスに指定された名前と関連付けられたセッターメソッドがある場合（この場合、プロパティ名はケースインセンシティブです）。
  • クラスに指定された名前のメンバ変数がある場合（$checkVarsがtrueの場合）。
  • アタッチされたビヘイビアに、指定された名前の書き込み可能なプロパティがある場合（$checkBehaviorsがtrueの場合）。

こちらも参照してください canGetProperty()。

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

プロパティ名
$checkVars boolean

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

ビヘイビアのプロパティをこのコンポーネントのプロパティとして扱うかどうか
戻り値 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メソッド
2.0.14から非推奨。PHP >= 5.5では、代わりに::classを使用してください。

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

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

public static string className ( )
戻り値 string

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

 

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

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

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

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

ビヘイビアの名前。
戻り値 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メソッド

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

public void detachBehaviors ( )

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

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メソッド

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

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

ビヘイビア名
戻り値 yii\base\Behavior|null

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

 

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

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

public yii\base\Behavior[] getBehaviors ( )
戻り値 yii\base\Behavior[]

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

 

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}
hasEventHandlers() publicメソッド

名前付きイベントにハンドラがアタッチされているかどうかを示す値を返します。

public boolean hasEventHandlers ( $name )
$name string

イベント名
戻り値 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メソッド

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

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

  • クラスに指定された名前のメソッドがある場合。
  • アタッチされたビヘイビアに、指定された名前のメソッドがある場合（$checkBehaviorsがtrueの場合）。
public boolean hasMethod ( $name, $checkBehaviors = true )
$name string

プロパティ名
$checkBehaviors boolean

ビヘイビアのメソッドをこのコンポーネントのメソッドとして扱うかどうか
戻り値 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 メソッド

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

プロパティが定義されている場合

  • クラスに、指定された名前と関連付けられたゲッターまたはセッターメソッドがある場合（この場合、プロパティ名はケースインセンシティブです）。
  • クラスに指定された名前のメンバ変数がある場合（$checkVarsがtrueの場合）。
  • アタッチされたビヘイビアに、指定された名前のプロパティがある場合（$checkBehaviorsがtrueの場合）。

参照

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

プロパティ名
$checkVars boolean

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

ビヘイビアのプロパティをこのコンポーネントのプロパティとして扱うかどうか
戻り値 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()
{
}
off() public メソッド

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

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

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

参照 on().

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

イベント名
$handler callable|null

削除するイベントハンドラ。nullの場合、指定されたイベントにアタッチされたすべてのハンドラが削除されます。
戻り値 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 メソッド

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

イベントハンドラは有効な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 メソッド

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

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

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