ArrayTransformer
This class is responsible for transforming a Rule in to an array of \DateTimeInterface objects.
If a recurrence rule is infinitely recurring, a virtual limit is imposed.
Table of Contents
Methods
- __construct() : mixed
- Construct a new ArrayTransformer
- setConfig() : mixed
- transform() : array<string|int, Recurrence>
- Transform a Rule in to an array of \DateTimeInterface objects
Methods
__construct()
Construct a new ArrayTransformer
public
__construct([ArrayTransformerConfig $config = null ]) : mixed
Parameters
- $config : ArrayTransformerConfig = null
setConfig()
public
setConfig(ArrayTransformerConfig $config) : mixed
Parameters
- $config : ArrayTransformerConfig
transform()
Transform a Rule in to an array of \DateTimeInterface objects
public
transform(Rule $rule[, ConstraintInterface|null $constraint = null ][, bool $countConstraintFailures = true ]) : array<string|int, Recurrence>
Parameters
- $rule : Rule
-
the Rule object
- $constraint : ConstraintInterface|null = null
-
Potential recurrences must pass the constraint, else they will not be included in the returned collection.
- $countConstraintFailures : bool = true
-
Whether recurrences that fail the constraint's test should count towards a rule's COUNT limit.