0 フォロワー

クラス yii\web\UserEvent

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

このイベントクラスは、yii\web\Userクラスによってトリガーされるイベントに使用されます。

公開プロパティ

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

プロパティ 型 説明 定義元
$cookieBased boolean ログインがCookieベースかどうか。 yii\web\UserEvent
$data mixed イベントハンドラの添付時にyii\base\Component::on()に渡されるデータ。 yii\base\Event
$duration integer ユーザーがログイン状態を維持できる秒数。 yii\web\UserEvent
$handled boolean イベントが処理されたかどうか。 yii\base\Event
$identity yii\web\IdentityInterface このイベントに関連付けられたIDオブジェクト。 yii\web\UserEvent
$isValid boolean ログインまたはログアウトを続行するかどうか。 yii\web\UserEvent
$name string イベント名。 yii\base\Event
$sender object|null このイベントの送信元。 yii\base\Event

公開メソッド

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

メソッド 説明 定義元
__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
hasHandlers() 指定されたクラスレベルのイベントに添付されたハンドラがあるかどうかを示す値を返します。 yii\base\Event
hasMethod() メソッドが定義されているかどうかを示す値を返します。 yii\base\BaseObject
hasProperty() プロパティが定義されているかどうかを示す値を返します。 yii\base\BaseObject
init() オブジェクトを初期化します。 yii\base\BaseObject
off() クラスレベルのイベントからイベントハンドラをデタッチします。 yii\base\Event
offAll() 登録されているすべてのクラスレベルのイベントハンドラをデタッチします。 yii\base\Event
on() クラスレベルのイベントにイベントハンドラをアタッチします。 yii\base\Event
trigger() クラスレベルのイベントをトリガーします。 yii\base\Event

プロパティの詳細

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

$cookieBased public property

ログインがCookieベースかどうか。このプロパティは、yii\web\User::EVENT_BEFORE_LOGINとyii\web\User::EVENT_AFTER_LOGINイベントに対してのみ意味を持ちます。

public boolean $cookieBased = null
$duration public property

ユーザーがログイン状態を維持できる秒数。0の場合は、ユーザーがブラウザを閉じたり、セッションを手動で破棄するまでログインすることを意味します。

public integer $duration = null
$identity public property

このイベントに関連付けられたIDオブジェクト。

public yii\web\IdentityInterface $identity = null
$isValid public property

ログインまたはログアウトを続行するかどうか。イベントハンドラは、このプロパティを変更して、ログインまたはログアウトを続行するかどうかを決定できます。このプロパティは、yii\web\User::EVENT_BEFORE_LOGINとyii\web\User::EVENT_BEFORE_LOGOUTイベントに対してのみ意味を持ちます。

public boolean $isValid = true

メソッドの詳細

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

__call() public method

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

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

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

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

メソッド名
$params array

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

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

プロパティ名
戻り値 mixed

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

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

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

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

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

プロパティ名
例外 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()

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

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

  • クラスに、指定された名前（この場合、プロパティ名は大文字小文字を区別しません）に関連付けられたゲッターメソッドがある場合。
  • クラスに、指定された名前のメンバ変数がある場合（$checkVarsがtrueの場合）。

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

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

プロパティ名
$checkVars boolean

メンバ変数をプロパティとして扱うかどうか
戻り値 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

メンバ変数をプロパティとして扱うかどうか
戻り値 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 ( )
戻り値 string

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

 

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

定義場所: yii\base\Event::hasHandlers()

指定されたクラスレベルのイベントに添付されたハンドラがあるかどうかを示す値を返します。

このメソッドは、すべての親クラスも調べて、指定されたイベントにハンドラが添付されているかどうかを確認することに注意してください。

public static boolean hasHandlers ( $class, $name )
$class string|object

クラスレベルのイベントを指定するオブジェクトまたは完全修飾クラス名。
$name string

イベント名。
戻り値 boolean

イベントにハンドラが添付されているかどうか。

 

                public static function hasHandlers($class, $name)
{
    if (empty(self::$_eventWildcards) && empty(self::$_events[$name])) {
        return false;
    }
    if (is_object($class)) {
        $class = get_class($class);
    } else {
        $class = ltrim($class, '\\');
    }
    $classes = array_merge(
        [$class],
        class_parents($class, true),
        class_implements($class, true)
    );
    // regular events
    foreach ($classes as $className) {
        if (!empty(self::$_events[$name][$className])) {
            return true;
        }
    }
    // wildcard events
    foreach (self::$_eventWildcards as $nameWildcard => $classHandlers) {
        if (!StringHelper::matchWildcard($nameWildcard, $name, ['escape' => false])) {
            continue;
        }
        foreach ($classHandlers as $classWildcard => $handlers) {
            if (empty($handlers)) {
                continue;
            }
            foreach ($classes as $className) {
                if (StringHelper::matchWildcard($classWildcard, $className, ['escape' => false])) {
                    return true;
                }
            }
        }
    }
    return false;
}
hasMethod() publicメソッド

定義場所: yii\base\BaseObject::hasMethod()

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

デフォルトの実装は、PHP関数method_exists()の呼び出しです。PHPのマジックメソッド__call()を実装した場合は、このメソッドをオーバーライドできます。

public boolean hasMethod ( $name )
$name string

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

メンバ変数をプロパティとして扱うかどうか
戻り値 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()
{
}
off() public static メソッド

定義済み: yii\base\Event::off()

クラスレベルのイベントからイベントハンドラをデタッチします。

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

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

こちらも参照してください on().

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

イベントハンドラーをデタッチする必要がある完全修飾クラス名。
$name string

イベント名。
$handler callable|null

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

ハンドラーが見つかり、デタッチされたかどうか。

 

                public static function off($class, $name, $handler = null)
{
    $class = ltrim($class, '\\');
    if (empty(self::$_events[$name][$class]) && empty(self::$_eventWildcards[$name][$class])) {
        return false;
    }
    if ($handler === null) {
        unset(self::$_events[$name][$class]);
        unset(self::$_eventWildcards[$name][$class]);
        return true;
    }
    // plain event names
    if (isset(self::$_events[$name][$class])) {
        $removed = false;
        foreach (self::$_events[$name][$class] as $i => $event) {
            if ($event[0] === $handler) {
                unset(self::$_events[$name][$class][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            self::$_events[$name][$class] = array_values(self::$_events[$name][$class]);
            return true;
        }
    }
    // wildcard event names
    $removed = false;
    if (isset(self::$_eventWildcards[$name][$class])) {
        foreach (self::$_eventWildcards[$name][$class] as $i => $event) {
            if ($event[0] === $handler) {
                unset(self::$_eventWildcards[$name][$class][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            self::$_eventWildcards[$name][$class] = array_values(self::$_eventWildcards[$name][$class]);
            // remove empty wildcards to save future redundant regex checks :
            if (empty(self::$_eventWildcards[$name][$class])) {
                unset(self::$_eventWildcards[$name][$class]);
                if (empty(self::$_eventWildcards[$name])) {
                    unset(self::$_eventWildcards[$name]);
                }
            }
        }
    }
    return $removed;
}
offAll() public static メソッド (バージョン2.0.10から利用可能)

定義済み: yii\base\Event::offAll()

登録されているすべてのクラスレベルのイベントハンドラをデタッチします。

こちらも参照してください

public static void offAll ( )

                public static function offAll()
{
    self::$_events = [];
    self::$_eventWildcards = [];
}
on() public static メソッド

定義済み: yii\base\Event::on()

クラスレベルのイベントにイベントハンドラをアタッチします。

クラスレベルのイベントがトリガーされると、そのクラスとそのすべての親クラスにアタッチされたイベントハンドラーが呼び出されます。

例えば、以下のコードはActiveRecordのafterInsertイベントにイベントハンドラーをアタッチします。

Event::on(ActiveRecord::class, ActiveRecord::EVENT_AFTER_INSERT, function ($event) {
    Yii::trace(get_class($event->sender) . ' is inserted.');
});

このハンドラーは、成功したActiveRecordの挿入ごとに呼び出されます。

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

Event::on('app\models\db\*', '*Insert', function ($event) {
    Yii::trace(get_class($event->sender) . ' is inserted.');
});

イベントハンドラーの宣言方法の詳細については、yii\base\Component::on()を参照してください。

こちらも参照してください off().

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

イベントハンドラーをアタッチする必要がある完全修飾クラス名。
$name string

イベント名。
$handler callable

イベントハンドラー。
$data mixed

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

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

 

                public static function on($class, $name, $handler, $data = null, $append = true)
{
    $class = ltrim($class, '\\');
    if (strpos($class, '*') !== false || strpos($name, '*') !== false) {
        if ($append || empty(self::$_eventWildcards[$name][$class])) {
            self::$_eventWildcards[$name][$class][] = [$handler, $data];
        } else {
            array_unshift(self::$_eventWildcards[$name][$class], [$handler, $data]);
        }
        return;
    }
    if ($append || empty(self::$_events[$name][$class])) {
        self::$_events[$name][$class][] = [$handler, $data];
    } else {
        array_unshift(self::$_events[$name][$class], [$handler, $data]);
    }
}
trigger() public static メソッド

定義済み: yii\base\Event::trigger()

クラスレベルのイベントをトリガーします。

このメソッドは、指定されたクラスとそのすべての親クラスに対して、名前付きイベントにアタッチされているイベントハンドラーの呼び出しを発生させます。

public static void trigger ( $class, $name, $event = null )
$class string|object

クラスレベルのイベントを指定するオブジェクトまたは完全修飾クラス名。
$name string

イベント名。
$event yii\base\Event|null

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

 

                public static function trigger($class, $name, $event = null)
{
    $wildcardEventHandlers = [];
    foreach (self::$_eventWildcards as $nameWildcard => $classHandlers) {
        if (!StringHelper::matchWildcard($nameWildcard, $name)) {
            continue;
        }
        $wildcardEventHandlers = array_merge($wildcardEventHandlers, $classHandlers);
    }
    if (empty(self::$_events[$name]) && empty($wildcardEventHandlers)) {
        return;
    }
    if ($event === null) {
        $event = new static();
    }
    $event->handled = false;
    $event->name = $name;
    if (is_object($class)) {
        if ($event->sender === null) {
            $event->sender = $class;
        }
        $class = get_class($class);
    } else {
        $class = ltrim($class, '\\');
    }
    $classes = array_merge(
        [$class],
        class_parents($class, true),
        class_implements($class, true)
    );
    foreach ($classes as $class) {
        $eventHandlers = [];
        foreach ($wildcardEventHandlers as $classWildcard => $handlers) {
            if (StringHelper::matchWildcard($classWildcard, $class, ['escape' => false])) {
                $eventHandlers = array_merge($eventHandlers, $handlers);
                unset($wildcardEventHandlers[$classWildcard]);
            }
        }
        if (!empty(self::$_events[$name][$class])) {
            $eventHandlers = array_merge($eventHandlers, self::$_events[$name][$class]);
        }
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            if ($event->handled) {
                return;
            }
        }
    }
}