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

Class Content

Charcoal\Model\AbstractModel
Extended by Charcoal\Object\Content implements Charcoal\Object\ContentInterface, Charcoal\Object\RevisionableInterface uses Charcoal\Object\RevisionableTrait

Direct known subclasses

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

Indirect known subclasses

Charcoal\User\GenericUser
Namespace: Charcoal\Object
Located at Charcoal/Object/Content.php
Methods summary
public
# setDependencies( Pimple\Container $container )

Dependencies

Dependencies

Parameters

$container
DI Container.
protected AdminScript
# setModelFactory( Charcoal\Factory\FactoryInterface $factory )

Parameters

$factory
The factory used to create models.

Returns

AdminScript
Chainable
protected Charcoal\Factory\FactoryInterface
# modelFactory( )

Returns

Charcoal\Factory\FactoryInterface
The model factory.
public Charcoal\Object\Content
# setActive( boolean $active )

Parameters

$active
The active flag.

Returns

Charcoal\Object\Content
Chainable

Implementation of

Charcoal\Object\ContentInterface::setActive()
public boolean
# active( )

Returns

boolean

Implementation of

Charcoal\Object\ContentInterface::active()
public Charcoal\Object\Content
# setPosition( integer $position )

Parameters

$position
The position (for ordering purpose).

Returns

Charcoal\Object\Content
Chainable

Throws

InvalidArgumentException
If the position is not an integer (or numeric integer string).

Implementation of

Charcoal\Object\ContentInterface::setPosition()
public integer
# position( )

Returns

integer

Implementation of

Charcoal\Object\ContentInterface::position()
public Charcoal\Object\Content
# setCreated( DateTimeInterface|string|null $created )

Parameters

$created
The date/time at object's creation.

Returns

Charcoal\Object\Content
Chainable

Throws

InvalidArgumentException
If the date/time is invalid.

Implementation of

Charcoal\Object\ContentInterface::setCreated()
public DateTimeInterface|null
# created( )

Returns

DateTimeInterface|null

Implementation of

Charcoal\Object\ContentInterface::created()
public Charcoal\Object\Content
# setCreatedBy( mixed $createdBy )

Parameters

$createdBy
The creator of the content object.

Returns

Charcoal\Object\Content
Chainable

Implementation of

Charcoal\Object\ContentInterface::setCreatedBy()
public mixed
# createdBy( )

Returns

mixed

Implementation of

Charcoal\Object\ContentInterface::createdBy()
public Charcoal\Object\Content
# setLastModified( DateTimeInterface|string|null $lastModified )

Parameters

$lastModified
The last modified date/time.

Returns

Charcoal\Object\Content
Chainable

Throws

InvalidArgumentException
If the date/time is invalid.

Implementation of

Charcoal\Object\ContentInterface::setLastModified()
public DateTimeInterface
# lastModified( )

Returns

DateTimeInterface

Implementation of

Charcoal\Object\ContentInterface::lastModified()
public Charcoal\Object\Content
# setLastModifiedBy( mixed $lastModifiedBy )

Parameters

$lastModifiedBy
The last modification's username.

Returns

Charcoal\Object\Content
Chainable

Implementation of

Charcoal\Object\ContentInterface::setLastModifiedBy()
public mixed
# lastModifiedBy( )

Returns

mixed

Implementation of

Charcoal\Object\ContentInterface::lastModifiedBy()
public boolean
# preSave( )

StorableTrait > preSavÆ’e(): Called automatically before saving the object to source. For content object, set the created and lastModified properties automatically

StorableTrait > preSavÆ’e(): Called automatically before saving the object to source. For content object, set the created and lastModified properties automatically

Returns

boolean
public boolean
# preUpdate( array $properties = null )

StorableTrait > preUpdate(): Called automatically before updating the object to source. For content object, set the lastModified property automatically.

StorableTrait > preUpdate(): Called automatically before updating the object to source. For content object, set the lastModified property automatically.

Parameters

$properties
The properties (ident) set for update.

Returns

boolean
Methods inherited from Charcoal\Object\RevisionableInterface
allRevisions(), createRevisionObject(), generateRevision(), latestRevision(), objectRevisionClass(), revertToRevision(), revisionEnabled(), revisionNum(), setRevisionEnabled()
Methods used from Charcoal\Object\RevisionableTrait
allRevisions(), createRevisionObject(), generateRevision(), latestRevision(), objectRevisionClass(), revertToRevision(), revisionEnabled(), revisionNum(), setObjectRevisionClass(), setRevisionEnabled()
Properties used from Charcoal\Object\RevisionableTrait
$revisionEnabled
API documentation generated by ApiGen