DraftBehavior
- Type
- Class
- Namespace
- craft\behaviors
- Inherits
- craft\behaviors\DraftBehavior » yii\base\Behavior » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.2.0
DraftBehavior is applied to element drafts.
Public Properties
| Property | Description |
|---|---|
| creator | craft\elements\User, null |
| creatorId | integer, null – The draft creator’s ID |
| draftName | string – The draft name |
| draftNotes | string, null – The draft notes |
| owner | yii\base\Component, null – The owner of this behavior |
| source | craft\base\ElementInterface, null |
| sourceId | integer, null – The source element’s ID |
creator
- Type
- craft\elements\User, null
- Access
- Read-only
creatorId
The draft creator’s ID
draftName
- Type
- string
- Access
- Read-only
The draft name
draftNotes
The draft notes
source
- Type
- craft\base\ElementInterface, null
- Access
- Read-only
sourceId
The source element’s ID
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. |
| getDraftName() | Returns the draft’s name. |
| getSource() | Returns the draft’s source element. |
| handleDelete() | Deletes the row in the drafts table after the draft element is deleted. |
| handleSave() | Updates the row in the drafts table after the draft element is saved. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined. |
| init() | Initializes the object. |
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:
[
Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
Returns
array – Events (array keys) and the corresponding event handler methods (array values).
getCreator()
Returns the draft’s creator.
Returns
getDraftName()
- Since
- 3.3.17
Returns the draft’s name.
Returns
getSource()
DEPRECATED
Deprecated in 3.2.9. Use craft\base\ElementInterface::getSource() instead.
Returns the draft’s source element.
Returns
craft\base\ElementInterface, null
handleDelete()
Deletes the row in the drafts table after the draft element is deleted.
handleSave()
Updates the row in the drafts table after the draft element is saved.