Class CClipWidget

CClipWidget records its content and makes it available elsewhere.

Content rendered between its CClipWidget::init() and CClipWidget::run() calls are saved as a clip in the controller. The clip is named after the widget ID.

See CBaseController::beginClip() and CBaseController::endClip() for a shortcut usage of CClipWidget.

CComponent

CBaseController

CWidget

CClipWidget

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/CClipWidget.php

Methods summary
`public`	# `init( )` Starts recording a clip. Starts recording a clip. Overrides `CWidget::init()`
`public`	# `run( )` Ends recording a clip. This method stops output buffering and saves the rendering result as a named clip in the controller. Ends recording a clip. This method stops output buffering and saves the rendering result as a named clip in the controller. Overrides `CWidget::run()`

Methods inherited from CWidget
`__construct(), 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 boolean`	`$renderClip`	`false`	# whether to render the clip content in place. Defaults to false, meaning the captured clip will not be displayed. whether to render the clip content in place. Defaults to false, meaning the captured clip will not be displayed.

Properties inherited from CWidget
`$actionPrefix, $skin`

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

Packages

Classes

Class CClipWidget

Overrides

Overrides