Overview

Namespaces

  • Charcoal
    • Object
    • User
      • Acl

Classes

  • Content
  • ObjectRevision
  • ObjectRoute
  • ObjectSchedule
  • UserData

Interfaces

  • ArchivableInterface
  • CategorizableInterface
  • CategorizableMultipleInterface
  • CategoryInterface
  • ContentInterface
  • HierarchicalInterface
  • ObjectRevisionInterface
  • ObjectRouteInterface
  • ObjectScheduleInterface
  • PublishableInterface
  • RevisionableInterface
  • RoutableInterface
  • UserDataInterface

Traits

  • ArchivableTrait
  • CategorizableMultipleTrait
  • CategorizableTrait
  • CategoryTrait
  • HierarchicalTrait
  • PublishableTrait
  • RevisionableTrait
  • RoutableTrait
  • Overview
  • Namespace
  • Class

Interface RevisionableInterface

Direct known implementers

Charcoal\Object\Content

Indirect known implementers

Charcoal\User\AbstractUser, Charcoal\User\Acl\PermissionCategory, Charcoal\User\GenericUser
Namespace: Charcoal\Object
Located at Charcoal/Object/RevisionableInterface.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
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\ObjectRevisionInterface
# generateRevision( )

Returns

Charcoal\Object\ObjectRevisionInterface
public Charcoal\Object\ObjectRevisionInterface
# latestRevision( )

Returns

Charcoal\Object\ObjectRevisionInterface
public Charcoal\Object\ObjectRevisionInterface
# revisionNum( integer $revNum )

Parameters

$revNum
The revision number to retrieve.

Returns

Charcoal\Object\ObjectRevisionInterface

See

\Charcoal\Object\ObejctRevision::objectRevisionNum
public array
# allRevisions( )

Returns

array
public boolean
# revertToRevision( integer $revNum )

Parameters

$revNum
The revision number to revert to.

Returns

boolean
Success / Failure.
API documentation generated by ApiGen