0 追蹤者

Class yii\base\Action

所有類別 | 屬性 | 方法
繼承關係yii\base\Action » yii\base\Component » yii\base\BaseObject
實作介面yii\base\Configurable
子類別yii\base\InlineAction, yii\captcha\CaptchaAction, yii\rest\Action, yii\rest\CreateAction, yii\rest\DeleteAction, yii\rest\IndexAction, yii\rest\OptionsAction, yii\rest\UpdateAction, yii\rest\ViewAction, yii\web\ErrorAction, yii\web\ViewAction
起始版本2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/base/Action.php

Action 是所有控制器 action 類別的基底類別。

Action 提供重複使用 action 方法程式碼的方式。Action 類別中的 action 方法可以用於多個控制器或不同的專案中。

衍生類別必須實作一個名為 run() 的方法。當 action 被請求時，此方法將由控制器調用。run() 方法可以有參數，這些參數會根據其名稱自動填入使用者輸入值。例如，如果 run() 方法宣告如下

public function run($id, $type = 'book') { ... }

並且為 action 提供的參數是：['id' => 1]。那麼 run() 方法將會自動以 run(1) 的形式調用。

關於 Action 的更多詳細資訊和使用方法，請參閱關於 action 的指南文章。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$behaviors yii\base\Behavior[] 附加到此組件的 behavior 列表。 yii\base\Component
$controller yii\base\Controller|yii\web\Controller|yii\console\Controller 擁有此 action 的控制器 yii\base\Action
$id string action 的 ID yii\base\Action
$uniqueId string 此 action 在整個應用程式中的唯一 ID。 yii\base\Action

公開方法

隱藏繼承的方法

方法 描述 定義於
__call() 調用指定的非類別方法。 yii\base\Component
__clone() 此方法在通過複製現有物件建立物件後調用。 yii\base\Component
__construct() 建構子。 yii\base\Action
__get() 傳回組件屬性的值。 yii\base\Component
__isset() 檢查屬性是否已設定，即已定義且非 null。 yii\base\Component
__set() 設定組件屬性的值。 yii\base\Component
__unset() 將組件屬性設定為 null。 yii\base\Component
attachBehavior() 將一個 behavior 附加到此組件。 yii\base\Component
attachBehaviors() 將 behavior 列表附加到組件。 yii\base\Component
behaviors() 傳回此組件應表現為的 behavior 列表。 yii\base\Component
canGetProperty() 傳回一個值，指示屬性是否可讀取。 yii\base\Component
canSetProperty() 傳回一個值，指示屬性是否可設定。 yii\base\Component
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
detachBehavior() 從組件分離一個 behavior。 yii\base\Component
detachBehaviors() 從組件分離所有 behavior。 yii\base\Component
ensureBehaviors() 確保在 behaviors() 中宣告的 behavior 已附加到此組件。 yii\base\Component
getBehavior() 傳回指定的 behavior 物件。 yii\base\Component
getBehaviors() 傳回附加到此組件的所有 behavior。 yii\base\Component
getUniqueId() 傳回此 action 在整個應用程式中的唯一 ID。 yii\base\Action
hasEventHandlers() 傳回一個值，指示是否有任何處理器附加到指定的事件。 yii\base\Component
hasMethod() 傳回一個值，指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值，指示是否為此組件定義了屬性。 yii\base\Component
init() 初始化物件。 yii\base\BaseObject
off() 從此組件分離現有的事件處理器。 yii\base\Component
on() 將事件處理器附加到一個事件。 yii\base\Component
runWithParams() 使用指定的參數執行此 action。 yii\base\Action
trigger() 觸發一個事件。 yii\base\Component

受保護方法

隱藏繼承的方法

方法 描述 定義於
afterRun() 此方法在 run() 執行後立即調用。 yii\base\Action
beforeRun() 此方法在 run() 執行前立即調用。 yii\base\Action

屬性詳情

隱藏繼承的屬性

$controller public property

擁有此 action 的控制器

public yii\base\Controller|yii\web\Controller|yii\console\Controller $controller = null
$id 公開屬性

action 的 ID

public string $id = null
$uniqueId 公開屬性

此 action 在整個應用程式中的唯一 ID。

public string $uniqueId = null

方法詳情

隱藏繼承的方法

__call() 公開方法

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

調用指定的非類別方法。

此方法將檢查是否有任何附加的行為具有指定名稱的方法，如果有的話將會執行它。

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

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

方法名稱
$params array

方法參數
return mixed

方法的傳回值
throws 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() 公開方法

定義於： yii\base\Component::__clone()

此方法在通過複製現有物件建立物件後調用。

它會移除所有行為，因為它們附加到舊物件。

public void __clone ( )

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

建構子。

public void __construct ( $id, $controller, $config = [] )
$id string

此 action 的 ID
$controller yii\base\Controller

擁有此 action 的控制器
$config array

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

 

                public function __construct($id, $controller, $config = [])
{
    $this->id = $id;
    $this->controller = $controller;
    parent::__construct($config);
}
__get() 公開方法

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

傳回組件屬性的值。

此方法將依以下順序檢查並相應地執行

  • getter 定義的屬性：傳回 getter 結果
  • 行為的屬性：傳回行為屬性值

請勿直接呼叫此方法，因為它是一個 PHP 魔術方法，當執行 $value = $component->property; 時會被隱式呼叫。

另請參閱 __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)) {
        // 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() 公開方法

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

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

此方法將依以下順序檢查並相應地執行

  • setter 定義的屬性：傳回屬性是否已設定
  • 行為的屬性：傳回屬性是否已設定
  • 對於不存在的屬性傳回 false

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

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php。

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱
return 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() 公開方法

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

設定組件屬性的值。

此方法將依以下順序檢查並相應地執行

  • setter 定義的屬性：設定屬性值
  • 格式為 "on xyz" 的事件：將處理常式附加到事件 "xyz"
  • 格式為 "as xyz" 的行為：附加名為 "xyz" 的行為
  • 行為的屬性：設定行為屬性值

請勿直接呼叫此方法，因為它是一個 PHP 魔術方法，當執行 $component->property = $value; 時會被隱式呼叫。

另請參閱 __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)) {
        // 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() 公開方法

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

將組件屬性設定為 null。

此方法將依以下順序檢查並相應地執行

  • setter 定義的屬性：將屬性值設定為 null
  • 行為的屬性：將屬性值設定為 null

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

另請參閱 https://php.dev.org.tw/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);
        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);
}
afterRun() 保護方法

此方法在 run() 執行後立即調用。

您可以覆寫此方法，為 action 執行後的工作進行後處理。

protected void afterRun ( )

                protected function afterRun()
{
}
attachBehavior() 公開方法

定義於： yii\base\Component::attachBehavior()

將一個 behavior 附加到此組件。

此方法將根據給定的配置建立行為物件。之後，將透過呼叫 yii\base\Behavior::attach() 方法將行為物件附加到此組件。

另請參閱 detachBehavior()。

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行為的名稱。
$behavior string|array|yii\base\Behavior

行為配置。這可以是以下其中之一
return yii\base\Behavior

行為物件

 

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}
attachBehaviors() 公開方法

定義於： yii\base\Component::attachBehaviors()

將 behavior 列表附加到組件。

每個行為都由其名稱索引，並且應該是 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);
    }
}
beforeRun() 保護方法

此方法在 run() 執行前立即調用。

您可以覆寫此方法，為 action 執行前的工作進行準備。如果此方法傳回 false，它將取消 action。

protected boolean beforeRun ( )
return boolean

是否執行 action。

 

                protected function beforeRun()
{
    return true;
}
behaviors() 公開方法

定義於： yii\base\Component::behaviors()

傳回此組件應表現為的 behavior 列表。

子類別可以覆寫此方法以指定它們想要作為的行為。

此方法的傳回值應該是由行為名稱索引的行為物件或配置陣列。行為配置可以是指定行為類別的字串，也可以是以下結構的陣列

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

請注意，行為類別必須從 yii\base\Behavior 擴展。行為可以使用名稱或匿名方式附加。當名稱用作陣列鍵時，使用此名稱，稍後可以使用 getBehavior() 檢索行為，或使用 detachBehavior() 分離行為。匿名行為無法檢索或分離。

在此方法中宣告的行為將自動（按需）附加到組件。

public array behaviors ( )
return array

行為配置。

 

                public function behaviors()
{
    return [];
}
canGetProperty() 公開方法

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

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

如果符合以下條件，則可以讀取屬性

  • 類別具有與指定名稱關聯的 getter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；
  • 附加的行為具有給定名稱的可讀屬性（當 $checkBehaviors 為 true 時）。

另請參閱 canSetProperty()。

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

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
$checkBehaviors boolean

是否將行為的屬性視為此組件的屬性
return 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() 公開方法

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

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

如果符合以下條件，則可以寫入屬性

  • 類別具有與指定名稱關聯的 setter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；
  • 附加的行為具有給定名稱的可寫屬性（當 $checkBehaviors 為 true 時）。

另請參閱 canGetProperty()。

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

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
$checkBehaviors boolean

是否將行為的屬性視為此組件的屬性
return 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() 公開靜態方法
自 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();
}
detachBehavior() 公開方法

定義於： yii\base\Component::detachBehavior()

從組件分離一個 behavior。

將會調用行為的 yii\base\Behavior::detach() 方法。

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

行為的名稱。
return 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() 公開方法

定義於： yii\base\Component::detachBehaviors()

從組件分離所有 behavior。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}
ensureBehaviors() 公開方法

定義於： yii\base\Component::ensureBehaviors()

確保在 behaviors() 中宣告的 behavior 已附加到此組件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}
getBehavior() 公開方法

定義於： yii\base\Component::getBehavior()

傳回指定的 behavior 物件。

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

行為名稱
return yii\base\Behavior|null

行為物件，如果行為不存在則為 null

 

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
getBehaviors() 公開方法

定義於： yii\base\Component::getBehaviors()

傳回附加到此組件的所有 behavior。

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此組件的行為列表

 

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}
getUniqueId() 公開方法

傳回此 action 在整個應用程式中的唯一 ID。

public string getUniqueId ( )
return string

此 action 在整個應用程式中的唯一 ID。

 

                public function getUniqueId()
{
    return $this->controller->getUniqueId() . '/' . $this->id;
}
hasEventHandlers() 公開方法

定義於： yii\base\Component::hasEventHandlers()

傳回一個值，指示是否有任何處理器附加到指定的事件。

public boolean hasEventHandlers ( $name )
$name string

事件名稱
return 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() 公開方法

定義於： yii\base\Component::hasMethod()

傳回一個值，指示是否已定義方法。

如果符合以下條件，則定義方法

  • 類別具有具有指定名稱的方法
  • 附加的行為具有給定名稱的方法（當 $checkBehaviors 為 true 時）。
public boolean hasMethod ( $name, $checkBehaviors = true )
$name string

屬性名稱
$checkBehaviors boolean

是否將行為的方法視為此組件的方法
return 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() 公開方法

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

傳回一個值，指示是否為此組件定義了屬性。

如果符合以下條件，則定義屬性

  • 類別具有與指定名稱關聯的 getter 或 setter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；
  • 附加的行為具有給定名稱的屬性（當 $checkBehaviors 為 true 時）。

另請參閱

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

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
$checkBehaviors boolean

是否將行為的屬性視為此組件的屬性
return boolean

屬性是否已定義

 

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
init() public method

Defined in: yii\base\BaseObject::init()

初始化物件。

此方法在建構子結束時調用，在物件使用給定的配置初始化之後。

public void init ( )

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

Defined in: yii\base\Component::off()

從此組件分離現有的事件處理器。

此方法與 on() 方法相反。

注意：如果為事件名稱傳遞了萬用字元模式，則只會移除使用此萬用字元註冊的處理器，而使用與此萬用字元匹配的純名稱註冊的處理器將保留。

另請參閱 on()。

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

事件名稱
$handler callable|null

要移除的事件處理器。如果為 null，則將移除附加到具名事件的所有處理器。
return 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 method

Defined in: yii\base\Component::on()

將事件處理器附加到一個事件。

事件處理器必須是有效的 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]);
    }
}
runWithParams() public method

使用指定的參數執行此 action。

此方法主要由控制器調用。

public mixed runWithParams ( $params )
$params array

要綁定到 action 的 run() 方法的參數。
return mixed

action 的結果
throws yii\base\InvalidConfigException

如果 action 類別沒有 run() 方法

 

                public function runWithParams($params)
{
    if (!method_exists($this, 'run')) {
        throw new InvalidConfigException(get_class($this) . ' must define a "run()" method.');
    }
    $args = $this->controller->bindActionParams($this, $params);
    Yii::debug('Running action: ' . get_class($this) . '::run(), invoked by ' . get_class($this->controller), __METHOD__);
    if (Yii::$app->requestedParams === null) {
        Yii::$app->requestedParams = $args;
    }
    if ($this->beforeRun()) {
        $result = call_user_func_array([$this, 'run'], $args);
        $this->afterRun();
        return $result;
    }
    return null;
}
trigger() public method

Defined in: yii\base\Component::trigger()

觸發一個事件。

此方法表示事件的發生。它會調用事件的所有附加處理器，包括類別層級的處理器。

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