DraftEvent

Type: Class
Namespace: craft\events
Inherits: craft\events\DraftEvent » yii\base\Event » yii\base\BaseObject
Implements: yii\base\Configurable
Since: 3.2.0

Draft event class.

Public Properties

Property	Description
canonical	craft\base\ElementInterface – The canonical element
creatorId	integer, null – The creator ID
data	`mixed` – The data that is passed to yii\base\Component::on() when attaching an event handler.
draft	craft\base\ElementInterface, null – The draft associated with the event (if it exists yet)
draftName	string, null – The draft name
draftNotes	string, null – The draft notes
handled	boolean – Whether the event is handled.
name	string – The event name.
provisional	boolean – Whether this is a provisional draft
sender	object, null – The sender of this event.

`canonical`

Type: craft\base\ElementInterface
Default value: null

The canonical element

`creatorId`

Type: integer, null
Default value: null

The creator ID

`draft`

Type: craft\base\ElementInterface, null
Default value: null

The draft associated with the event (if it exists yet)

`draftName`

Type: string, null
Default value: null

The draft name

`draftNotes`

Type: string, null
Default value: null

The draft notes

`provisional`

Type: boolean
Default value: false

Whether this is a provisional draft

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.