Recur property.
This object represents RECUR properties.
These values are just used for RRULE and the now deprecated EXRULE.
The RRULE property may look something like this:
RRULE:FREQ=MONTHLY;BYDAY=1,2,3;BYHOUR=5.
This property exposes this as a key=>value array that is accessible using
getParts, and may be set using setParts.
| Methods |
public
|
setValue(string|array $value)
Updates the current value.
Updates the current value.
This may be either a single, or multiple strings in an array.
Overrides
|
#
|
public
|
getValue(): string
Returns the current value.
Returns the current value.
This method will always return a singular value. If this was a
multi-value object, some decision will be made first on how to represent
it as a string.
To get the correct multi-value version, use getParts.
Overrides
|
#
|
public
|
setParts(array $parts)
Sets a multi-valued property.
Sets a multi-valued property.
Overrides
|
#
|
public
|
getParts(): array
Returns a multi-valued property.
Returns a multi-valued property.
This method always returns an array, if there was only a single value,
it will still be wrapped in an array.
Overrides
|
#
|
public
|
setRawMimeDirValue(string $val)
Sets a raw value coming from a mimedir (iCalendar/vCard) file.
Sets a raw value coming from a mimedir (iCalendar/vCard) file.
This has been 'unfolded', so only 1 line will be passed. Unescaping is
not yet done, but parameters are not included.
Implements
|
#
|
public
|
getRawMimeDirValue(): string
Returns a raw mime-dir representation of the value.
Returns a raw mime-dir representation of the value.
Implements
|
#
|
public
|
getValueType(): string
Returns the type of value.
Returns the type of value.
This corresponds to the VALUE= parameter. Every property also has a
'default' valueType.
Implements
|
#
|
public
|
getJsonValue(): array
Returns the value, in the format it should be encoded for json.
Returns the value, in the format it should be encoded for json.
This method must always return an array.
Overrides
|
#
|
public
static
|
stringToArray(string $value): array
Parses an RRULE value string, and turns it into a struct-ish array.
Parses an RRULE value string, and turns it into a struct-ish array.
|
#
|
public
|
validate(int $options = 0): array
Validates the node for correctness.
Validates the node for correctness.
The following options are supported:
Node::REPAIR - May attempt to automatically repair the problem.
This method returns an array with detected problems.
Every element has the following properties:
- level - problem level.
- message - A human-readable string describing the issue.
- node - A reference to the problematic node.
The level means:
1 - The issue was repaired (only happens if REPAIR was turned on)
2 - An inconsequential issue
3 - A severe issue.
Overrides
|
#
|