interface/modules/zend_modules/library/Zend/Ldap/Node/ChildrenIterator.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\Ldap\Node;
  11
  12 use ArrayAccess;
  13 use Countable;
  14 use Iterator;
  15 use RecursiveIterator;
  16 use Zend\Ldap;
  17
  18 /**
  19  * Zend\Ldap\Node\ChildrenIterator provides an iterator to a collection of children nodes.
  20  */
  21 class ChildrenIterator implements Iterator, Countable, RecursiveIterator, ArrayAccess
  22 {
  23     /**
  24      * An array of Zend\Ldap\Node objects
  25      *
  26      * @var array
  27      */
  28     private $data;
  29
  30     /**
  31      * Constructor.
  32      *
  33      * @param array $data
  34      * @return \Zend\Ldap\Node\ChildrenIterator
  35      */
  36     public function __construct(array $data)
  37     {
  38         $this->data = $data;
  39     }
  40
  41     /**
  42      * Returns the number of child nodes.
  43      * Implements Countable
  44      *
  45      * @return int
  46      */
  47     public function count()
  48     {
  49         return count($this->data);
  50     }
  51
  52     /**
  53      * Return the current child.
  54      * Implements Iterator
  55      *
  56      * @return \Zend\Ldap\Node
  57      */
  58     public function current()
  59     {
  60         return current($this->data);
  61     }
  62
  63     /**
  64      * Return the child'd RDN.
  65      * Implements Iterator
  66      *
  67      * @return string
  68      */
  69     public function key()
  70     {
  71         return key($this->data);
  72     }
  73
  74     /**
  75      * Move forward to next child.
  76      * Implements Iterator
  77      */
  78     public function next()
  79     {
  80         next($this->data);
  81     }
  82
  83     /**
  84      * Rewind the Iterator to the first child.
  85      * Implements Iterator
  86      */
  87     public function rewind()
  88     {
  89         reset($this->data);
  90     }
  91
  92     /**
  93      * Check if there is a current child
  94      * after calls to rewind() or next().
  95      * Implements Iterator
  96      *
  97      * @return bool
  98      */
  99     public function valid()
 100     {
 101         return (current($this->data) !== false);
 102     }
 103
 104     /**
 105      * Checks if current node has children.
 106      * Returns whether the current element has children.
 107      *
 108      * @return bool
 109      */
 110     public function hasChildren()
 111     {
 112         if ($this->current() instanceof Ldap\Node) {
 113             return $this->current()->hasChildren();
 114         }
 115
 116         return false;
 117     }
 118
 119     /**
 120      * Returns the children for the current node.
 121      *
 122      * @return ChildrenIterator
 123      */
 124     public function getChildren()
 125     {
 126         if ($this->current() instanceof Ldap\Node) {
 127             return $this->current()->getChildren();
 128         }
 129
 130         return null;
 131     }
 132
 133     /**
 134      * Returns a child with a given RDN.
 135      * Implements ArrayAccess.
 136      *
 137      * @param  string $rdn
 138      * @return array|null
 139      */
 140     public function offsetGet($rdn)
 141     {
 142         if ($this->offsetExists($rdn)) {
 143             return $this->data[$rdn];
 144         }
 145
 146         return null;
 147     }
 148
 149     /**
 150      * Checks whether a given rdn exists.
 151      * Implements ArrayAccess.
 152      *
 153      * @param  string $rdn
 154      * @return bool
 155      */
 156     public function offsetExists($rdn)
 157     {
 158         return (array_key_exists($rdn, $this->data));
 159     }
 160
 161     /**
 162      * Does nothing.
 163      * Implements ArrayAccess.
 164      *
 165      * @param $name
 166      */
 167     public function offsetUnset($name)
 168     {
 169     }
 170
 171     /**
 172      * Does nothing.
 173      * Implements ArrayAccess.
 174      *
 175      * @param  string $name
 176      * @param         $value
 177      */
 178     public function offsetSet($name, $value)
 179     {
 180     }
 181
 182     /**
 183      * Get all children as an array
 184      *
 185      * @return array
 186      */
 187     public function toArray()
 188     {
 189         $data = array();
 190         foreach ($this as $rdn => $node) {
 191             $data[$rdn] = $node;
 192         }
 193         return $data;
 194     }
 195 }