EntryRevisionsService

Type
Class
Namespace
Craft
Inherits
Craft\EntryRevisionsService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.0

Class EntryRevisionsService

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
deleteDraft()Deletes a draft by it's model.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()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()Returns the list of attached event handlers for an event.
getIsInitialized()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()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()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()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

Arguments

Signature

public void deleteDraft ( Craft\EntryDraftModel $draft )

getDraftById()

Returns a draft by its ID.

View source

Arguments

Returns

Craft\EntryDraftModel, null

Signature

public Craft\EntryDraftModel, null getDraftById ( $draftId )

getDraftByOffset()

DEPRECATED

Deprecated Deprecated in 2.1.

Returns a draft by its offset.

View source

Arguments

Returns

Craft\EntryDraftModel, null

Signature

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

getDraftsByEntryId()

Returns drafts of a given entry.

View source

Arguments

Returns

array

Signature

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

getEditableDraftsByEntryId()

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

View source

Arguments

Returns

array

Signature

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

getVersionById()

Returns a version by its ID.

View source

Arguments

Returns

Craft\EntryDraftModel, null

Signature

public Craft\EntryDraftModel, null getVersionById ( $versionId )

getVersionByOffset()

DEPRECATED

Deprecated Deprecated in 2.1.

Returns a version by its offset.

View source

Arguments

Returns

Craft\EntryVersionModel, null

Signature

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

getVersionsByEntryId()

Returns versions by an entry ID.

View source

Arguments

  • $entryId (integer) – The entry ID to search for.
  • $localeId (string) – The locale ID to search for.
  • $limit (integer, null) – The limit on the number of versions to retrieve.
  • $includeCurrent (boolean) – Whether to include the current "top" version of the entry.

Returns

array

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

Arguments

Returns

null

Signature

public null onAfterDeleteDraft ( Craft\Event $event )

onBeforeDeleteDraft()

Fires an 'onBeforeDeleteDraft' event.

View source

Arguments

Returns

null

Signature

public null onBeforeDeleteDraft ( Craft\Event $event )

onDeleteDraft()

Fires an 'onDeleteDraft' event.

View source

Arguments

Returns

null

Signature

public null onDeleteDraft ( Craft\Event $event )

onPublishDraft()

Fires an 'onPublishDraft' event.

View source

Arguments

Returns

null

Signature

public null onPublishDraft ( Craft\Event $event )

onRevertEntryToVersion()

Fires an 'onRevertEntryToVersion' event.

View source

Arguments

Returns

null

Signature

public null onRevertEntryToVersion ( Craft\Event $event )

onSaveDraft()

Fires an 'onSaveDraft' event.

View source

Arguments

Returns

null

Signature

public null onSaveDraft ( Craft\Event $event )

publishDraft()

Publishes a draft.

View source

Arguments

Returns

boolean

Signature

public boolean publishDraft ( Craft\EntryDraftModel $draft )

revertEntryToVersion()

Reverts an entry to a version.

View source

Arguments

Returns

boolean

Signature

public boolean revertEntryToVersion ( Craft\EntryVersionModel $version )

saveDraft()

Saves a draft.

View source

Arguments

Returns

boolean

Signature

public boolean saveDraft ( Craft\EntryDraftModel $draft )

saveVersion()

Saves a new version.

View source

Arguments

Returns

boolean

Signature

public boolean saveVersion ( Craft\EntryModel $entry )