Revisions

Type
Class
Namespace
craft\services
Inherits
craft\services\Revisions » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
3.2.0

Revisions service.

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

View source (opens new window)

# Public Properties

Property Description
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone() (opens new window) This method is called after the object is created by cloning an existing one.
__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.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
behaviors() (opens new window) Returns a list of behaviors that this component should behave as.
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.
createRevision() Creates a new revision for the given element.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
hasEventHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
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.
off() (opens new window) Detaches an existing event handler from this component.
on() (opens new window) Attaches an event handler to an event.
revertToRevision() Reverts an element to a revision, and creates a new revision for the element.
trigger() (opens new window) 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 (opens new window)

Arguments

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 (opens new window)

Arguments

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.