Class CContentDecorator

CContentDecorator decorates the content it encloses with the specified view.

CContentDecorator is mostly used to implement nested layouts, i.e., a layout is embedded within another layout. CBaseController defines a pair of convenient methods to use CContentDecorator:

$this->beginContent('path/to/view');
// ... content to be decorated
$this->endContent();

The property CContentDecorator::$view specifies the name of the view that is used to decorate the content. In the view, the content being decorated may be accessed with variable <span class="php-var">$content</span>.

CComponent

CBaseController

CWidget

CFilterWidget implements IFilter

COutputProcessor

CContentDecorator

Package: system\web\widgets
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/web/widgets/CContentDecorator.php

Methods summary
`public`	# `processOutput( string $output )` Processes the captured output. This method decorates the output with the specified `CContentDecorator::$view`. Processes the captured output. This method decorates the output with the specified `CContentDecorator::$view`. Parameters `$output` `string` $output the captured output to be processed Overrides `COutputProcessor::processOutput()`
`protected string`	# `decorate( string $content )` Decorates the content by rendering a view and embedding the content in it. The content being embedded can be accessed in the view using variable `<span class="php-var">$content</span>` The decorated content will be displayed directly. Decorates the content by rendering a view and embedding the content in it. The content being embedded can be accessed in the view using variable `<span class="php-var">$content</span>` The decorated content will be displayed directly. Parameters `$content` `string` $content the content to be decorated Returns `string` the decorated content

Methods inherited from COutputProcessor
`init(), onProcessOutput(), run()`

Methods inherited from CFilterWidget
`__construct(), filter(), getIsFilter()`

Methods inherited from CWidget
`actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), setId()`

Methods inherited from CBaseController
`beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderFile(), renderInternal(), widget()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public mixed`	`$view`		# the name of the view that will be used to decorate the captured content. If this property is null (default value), the default layout will be used as the decorative view. Note that if the current controller does not belong to any module, the default layout refers to the application's CWebApplication::layout default layout; If the controller belongs to a module, the default layout refers to the module's CWebModule::layout default layout. the name of the view that will be used to decorate the captured content. If this property is null (default value), the default layout will be used as the decorative view. Note that if the current controller does not belong to any module, the default layout refers to the application's CWebApplication::layout default layout; If the controller belongs to a module, the default layout refers to the module's CWebModule::layout default layout.
`public array`	`$data`	`array()`	# the variables (name=>value) to be extracted and made available in the decorative view. the variables (name=>value) to be extracted and made available in the decorative view.

Properties inherited from CFilterWidget
`$stopAction`

Properties inherited from CWidget
`$actionPrefix, $skin`

Magic properties inherited from CFilterWidget
`$isFilter`

Magic properties inherited from CWidget
`$controller, $id, $owner, $viewPath`

Packages

Classes

Class CContentDecorator

Parameters

Overrides

Parameters

Returns