Class yii\widgets\ContentDecorator
ContentDecorator records all output between begin() and end() calls, passes it to the given view file
as $content and then echoes rendering result.
<?php ContentDecorator::begin([
'viewFile' => '@app/views/layouts/base.php',
'params' => [],
'view' => $this,
]) ?>
some content here
<?php ContentDecorator::end() ?>
There are yii\base\View::beginContent() and yii\base\View::endContent() wrapper methods in the yii\base\View component to make syntax more friendly. In the view these could be used as follows:
<?php $this->beginContent('@app/views/layouts/base.php') ?>
some content here
<?php $this->endContent() ?>
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| $autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $id | string | ID of the widget. | yii\base\Widget |
| $params | array | The parameters (name => value) to be extracted and made available in the decorative view. | yii\widgets\ContentDecorator |
| $stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
| $view | yii\web\View | The view object that can be used to render views or view files. | yii\base\Widget |
| $viewFile | string | The view file that will be used to decorate the content enclosed by this widget. | yii\widgets\ContentDecorator |
| $viewPath | string | The directory containing the view files for this widget. | yii\base\Widget |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| afterRun() | This method is invoked right after a widget is executed. | yii\base\Widget |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| beforeRun() | This method is invoked right before the widget is executed. | yii\base\Widget |
| begin() | Begins a widget. | yii\base\Widget |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| end() | Ends a widget. | yii\base\Widget |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getId() | Returns the ID of the widget. | yii\base\Widget |
| getView() | Returns the view object that can be used to render views or view files. | yii\base\Widget |
| getViewPath() | Returns the directory containing the view files for this widget. | yii\base\Widget |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Starts recording a clip. | yii\widgets\ContentDecorator |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| render() | Renders a view. | yii\base\Widget |
| renderFile() | Renders a view file. | yii\base\Widget |
| run() | Ends recording a clip. | yii\widgets\ContentDecorator |
| setId() | Sets the ID of the widget. | yii\base\Widget |
| setView() | Sets the view object to be used by this widget. | yii\base\Widget |
| trigger() | Triggers an event. | yii\base\Component |
| widget() | Creates a widget instance and runs it. | yii\base\Widget |
Events
| 事件 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | An event raised right after executing a widget. （自版本 2.0.11 可用） | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | An event raised right before executing a widget. （自版本 2.0.11 可用） | yii\base\Widget |
| EVENT_INIT | yii\base\Event | An event that is triggered when the widget is initialized via init(). （自版本 2.0.11 可用） | yii\base\Widget |
属性详情
The parameters (name => value) to be extracted and made available in the decorative view.
The view file that will be used to decorate the content enclosed by this widget. This can be specified as either the view file path or path alias.