aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/sabre/xml/lib/XmlSerializable.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/sabre/xml/lib/XmlSerializable.php')
-rw-r--r--vendor/sabre/xml/lib/XmlSerializable.php36
1 files changed, 36 insertions, 0 deletions
diff --git a/vendor/sabre/xml/lib/XmlSerializable.php b/vendor/sabre/xml/lib/XmlSerializable.php
new file mode 100644
index 000000000..3e2c528b9
--- /dev/null
+++ b/vendor/sabre/xml/lib/XmlSerializable.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace Sabre\Xml;
+
+/**
+ * Objects implementing XmlSerializable can control how they are represented in
+ * Xml.
+ *
+ * @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 XmlSerializable {
+
+ /**
+ * The xmlSerialize method is called during xml writing.
+ *
+ * Use the $writer argument to write its own xml serialization.
+ *
+ * An important note: do _not_ create a parent element. Any element
+ * implementing XmlSerializble should only ever write what's considered
+ * its 'inner xml'.
+ *
+ * The parent of the current element is responsible for writing a
+ * containing element.
+ *
+ * This allows serializers to be re-used for different element names.
+ *
+ * If you are opening new elements, you must also close them again.
+ *
+ * @param Writer $writer
+ * @return void
+ */
+ function xmlSerialize(Writer $writer);
+
+}