\Charcoal\ObjectObjectScheduleInterface

Summary

Methods
Constants
setTargetType()
targetType()
setTargetId()
targetId()
setScheduledDate()
scheduledDate()
setDataDiff()
dataDiff()
setProcessedDate()
processedDate()
process()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

setTargetType()

setTargetType(string  $targetType) : \Charcoal\Object\ObjectScheduleInterface

Parameters

string $targetType

The object type (type-ident).

Returns

\Charcoal\Object\ObjectScheduleInterface

Chainable

targetType()

targetType() : string

Returns

string

targetId()

targetId() : mixed

Returns

mixed

setScheduledDate()

setScheduledDate(null|string|\Charcoal\Object\DateTimeInterface  $ts) : \Charcoal\Object\ObjectScheduleInterface

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

Parameters

null|string|\Charcoal\Object\DateTimeInterface $ts

A date/time string or object.

Throws

\Charcoal\Object\InvalidArgumentException

If the date/time is invalid.

Returns

\Charcoal\Object\ObjectScheduleInterface

Chainable

scheduledDate()

scheduledDate() : null|\DateTimeInterface

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

Returns

null|\DateTimeInterface

dataDiff()

dataDiff() : array

Returns

array

setProcessedDate()

setProcessedDate(null|string|\Charcoal\Object\DateTimeInterface  $ts) : \Charcoal\Object\ObjectScheduleInterface

Set the date/time the item was processed at.

Parameters

null|string|\Charcoal\Object\DateTimeInterface $ts

A date/time string or object.

Throws

\Charcoal\Object\InvalidArgumentException

If the date/time is invalid.

Returns

\Charcoal\Object\ObjectScheduleInterface

Chainable

processedDate()

processedDate() : null|\DateTimeInterface

Retrieve the date/time the item was processed at.

Returns

null|\DateTimeInterface

process()

process(callable  $callback = null, callable  $successCallback = null, callable  $failureCallback = null) : boolean

Process the item.

Parameters

callable $callback

An optional callback routine executed after the item is processed.

callable $successCallback

An optional callback routine executed when the item is resolved.

callable $failureCallback

An optional callback routine executed when the item is rejected.

Returns

boolean —

Success / Failure