Methods summary
public
Charcoal\Object\ObjectScheduleInterface
|
#
setTargetType( string $targetType )
Parameters
- $targetType
- The object type (type-ident).
Returns
|
public
string
|
|
public
Charcoal\Object\ObjectScheduleInterface
|
|
public
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
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
|
|
public
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
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.
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
|