aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/sabre/xml/lib/XmlDeserializable.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/sabre/xml/lib/XmlDeserializable.php')
-rw-r--r--vendor/sabre/xml/lib/XmlDeserializable.php38
1 files changed, 38 insertions, 0 deletions
diff --git a/vendor/sabre/xml/lib/XmlDeserializable.php b/vendor/sabre/xml/lib/XmlDeserializable.php
new file mode 100644
index 000000000..fa857e82c
--- /dev/null
+++ b/vendor/sabre/xml/lib/XmlDeserializable.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Sabre\Xml;
+
+/**
+ * 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/)
+ * @license http://sabre.io/license/ Modified BSD License
+ */
+interface XmlDeserializable {
+
+ /**
+ * 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.
+ *
+ * @param Reader $reader
+ * @return mixed
+ */
+ static function xmlDeserialize(Reader $reader);
+
+}