\Charcoal\ObjectRevisionableInterface

Summary

Methods

Constants

setRevisionEnabled()
revisionEnabled()
createRevisionObject()
objectRevisionClass()
generateRevision()
latestRevision()
revisionNum()
allRevisions()
revertToRevision()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

setRevisionEnabled()

setRevisionEnabled(boolean  $enabled) : \Charcoal\Object\RevisionableInterface

Parameters

boolean

$enabled

The (revision) enabled flag.

Returns

\Charcoal\Object\RevisionableInterface —

Chainable

revisionEnabled()

revisionEnabled() : boolean

Returns

boolean

createRevisionObject()

createRevisionObject() : \Charcoal\Object\ObjectRevisionInterface

Create a revision object.

Returns

\Charcoal\Object\ObjectRevisionInterface

objectRevisionClass()

objectRevisionClass() : string

Retrieve the class name of the object revision model.

Returns

string

generateRevision()

generateRevision() : \Charcoal\Object\ObjectRevisionInterface

Returns

\Charcoal\Object\ObjectRevisionInterface

latestRevision()

latestRevision() : \Charcoal\Object\ObjectRevisionInterface

Returns

\Charcoal\Object\ObjectRevisionInterface

revisionNum()

revisionNum(integer  $revNum) : \Charcoal\Object\ObjectRevisionInterface

Parameters

integer

$revNum

The revision number to retrieve.

Returns

\Charcoal\Object\ObjectRevisionInterface

allRevisions()

allRevisions() : array

Returns

array

revertToRevision()

revertToRevision(integer  $revNum) : boolean

Parameters

integer

$revNum

The revision number to revert to.

Returns

boolean —

Success / Failure.