tests/PHPUnit/PHP/CodeCoverage/Report/HTML/Node/Iterator.php

   1 <?php
   2 /**
   3  * PHP_CodeCoverage
   4  *
   5  * Copyright (c) 2009-2011, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @category   PHP
  38  * @package    CodeCoverage
  39  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2009-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://github.com/sebastianbergmann/php-code-coverage
  43  * @since      File available since Release 1.0.0
  44  */
  45
  46 /**
  47  * Recursive iterator for PHP_CodeCoverage_Report_HTML_Node object graphs.
  48  *
  49  * @category   PHP
  50  * @package    CodeCoverage
  51  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  52  * @copyright  2009-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  53  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  54  * @version    Release: 1.0.4
  55  * @link       http://github.com/sebastianbergmann/php-code-coverage
  56  * @since      Class available since Release 1.0.0
  57  */
  58 class PHP_CodeCoverage_Report_HTML_Node_Iterator implements RecursiveIterator
  59 {
  60     /**
  61      * @var integer
  62      */
  63     protected $position;
  64
  65     /**
  66      * @var PHP_CodeCoverage_Report_HTML_Node[]
  67      */
  68     protected $nodes;
  69
  70     /**
  71      * Constructor.
  72      *
  73      * @param PHP_CodeCoverage_Report_HTML_Node_Directory $node
  74      */
  75     public function __construct(PHP_CodeCoverage_Report_HTML_Node_Directory $node)
  76     {
  77         $this->nodes = $node->getChildNodes();
  78     }
  79
  80     /**
  81      * Rewinds the Iterator to the first element.
  82      *
  83      */
  84     public function rewind()
  85     {
  86         $this->position = 0;
  87     }
  88
  89     /**
  90      * Checks if there is a current element after calls to rewind() or next().
  91      *
  92      * @return boolean
  93      */
  94     public function valid()
  95     {
  96         return $this->position < count($this->nodes);
  97     }
  98
  99     /**
 100      * Returns the key of the current element.
 101      *
 102      * @return integer
 103      */
 104     public function key()
 105     {
 106         return $this->position;
 107     }
 108
 109     /**
 110      * Returns the current element.
 111      *
 112      * @return PHPUnit_Framework_Test
 113      */
 114     public function current()
 115     {
 116         return $this->valid() ? $this->nodes[$this->position] : NULL;
 117     }
 118
 119     /**
 120      * Moves forward to next element.
 121      *
 122      */
 123     public function next()
 124     {
 125         $this->position++;
 126     }
 127
 128     /**
 129      * Returns the sub iterator for the current element.
 130      *
 131      * @return PHP_CodeCoverage_Report_HTML_Node_Iterator
 132      */
 133     public function getChildren()
 134     {
 135         return new PHP_CodeCoverage_Report_HTML_Node_Iterator(
 136           $this->nodes[$this->position]
 137         );
 138     }
 139
 140     /**
 141      * Checks whether the current element has children.
 142      *
 143      * @return boolean
 144      */
 145     public function hasChildren()
 146     {
 147         return $this->nodes[$this->position] instanceof PHP_CodeCoverage_Report_HTML_Node_Directory;
 148     }
 149 }