RevisionBehavior

Type
Class
Namespace
craft\behaviors
Inherits
craft\behaviors\RevisionBehavior » craft\behaviors\BaseRevisionBehavior » yii\base\Behavior (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
3.2.0

RevisionBehavior is applied to element revisions.

View source (opens new window)

# Public Properties

# revisionLabel

Type
string (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# revisionNotes

Type
string (opens new window), null (opens new window)
Default value
null

The revision notes

View source (opens new window)

# revisionNum

Type
integer (opens new window)
Default value
null

The revision number

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
attach() (opens new window) Attaches the behavior object to the component.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
detach() (opens new window) Detaches the behavior object from the component.
events() Declares event handlers for the owner (opens new window)'s events.
getCreator() Returns the draft’s creator.
getRevisionLabel() Returns the revision label.
getSource() Returns the draft/revision’s source element.
handleDelete() Deletes the row in the drafts table after the draft element is deleted.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() (opens new window) Initializes the object.
setCreator() Sets the draft's creator.

# events()

Declares event handlers for the owner (opens new window)'s events.

Child classes may override this method to declare what PHP callbacks should be attached to the events of the owner (opens new window) component.

The callbacks will be attached to the owner (opens new window)'s events when the behavior is attached to the owner; and they will be detached from the events when the behavior is detached from the component.

The callbacks can be any of the following:

  • method in this behavior: 'handleClick', equivalent to [$this, 'handleClick']
  • object method: [$object, 'handleClick']
  • static method: ['Page', 'handleClick']
  • anonymous function: function ($event) { ... }

The following is an example:

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]

View source (opens new window)

Returns

array (opens new window) – Events (array keys) and the corresponding event handler methods (array values).

# getRevisionLabel()

Returns the revision label.

View source (opens new window)

Returns

string (opens new window)

# handleDelete()

Deletes the row in the drafts table after the draft element is deleted.

View source (opens new window)

# Protected Methods

Method Description
source() Returns the source element.