4 位关注者

类 yii\widgets\ActiveForm

继承关系yii\widgets\ActiveForm » yii\base\Widget » yii\base\Component » yii\base\BaseObject
实现接口yii\base\Configurable, yii\base\ViewContextInterface
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/widgets/ActiveForm.php

ActiveForm 是一个用于构建一个或多个数据模型的交互式 HTML 表单的小部件。

有关 ActiveForm 的更多详细信息和使用信息,请参阅 表单指南文章

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$action 数组|字符串 表单操作 URL。 yii\widgets\ActiveForm
$ajaxDataType 字符串 您期望从服务器返回的数据类型。 yii\widgets\ActiveForm
$ajaxParam 字符串 指示验证请求是否为 AJAX 请求的 GET 参数名称。 yii\widgets\ActiveForm
$autoIdPrefix 字符串 自动生成的部件 ID 的前缀。 yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$enableAjaxValidation 布尔值 是否启用基于 AJAX 的数据验证。 yii\widgets\ActiveForm
$enableClientScript 布尔值 是否挂载 yii.activeForm JavaScript 插件。 yii\widgets\ActiveForm
$enableClientValidation 布尔值 是否启用客户端数据验证。 yii\widgets\ActiveForm
$encodeErrorSummary 布尔值 是否对错误摘要执行编码。 yii\widgets\ActiveForm
$errorCssClass 字符串 当关联属性存在验证错误时,添加到字段容器的 CSS 类。 yii\widgets\ActiveForm
$errorSummaryCssClass 字符串 错误摘要容器的默认 CSS 类。 yii\widgets\ActiveForm
$fieldClass 字符串 调用 field() 创建新字段时的默认字段类名。 yii\widgets\ActiveForm
$fieldConfig 数组|闭包 field() 创建新字段对象时使用的默认配置。 yii\widgets\ActiveForm
$id 字符串|null 部件的 ID。 yii\base\Widget
$method 字符串 表单提交方法。 yii\widgets\ActiveForm
$options 数组 表单标签的 HTML 属性(名称-值对)。 yii\widgets\ActiveForm
$requiredCssClass 字符串 当关联属性为必填时,添加到字段容器的 CSS 类。 yii\widgets\ActiveForm
$scrollToError 布尔值 验证后是否滚动到第一个错误。 yii\widgets\ActiveForm
$scrollToErrorOffset 整数 滚动到第一个错误时应添加的像素偏移量。 yii\widgets\ActiveForm
$successCssClass 字符串 当关联属性验证成功时,添加到字段容器的 CSS 类。 yii\widgets\ActiveForm
$validateOnBlur 布尔值 输入字段失去焦点时是否执行验证。 yii\widgets\ActiveForm
$validateOnChange 布尔值 输入字段的值更改时是否执行验证。 yii\widgets\ActiveForm
$validateOnSubmit 布尔值 表单提交时是否执行验证。 yii\widgets\ActiveForm
$validateOnType 布尔值 用户在输入字段中键入时是否执行验证。 yii\widgets\ActiveForm
$validatingCssClass 字符串 当关联属性正在验证时,添加到字段容器的 CSS 类。 yii\widgets\ActiveForm
$validationDelay 整数 当用户在字段中键入并且 $validateOnType 设置为 true 时,验证应延迟的毫秒数。 yii\widgets\ActiveForm
$validationStateOn 字符串 渲染验证状态类的位置 可以是 "container" 或 "input"。 yii\widgets\ActiveForm
$validationUrl 数组|字符串|null 执行基于 AJAX 的验证的 URL。 yii\widgets\ActiveForm
$view yii\web\View 可用于渲染视图或视图文件的视图对象。 yii\base\Widget
$viewPath 字符串 包含此部件的视图文件的目录。 yii\base\Widget

公共方法

隐藏继承的方法

方法 描述 定义于
__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
afterRun() 此方法在部件执行后立即调用。 yii\base\Widget
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
beforeRun() 此方法在部件执行之前立即调用。 yii\base\Widget
begin() 开始一个部件。 yii\base\Widget
beginField() 开始一个表单字段。 yii\widgets\ActiveForm
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示属性是否可以读取。 yii\base\Component
canSetProperty() 返回一个值,指示属性是否可以设置。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
end() 结束一个部件。 yii\base\Widget
endField() 结束一个表单字段。 yii\widgets\ActiveForm
ensureBehaviors() 确保 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
errorSummary() 生成验证错误的摘要。 yii\widgets\ActiveForm
field() 生成一个表单字段。 yii\widgets\ActiveForm
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getId() 返回部件的 ID。 yii\base\Widget
getView() 返回可用于渲染视图或视图文件的视图对象。 yii\base\Widget
getViewPath() 返回包含此部件的视图文件的目录。 yii\base\Widget
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值,指示此组件是否定义了属性。 yii\base\Component
init() 初始化部件。 yii\widgets\ActiveForm
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
registerClientScript() 这将注册必要的 JavaScript 代码。 yii\widgets\ActiveForm
render() 渲染视图。 yii\base\Widget
renderFile() 渲染视图文件。 yii\base\Widget
run() 运行部件。 yii\widgets\ActiveForm
setId() 设置部件的 ID。 yii\base\Widget
setView() 设置此部件要使用的视图对象。 yii\base\Widget
trigger() 触发事件。 yii\base\Component
validate() 验证一个或多个模型并返回一个错误消息数组,该数组以属性 ID 为索引。 yii\widgets\ActiveForm
validateMultiple() 验证模型实例数组并返回一个错误消息数组,该数组以属性 ID 为索引。 yii\widgets\ActiveForm
widget() 创建部件实例并运行它。 yii\base\Widget

受保护的方法

隐藏继承的方法

方法 描述 定义于
getClientOptions() 返回表单 JS 部件的选项。 yii\widgets\ActiveForm

事件

隐藏继承的事件

事件 类型 描述 定义于
EVENT_AFTER_RUN yii\base\WidgetEvent 执行部件后立即触发的事件。(自版本 2.0.11 起可用) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent 在执行小部件之前触发的事件。(自 2.0.11 版本起可用) yii\base\Widget
EVENT_INIT yii\base\Event 通过 init() 初始化小部件时触发的事件。(自 2.0.11 版本起可用) yii\base\Widget

常量

隐藏继承的常量

常量 描述 定义于
VALIDATION_STATE_ON_CONTAINER 'container' 在容器标签上添加验证状态类 yii\widgets\ActiveForm
VALIDATION_STATE_ON_INPUT 'input' 在输入标签上添加验证状态类 yii\widgets\ActiveForm

属性详情

隐藏继承的属性

$action 公共属性

表单操作 URL。此参数将由 yii\helpers\Url::to() 处理。

另请参阅 $method 以指定此表单的 HTTP 方法。

public 数组|字符串 $action ''
$ajaxDataType 公共属性

您期望从服务器返回的数据类型。

public 字符串 $ajaxDataType 'json'
$ajaxParam 公共属性

指示验证请求是否为 AJAX 请求的 GET 参数名称。

public 字符串 $ajaxParam 'ajax'
$enableAjaxValidation 公共属性

是否启用基于 AJAX 的数据验证。如果 yii\widgets\ActiveField::$enableAjaxValidation 已设置,则其值将优先于该输入字段。

$enableClientScript 公共属性

是否挂接 yii.activeForm JavaScript 插件。如果您想支持客户端验证和/或 AJAX 验证,或者想利用 yii.activeForm 插件,则必须将此属性设置为 true。当此值为 false 时,表单将不会生成任何 JavaScript。

另请参阅 registerClientScript()

$enableClientValidation 公共属性

是否启用客户端数据验证。如果 yii\widgets\ActiveField::$enableClientValidation 已设置,则其值将优先于该输入字段。

$encodeErrorSummary 公共属性

是否对错误摘要执行编码。

$errorCssClass 公共属性

当关联属性存在验证错误时,添加到字段容器的 CSS 类。

public 字符串 $errorCssClass 'has-error'
$errorSummaryCssClass 公共属性

错误摘要容器的默认 CSS 类。

另请参阅 errorSummary()

public 字符串 $errorSummaryCssClass 'error-summary'
$fieldClass 公共属性

调用 field() 创建新字段时的默认字段类名。

另请参阅 $fieldConfig

public 字符串 $fieldClass 'yii\widgets\ActiveField'
$fieldConfig 公共属性

创建新字段对象时,field() 使用的默认配置。这可以是配置数组或返回配置数组的匿名函数。如果是后者,则签名应如下所示

function ($model, $attribute)

此属性的值将与传递给 field()$options 参数递归合并。

另请参阅 $fieldClass

$method 公共属性

表单提交方法。这应该为 postget。默认为 post

当您将其设置为 get 时,您可能会看到每个请求中都重复了 url 参数。这是因为 $action 的默认值设置为当前请求 url,并且每次提交都会添加新参数而不是替换现有参数。您可以显式设置 $action 以避免这种情况

$form = ActiveForm::begin([
    'method' => 'get',
    'action' => ['controller/action'],
]);
public 字符串 $method 'post'
$options 公共属性

表单标签的 HTML 属性(名称-值对)。

另请参阅 yii\helpers\Html::renderTagAttributes() 以了解属性如何呈现的详细信息。

public 数组 $options = []
$requiredCssClass 公共属性

当关联属性为必填时,添加到字段容器的 CSS 类。

public 字符串 $requiredCssClass 'required'
$scrollToError 公共属性 (自 2.0.6 版本起可用)

验证后是否滚动到第一个错误。

public 布尔值 $scrollToError true
$scrollToErrorOffset 公共属性 (自 2.0.11 版本起可用)

滚动到第一个错误时应添加的像素偏移量。

$successCssClass 公共属性

当关联属性验证成功时,添加到字段容器的 CSS 类。

public 字符串 $successCssClass 'has-success'
$validateOnBlur 公共属性

当输入字段失去焦点时是否执行验证。如果 yii\widgets\ActiveField::$validateOnBlur 已设置,则其值将优先于该输入字段。

public 布尔值 $validateOnBlur true
$validateOnChange 公共属性

当输入字段的值更改时是否执行验证。如果 yii\widgets\ActiveField::$validateOnChange 已设置,则其值将优先于该输入字段。

$validateOnSubmit 公共属性

表单提交时是否执行验证。

$validateOnType 公共属性

当用户在输入字段中键入时是否执行验证。如果 yii\widgets\ActiveField::$validateOnType 已设置,则其值将优先于该输入字段。

另请参阅 $validationDelay

public 布尔值 $validateOnType false
$validatingCssClass 公共属性

当关联属性正在验证时,添加到字段容器的 CSS 类。

public 字符串 $validatingCssClass 'validating'
$validationDelay 公共属性

当用户在字段中键入并且 $validateOnType 设置为 true 时,验证应延迟的毫秒数。如果 yii\widgets\ActiveField::$validationDelay 已设置,则其值将优先于该输入字段。

public 整数 $validationDelay 500
$validationStateOn 公共属性 (自 2.0.14 版本起可用)

在何处渲染验证状态类 可以是“容器”或“输入”。默认为“容器”。

public 字符串 $validationStateOn self::VALIDATION_STATE_ON_CONTAINER
$validationUrl 公共属性

执行基于 AJAX 的验证的 URL。此属性将由 yii\helpers\Url::to() 处理。有关如何配置此属性的更多详细信息,请参阅 yii\helpers\Url::to()。如果未设置此属性,它将采用表单的 action 属性的值。

方法详情

隐藏继承的方法

__call() 公共方法

定义于: yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查任何附加的行为是否具有指定名称的方法,并在可用时执行它。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用。

public mixed __call ( $name, $params )
$name 字符串

方法名称

$params 数组

方法参数

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

定义于: yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后被调用。

它删除所有行为,因为它们附加到旧对象。

public void __clone ( )

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

            
__construct() 公共方法

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

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按以下顺序检查并相应地执行

  • 由 getter 定义的属性:返回 getter 的结果
  • 行为的属性:返回行为属性的值

不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $value = $component->property; 时会隐式调用。

另请参阅 __set()

public mixed __get ( $name )
$name 字符串

属性名称

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

定义于: yii\base\Component::__isset()

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

此方法将按以下顺序检查并相应地执行

  • 由 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性返回 false

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

另请参阅 https://php.ac.cn/manual/en/function.isset.php

public boolean __isset ( $name )
$name 字符串

属性名称或事件名称

返回值 布尔值

指定的属性是否已设置

                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 字符串

属性名称或事件名称

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

定义于: 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 字符串

属性名称

抛出异常 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() 公共方法 (自版本 2.0.11 起可用)

定义于: yii\base\Widget::afterRun()

此方法在部件执行后立即调用。

此方法将触发 EVENT_AFTER_RUN 事件。此方法的返回值将用作小部件的返回值。

如果您重写此方法,您的代码应如下所示

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}
public mixed afterRun ( $result )
$result mixed

小部件的返回结果。

返回值 mixed

已处理的小部件结果。

                public function afterRun($result)
{
    $event = new WidgetEvent();
    $event->result = $result;
    $this->trigger(self::EVENT_AFTER_RUN, $event);
    return $event->result;
}

            
attachBehavior() 公共方法

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

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另请参阅 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name 字符串

行为的名称。

$behavior string|array|yii\base\Behavior

行为配置。可以是以下之一

返回值 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 数组

要附加到组件的行为列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeRun() 公共方法 (自版本 2.0.11 起可用)

定义于: yii\base\Widget::beforeRun()

此方法在部件执行之前立即调用。

此方法将触发EVENT_BEFORE_RUN事件。该方法的返回值将决定小部件是否应该继续运行。

覆盖此方法时,请确保像下面这样调用父实现

public function beforeRun()
{
    if (!parent::beforeRun()) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the widget
}
public boolean beforeRun ( )
返回值 布尔值

小部件是否应该继续执行。

                public function beforeRun()
{
    $event = new WidgetEvent();
    $this->trigger(self::EVENT_BEFORE_RUN, $event);
    return $event->isValid;
}

            
begin() 公共静态方法

定义于: yii\base\Widget::begin()

开始一个部件。

此方法创建调用类的实例。它会将配置应用于创建的实例。稍后应调用匹配的end()调用。由于某些小部件可能使用输出缓冲,因此应在同一视图中进行end()调用,以避免破坏输出缓冲的嵌套。

另请参阅 end()

public static static begin ( $config = [] )
$config 数组

将用于初始化对象属性的名称-值对

返回值 yii\base\Widget

新创建的小部件实例

                public static function begin($config = [])
{
    $config['class'] = get_called_class();
    /* @var $widget Widget */
    $widget = Yii::createObject($config);
    self::$stack[] = $widget;
    return $widget;
}

            
beginField() 公共方法

开始一个表单字段。

此方法将创建一个新的表单字段并返回其开始标签。您应该随后调用endField()

另请参阅

public string beginField ( $model, $attribute, $options = [] )
$model yii\base\Model

数据模型。

$attribute 字符串

属性名称或表达式。有关属性表达式的格式,请参阅yii\helpers\Html::getAttributeName()

$options 数组

字段对象的附加配置。

返回值 字符串

开始标签。

                public function beginField($model, $attribute, $options = [])
{
    $field = $this->field($model, $attribute, $options);
    $this->_fields[] = $field;
    return $field->begin();
}

            
behaviors() 公共方法

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

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

子类可以重写此方法以指定它们希望表现出的行为。

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

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

请注意,行为类必须扩展自yii\base\Behavior。可以使用名称或匿名方式附加行为。当数组键使用名称时,使用此名称,稍后可以使用getBehavior()检索行为,或使用detachBehavior()分离行为。无法检索或分离匿名行为。

此方法中声明的行为将自动附加到组件(按需)。

public array behaviors ( )
返回值 数组

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

定义于: yii\base\Component::canGetProperty()

返回一个值,指示属性是否可以读取。

如果可以读取属性

  • 该类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有与指定名称相同的成员变量(当$checkVars为 true 时);
  • 附加的行为具有给定名称的可读属性(当$checkBehaviors为 true 时)。

另请参阅 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name 字符串

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性

返回值 布尔值

属性是否可以读取

                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 字符串

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性

返回值 布尔值

属性是否可以写入

                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 ( )
返回值 字符串

此类的完全限定名称。

                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 字符串

行为的名称。

返回值 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);
    }
}

            
end() 公共静态方法

定义于: yii\base\Widget::end()

结束一个部件。

请注意,小部件的渲染结果直接回显。

另请参阅 begin()

public static static end ( )
返回值 yii\base\Widget

结束的小部件实例。

抛出异常 yii\base\InvalidCallException

如果`begin()` 和 `end()` 调用没有正确嵌套

                public static function end()
{
    if (!empty(self::$stack)) {
        $widget = array_pop(self::$stack);
        $calledClass = get_called_class();
        if (Yii::$container->has($calledClass) && isset(Yii::$container->getDefinitions()[$calledClass]['class'])) {
            $calledClass = Yii::$container->getDefinitions()[$calledClass]['class'];
        }
        if (get_class($widget) === $calledClass) {
            /* @var $widget Widget */
            if ($widget->beforeRun()) {
                $result = $widget->run();
                $result = $widget->afterRun($result);
                echo $result;
            }
            return $widget;
        }
        throw new InvalidCallException('Expecting end() of ' . get_class($widget) . ', found ' . get_called_class());
    }
    throw new InvalidCallException('Unexpected ' . get_called_class() . '::end() call. A matching begin() is not found.');
}

            
endField() 公共方法

结束一个表单字段。

此方法将返回由 `beginField()` 启动的活动表单字段的结束标签。

public string endField ( )
返回值 字符串

表单字段的结束标签。

抛出异常 yii\base\InvalidCallException

如果在没有先前的 `beginField()` 调用情况下调用此方法。

                public function endField()
{
    $field = array_pop($this->_fields);
    if ($field instanceof ActiveField) {
        return $field->end();
    }
    throw new InvalidCallException('Mismatching endField() call.');
}

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

            
errorSummary() 公共方法

生成验证错误的摘要。

如果没有验证错误,仍然会生成一个空的错误摘要标记,但它将被隐藏。

另请参阅 $errorSummaryCssClass

public string errorSummary ( $models, $options = [] )
$models yii\base\Model|yii\base\Model[]

与此表单关联的模型。

$options 数组

以名称-值对形式表示的标签选项。以下选项将被特殊处理

  • header:字符串,错误摘要的标题 HTML。如果未设置,将使用默认提示字符串。
  • footer:字符串,错误摘要的脚注 HTML。

其余选项将呈现为容器标签的属性。值将使用 yii\helpers\Html::encode() 进行 HTML 编码。如果值为 null,则不会呈现相应的属性。

返回值 字符串

生成的错误摘要。

                public function errorSummary($models, $options = [])
{
    Html::addCssClass($options, $this->errorSummaryCssClass);
    $options['encode'] = $this->encodeErrorSummary;
    return Html::errorSummary($models, $options);
}

            
field() 公共方法

生成一个表单字段。

表单字段与模型和属性相关联。它包含标签、输入和错误消息,并使用它们与最终用户交互以收集其对属性的输入。

另请参阅 $fieldConfig

public yii\widgets\ActiveField field ( $model, $attribute, $options = [] )
$model yii\base\Model

数据模型。

$attribute 字符串

属性名称或表达式。有关属性表达式的格式,请参阅yii\helpers\Html::getAttributeName()

$options 数组

字段对象的附加配置。这些是 yii\widgets\ActiveField 或子类的属性,具体取决于 $fieldClass 的值。

返回值 yii\widgets\ActiveField

创建的 ActiveField 对象。

                public function field($model, $attribute, $options = [])
{
    $config = $this->fieldConfig;
    if ($config instanceof \Closure) {
        $config = call_user_func($config, $model, $attribute);
    }
    if (!isset($config['class'])) {
        $config['class'] = $this->fieldClass;
    }
    return Yii::createObject(ArrayHelper::merge($config, $options, [
        'model' => $model,
        'attribute' => $attribute,
        'form' => $this,
    ]));
}

            
getBehavior() 公共方法

定义于: yii\base\Component::getBehavior()

返回命名的行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name 字符串

行为名称

返回值 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 ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getClientOptions() 受保护方法

返回表单 JS 部件的选项。

protected array getClientOptions ( )
返回值 数组

选项。

                protected function getClientOptions()
{
    $options = [
        'encodeErrorSummary' => $this->encodeErrorSummary,
        'errorSummary' => '.' . implode('.', preg_split('/\s+/', $this->errorSummaryCssClass, -1, PREG_SPLIT_NO_EMPTY)),
        'validateOnSubmit' => $this->validateOnSubmit,
        'errorCssClass' => $this->errorCssClass,
        'successCssClass' => $this->successCssClass,
        'validatingCssClass' => $this->validatingCssClass,
        'ajaxParam' => $this->ajaxParam,
        'ajaxDataType' => $this->ajaxDataType,
        'scrollToError' => $this->scrollToError,
        'scrollToErrorOffset' => $this->scrollToErrorOffset,
        'validationStateOn' => $this->validationStateOn,
    ];
    if ($this->validationUrl !== null) {
        $options['validationUrl'] = Url::to($this->validationUrl);
    }
    // only get the options that are different from the default ones (set in yii.activeForm.js)
    return array_diff_assoc($options, [
        'encodeErrorSummary' => true,
        'errorSummary' => '.error-summary',
        'validateOnSubmit' => true,
        'errorCssClass' => 'has-error',
        'successCssClass' => 'has-success',
        'validatingCssClass' => 'validating',
        'ajaxParam' => 'ajax',
        'ajaxDataType' => 'json',
        'scrollToError' => true,
        'scrollToErrorOffset' => 0,
        'validationStateOn' => self::VALIDATION_STATE_ON_CONTAINER,
    ]);
}

            
getId() 公共方法

定义于: yii\base\Widget::getId()

返回部件的 ID。

public string|null getId ( $autoGenerate true )
$autoGenerate 布尔值

是否在之前未设置 ID 时生成 ID

返回值 字符串|null

部件的 ID。

                public function getId($autoGenerate = true)
{
    if ($autoGenerate && $this->_id === null) {
        $this->_id = static::$autoIdPrefix . static::$counter++;
    }
    return $this->_id;
}

            
getView() 公共方法

定义于: yii\base\Widget::getView()

返回可用于渲染视图或视图文件的视图对象。

render()renderFile() 方法将使用此视图对象来实现实际的视图渲染。如果未设置,它将默认为“view”应用程序组件。

public yii\web\View getView ( )
返回值 yii\web\View

可用于渲染视图或视图文件的视图对象。

                public function getView()
{
    if ($this->_view === null) {
        $this->_view = Yii::$app->getView();
    }
    return $this->_view;
}

            
getViewPath() 公共方法

定义于: yii\base\Widget::getViewPath()

返回包含此部件的视图文件的目录。

默认实现返回包含小部件类文件的目录下的“views”子目录。

public string getViewPath ( )
返回值 字符串

包含此部件的视图文件的目录。

                public function getViewPath()
{
    $class = new ReflectionClass($this);
    return dirname($class->getFileName()) . DIRECTORY_SEPARATOR . 'views';
}

            
hasEventHandlers() 公共方法

定义于: yii\base\Component::hasEventHandlers()

返回一个值,指示是否有任何处理程序附加到命名事件。

public boolean hasEventHandlers ( $name )
$name 字符串

事件名称

返回值 布尔值

是否有任何处理程序附加到事件。

                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 字符串

属性名称

$checkBehaviors 布尔值

是否将行为的方法视为此组件的方法

返回值 布尔值

方法是否已定义

                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 字符串

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性

返回值 布尔值

属性是否已定义

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

            
init() 公共方法

初始化部件。

此方法渲染表单的开始标签。

public void init ( )

                public function init()
{
    parent::init();
    if (!isset($this->options['id'])) {
        $this->options['id'] = $this->getId();
    }
    ob_start();
    ob_implicit_flush(false);
}

            
off() 公共方法

定义于: yii\base\Component::off()

从此组件中分离现有的事件处理程序。

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

注意:如果为事件名称传递通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。

另见 on()

public boolean off ( $name, $handler null )
$name 字符串

事件名称

$handler callable|null

要删除的事件处理程序。如果为 null,则将删除附加到指定事件的所有处理程序。

返回值 布尔值

如果找到并分离了一个处理程序,则

                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 字符串

事件名称

$handler callable

事件处理程序

$data mixed

触发事件时要传递给事件处理程序的数据。调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append 布尔值

是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 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]);
    }
}

            
registerClientScript() 公共方法 (自 2.0.12 版本起可用)

这将注册必要的 JavaScript 代码。

public void registerClientScript ( )

                public function registerClientScript()
{
    $id = $this->options['id'];
    $options = Json::htmlEncode($this->getClientOptions());
    $attributes = Json::htmlEncode($this->attributes);
    $view = $this->getView();
    ActiveFormAsset::register($view);
    $view->registerJs("jQuery('#$id').yiiActiveForm($attributes, $options);");
}

            
render() 公共方法

定义于: yii\base\Widget::render()

渲染视图。

要渲染的视图可以使用以下格式之一指定:

  • 路径别名(例如,“@app/views/site/index”);
  • 应用程序内的绝对路径(例如,“//site/index”):视图名称以双斜杠开头。实际的视图文件将在应用程序的 视图路径 下查找。
  • 模块内的绝对路径(例如,“/site/index”):视图名称以单个斜杠开头。实际的视图文件将在当前活动模块的 视图路径 下查找。
  • 相对路径(例如,“index”):实际的视图文件将在 $viewPath 下查找。

如果视图名称不包含文件扩展名,则将使用默认扩展名 .php

public string render ( $view, $params = [] )
$view 字符串

视图名称。

$params 数组

应在视图中可用的参数(名称-值对)。

返回值 字符串

渲染结果。

抛出异常 yii\base\InvalidArgumentException

如果视图文件不存在。

                public function render($view, $params = [])
{
    return $this->getView()->render($view, $params, $this);
}

            
renderFile() 公共方法

定义于: yii\base\Widget::renderFile()

渲染视图文件。

public string renderFile ( $file, $params = [] )
$file 字符串

要渲染的视图文件。这可以是文件路径或 路径别名

$params 数组

应在视图中可用的参数(名称-值对)。

返回值 字符串

渲染结果。

抛出异常 yii\base\InvalidArgumentException

如果视图文件不存在。

                public function renderFile($file, $params = [])
{
    return $this->getView()->renderFile($file, $params, $this);
}

            
run() 公共方法

运行部件。

此方法注册必要的 JavaScript 代码并渲染表单的开始和结束标签。

public void run ( )
抛出异常 yii\base\InvalidCallException

如果 beginField()endField() 调用不匹配。

                public function run()
{
    if (!empty($this->_fields)) {
        throw new InvalidCallException('Each beginField() should have a matching endField() call.');
    }
    $content = ob_get_clean();
    $html = Html::beginForm($this->action, $this->method, $this->options);
    $html .= $content;
    if ($this->enableClientScript) {
        $this->registerClientScript();
    }
    $html .= Html::endForm();
    return $html;
}

            
setId() 公共方法

定义于: yii\base\Widget::setId()

设置部件的 ID。

public void setId ( $value )
$value 字符串

小部件的 ID。

                public function setId($value)
{
    $this->_id = $value;
}

            
setView() 公共方法

定义于: yii\base\Widget::setView()

设置此部件要使用的视图对象。

public void setView ( $view )
$view yii\base\View

可用于渲染视图或视图文件的视图对象。

                public function setView($view)
{
    $this->_view = $view;
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它会调用事件的所有附加处理程序,包括类级别的处理程序。

public void trigger ( $name, yii\base\Event $event null )
$name 字符串

事件名称

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

            
validate() 公共静态方法

验证一个或多个模型并返回一个错误消息数组,该数组以属性 ID 为索引。

这是一个辅助方法,简化了编写 AJAX 验证代码的方式。

例如,您可以在控制器操作中使用以下代码来响应 AJAX 验证请求

$model = new Post;
$model->load(Yii::$app->request->post());
if (Yii::$app->request->isAjax) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validate($model);
}
// ... respond to non-AJAX request ...

要验证多个模型,只需将每个模型作为参数传递给此方法,如下所示

ActiveForm::validate($model1, $model2, ...);
public static array validate ( $model, $attributes null )
$model yii\base\Model

要验证的模型。

$attributes mixed

应验证的属性列表。如果此参数为空,则表示应验证在适用验证规则中列出的任何属性。

当此方法用于验证多个模型时,此参数将被解释为模型。

返回值 数组

错误消息数组,由属性 ID 索引。

                public static function validate($model, $attributes = null)
{
    $result = [];
    if ($attributes instanceof Model) {
        // validating multiple models
        $models = func_get_args();
        $attributes = null;
    } else {
        $models = [$model];
    }
    /* @var $model Model */
    foreach ($models as $model) {
        $model->validate($attributes);
        foreach ($model->getErrors() as $attribute => $errors) {
            $result[Html::getInputId($model, $attribute)] = $errors;
        }
    }
    return $result;
}

            
validateMultiple() 公共静态方法

验证模型实例数组并返回一个错误消息数组,该数组以属性 ID 为索引。

这是一个辅助方法,简化了为表格输入编写 AJAX 验证代码的方式。

例如,您可以在控制器操作中使用以下代码来响应 AJAX 验证请求

// ... load $models ...
if (Yii::$app->request->isAjax) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validateMultiple($models);
}
// ... respond to non-AJAX request ...
public static array validateMultiple ( $models, $attributes null )
$models 数组

要验证的模型数组。

$attributes mixed

应验证的属性列表。如果此参数为空,则表示应验证在适用验证规则中列出的任何属性。

返回值 数组

错误消息数组,由属性 ID 索引。

                public static function validateMultiple($models, $attributes = null)
{
    $result = [];
    /* @var $model Model */
    foreach ($models as $i => $model) {
        $model->validate($attributes);
        foreach ($model->getErrors() as $attribute => $errors) {
            $result[Html::getInputId($model, "[$i]" . $attribute)] = $errors;
        }
    }
    return $result;
}

            
widget() 公共静态方法

定义于: yii\base\Widget::widget()

创建部件实例并运行它。

此方法返回小部件的渲染结果。

public static string widget ( $config = [] )
$config 数组

将用于初始化对象属性的名称-值对

返回值 字符串

小部件的渲染结果。

抛出异常 Throwable

                public static function widget($config = [])
{
    ob_start();
    ob_implicit_flush(false);
    try {
        /* @var $widget Widget */
        $config['class'] = get_called_class();
        $widget = Yii::createObject($config);
        $out = '';
        if ($widget->beforeRun()) {
            $result = $widget->run();
            $out = $widget->afterRun($result);
        }
    } catch (\Exception $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    } catch (\Throwable $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    }
    return ob_get_clean() . $out;
}