interface/modules/zend_modules/library/Zend/Config/Reader/Xml.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\Config\Reader;
  11
  12 use XMLReader;
  13 use Zend\Config\Exception;
  14
  15 /**
  16  * XML config reader.
  17  */
  18 class Xml implements ReaderInterface
  19 {
  20     /**
  21      * XML Reader instance.
  22      *
  23      * @var XMLReader
  24      */
  25     protected $reader;
  26
  27     /**
  28      * Directory of the file to process.
  29      *
  30      * @var string
  31      */
  32     protected $directory;
  33
  34     /**
  35      * Nodes to handle as plain text.
  36      *
  37      * @var array
  38      */
  39     protected $textNodes = array(
  40         XMLReader::TEXT,
  41         XMLReader::CDATA,
  42         XMLReader::WHITESPACE,
  43         XMLReader::SIGNIFICANT_WHITESPACE
  44     );
  45
  46     /**
  47      * fromFile(): defined by Reader interface.
  48      *
  49      * @see    ReaderInterface::fromFile()
  50      * @param  string $filename
  51      * @return array
  52      * @throws Exception\RuntimeException
  53      */
  54     public function fromFile($filename)
  55     {
  56         if (!is_file($filename) || !is_readable($filename)) {
  57             throw new Exception\RuntimeException(sprintf(
  58                 "File '%s' doesn't exist or not readable",
  59                 $filename
  60             ));
  61         }
  62
  63         $this->reader = new XMLReader();
  64         $this->reader->open($filename, null, LIBXML_XINCLUDE);
  65
  66         $this->directory = dirname($filename);
  67
  68         set_error_handler(
  69             function ($error, $message = '', $file = '', $line = 0) use ($filename) {
  70                 throw new Exception\RuntimeException(sprintf(
  71                     'Error reading XML file "%s": %s',
  72                     $filename, $message
  73                 ), $error);
  74             }, E_WARNING
  75         );
  76         $return = $this->process();
  77         restore_error_handler();
  78
  79         return $return;
  80     }
  81
  82     /**
  83      * fromString(): defined by Reader interface.
  84      *
  85      * @see    ReaderInterface::fromString()
  86      * @param  string $string
  87      * @return array|bool
  88      * @throws Exception\RuntimeException
  89      */
  90     public function fromString($string)
  91     {
  92         if (empty($string)) {
  93             return array();
  94         }
  95         $this->reader = new XMLReader();
  96
  97         $this->reader->xml($string, null, LIBXML_XINCLUDE);
  98
  99         $this->directory = null;
 100
 101         set_error_handler(
 102             function ($error, $message = '', $file = '', $line = 0) {
 103                 throw new Exception\RuntimeException(sprintf(
 104                     'Error reading XML string: %s',
 105                     $message
 106                 ), $error);
 107             }, E_WARNING
 108         );
 109         $return = $this->process();
 110         restore_error_handler();
 111
 112         return $return;
 113     }
 114
 115     /**
 116      * Process data from the created XMLReader.
 117      *
 118      * @return array
 119      */
 120     protected function process()
 121     {
 122         return $this->processNextElement();
 123     }
 124
 125     /**
 126      * Process the next inner element.
 127      *
 128      * @return mixed
 129      */
 130     protected function processNextElement()
 131     {
 132         $children = array();
 133         $text     = '';
 134
 135         while ($this->reader->read()) {
 136             if ($this->reader->nodeType === XMLReader::ELEMENT) {
 137                 if ($this->reader->depth === 0) {
 138                     return $this->processNextElement();
 139                 }
 140
 141                 $attributes = $this->getAttributes();
 142                 $name       = $this->reader->name;
 143
 144                 if ($this->reader->isEmptyElement) {
 145                     $child = array();
 146                 } else {
 147                     $child = $this->processNextElement();
 148                 }
 149
 150                 if ($attributes) {
 151                     if (!is_array($child)) {
 152                         $child = array();
 153                     }
 154
 155                     $child = array_merge($child, $attributes);
 156                 }
 157
 158                 if (isset($children[$name])) {
 159                     if (!is_array($children[$name]) || !array_key_exists(0, $children[$name])) {
 160                         $children[$name] = array($children[$name]);
 161                     }
 162
 163                     $children[$name][] = $child;
 164                 } else {
 165                     $children[$name] = $child;
 166                 }
 167             } elseif ($this->reader->nodeType === XMLReader::END_ELEMENT) {
 168                 break;
 169             } elseif (in_array($this->reader->nodeType, $this->textNodes)) {
 170                 $text .= $this->reader->value;
 171             }
 172         }
 173
 174         return $children ?: $text;
 175     }
 176
 177     /**
 178      * Get all attributes on the current node.
 179      *
 180      * @return array
 181      */
 182     protected function getAttributes()
 183     {
 184         $attributes = array();
 185
 186         if ($this->reader->hasAttributes) {
 187             while ($this->reader->moveToNextAttribute()) {
 188                 $attributes[$this->reader->localName] = $this->reader->value;
 189             }
 190
 191             $this->reader->moveToElement();
 192         }
 193
 194         return $attributes;
 195     }
 196 }