5 * Copyright (c) 2009-2011, Sebastian Bergmann <sb@sebastian-bergmann.de>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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.
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.
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.1.0
47 * Recursive iterator for PHP_CodeCoverage_Report_Node object graphs.
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.1.1
55 * @link http://github.com/sebastianbergmann/php-code-coverage
56 * @since Class available since Release 1.1.0
58 class PHP_CodeCoverage_Report_Node_Iterator implements RecursiveIterator
66 * @var PHP_CodeCoverage_Report_Node[]
73 * @param PHP_CodeCoverage_Report_Node_Directory $node
75 public function __construct(PHP_CodeCoverage_Report_Node_Directory $node)
77 $this->nodes = $node->getChildNodes();
81 * Rewinds the Iterator to the first element.
84 public function rewind()
90 * Checks if there is a current element after calls to rewind() or next().
94 public function valid()
96 return $this->position < count($this->nodes);
100 * Returns the key of the current element.
104 public function key()
106 return $this->position;
110 * Returns the current element.
112 * @return PHPUnit_Framework_Test
114 public function current()
116 return $this->valid() ? $this->nodes[$this->position] : NULL;
120 * Moves forward to next element.
123 public function next()
129 * Returns the sub iterator for the current element.
131 * @return PHP_CodeCoverage_Report_Node_Iterator
133 public function getChildren()
135 return new PHP_CodeCoverage_Report_Node_Iterator(
136 $this->nodes[$this->position]
141 * Checks whether the current element has children.
145 public function hasChildren()
147 return $this->nodes[$this->position] instanceof PHP_CodeCoverage_Report_Node_Directory;