RevisionEvent

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

Revision event class.

View source

# Public Properties

Property Description
creatorId integer, null – The creator ID
data mixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
handled boolean – Whether the event is handled.
name string – The event name.
revision craft\base\ElementInterface, craft\behaviors\RevisionBehavior, null – The revision associated with the event (if it exists yet)
revisionNotes string, null – The revision notes
revisionNum integer – The revision number
sender object – The sender of this event.
source craft\base\ElementInterface – The source element

# creatorId

Type
integer, null

The creator ID

View source

# revision

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

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

View source

# revisionNotes

Type
string, null

The revision notes

View source

# revisionNum

Type
integer

The revision number

View source

# source

Type
craft\base\ElementInterface

The source element

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.