RouteEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\RouteEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0

RouteEvent class.

View source

Public Properties

PropertyDescription
$datamixed – The data that is passed to \craft\events\Component::on() when attaching an event handler.
$handledboolean – Whether the event is handled.
$namestring – The event name.
$routeIdinteger, null – The route ID, if it has one yet
$senderobject – The sender of this event.
$siteIdinteger, null – The site ID the route should be limited to, if any
$templatestring, null – The template to route matching requests to
$uriPartsarray, null – The URI as defined by the user.

$routeId

Type
integer, null

The route ID, if it has one yet

View source

Signature

public integer, null $routeId = null

$siteId

Type
integer, null

The site ID the route should be limited to, if any

View source

Signature

public integer, null $siteId = null

$template

Type
string, null

The template to route matching requests to

View source

Signature

public string, null $template = null

$uriParts

Type
array, null

The URI as defined by the user. This is an array where each element is either a string or an array containing the name of a subpattern and the subpattern.

View source

Signature

public array, null $uriParts = null

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.