SupportedCalendarComponentSet
in package
implements
Element
SupportedCalendarComponentSet property.
This class represents the {urn:ietf:params:xml:ns:caldav}supported-calendar-component-set property, as defined in:
https://tools.ietf.org/html/rfc4791#section-5.2.3
Tags
Interfaces, Classes and Traits
- Element
- This is the XML element interface.
Table of Contents
- $components : array<string|int, mixed>
- List of supported components.
- __construct() : mixed
- Creates the property.
- getValue() : array<string|int, mixed>
- Returns the list of supported components.
- xmlDeserialize() : mixed
- The deserialize method is called during xml parsing.
- xmlSerialize() : mixed
- The xmlSerialize method is called during xml writing.
Properties
$components
List of supported components.
protected
array<string|int, mixed>
$components
= []
This array will contain values such as VEVENT, VTODO and VJOURNAL.
Methods
__construct()
Creates the property.
public
__construct(array<string|int, mixed> $components) : mixed
Parameters
- $components : array<string|int, mixed>
Return values
mixed —getValue()
Returns the list of supported components.
public
getValue() : array<string|int, mixed>
Return values
array<string|int, mixed> —xmlDeserialize()
The deserialize method is called during xml parsing.
public
static xmlDeserialize(Reader $reader) : mixed
This method is called statically, this is because in theory this method may be used as a type of constructor, or factory method.
Often you want to return an instance of the current class, but you are free to return other data as well.
You are responsible for advancing the reader to the next element. Not doing anything will result in a never-ending loop.
If you just want to skip parsing for this element altogether, you can just call $reader->next();
$reader->parseInnerTree() will parse the entire sub-tree, and advance to the next element.
Parameters
- $reader : Reader
Return values
mixed —xmlSerialize()
The xmlSerialize method is called during xml writing.
public
xmlSerialize(Writer $writer) : mixed
Use the $writer argument to write its own xml serialization.
An important note: do not create a parent element. Any element implementing XmlSerializable should only ever write what's considered its 'inner xml'.
The parent of the current element is responsible for writing a containing element.
This allows serializers to be re-used for different element names.
If you are opening new elements, you must also close them again.
Parameters
- $writer : Writer