RevisionBehavior ​
- Type
- Class
- Namespace
- craft\behaviors
- Inherits
- craft\behaviors\RevisionBehavior » craft\behaviors\BaseRevisionBehavior » yii\base\Behavior » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.2.0
RevisionBehavior is applied to element revisions.
Public Properties ​
| Property | Description |
|---|---|
| creator | craft\elements\User, null |
| creatorId | integer, null – The creator’s ID |
| owner | craft\base\ElementInterface |
| revisionLabel | string – The revision label |
| revisionNotes | string, null – The revision notes |
| revisionNum | integer – The revision number |
| source | craft\base\ElementInterface, null |
| sourceId | integer |
revisionLabel ​
- Type
- string
- Default value
null
The revision label
revisionNotes ​
The revision notes
revisionNum ​
- Type
- integer
- Default value
null
The revision number
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. |
| attach() | Attaches the behavior object to the component. |
| 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. |
| detach() | Detaches the behavior object from the component. |
| events() | Declares event handlers for the owner's events. |
| getCreator() | Returns the draft’s creator. |
| getRevisionLabel() | Returns the revision label. |
| getSource() | Returns the draft/revision’s source element. |
| getSourceId() | Returns the draft/revision's source element ID. |
| handleDelete() | Deletes the row in the drafts table after the draft element is deleted. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined. |
| init() | Initializes the object. |
| setCreator() | Sets the draft's creator. |
events() ​
Declares event handlers for the owner's events.
Child classes may override this method to declare what PHP callbacks should be attached to the events of the owner component.
The callbacks will be attached to the owner'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:
php
[
Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]Returns ​
array – Events (array keys) and the corresponding event handler methods (array values).
getRevisionLabel() ​
Returns the revision label.
Returns ​
handleDelete() ​
Deletes the row in the drafts table after the draft element is deleted.