interface/modules/zend_modules/library/Zend/Dom/NodeList.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\Dom;
  11
  12 use ArrayAccess;
  13 use Countable;
  14 use DOMDocument;
  15 use DOMNodeList;
  16 use DOMNode;
  17 use Iterator;
  18
  19 /**
  20  * Nodelist for DOM XPath query
  21  */
  22 class NodeList implements Iterator, Countable, ArrayAccess
  23 {
  24     /**
  25      * CSS Selector query
  26      * @var string
  27      */
  28     protected $cssQuery;
  29
  30     /**
  31      * @var DOMDocument
  32      */
  33     protected $document;
  34
  35     /**
  36      * @var DOMNodeList
  37      */
  38     protected $nodeList;
  39
  40     /**
  41      * Current iterator position
  42      * @var int
  43      */
  44     protected $position = 0;
  45
  46     /**
  47      * XPath query
  48      * @var string
  49      */
  50     protected $xpathQuery;
  51
  52     /**
  53      * Constructor
  54      *
  55      * @param string       $cssQuery
  56      * @param string|array $xpathQuery
  57      * @param DOMDocument  $document
  58      * @param DOMNodeList  $nodeList
  59      */
  60     public function __construct($cssQuery, $xpathQuery, DOMDocument $document, DOMNodeList $nodeList)
  61     {
  62         $this->cssQuery   = $cssQuery;
  63         $this->xpathQuery = $xpathQuery;
  64         $this->document   = $document;
  65         $this->nodeList   = $nodeList;
  66     }
  67
  68     /**
  69      * Retrieve CSS Query
  70      *
  71      * @return string
  72      */
  73     public function getCssQuery()
  74     {
  75         return $this->cssQuery;
  76     }
  77
  78     /**
  79      * Retrieve XPath query
  80      *
  81      * @return string
  82      */
  83     public function getXpathQuery()
  84     {
  85         return $this->xpathQuery;
  86     }
  87
  88     /**
  89      * Retrieve DOMDocument
  90      *
  91      * @return DOMDocument
  92      */
  93     public function getDocument()
  94     {
  95         return $this->document;
  96     }
  97
  98     /**
  99      * Iterator: rewind to first element
 100      *
 101      * @return DOMNode
 102      */
 103     public function rewind()
 104     {
 105         $this->position = 0;
 106
 107         return $this->nodeList->item(0);
 108     }
 109
 110     /**
 111      * Iterator: is current position valid?
 112      *
 113      * @return bool
 114      */
 115     public function valid()
 116     {
 117         if (in_array($this->position, range(0, $this->nodeList->length - 1)) && $this->nodeList->length > 0) {
 118             return true;
 119         }
 120
 121         return false;
 122     }
 123
 124     /**
 125      * Iterator: return current element
 126      *
 127      * @return DOMNode
 128      */
 129     public function current()
 130     {
 131         return $this->nodeList->item($this->position);
 132     }
 133
 134     /**
 135      * Iterator: return key of current element
 136      *
 137      * @return int
 138      */
 139     public function key()
 140     {
 141         return $this->position;
 142     }
 143
 144     /**
 145      * Iterator: move to next element
 146      *
 147      * @return DOMNode
 148      */
 149     public function next()
 150     {
 151         ++$this->position;
 152
 153         return $this->nodeList->item($this->position);
 154     }
 155
 156     /**
 157      * Countable: get count
 158      *
 159      * @return int
 160      */
 161     public function count()
 162     {
 163         return $this->nodeList->length;
 164     }
 165
 166     /**
 167      * ArrayAccess: offset exists
 168      *
 169      * @param int $key
 170      * @return bool
 171      */
 172     public function offsetExists($key)
 173     {
 174         if (in_array($key, range(0, $this->nodeList->length - 1)) && $this->nodeList->length > 0) {
 175             return true;
 176         }
 177         return false;
 178     }
 179
 180     /**
 181      * ArrayAccess: get offset
 182      *
 183      * @param int $key
 184      * @return mixed
 185      */
 186     public function offsetGet($key)
 187     {
 188         return $this->nodeList->item($key);
 189     }
 190
 191     /**
 192      * ArrayAccess: set offset
 193      *
 194      * @param  mixed $key
 195      * @param  mixed $value
 196      * @throws Exception\BadMethodCallException when attemptingn to write to a read-only item
 197      */
 198     public function offsetSet($key, $value)
 199     {
 200         throw new Exception\BadMethodCallException('Attempting to write to a read-only list');
 201     }
 202
 203     /**
 204      * ArrayAccess: unset offset
 205      *
 206      * @param  mixed $key
 207      * @throws Exception\BadMethodCallException when attemptingn to unset a read-only item
 208      */
 209     public function offsetUnset($key)
 210     {
 211         throw new Exception\BadMethodCallException('Attempting to unset on a read-only list');
 212     }
 213 }