CronjobCollection
in package
implements
IteratorAggregate
Class CronjobCollection
Interfaces, Classes and Traits
- IteratorAggregate
Table of Contents
- $cronjobs : array<string|int, CronjobInterface>
- $meta : CronjobMetaInterface
- __construct() : mixed
- CronjobCollection constructor.
- collect() : CronjobCollection
- Named constructor of cronjob collection.
- getIterator() : ArrayIterator|Traversable
- Returns an array iterator of the collected cronjobs, so instances are iterable.
- getMeta() : CronjobMetaInterface
- Returns meta data about cronjobs.
- toArray() : array<string|int, mixed>
- Returns the array representation of collected cronjobs.
Properties
$cronjobs
protected
array<string|int, CronjobInterface>
$cronjobs
$meta
protected
CronjobMetaInterface
$meta
Methods
__construct()
CronjobCollection constructor.
public
__construct(CronjobMetaInterface $meta, CronjobInterface ...$cronjobs) : mixed
Parameters
- $meta : CronjobMetaInterface
-
Meta data for cronjobs.
- $cronjobs : CronjobInterface
-
Cronjobs to be collected.
Return values
mixed —collect()
Named constructor of cronjob collection.
public
static collect(CronjobMetaInterface $meta, CronjobInterface ...$cronjobs) : CronjobCollection
Parameters
- $meta : CronjobMetaInterface
-
Meta data for cronjobs.
- $cronjobs : CronjobInterface
-
Cronjobs to be collected.
Return values
CronjobCollection —New instance.
getIterator()
Returns an array iterator of the collected cronjobs, so instances are iterable.
public
getIterator() : ArrayIterator|Traversable
Return values
ArrayIterator|Traversable —getMeta()
Returns meta data about cronjobs.
public
getMeta() : CronjobMetaInterface
Return values
CronjobMetaInterface —toArray()
Returns the array representation of collected cronjobs.
public
toArray(ExistingDirectory $cacheDir) : array<string|int, mixed>
Parameters
- $cacheDir : ExistingDirectory