TemplateEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\TemplateEvent » craft\events\CancelableEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.0

TemplateEvent class.

View source

Public Properties

PropertyDescription
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
handledboolean – Whether the event is handled.
isValidboolean – Whether to continue performing the action that called this event
namestring – The event name.
outputstring – The rendering result of craft\web\View::renderTemplate().
senderobject – The sender of this event.
templatestring – The name of the template being rendered
templateModestring – The template mode to be used
variablesarray – The variables to be passed to the template

output

Type
string

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

template

Type
string

The name of the template being rendered

View source

templateMode

Type
string
Since
3.4.0

The template mode to be used

View source

variables

Type
array

The variables to be passed to the template

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
hasHandlers()Returns a value indicating whether there is any handler attached to the specified class-level event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
off()Detaches an event handler from a class-level event.
offAll()Detaches all registered class-level event handlers.
on()Attaches an event handler to a class-level event.
trigger()Triggers a class-level event.