Revisions

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

Revisions service.

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

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.
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.
createRevision()Creates a new revision 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.
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.
revertToRevision()Reverts an element to a revision, and creates a new revision for the element.
trigger()Triggers an event.

createRevision()

Creates a new revision for the given element. If the element appears to have not changed since its last revision, its last revision will be returned instead.

View source

Arguments

  • $source (craft\base\ElementInterface) – The element to create a revision for
  • $creatorId (integer, null) – The user ID that the revision should be attributed to
  • $notes (string, null) – The revision notes
  • $newAttributes (array) – Any attributes to apply to the draft
  • $force (boolean) – Whether to force a new revision even if the element doesn't appear to have changed since the last revision

Returns

craft\base\ElementInterface – The new revision

Throws

revertToRevision()

Reverts an element to a revision, and creates a new revision for the element.

View source

Arguments

  • $revision (craft\base\ElementInterface) – The revision whose source element should be reverted to
  • $creatorId (integer) – The user ID that the new revision should be attributed to

Returns

craft\base\ElementInterface – The new source element

Throws

Events

EVENT_AFTER_CREATE_REVISION

Type
\craft\services\DraftEvent

The event that is triggered after a revision is created.

EVENT_AFTER_REVERT_TO_REVISION

Type
\craft\services\DraftEvent

The event that is triggered after an element is reverted to a revision.

EVENT_BEFORE_CREATE_REVISION

Type
\craft\services\DraftEvent

The event that is triggered before a revision is created.

EVENT_BEFORE_REVERT_TO_REVISION

Type
\craft\services\DraftEvent

The event that is triggered before an element is reverted to a revision.