DraftEvent

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

Draft event class.

View source

Public Properties

PropertyDescription
creatorIdinteger – The creator ID
datamixed – The data that is passed to \craft\events\Component::on() when attaching an event handler.
draftcraft\base\ElementInterface, \craft\behaviors\DraftBehavior, null – The draft associated with the event (if it exists yet)
draftNamestring, null – The draft name
draftNotesstring, null – The draft notes
handledboolean – Whether the event is handled.
namestring – The event name.
senderobject – The sender of this event.
sourcecraft\base\ElementInterface, null – The source element

creatorId

Type
integer

The creator ID

View source

draft

Type
craft\base\ElementInterface, \craft\behaviors\DraftBehavior, null

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

View source

draftName

Type
string, null

The draft name

View source

draftNotes

Type
string, null

The draft notes

View source

source

Type
craft\base\ElementInterface, null

The source element

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.