Documentation

Share
in package

Application

implements XmlDeserializable

Share POST request parser.

This class parses the share POST request, as defined in:

http://svn.calendarserver.org/repository/calendarserver/CalendarServer/trunk/doc/Extensions/caldav-sharing.txt

XmlDeserializable: Implementing the XmlDeserializable interface allows you to use a class as a deserializer for a specific element.

$sharees : array<string|int, Sharee>: The list of new people added or updated or removed from the share.
__construct() : mixed: Constructor.
xmlDeserialize() : mixed: The deserialize method is called during xml parsing.

The list of new people added or updated or removed from the share.


    public
        array<string|int, Sharee>
    $sharees
     = []

Constructor.


    public
                __construct(array<string|int, Sharee> $sharees) : mixed

mixed —

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.

mixed —