Trait RevisionableTrait

Direct Known Users

Charcoal\Object\Content

Indirect Known Users

Charcoal\User\AbstractUser, Charcoal\User\Acl\PermissionCategory, Charcoal\User\GenericUser

Namespace: Charcoal\Object
Located at Charcoal/Object/RevisionableTrait.php

Methods summary
`public Charcoal\Object\RevisionableInterface`	# `setRevisionEnabled( boolean $enabled )` Parameters `$enabled` The (revision) enabled flag. Returns `Charcoal\Object\RevisionableInterface` Chainable
`public boolean`	# `revisionEnabled( )` Returns boolean
`public Charcoal\Object\ObjectRevisionInterface`	# `createRevisionObject( )` Create a revision object. Create a revision object. Returns `Charcoal\Object\ObjectRevisionInterface`
`protected AbstractPropertyDisplay`	# `setObjectRevisionClass( string $className )` Set the class name of the object revision model. Set the class name of the object revision model. Parameters `$className` The class name of the object revision model. Returns AbstractPropertyDisplay Chainable Throws InvalidArgumentException If the class name is not a string.
`public string`	# `objectRevisionClass( )` Retrieve the class name of the object revision model. Retrieve the class name of the object revision model. Returns string
`public Charcoal\Object\ObjectRevision`	# `generateRevision( )` Returns `Charcoal\Object\ObjectRevision` See \Charcoal\Object\ObjectRevision::create_fromObject()
`public Charcoal\Object\ObjectRevision`	# `latestRevision( )` Returns `Charcoal\Object\ObjectRevision` See \Charcoal\Object\ObejctRevision::lastObjectRevision
`public Charcoal\Object\ObjectRevision`	# `revisionNum( integer $revNum )` Parameters `$revNum` The revision number. Returns `Charcoal\Object\ObjectRevision` See \Charcoal\Object\ObejctRevision::objectRevisionNum
`public array`	# `allRevisions( callable $callback = null )` Retrieves all revisions for the current objet Retrieves all revisions for the current objet Parameters `$callback` Optional object callback. Returns array
`public boolean`	# `revertToRevision( integer $revNum )` Parameters `$revNum` The revision number to revert to. Returns boolean Success / Failure. Throws InvalidArgumentException If revision number is invalid.
`abstract public Charcoal\Factory\FactoryInterface`	# `modelFactory( )` Retrieve the object model factory. Retrieve the object model factory. Returns Charcoal\Factory\FactoryInterface

Properties summary
`protected boolean`	`$revisionEnabled` $revisionEnabled $revisionEnabled	# `true`