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

Trait PublishableTrait

A full implementation, as trait, of the PublishableInterface.

Namespace: Charcoal\Object
Located at Charcoal/Object/PublishableTrait.php
Methods summary
public Charcoal\Object\PublishableInterface
# setPublishDate( string|DateTimeInterface|null $publishDate )

Parameters

$publishDate
The publishing date.

Returns

Charcoal\Object\PublishableInterface
Chainable

Throws

InvalidArgumentException
If the date/time is invalid.
public DateTimeInterface|null
# publishDate( )

Returns

DateTimeInterface|null
public Charcoal\Object\PublishableInterface
# setExpiryDate( string|DateTimeInterface|null $expiryDate )

Parameters

$expiryDate
The expiry date.

Returns

Charcoal\Object\PublishableInterface
Chainable

Throws

InvalidArgumentException
If the date/time is invalid.
public DateTimeInterface|null
# expiryDate( )

Returns

DateTimeInterface|null
public Charcoal\Object\PublishableInterface
# setPublishStatus( string $status )

Parameters

$status
The publish status (draft, pending or published).

Returns

Charcoal\Object\PublishableInterface
Chainable

Throws

InvalidArgumentException
If the status is not one of the 3 valid status.
public string
# publishStatus( )

Get the object's publish status.

Get the object's publish status.

Status can be: - draft - pending - published - upcoming - expired

Note that the upcoming and expired status are specialized status when the object is set to published but the publishDate or expiryDate do not match.

Returns

string
public boolean
# isPublished( )

Returns

boolean
Properties summary
protected DateTimeInterface $publishDate

$publishDate

$publishDate

#
protected DateTimeInterface $expiryDate

$expiryDate

$expiryDate

#
protected string $publishStatus

$publishStatus

$publishStatus

#
API documentation generated by ApiGen