Sabre\Xml\XmlDeserializable Interface Reference

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

Inheritance diagram for Sabre\Xml\XmlDeserializable:

Collaboration diagram for Sabre\Xml\XmlDeserializable:

Static Public Member Functions
static	xmlDeserialize (Reader $reader)
	The deserialize method is called during xml parsing. More...

Detailed Description

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

Copyright

Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/).

Author

Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 13 of file XmlDeserializable.php.

Member Function Documentation

xmlDeserialize()

static Sabre\Xml\XmlDeserializable::xmlDeserialize ( Reader  $reader )

static

The deserialize method is called during xml parsing.

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

Returns

mixed

Implemented in Sabre\DAV\Xml\Element\Response, Sabre\DAVACL\Xml\Property\Principal, Sabre\DAVACL\Xml\Property\Acl, Sabre\DAV\Xml\Element\Sharee, Sabre\DAV\Xml\Property\Href, Sabre\Xml\Element\XmlFragment, Sabre\DAV\Xml\Property\ShareAccess, Sabre\CardDAV\Xml\Request\AddressBookQueryReport, Sabre\DAV\Xml\Response\MultiStatus, Sabre\DAVACL\Xml\Property\CurrentUserPrivilegeSet, Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet, Sabre\DAV\Xml\Property\GetLastModified, Sabre\CalDAV\Xml\Request\InviteReply, Sabre\DAV\Xml\Request\PropPatch, Sabre\CalDAV\Xml\Request\CalendarMultiGetReport, Sabre\CalDAV\Xml\Request\CalendarQueryReport, Sabre\DAVACL\Xml\Request\PrincipalPropertySearchReport, Sabre\DAVACL\Xml\Request\PrincipalMatchReport, Sabre\CardDAV\Xml\Request\AddressBookMultiGetReport, Sabre\DAV\Xml\Request\SyncCollectionReport, Sabre\CalDAV\Xml\Request\Share, Sabre\DAV\Xml\Request\MkCol, Sabre\DAV\Xml\Request\ShareResource, Sabre\CalDAV\Xml\Request\MkCalendar, Sabre\CalDAV\Xml\Request\FreeBusyQueryReport, Sabre\DAV\Xml\Request\Lock, Sabre\DAV\Xml\Request\PropFind, Sabre\DAVACL\Xml\Request\ExpandPropertyReport, Sabre\CalDAV\Xml\Filter\CalendarData, Sabre\CalDAV\Xml\Filter\CompFilter, Sabre\CalDAV\Xml\Filter\PropFilter, Sabre\CardDAV\Xml\Filter\AddressData, Sabre\CardDAV\Xml\Filter\ParamFilter, Sabre\CardDAV\Xml\Filter\PropFilter, Sabre\CalDAV\Xml\Filter\ParamFilter, Sabre\DAVACL\Xml\Request\AclPrincipalPropSetReport, Sabre\DAVACL\Xml\Request\PrincipalSearchPropertySetReport, Sabre\DAV\Xml\Element\Prop, and Sabre\DAV\Xml\Property\Complex.

---

The documentation for this interface was generated from the following file:

• libs/composer/vendor/sabre/xml/lib/XmlDeserializable.php