Drafts

Type
Class
Namespace
craft\services
Inherits
craft\services\Drafts » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.2.0

Drafts service.

An instance of the Drafts service is globally accessible in Craft via Craft::$app->drafts.

View source

Public Properties

PropertyDescription
behaviorsyii\base\Behavior – List of behaviors attached to this component

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__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.
applyDraft()Applies a draft onto its source element.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
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.
createDraft()Creates a new draft for the given element.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getEditableDrafts()Returns drafts for a given element ID that the current user is allowed to edit
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named 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 existing event handler from this component.
on()Attaches an event handler to an event.
purgeUnsavedDrafts()Deletes any sourceless drafts that were never formally saved.
saveElementAsDraft()Saves an element as a draft.
trigger()Triggers an event.

applyDraft()

Applies a draft onto its source element.

View source

Arguments

Returns

craft\base\ElementInterface – The updated source element

Throws

createDraft()

Creates a new draft for the given element.

View source

Arguments

Returns

craft\base\ElementInterface – The new draft

Throws

getEditableDrafts()

Returns drafts for a given element ID that the current user is allowed to edit

View source

Arguments

Returns

craft\base\ElementInterface[]

purgeUnsavedDrafts()

Deletes any sourceless drafts that were never formally saved. This method will check the purgeUnsavedDraftsDuration config setting, and if it is set to a valid duration, it will delete any sourceless drafts that were created that duration ago, and have still not been formally saved.

View source

saveElementAsDraft()

Saves an element as a draft.

View source

Arguments

Returns

boolean

Throws

Events

EVENT_AFTER_APPLY_DRAFT

Type
craft\events\DraftEvent

The event that is triggered after a draft is applied to its source element.

EVENT_AFTER_CREATE_DRAFT

Type
craft\events\DraftEvent

The event that is triggered after a draft is created.

EVENT_BEFORE_APPLY_DRAFT

Type
craft\events\DraftEvent

The event that is triggered before a draft is applied to its source element.

EVENT_BEFORE_CREATE_DRAFT

Type
craft\events\DraftEvent

The event that is triggered before a draft is created.