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 ObjectScheduleInterface

Direct known implementers

Charcoal\Object\ObjectSchedule
Namespace: Charcoal\Object
Located at Charcoal/Object/ObjectScheduleInterface.php
Methods summary
public Charcoal\Object\ObjectScheduleInterface
# setTargetType( string $targetType )

Parameters

$targetType
The object type (type-ident).

Returns

Charcoal\Object\ObjectScheduleInterface
Chainable
public string
# targetType( )

Returns

string
public Charcoal\Object\ObjectScheduleInterface
# setTargetId( mixed $targetId )

Parameters

$targetId
The object ID.

Returns

Charcoal\Object\ObjectScheduleInterface
Chainable
public mixed
# targetId( )

Returns

mixed
public Charcoal\Object\ObjectScheduleInterface
# setScheduledDate( null|string|DateTimeInterface $ts )

Set the date/time the item should be processed at.

Set the date/time the item should be processed at.

Parameters

$ts
A date/time string or object.

Returns

Charcoal\Object\ObjectScheduleInterface
Chainable

Throws

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

Retrieve the date/time the item should be processed at.

Retrieve the date/time the item should be processed at.

Returns

null|DateTimeInterface
public Charcoal\Object\ObjectScheduleInterface
# setDataDiff( array|string $data )

Parameters

$data
The data diff.

Returns

Charcoal\Object\ObjectScheduleInterface
Chainable
public array
# dataDiff( )

Returns

array
public Charcoal\Object\ObjectScheduleInterface
# setProcessedDate( null|string|DateTimeInterface $ts )

Set the date/time the item was processed at.

Set the date/time the item was processed at.

Parameters

$ts
A date/time string or object.

Returns

Charcoal\Object\ObjectScheduleInterface
Chainable

Throws

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

Retrieve the date/time the item was processed at.

Retrieve the date/time the item was processed at.

Returns

null|DateTimeInterface
public boolean
# process( callable $callback = null, callable $successCallback = null, callable $failureCallback = null )

Process the item.

Process the item.

Parameters

$callback
An optional callback routine executed after the item is processed.
$successCallback
An optional callback routine executed when the item is resolved.
$failureCallback
An optional callback routine executed when the item is rejected.

Returns

boolean
Success / Failure
API documentation generated by ApiGen