API Documentation for Yii 1.0
0 follower
CClipWidget
| Package | system.web.widgets |
|---|---|
| Inheritance | class CClipWidget » CWidget » CBaseController » CComponent |
| Since | 1.0 |
| Version | $Id$ |
| Source Code | framework/web/widgets/CClipWidget.php |
CClipWidget records its content and makes it available elsewhere.
Content rendered between its init() and 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.
Content rendered between its init() and 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.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| actionPrefix | string | the prefix to the IDs of the actions. | CWidget |
| controller | CController | the controller that this widget belongs to. | CWidget |
| id | string | id of the widget. | CWidget |
| owner | CBaseController | owner/creator of this widget. | CWidget |
| renderClip | boolean | whether to render the clip content in place. | CClipWidget |
| viewPath | string | Returns the directory containing the view files for this widget. | CWidget |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CWidget |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| actions() | Returns a list of actions that are used by this widget. | CWidget |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| beginCache() | Begins fragment caching. | CBaseController |
| beginClip() | Begins recording a clip. | CBaseController |
| beginContent() | Begins the rendering of content that is to be decorated by the specified view. | CBaseController |
| beginWidget() | Creates a widget and executes it. | CBaseController |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| createWidget() | Creates a widget and initializes it. | CBaseController |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| endCache() | Ends fragment caching. | CBaseController |
| endClip() | Ends recording a clip. | CBaseController |
| endContent() | Ends the rendering of content. | CBaseController |
| endWidget() | Ends the execution of the named widget. | CBaseController |
| getController() | Returns the controller that this widget belongs to. | CWidget |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getId() | Returns id of the widget. | CWidget |
| getOwner() | Returns owner/creator of this widget. It could be either a widget or a controller. | CWidget |
| getViewFile() | Looks for the view script file according to the view name. | CWidget |
| getViewPath() | Returns the directory containing the view files for this widget. | CWidget |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| init() | Starts recording a clip. | CClipWidget |
| raiseEvent() | Raises an event. | CComponent |
| render() | Renders a view. | CWidget |
| renderFile() | Renders a view file. | CBaseController |
| renderInternal() | Renders a view file. | CBaseController |
| run() | Ends recording a clip. | CClipWidget |
| setId() | Sets id of the widget. | CWidget |
| widget() | Creates a widget and executes it. | CBaseController |
Property Details
renderClip
property
public boolean $renderClip;
whether to render the clip content in place. Defaults to false, meaning the captured clip will not be displayed.
Method Details
init()
method
|
public void init()
|
Source Code: framework/web/widgets/CClipWidget.php#38 (show)
public function init()
{
ob_start();
ob_implicit_flush(false);
}
Starts recording a clip.
run()
method
|
public void run()
|
Source Code: framework/web/widgets/CClipWidget.php#48 (show)
public function run()
{
$clip=ob_get_clean();
if($this->renderClip)
echo $clip;
$this->getController()->getClips()->add($this->getId(),$clip);
}
Ends recording a clip. This method stops output buffering and saves the rendering result as a named clip in the controller.
Signup or Login in order to comment.