EntryRevisionsService

Type
Class
Namespace
Craft
Inherits
Craft\EntryRevisionsService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
Implements
IApplicationComponent
Since
1.0

Class EntryRevisionsService

See also http://craftcms.com

View source (opens new window)

# Public Properties

Property Description
$behaviors (opens new window) array (opens new window) – The behaviors that should be attached to this component.

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__get() (opens new window) Returns a property value, an event handler list or a behavior based on its name.
__isset() (opens new window) Checks if a property value is null.
__set() (opens new window) Sets value of a component property.
__unset() (opens new window) Sets a component property to be null.
asa() (opens new window) Returns the named behavior object.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attachEventHandler() (opens new window) Attaches an event handler to an event.
canGetProperty() (opens new window) Determines whether a property can be read.
canSetProperty() (opens new window) Determines whether a property can be set.
deleteDraft() Deletes a draft by it's model.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
detachEventHandler() (opens new window) Detaches an existing event handler.
disableBehavior() (opens new window) Disables an attached behavior.
disableBehaviors() (opens new window) Disables all behaviors attached to this component.
enableBehavior() (opens new window) Enables an attached behavior.
enableBehaviors() (opens new window) Enables all behaviors attached to this component.
evaluateExpression() (opens new window) Evaluates a PHP expression or callback under the context of this component.
getDraftById() Returns a draft by its ID.
getDraftByOffset() Returns a draft by its offset.
getDraftsByEntryId() Returns drafts of a given entry.
getEditableDraftsByEntryId() Returns the drafts of a given entry that are editable by the current user.
getEventHandlers() (opens new window) Returns the list of attached event handlers for an event.
getIsInitialized() (opens new window) Checks if this application component has been initialized.
getVersionById() Returns a version by its ID.
getVersionByOffset() Returns a version by its offset.
getVersionsByEntryId() Returns versions by an entry ID.
hasEvent() (opens new window) Determines whether an event is defined.
hasEventHandler() (opens new window) Checks whether the named event has attached handlers.
hasProperty() (opens new window) Determines whether a property is defined.
init() (opens new window) Initializes the application component.
isInitialized() Checks if this application component has been initialized yet, or not.
onAfterDeleteDraft() Fires an 'onAfterDeleteDraft' event.
onBeforeDeleteDraft() Fires an 'onBeforeDeleteDraft' event.
onDeleteDraft() Fires an 'onDeleteDraft' event.
onPublishDraft() Fires an 'onPublishDraft' event.
onRevertEntryToVersion() Fires an 'onRevertEntryToVersion' event.
onSaveDraft() Fires an 'onSaveDraft' event.
publishDraft() Publishes a draft.
raiseEvent() (opens new window) Raises an event.
revertEntryToVersion() Reverts an entry to a version.
saveDraft() Saves a draft.
saveVersion() Saves a new version.

# deleteDraft()

Deletes a draft by it's model.

View source (opens new window)

Arguments

Signature

public void deleteDraft ( Craft\EntryDraftModel $draft )

# getDraftById()

Signature

public Craft\EntryDraftModel, null getDraftById ( $draftId )

# getDraftByOffset()

DEPRECATED

Deprecated Deprecated in 2.1.

Returns a draft by its offset.

View source (opens new window)

Arguments

Returns

Craft\EntryDraftModel, null (opens new window)

Signature

public Craft\EntryDraftModel, null getDraftByOffset ( $entryId, $offset = 0 )

# getDraftsByEntryId()

Returns drafts of a given entry.

View source (opens new window)

Arguments

Returns

array (opens new window)

Signature

public array getDraftsByEntryId ( $entryId, $localeId = null )

# getEditableDraftsByEntryId()

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

View source (opens new window)

Arguments

Returns

array (opens new window)

Signature

public array getEditableDraftsByEntryId ( $entryId, $localeId = null )

# getVersionById()

Signature

public Craft\EntryDraftModel, null getVersionById ( $versionId )

# getVersionByOffset()

DEPRECATED

Deprecated Deprecated in 2.1.

Returns a version by its offset.

View source (opens new window)

Arguments

Returns

Craft\EntryVersionModel, null (opens new window)

Signature

public Craft\EntryVersionModel, null getVersionByOffset ( $entryId, $offset = 0 )

# getVersionsByEntryId()

Returns versions by an entry ID.

View source (opens new window)

Arguments

Returns

array (opens new window)

Signature

public array getVersionsByEntryId ( $entryId, $localeId, $limit = null, $includeCurrent = false )

# onAfterDeleteDraft()

DEPRECATED

Deprecated Deprecated in 2.3. Use {@link onDeleteDraft() entryRevisions.onDeleteDraft} instead.

Fires an 'onAfterDeleteDraft' event.

View source (opens new window)

Arguments

Returns

null (opens new window)

Signature

public null onAfterDeleteDraft ( Craft\Event $event )

# onBeforeDeleteDraft()

Fires an 'onBeforeDeleteDraft' event.

View source (opens new window)

Arguments

Returns

null (opens new window)

Signature

public null onBeforeDeleteDraft ( Craft\Event $event )

# onDeleteDraft()

Fires an 'onDeleteDraft' event.

View source (opens new window)

Arguments

Returns

null (opens new window)

Signature

public null onDeleteDraft ( Craft\Event $event )

# onPublishDraft()

Fires an 'onPublishDraft' event.

View source (opens new window)

Arguments

Returns

null (opens new window)

Signature

public null onPublishDraft ( Craft\Event $event )

# onRevertEntryToVersion()

Fires an 'onRevertEntryToVersion' event.

View source (opens new window)

Arguments

Returns

null (opens new window)

Signature

public null onRevertEntryToVersion ( Craft\Event $event )

# onSaveDraft()

Fires an 'onSaveDraft' event.

View source (opens new window)

Arguments

Returns

null (opens new window)

Signature

public null onSaveDraft ( Craft\Event $event )

# publishDraft()

Signature

public boolean publishDraft ( Craft\EntryDraftModel $draft )

# revertEntryToVersion()

Reverts an entry to a version.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Signature

public boolean revertEntryToVersion ( Craft\EntryVersionModel $version )

# saveDraft()

Signature

public boolean saveDraft ( Craft\EntryDraftModel $draft )

# saveVersion()

Saves a new version.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Signature

public boolean saveVersion ( Craft\EntryModel $entry )