| Methods |
public
|
setParts(array $parts)
Sets a multi-valued property.
Sets a multi-valued property.
You may also specify DateTime objects here.
Overrides
|
#
|
public
|
setValue(string|array|DateTimeInterface $value)
Updates the current value.
Updates the current value.
This may be either a single, or multiple strings in an array.
Instead of strings, you may also use DateTime here.
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
|
hasTime(): bool
Returns true if this is a DATE-TIME value, false if it's a DATE.
Returns true if this is a DATE-TIME value, false if it's a DATE.
|
#
|
public
|
isFloating()
Returns true if this is a floating DATE or DATE-TIME.
Returns true if this is a floating DATE or DATE-TIME.
Note that DATE is always floating.
|
#
|
public
|
getDateTime(DateTimeZone $timeZone = null): DateTimeImmutable
Returns a date-time value.
Returns a date-time value.
Note that if this property contained more than 1 date-time, only the
first will be returned. To get an array with multiple values, call
getDateTimes.
If no timezone information is known, because it's either an all-day
property or floating time, we will use the DateTimeZone argument to
figure out the exact date.
|
#
|
public
|
getDateTimes(DateTimeZone $timeZone = null): DateTimeImmutable[]
Returns multiple date-time values.
Returns multiple date-time values.
If no timezone information is known, because it's either an all-day
property or floating time, we will use the DateTimeZone argument to
figure out the exact date.
|
#
|
public
|
setDateTime(DateTimeInterface $dt, $isFloating = false)
Sets the property as a DateTime object.
Sets the property as a DateTime object.
|
#
|
public
|
setDateTimes(DateTimeInterface[] $dt, $isFloating = false)
Sets the property as multiple date-time objects.
Sets the property as multiple date-time objects.
The first value will be used as a reference for the timezones, and all
the other values will be adjusted for that timezone
|
#
|
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
|
setJsonValue(array $value)
Sets the json value, as it would appear in a jCard or jCal object.
Sets the json value, as it would appear in a jCard or jCal object.
The value must always be an array.
Overrides
|
#
|
public
|
offsetSet(string $name, mixed $value)
We need to intercept offsetSet, because it may be used to alter the
VALUE from DATE-TIME to DATE or vice-versa.
We need to intercept offsetSet, because it may be used to alter the
VALUE from DATE-TIME to DATE or vice-versa.
Overrides
|
#
|
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
|
#
|