TemplateEvent
- Type
- Class
- Namespace
- craft\events
- Inherits
- craft\events\TemplateEvent » craft\events\CancelableEvent » yii\base\Event (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.0.0
TemplateEvent class.
View source (opens new window)
# Public Properties
Property | Description |
---|---|
data (opens new window) | mixed – The data that is passed to yii\base\Component::on() (opens new window) when attaching an event handler. |
handled (opens new window) | boolean (opens new window) – Whether the event is handled. |
isValid | boolean (opens new window) – Whether to continue performing the action that called this event |
name (opens new window) | string (opens new window) – The event name. |
output | string (opens new window) – The rendering result of craft\web\View::renderTemplate(). |
sender (opens new window) | object (opens new window), null (opens new window) – The sender of this event. |
template | string (opens new window) – The name of the template being rendered |
templateMode | string (opens new window) – The template mode to be used |
variables | array (opens new window) – The variables to be passed to the template |
# output
- Type
- string (opens new window)
- Default value
null
The rendering result of craft\web\View::renderTemplate().
Event handlers may modify this property and the modified output will be returned by craft\web\View::renderTemplate(). This property is only used by craft\web\View::EVENT_AFTER_RENDER_TEMPLATE event.
View source (opens new window)
# template
- Type
- string (opens new window)
- Default value
null
The name of the template being rendered
View source (opens new window)
# templateMode
- Type
- string (opens new window)
- Default value
null
- Since
- 3.4.0
The template mode to be used
View source (opens new window)
# variables
- Type
- array (opens new window)
- Default value
null
The variables to be passed to the template
View source (opens new window)
# Public Methods
Method | Description |
---|---|
__call() (opens new window) | Calls the named method which is not a class method. |
__construct() (opens new window) | Constructor. |
__get() (opens new window) | Returns the value of an object property. |
__isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
__set() (opens new window) | Sets value of an object property. |
__unset() (opens new window) | Sets an object property to null. |
canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
className() (opens new window) | Returns the fully qualified name of this class. |
hasHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the specified class-level event. |
hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
hasProperty() (opens new window) | Returns a value indicating whether a property is defined. |
init() (opens new window) | Initializes the object. |
off() (opens new window) | Detaches an event handler from a class-level event. |
offAll() (opens new window) | Detaches all registered class-level event handlers. |
on() (opens new window) | Attaches an event handler to a class-level event. |
trigger() (opens new window) | Triggers a class-level event. |