tests/PHPUnit/Util/TestSuiteIterator.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, 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   Testing
  38  * @package    PHPUnit
  39  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.1.0
  45  */
  46
  47 require_once 'PHPUnit/Util/Filter.php';
  48
  49 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  50
  51 /**
  52  * Iterator for test suites.
  53  *
  54  * @category   Testing
  55  * @package    PHPUnit
  56  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  57  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  58  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  59  * @version    Release: 3.3.17
  60  * @link       http://www.phpunit.de/
  61  * @since      Class available since Release 3.1.0
  62  */
  63 class PHPUnit_Util_TestSuiteIterator implements RecursiveIterator
  64 {
  65     /**
  66      * @var    integer
  67      */
  68     protected $position;
  69
  70     /**
  71      * @var    PHPUnit_Framework_Test[]
  72      */
  73     protected $tests;
  74
  75     /**
  76      * Constructor.
  77      *
  78      * @param  PHPUnit_Framework_TestSuite $suite
  79      */
  80     public function __construct(PHPUnit_Framework_TestSuite $testSuite)
  81     {
  82         $this->tests = $testSuite->tests();
  83     }
  84
  85     /**
  86      * Rewinds the Iterator to the first element.
  87      *
  88      */
  89     public function rewind()
  90     {
  91         $this->position = 0;
  92     }
  93
  94     /**
  95      * Checks if there is a current element after calls to rewind() or next().
  96      *
  97      * @return boolean
  98      */
  99     public function valid()
 100     {
 101         return $this->position < count($this->tests);
 102     }
 103
 104     /**
 105      * Returns the key of the current element.
 106      *
 107      * @return integer
 108      */
 109     public function key()
 110     {
 111         return $this->position;
 112     }
 113
 114     /**
 115      * Returns the current element.
 116      *
 117      * @return PHPUnit_Framework_Test
 118      */
 119     public function current()
 120     {
 121         return $this->valid() ? $this->tests[$this->position] : NULL;
 122     }
 123
 124     /**
 125      * Moves forward to next element.
 126      *
 127      */
 128     public function next()
 129     {
 130         $this->position++;
 131     }
 132
 133     /**
 134      * Returns the sub iterator for the current element.
 135      *
 136      * @return PHPUnit_Util_TestSuiteIterator
 137      */
 138     public function getChildren()
 139     {
 140         return new PHPUnit_Util_TestSuiteIterator($this->tests[$this->position]);
 141     }
 142
 143     /**
 144      * Checks whether the current element has children.
 145      *
 146      * @return boolean
 147      */
 148     public function hasChildren()
 149     {
 150         return $this->tests[$this->position] instanceof PHPUnit_Framework_TestSuite;
 151     }
 152 }
 153 ?>