5 * Copyright (c) 2010-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.
37 * @package PHPUnit_MockObject
38 * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
39 * @copyright 2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
40 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
41 * @link http://github.com/sebastianbergmann/phpunit-mock-objects
42 * @since File available since Release 1.0.0
46 * Invocation matcher which checks if a method was invoked at a certain index.
48 * If the expected index number does not match the current invocation index it
49 * will not match which means it skips all method and parameter matching. Only
50 * once the index is reached will the method and parameter start matching and
53 * If the index is never reached it will throw an exception in index.
55 * @package PHPUnit_MockObject
56 * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
57 * @copyright 2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
58 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
59 * @version Release: 1.0.9
60 * @link http://github.com/sebastianbergmann/phpunit-mock-objects
61 * @since Class available since Release 1.0.0
63 class PHPUnit_Framework_MockObject_Matcher_InvokedAtIndex implements PHPUnit_Framework_MockObject_Matcher_Invocation
68 protected $sequenceIndex;
73 protected $currentIndex = -1;
76 * @param integer $sequenceIndex
78 public function __construct($sequenceIndex)
80 $this->sequenceIndex = $sequenceIndex;
86 public function toString()
88 return 'invoked at sequence index ' . $this->sequenceIndex;
92 * @param PHPUnit_Framework_MockObject_Invocation $invocation
95 public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
97 $this->currentIndex++;
99 return $this->currentIndex == $this->sequenceIndex;
103 * @param PHPUnit_Framework_MockObject_Invocation $invocation
105 public function invoked(PHPUnit_Framework_MockObject_Invocation $invocation)
110 * Verifies that the current expectation is valid. If everything is OK the
111 * code should just return, if not it must throw an exception.
113 * @throws PHPUnit_Framework_ExpectationFailedException
115 public function verify()
117 if ($this->currentIndex < $this->sequenceIndex) {
118 throw new PHPUnit_Framework_ExpectationFailedException(
120 'The expected invocation at index %s was never reached.',