0 追蹤者

類別 yii\base\Event

所有類別 | 屬性 | 方法
繼承關係yii\base\Event » yii\base\BaseObject
實作介面yii\base\Configurable
子類別yii\base\ActionEvent, yii\base\ModelEvent, yii\base\ViewEvent, yii\base\WidgetEvent, yii\db\AfterSaveEvent, yii\i18n\MissingTranslationEvent, yii\mail\MailEvent, yii\web\UserEvent
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/base/Event.php

Event 是所有事件類別的基底類別。

它封裝了與事件相關聯的參數。$sender 屬性描述了誰引發了事件。而 $handled 屬性指示事件是否已被處理。如果事件處理器將 $handled 設置為 true，則其餘未調用的處理器將不再被調用來處理該事件。

此外，在附加事件處理器時，可以傳遞額外數據，並且在調用事件處理器時可以通過 $data 屬性來訪問。

有關 Event 的更多詳細資訊和使用方法，請參閱 事件指南文章。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$data mixed 當附加事件處理器時，傳遞給 yii\base\Component::on() 的數據。 yii\base\Event
$handled boolean 事件是否已被處理。 yii\base\Event
$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

屬性詳細資訊

隱藏繼承的屬性

$data public property

當附加事件處理常式時，傳遞到 yii\base\Component::on() 的資料。請注意，這會根據目前正在執行的事件處理常式而有所不同。

public mixed $data = null
$handled public property

事件是否已被處理。預設值為 false。當處理常式將其設定為 true 時，事件處理將停止並忽略其餘未調用的事件處理常式。

public boolean $handled = false
$name public property

事件名稱。此屬性由 yii\base\Component::trigger() 和 trigger() 設定。事件處理常式可以使用此屬性來檢查它正在處理哪個事件。

public string $name = null
$sender public property

此事件的發送者。如果未設定，此屬性將設定為呼叫 trigger() 方法的物件。當此事件是在靜態上下文中觸發的類別層級事件時，此屬性也可能為 null。

public object|null $sender = null

方法詳細資訊

隱藏繼承的方法

__call() public method

定義於： yii\base\BaseObject::__call()

調用指定的非類別方法。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，當調用未知方法時會隱式呼叫。

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

方法名稱
$params 陣列

方法參數
傳回 mixed

方法傳回值
拋出 yii\base\UnknownMethodException

當呼叫未知方法時

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() public method

定義於： yii\base\BaseObject::__construct()

建構子。

預設實作執行兩件事

  • 使用給定的組態 $config 初始化物件。
  • 呼叫 init()。

如果在子類別中覆寫此方法，建議

  • 建構子的最後一個參數是組態陣列，例如此處的 $config。
  • 在建構子的結尾呼叫父類別實作。
public void __construct ( $config = [] )
$config 陣列

將用於初始化物件屬性的名稱-值對。

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() public method

定義於： yii\base\BaseObject::__get()

返回物件屬性的值。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，當執行 $value = $object->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)) {
        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 method

定義於： yii\base\BaseObject::__isset()

檢查屬性是否已設置，即已定義且非 null。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，當執行 isset($object->property) 時會隱式呼叫。

請注意，如果屬性未定義，將傳回 false。

另請參閱 https://php.dev.org.tw/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 method

定義於： yii\base\BaseObject::__set()

設置物件屬性的值。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，當執行 $object->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)) {
        $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 method

定義於： yii\base\BaseObject::__unset()

將物件屬性設置為 null。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，當執行 unset($object->property) 時會隱式呼叫。

請注意，如果屬性未定義，此方法將不會執行任何操作。如果屬性為唯讀，它將拋出例外。

另請參閱 https://php.dev.org.tw/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 method

定義於： yii\base\BaseObject::canGetProperty()

傳回值，指示屬性是否可讀取。

如果屬性可讀取，條件為

  • 類別具有與指定名稱相關聯的 getter 方法 (在此情況下，屬性名稱不區分大小寫)；
  • 類別具有具有指定名稱的成員變數 (當 $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 method

定義於： yii\base\BaseObject::canSetProperty()

傳回值，指示屬性是否可設定。

如果屬性可寫入，條件為

  • 類別具有與指定名稱相關聯的 setter 方法 (在此情況下，屬性名稱不區分大小寫)；
  • 類別具有具有指定名稱的成員變數 (當 $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 method
自 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 method

傳回值，指示是否有任何處理常式附加到指定的類別層級事件。

請注意，此方法還將檢查所有父類別，以查看是否有任何處理常式附加到指定的事件。

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 method

定義於： 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 method

定義於： yii\base\BaseObject::hasProperty()

傳回值，指示屬性是否已定義。

如果屬性已定義，條件為

  • 類別具有與指定名稱相關聯的 getter 或 setter 方法 (在此情況下，屬性名稱不區分大小寫)；
  • 類別具有具有指定名稱的成員變數 (當 $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 method

定義於： yii\base\BaseObject::init()

初始化物件。

在使用給定組態初始化物件後，此方法會在建構子的結尾被調用。

public void init ( )

                public function init()
{
}
off() public static method

從類別層級事件中分離事件處理常式。

此方法與 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 method (available since version 2.0.10)

分離所有已註冊的類別層級事件處理常式。

另請參閱

public static void offAll ( )

                public static function offAll()
{
    self::$_events = [];
    self::$_eventWildcards = [];
}
on() public static method

將事件處理常式附加到類別層級事件。

當觸發類別層級事件時，將調用附加到該類別和所有父類別的事件處理常式。

例如，以下程式碼將事件處理常式附加到 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 method

觸發類別層級事件。

此方法將導致調用附加到指定類別及其所有父類別的指定名稱事件的事件處理常式。

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