interface/modules/zend_modules/library/Zend/XmlRpc/Generator/AbstractGenerator.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\XmlRpc\Generator;
  11
  12 /**
  13  * Abstract XML generator adapter
  14  */
  15 abstract class AbstractGenerator implements GeneratorInterface
  16 {
  17     /**
  18      * XML encoding string
  19      *
  20      * @var string
  21      */
  22     protected $encoding;
  23
  24     /**
  25      * Construct new instance of the generator
  26      *
  27      * @param string $encoding XML encoding, default UTF-8
  28      */
  29     public function __construct($encoding = 'UTF-8')
  30     {
  31         $this->setEncoding($encoding);
  32         $this->_init();
  33     }
  34
  35     /**
  36      * Initialize internal objects
  37      *
  38      * @return void
  39      */
  40     abstract protected function _init();
  41
  42     /**
  43      * Start XML element
  44      *
  45      * Method opens a new XML element with an element name and an optional value
  46      *
  47      * @param string $name XML tag name
  48      * @param string $value Optional value of the XML tag
  49      * @return AbstractGenerator Fluent interface
  50      */
  51     public function openElement($name, $value = null)
  52     {
  53         $this->_openElement($name);
  54         if ($value !== null) {
  55             $this->_writeTextData($value);
  56         }
  57
  58         return $this;
  59     }
  60
  61     /**
  62      * End of an XML element
  63      *
  64      * Method marks the end of an XML element
  65      *
  66      * @param string $name XML tag name
  67      * @return AbstractGenerator Fluent interface
  68      */
  69     public function closeElement($name)
  70     {
  71         $this->_closeElement($name);
  72
  73         return $this;
  74     }
  75
  76     /**
  77      * Return encoding
  78      *
  79      * @return string
  80      */
  81     public function getEncoding()
  82     {
  83         return $this->encoding;
  84     }
  85
  86     /**
  87      * Set XML encoding
  88      *
  89      * @param  string $encoding
  90      * @return AbstractGenerator
  91      */
  92     public function setEncoding($encoding)
  93     {
  94         $this->encoding = $encoding;
  95         return $this;
  96     }
  97
  98     /**
  99      * Returns the XML as a string and flushes all internal buffers
 100      *
 101      * @return string
 102      */
 103     public function flush()
 104     {
 105         $xml = $this->saveXml();
 106         $this->_init();
 107         return $xml;
 108     }
 109
 110     /**
 111      * Returns XML without document declaration
 112      *
 113      * @return string
 114      */
 115     public function __toString()
 116     {
 117         return $this->stripDeclaration($this->saveXml());
 118     }
 119
 120     /**
 121      * Removes XML declaration from a string
 122      *
 123      * @param  string $xml
 124      * @return string
 125      */
 126     public function stripDeclaration($xml)
 127     {
 128         return preg_replace('/<\?xml version="1.0"( encoding="[^\"]*")?\?>\n/u', '', $xml);
 129     }
 130
 131     /**
 132      * Start XML element
 133      *
 134      * @param string $name XML element name
 135      */
 136     abstract protected function _openElement($name);
 137
 138     /**
 139      * Write XML text data into the currently opened XML element
 140      *
 141      * @param string $text
 142      */
 143     abstract protected function _writeTextData($text);
 144
 145     /**
 146      * End XML element
 147      *
 148      * @param string $name
 149      */
 150     abstract protected function _closeElement($name);
 151 }