COutputEvent
| Package | system.web |
|---|---|
| Inheritance | class COutputEvent » CEvent » CComponent |
| Since | 1.0 |
| Source Code | framework/web/COutputEvent.php |
COutputEvent represents the parameter for events related with output handling.
An event handler may retrieve the captured output for further processing.
An event handler may retrieve the captured output for further processing.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| handled | boolean | whether the event is handled. | CEvent |
| output | string | the output to be processed. | COutputEvent |
| params | mixed | additional event parameters. | CEvent |
| sender | object | the sender of this event | CEvent |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | COutputEvent |
| __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 |
| 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 |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| 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 |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| 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 |
| raiseEvent() | Raises an event. | CComponent |
Property Details
output property
public string $output;
the output to be processed. The processed output should be stored back to this property.
Method Details
__construct() method
public void __construct(mixed $sender, string $output) | ||
| $sender | mixed | sender of the event |
| $output | string | the output to be processed |
Source Code: framework/web/COutputEvent.php#32 (show)
public function __construct($sender,$output)
{
parent::__construct($sender);
$this->output=$output;
}
Constructor.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/COutputEvent