0 关注者

类 yii\web\ViewAction

所有类 | 属性 | 方法
继承yii\web\ViewAction » yii\base\Action » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/web/ViewAction.php

ViewAction 表示一个操作，该操作根据用户指定的参数显示一个视图。

默认情况下，要显示的视图通过 view GET 参数指定。GET 参数的名称可以通过 $viewParam 自定义。

用户以 path/to/view 的格式指定视图，这将转换为视图名称 ViewPrefix/path/to/view，其中 ViewPrefix 由 $viewPrefix 给出。然后，当前活动控制器将通过 render() 方法呈现该视图。

注意，用户指定的视图名称必须以单词字符开头，并且只能包含单词字符、正斜杠、点和连字符。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$controller yii\base\Controller|yii\web\Controller|yii\console\Controller 拥有此操作的控制器 yii\base\Action
$defaultView string 当用户未提供 yii\web\ViewAction::$viewParam GET 参数时，默认视图的名称。默认为 'index'。这应该以 'path/to/view' 的格式给出，类似于 GET 参数中给出的格式。 yii\web\ViewAction
$id string 操作的 ID yii\base\Action
$layout mixed 要应用于请求视图的布局名称。 yii\web\ViewAction
$uniqueId string 此操作在整个应用程序中的唯一 ID。 yii\base\Action
$viewParam string 包含请求视图名称的 GET 参数的名称。 yii\web\ViewAction
$viewPrefix string 要添加到用户指定的视图名称之前以形成完整视图名称的字符串。 yii\web\ViewAction

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法是在对象通过克隆现有对象创建后调用的。 yii\base\Component
__construct() 构造函数。 yii\base\Action
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置，即定义且不为空。 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
getUniqueId() 返回此操作在整个应用程序中的唯一 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
run() 运行操作。 yii\web\ViewAction
runWithParams() 使用指定参数运行此操作。 yii\base\Action
trigger() 触发事件。 yii\base\Component

受保护方法

隐藏继承的方法

方法 描述 定义于
afterRun() 此方法在 run() 执行后立即调用。 yii\base\Action
beforeRun() 此方法在 run() 执行之前立即调用。 yii\base\Action
render() 呈现视图。 yii\web\ViewAction
resolveViewName() 解析当前正在请求的视图名称。 yii\web\ViewAction

属性详情

隐藏继承的属性

$defaultView 公共属性

当用户未提供 yii\web\ViewAction::$viewParam GET 参数时，默认视图的名称。默认为 'index'。这应该以 'path/to/view' 的格式给出，类似于 GET 参数中给出的格式。

另请参见 yii\web\ViewAction::$viewPrefix。

public string $defaultView = 'index'
$layout 公共属性

要应用于请求视图的布局名称。这将在呈现视图之前分配给 yii\base\Controller::$layout。默认为 null，这意味着将使用控制器的布局。如果为 false，则不会应用任何布局。

public mixed $layout = null
$viewParam 公共属性

包含请求视图名称的 GET 参数的名称。

public string $viewParam = 'view'
$viewPrefix 公共属性

一个字符串，用作用户指定视图名称的前缀，以形成完整的视图名称。例如，如果用户请求tutorial/chap1，则相应的视图名称将为pages/tutorial/chap1，假设前缀为pages。实际的视图文件由 yii\base\View::findViewFile() 确定。

另请参见 yii\base\View::findViewFile()。

public string $viewPrefix = 'pages'

方法详细信息

隐藏继承的方法

__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() 公共方法

定义于： yii\base\Action::__construct()

构造函数。

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

此操作的 ID
$controller yii\base\Controller

拥有此操作的控制器
$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()

检查属性是否已设置，即定义且不为空。

此方法将按照以下顺序检查并采取相应的措施

  • 通过 setter 定义的属性：返回属性是否已设置
  • 行为的属性：返回属性是否已设置
  • 对于不存在的属性，返回false

不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行isset($component->property)时将隐式调用。

另请参见 https://php.ac.cn/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.ac.cn/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() 受保护方法

定义于： yii\base\Action::afterRun()

此方法在 run() 执行后立即调用。

您可以覆盖此方法以对操作运行进行后处理。

protected void afterRun ( )

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

定义于： yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后，行为对象将通过调用 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()

将行为列表附加到组件。

每个行为由其名称索引，并且应该是 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() 受保护方法

定义于： yii\base\Action::beforeRun()

此方法在 run() 执行之前立即调用。

您可能需要重写此方法来为操作运行做准备工作。如果方法返回 false，则会取消操作。

protected boolean beforeRun ( )
return boolean

是否运行操作。

 

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

定义于： yii\base\Component::behaviors()

返回此组件应表现为的行为列表。

子类可以重写此方法来指定它们想要表现的行为。

此方法的返回值应该是一个行为对象或配置的数组，由行为名称索引。行为配置可以是指定行为类的字符串，也可以是以下结构的数组

'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()

从组件中分离行为。

行为的 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()

从组件中分离所有行为。

public void detachBehaviors ( )

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

定义于： yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为附加到此组件。

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

返回命名行为对象。

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

返回附加到此组件的所有行为。

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

附加到此组件的行为列表。

 

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

定义在: yii\base\Action::getUniqueId()

返回此操作在整个应用程序中的唯一 ID。

public string getUniqueId ( )
return string

此操作在整个应用程序中的唯一 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 为真时）。
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 为真时）。

另请参阅

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() 公共方法

定义在: yii\base\BaseObject::init()

初始化对象。

此方法在构造函数结束时调用，在对象使用给定配置初始化之后。

public void init ( )

                public function init()
{
}
off() 公共方法

定义在: 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() 公共方法

定义在: 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]);
    }
}
render() 受保护方法

呈现视图。

protected string render ( $viewName )
$viewName string

视图名称
return string

渲染结果

 

                protected function render($viewName)
{
    return $this->controller->render($viewName);
}
resolveViewName() 受保护方法

解析当前正在请求的视图名称。

protected string resolveViewName ( )
return string

解析的视图名称
throws yii\web\NotFoundHttpException

如果指定的视图名称无效

 

                protected function resolveViewName()
{
    $viewName = Yii::$app->request->get($this->viewParam, $this->defaultView);
    if (!is_string($viewName) || !preg_match('~^\w(?:(?!\/\.{0,2}\/)[\w\/\-\.])*$~', $viewName)) {
        if (YII_DEBUG) {
            throw new NotFoundHttpException("The requested view \"$viewName\" must start with a word character, must not contain /../ or /./, can contain only word characters, forward slashes, dots and dashes.");
        }
        throw new NotFoundHttpException(Yii::t('yii', 'The requested view "{name}" was not found.', ['name' => $viewName]));
    }
    return empty($this->viewPrefix) ? $viewName : $this->viewPrefix . '/' . $viewName;
}
run() 公共方法

运行操作。

此方法显示用户请求的视图。

public void run ( )
throws yii\web\NotFoundHttpException

如果找不到视图文件

 

                public function run()
{
    $viewName = $this->resolveViewName();
    $this->controller->actionParams[$this->viewParam] = Yii::$app->request->get($this->viewParam);
    $controllerLayout = null;
    if ($this->layout !== null) {
        $controllerLayout = $this->controller->layout;
        $this->controller->layout = $this->layout;
    }
    try {
        $output = $this->render($viewName);
        if ($controllerLayout) {
            $this->controller->layout = $controllerLayout;
        }
    } catch (ViewNotFoundException $e) {
        if ($controllerLayout) {
            $this->controller->layout = $controllerLayout;
        }
        if (YII_DEBUG) {
            throw new NotFoundHttpException($e->getMessage());
        }
        throw new NotFoundHttpException(
            Yii::t('yii', 'The requested view "{name}" was not found.', ['name' => $viewName])
        );
    }
    return $output;
}
runWithParams() 公共方法

定义在: yii\base\Action::runWithParams()

使用指定参数运行此操作。

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

public mixed runWithParams ( $params )
$params array

要绑定到操作的 run() 方法的参数。
return mixed

操作的结果
throws yii\base\InvalidConfigException

如果操作类没有 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() 公共方法

定义在: 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);
}