SiteEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\SiteEvent » craft\events\CancelableEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Extended by
craft\events\DeleteSiteEvent
Since
3.0.0

Site event class.

View source

# Public Properties

Property Description
data mixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
handled boolean – Whether the event is handled.
isNew boolean – Whether the site is brand new
isValid boolean – Whether to continue performing the action that called this event
name string – The event name.
oldPrimarySiteId integer, null – The old primary site ID
sender object – The sender of this event.
site craft\models\Site, null – The site model associated with the event.

# isNew

Type
boolean

Whether the site is brand new

View source

# oldPrimarySiteId

Type
integer, null

The old primary site ID

View source

# site

Type
craft\models\Site, null

The site model associated with the event.

View source

# Public Methods

Method Description
__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.