EntryRevisions

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

Entry Revisions service.

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

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.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
doesEntryHaveVersions() Returns whether an entry has any versions stored.
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.
getDraftById() Returns a draft by its ID.
getDraftsByEntryId() Returns drafts of a given entry.
getEditableDraftsByEntryId() Returns the drafts of a given entry that are editable by the current user.
getVersionById() Returns a version by its ID.
getVersionsByEntryId() Returns versions by an entry ID.
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.
trigger() (opens new window) Triggers an event.

# doesEntryHaveVersions()

DEPRECATED

Deprecated in 3.2.0. Use an entry query instead.

Returns whether an entry has any versions stored.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# getDraftById()

DEPRECATED

Deprecated in 3.2.0. Use an entry query instead.

Returns a draft by its ID.

View source (opens new window)

Arguments

Returns

craft\elements\Entry, null (opens new window)

# getDraftsByEntryId()

DEPRECATED

Deprecated in 3.2.0. Use an entry query instead.

Returns drafts of a given entry.

View source (opens new window)

Arguments

Returns

craft\elements\Entry[]

# getEditableDraftsByEntryId()

DEPRECATED

Deprecated in 3.2.0. Use craft\services\Drafts::getEditableDrafts() instead.

Returns the drafts of a given entry that are editable by the current user.

View source (opens new window)

Arguments

Returns

craft\elements\Entry[]

Throws

# getVersionById()

DEPRECATED

Deprecated in 3.2.0. Use an entry query instead.

Returns a version by its ID.

View source (opens new window)

Arguments

Returns

craft\elements\Entry, null (opens new window)

# getVersionsByEntryId()

DEPRECATED

Deprecated in 3.2.0. Use an entry query instead.

Returns versions by an entry ID.

View source (opens new window)

Arguments

Returns

craft\elements\Entry[]

# Events

# EVENT_AFTER_DELETE_DRAFT

DEPRECATED

Deprecated in 3.2.0

Type
\craft\services\DraftEvent

The event that is triggered after a draft is deleted.

# EVENT_AFTER_PUBLISH_DRAFT

DEPRECATED

Deprecated in 3.2.0

Type
\craft\services\DraftEvent

The event that is triggered after a draft is published.

# EVENT_AFTER_REVERT_ENTRY_TO_VERSION

DEPRECATED

Deprecated in 3.2.0

Type
\craft\services\VersionEvent

The event that is triggered after an entry is reverted to an old version.

# EVENT_AFTER_SAVE_DRAFT

DEPRECATED

Deprecated in 3.2.0

Type
\craft\services\DraftEvent

The event that is triggered after a draft is saved.

# EVENT_BEFORE_DELETE_DRAFT

DEPRECATED

Deprecated in 3.2.0

Type
\craft\services\DraftEvent

The event that is triggered before a draft is deleted.

# EVENT_BEFORE_PUBLISH_DRAFT

DEPRECATED

Deprecated in 3.2.0

Type
\craft\services\DraftEvent

The event that is triggered before a draft is published.

# EVENT_BEFORE_REVERT_ENTRY_TO_VERSION

DEPRECATED

Deprecated in 3.2.0

Type
\craft\services\VersionEvent

The event that is triggered before an entry is reverted to an old version.

# EVENT_BEFORE_SAVE_DRAFT

DEPRECATED

Deprecated in 3.2.0

Type
\craft\services\DraftEvent

The event that is triggered before a draft is saved.