128 lines
4.4 KiB
PHP
128 lines
4.4 KiB
PHP
<?php
|
|
/**
|
|
* PHPUnit
|
|
*
|
|
* Copyright (c) 2010-2013, Sebastian Bergmann <sb@sebastian-bergmann.de>.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
*
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
*
|
|
* * Neither the name of Sebastian Bergmann nor the names of his
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* @package PHPUnit_MockObject
|
|
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
|
* @copyright 2010-2013 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
|
* @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License
|
|
* @link http://github.com/sebastianbergmann/phpunit-mock-objects
|
|
* @since File available since Release 1.0.0
|
|
*/
|
|
|
|
/**
|
|
* Invocation matcher which checks if a method was invoked at a certain index.
|
|
*
|
|
* If the expected index number does not match the current invocation index it
|
|
* will not match which means it skips all method and parameter matching. Only
|
|
* once the index is reached will the method and parameter start matching and
|
|
* verifying.
|
|
*
|
|
* If the index is never reached it will throw an exception in index.
|
|
*
|
|
* @package PHPUnit_MockObject
|
|
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
|
* @copyright 2010-2013 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
|
* @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License
|
|
* @version Release: 1.2.3
|
|
* @link http://github.com/sebastianbergmann/phpunit-mock-objects
|
|
* @since Class available since Release 1.0.0
|
|
*/
|
|
class PHPUnit_Framework_MockObject_Matcher_InvokedAtIndex implements PHPUnit_Framework_MockObject_Matcher_Invocation
|
|
{
|
|
/**
|
|
* @var integer
|
|
*/
|
|
protected $sequenceIndex;
|
|
|
|
/**
|
|
* @var integer
|
|
*/
|
|
protected $currentIndex = -1;
|
|
|
|
/**
|
|
* @param integer $sequenceIndex
|
|
*/
|
|
public function __construct($sequenceIndex)
|
|
{
|
|
$this->sequenceIndex = $sequenceIndex;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function toString()
|
|
{
|
|
return 'invoked at sequence index ' . $this->sequenceIndex;
|
|
}
|
|
|
|
/**
|
|
* @param PHPUnit_Framework_MockObject_Invocation $invocation
|
|
* @return boolean
|
|
*/
|
|
public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
|
|
{
|
|
$this->currentIndex++;
|
|
|
|
return $this->currentIndex == $this->sequenceIndex;
|
|
}
|
|
|
|
/**
|
|
* @param PHPUnit_Framework_MockObject_Invocation $invocation
|
|
*/
|
|
public function invoked(PHPUnit_Framework_MockObject_Invocation $invocation)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Verifies that the current expectation is valid. If everything is OK the
|
|
* code should just return, if not it must throw an exception.
|
|
*
|
|
* @throws PHPUnit_Framework_ExpectationFailedException
|
|
*/
|
|
public function verify()
|
|
{
|
|
if ($this->currentIndex < $this->sequenceIndex) {
|
|
throw new PHPUnit_Framework_ExpectationFailedException(
|
|
sprintf(
|
|
'The expected invocation at index %s was never reached.',
|
|
|
|
$this->sequenceIndex
|
|
)
|
|
);
|
|
}
|
|
}
|
|
}
|