← Back to branch summary

~ubuntu-branches/ubuntu/natty/phpunit/natty

« back to all changes in this revision

Viewing changes to PHPUnit-3.5.5/PHPUnit/Util/TestSuiteIterator.php

  • Committer: Package Import Robot
  • Author(s): Ivan Borzenkov
  • Date: 2010-12-11 18:19:39 UTC
  • mfrom: (0.11.1) (1.5.3) (12.1.7 sid)
  • Revision ID: package-import@ubuntu.com-20101211181939-8650nbu08hf2z9v1
Tags: 3.5.5-2
fix doc-base-file-references-missing-file

Show diffs side-by-side

added added

removed removed

Lines of Context:
PHPUnit-3.5.5/PHPUnit/Util/TestSuiteIterator.php
 
1
<?php
 
2
/**
 
3
 * PHPUnit
 
4
 *
 
5
 * Copyright (c) 2002-2010, Sebastian Bergmann <sebastian@phpunit.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
 * @package    PHPUnit
 
38
 * @subpackage Util
 
39
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 
40
 * @copyright  2002-2010 Sebastian Bergmann <sebastian@phpunit.de>
 
41
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 
42
 * @link       http://www.phpunit.de/
 
43
 * @since      File available since Release 3.1.0
 
44
 */
 
45
 
 
46
/**
 
47
 * Iterator for test suites.
 
48
 *
 
49
 * @package    PHPUnit
 
50
 * @subpackage Util
 
51
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 
52
 * @copyright  2002-2010 Sebastian Bergmann <sebastian@phpunit.de>
 
53
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 
54
 * @version    Release: 3.5.5
 
55
 * @link       http://www.phpunit.de/
 
56
 * @since      Class available since Release 3.1.0
 
57
 */
 
58
class PHPUnit_Util_TestSuiteIterator implements RecursiveIterator
 
59
{
 
60
    /**
 
61
     * @var    integer
 
62
     */
 
63
    protected $position;
 
64
 
 
65
    /**
 
66
     * @var    PHPUnit_Framework_Test[]
 
67
     */
 
68
    protected $tests;
 
69
 
 
70
    /**
 
71
     * Constructor.
 
72
     *
 
73
     * @param  PHPUnit_Framework_TestSuite $suite
 
74
     */
 
75
    public function __construct(PHPUnit_Framework_TestSuite $testSuite)
 
76
    {
 
77
        $this->tests = $testSuite->tests();
 
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->tests);
 
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->tests[$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 PHPUnit_Util_TestSuiteIterator
 
132
     */
 
133
    public function getChildren()
 
134
    {
 
135
        return new PHPUnit_Util_TestSuiteIterator(
 
136
          $this->tests[$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->tests[$this->position] instanceof PHPUnit_Framework_TestSuite;
 
148
    }
 
149
}