| Methods |
abstract
public
|
serialize(): string
Serializes the node into a mimedir format.
Serializes the node into a mimedir format.
Implemented by
|
#
|
abstract
public
|
jsonSerialize(): array
This method returns an array, with the representation as it should be
encoded in JSON. This is used to create jCard or…
This method returns an array, with the representation as it should be
encoded in JSON. This is used to create jCard or jCal documents.
Implements
Implemented by
|
#
|
abstract
public
|
xmlSerialize(Writer $writer): void
This method serializes the data into XML. This is used to create xCard or
xCal documents.
This method serializes the data into XML. This is used to create xCard or
xCal documents.
Parameters
Implements
Implemented by
|
#
|
public
|
destroy()
Call this method on a document if you're done using it.
Call this method on a document if you're done using it.
It's intended to remove all circular references, so PHP can easily clean
it up.
Overriden by
|
#
|
public
|
getIterator(): ElementList
Returns the iterator for this object.
Returns the iterator for this object.
Implements
|
#
|
public
|
setIterator(ElementList $iterator)
Sets the overridden iterator.
Sets the overridden iterator.
Note that this is not actually part of the iterator interface
|
#
|
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.
Overriden by
|
#
|
public
|
count(): int
Returns the number of elements.
Returns the number of elements.
Implements
|
#
|
public
|
offsetExists(int $offset): bool
Checks if an item exists through ArrayAccess.
Checks if an item exists through ArrayAccess.
This method just forwards the request to the inner iterator
Overriden by
Implements
|
#
|
public
|
offsetGet(int $offset): mixed
Gets an item through ArrayAccess.
Gets an item through ArrayAccess.
This method just forwards the request to the inner iterator
Overriden by
Implements
|
#
|
public
|
offsetSet(int $offset, mixed $value)
Sets an item through ArrayAccess.
Sets an item through ArrayAccess.
This method just forwards the request to the inner iterator
Overriden by
Implements
|
#
|
public
|
offsetUnset(int $offset)
Sets an item through ArrayAccess.
Sets an item through ArrayAccess.
This method just forwards the request to the inner iterator
Overriden by
Implements
|
#
|
| Constants |
public
|
REPAIR = 1
The following constants are used by the validate() method.
The following constants are used by the validate() method.
If REPAIR is set, the validator will attempt to repair any broken data
(if possible).
|
#
|
public
|
PROFILE_CARDDAV = 2
If this option is set, the validator will operate on the vcards on the
assumption that the vcards need to be valid for…
If this option is set, the validator will operate on the vcards on the
assumption that the vcards need to be valid for CardDAV.
This means for example that the UID is required, whereas it is not for
regular vcards.
|
#
|
public
|
PROFILE_CALDAV = 4
If this option is set, the validator will operate on iCalendar objects
on the assumption that the vcards need to be…
If this option is set, the validator will operate on iCalendar objects
on the assumption that the vcards need to be valid for CalDAV.
This means for example that calendars can only contain objects with
identical component types and UIDs.
|
#
|