COutputProcessor

Package	system.web.widgets
Inheritance	class COutputProcessor » CFilterWidget » CWidget » CBaseController » CComponent
Implements	IFilter
Subclasses	CContentDecorator, CHtmlPurifier, CMarkdown, CTextHighlighter
Since	1.0
Source Code	framework/web/widgets/COutputProcessor.php

COutputProcessor transforms the content into a different format.

COutputProcessor captures the output generated by an action or a view fragment and passes it to its onProcessOutput event handlers for further processing.

The event handler may process the output and store it back to the COutputEvent::output property. By setting the handled property of the event parameter to true, the output will not be echoed anymore. Otherwise (by default), the output will be echoed.

Public Properties

Property	Type	Description	Defined By
actionPrefix	string	the prefix to the IDs of the actions.	CWidget
controller	CController	Returns the controller that this widget belongs to.	CWidget
id	string	Returns the ID of the widget or generates a new one if requested.	CWidget
isFilter	boolean	whether this widget is used as a filter.	CFilterWidget
owner	CBaseController	Returns the owner/creator of this widget.	CWidget
skin	mixed	the name of the skin to be used by this widget.	CWidget
stopAction	boolean	whether to stop the action execution when this widget is used as a filter.	CFilterWidget
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.	CFilterWidget
__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
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
filter()	Performs the filtering.	CFilterWidget
getController()	Returns the controller that this widget belongs to.	CWidget
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getId()	Returns the ID of the widget or generates a new one if requested.	CWidget
getIsFilter()	Checks whether this widget is used as a filter.	CFilterWidget
getOwner()	Returns the owner/creator of this widget.	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()	Initializes the widget.	COutputProcessor
onProcessOutput()	Raised when the output has been captured.	COutputProcessor
processOutput()	Processes the captured output.	COutputProcessor
raiseEvent()	Raises an event.	CComponent
render()	Renders a view.	CWidget
renderFile()	Renders a view file.	CBaseController
renderInternal()	Renders a view file.	CBaseController
run()	Executes the widget.	COutputProcessor
setId()	Sets the ID of the widget.	CWidget
widget()	Creates a widget and executes it.	CBaseController

Events

Event	Description	Defined By
onProcessOutput	Raised when the output has been captured.	COutputProcessor

Method Details

init() method

public void init()

Source Code: framework/web/widgets/COutputProcessor.php#31 (show)

public function init()
{
    ob_start();
    ob_implicit_flush(false);
}

Initializes the widget. This method starts the output buffering.

onProcessOutput() method

public void onProcessOutput(COutputEvent $event)
$event	COutputEvent	event parameter

Source Code: framework/web/widgets/COutputProcessor.php#72 (show)

public function onProcessOutput($event)
{
    $this->raiseEvent('onProcessOutput',$event);
}

Raised when the output has been captured.

processOutput() method

public void processOutput(string $output)
$output	string	the captured output to be processed

Source Code: framework/web/widgets/COutputProcessor.php#55 (show)

public function processOutput($output)
{
    if($this->hasEventHandler('onProcessOutput'))
    {
        $event=new COutputEvent($this,$output);
        $this->onProcessOutput($event);
        if(!$event->handled)
            echo $output;
    }
    else
        echo $output;
}

Processes the captured output.

The default implementation raises an onProcessOutput event. If the event is not handled by any event handler, the output will be echoed.

run() method

public void run()

Source Code: framework/web/widgets/COutputProcessor.php#41 (show)

public function run()
{
    $output=ob_get_clean();
    $this->processOutput($output);
}

Executes the widget. This method stops output buffering and processes the captured output.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/COutputProcessor