InviteReply
in package
implements
XmlDeserializable
Invite-reply POST request parser.
This class parses the invite-reply POST request, as defined in:
http://svn.calendarserver.org/repository/calendarserver/CalendarServer/trunk/doc/Extensions/caldav-sharing.txt
Tags
Interfaces, Classes and Traits
- XmlDeserializable
- Implementing the XmlDeserializable interface allows you to use a class as a deserializer for a specific element.
Table of Contents
- $calendarUri : string
- The uri to the calendar that was being shared.
- $href : string
- The sharee calendar user address.
- $inReplyTo : string
- The id of the invite message that's being responded to.
- $status : int
- Either SharingPlugin::STATUS_ACCEPTED or SharingPlugin::STATUS_DECLINED.
- $summary : string
- An optional message.
- __construct() : mixed
- Constructor.
- xmlDeserialize() : mixed
- The deserialize method is called during xml parsing.
Properties
$calendarUri
The uri to the calendar that was being shared.
public
string
$calendarUri
$href
The sharee calendar user address.
public
string
$href
This is the address that the original invite was set to
$inReplyTo
The id of the invite message that's being responded to.
public
string
$inReplyTo
$status
Either SharingPlugin::STATUS_ACCEPTED or SharingPlugin::STATUS_DECLINED.
public
int
$status
$summary
An optional message.
public
string
$summary
Methods
__construct()
Constructor.
public
__construct(string $href, string $calendarUri, string $inReplyTo, string $summary, int $status) : mixed
Parameters
- $href : string
- $calendarUri : string
- $inReplyTo : string
- $summary : string
- $status : int
Return values
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