web/Zend/XmlRpc/Generator/GeneratorAbstract.php
changeset 0 4eba9c11703f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/web/Zend/XmlRpc/Generator/GeneratorAbstract.php	Mon Dec 13 18:29:26 2010 +0100
@@ -0,0 +1,150 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_XmlRpc
+ * @subpackage Generator
+ * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id: GeneratorAbstract.php 20785 2010-01-31 09:43:03Z mikaelkael $
+ */
+
+/**
+ * Abstract XML generator adapter
+ */
+abstract class Zend_XmlRpc_Generator_GeneratorAbstract
+{
+    /**
+     * XML encoding string
+     *
+     * @var string
+     */
+    protected $_encoding;
+
+    /**
+     * Construct new instance of the generator
+     *
+     * @param string $encoding XML encoding, default UTF-8
+     */
+    public function __construct($encoding = 'UTF-8')
+    {
+        $this->_encoding = $encoding;
+        $this->_init();
+    }
+
+    /**
+     * Start XML element
+     *
+     * Method opens a new XML element with an element name and an optional value
+     * 
+     * @param string $name XML tag name
+     * @param string $value Optional value of the XML tag
+     * @return Zend_XmlRpc_Generator_Abstract Fluent interface
+     */
+    public function openElement($name, $value = null)
+    {
+        $this->_openElement($name);
+        if ($value !== null) {
+            $this->_writeTextData($value);
+        }
+
+        return $this;
+    }
+
+    /**
+     * End of an XML element
+     *
+     * Method marks the end of an XML element
+     *
+     * @param string $name XML tag name
+     * @return Zend_XmlRpc_Generator_Abstract Fluent interface
+     */
+    public function closeElement($name)
+    {
+        $this->_closeElement($name);
+
+        return $this;
+    }
+
+    /**
+     * Return XML as a string
+     *
+     * @return string
+     */
+    abstract public function saveXml();
+
+    /**
+     * Return encoding
+     * 
+     * @return string
+     */
+    public function getEncoding()
+    {
+        return $this->_encoding;
+    }
+
+    /**
+     * Returns the XML as a string and flushes all internal buffers
+     *
+     * @return string
+     */
+    public function flush()
+    {
+        $xml = $this->saveXml();
+        $this->_init();
+        return $xml;
+    }
+
+    /**
+     * Returns XML without document declaration
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return $this->stripDeclaration($this->saveXml());
+    }
+
+    /**
+     * Removes XML declaration from a string
+     *
+     * @param string $xml
+     * @return string
+     */
+    public function stripDeclaration($xml)
+    {
+        return preg_replace('/<\?xml version="1.0"( encoding="[^\"]*")?\?>\n/u', '', $xml);
+    }
+
+    /**
+     * Start XML element
+     *
+     * @param string $name XML element name
+     */
+    abstract protected function _openElement($name);
+
+    /**
+     * Write XML text data into the currently opened XML element
+     *
+     * @param string $text
+     */
+    abstract protected function _writeTextData($text);
+
+    /**
+     * End XML element
+     * 
+     * @param string $name
+     */
+    abstract protected function _closeElement($name);
+}