tests/PHPUnit/PHPUnit/Framework/MockObject/Matcher/InvokedAtIndex.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2010-2011, 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  * @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
  43  */
  44
  45 /**
  46  * Invocation matcher which checks if a method was invoked at a certain index.
  47  *
  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
  51  * verifying.
  52  *
  53  * If the index is never reached it will throw an exception in index.
  54  *
  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.8
  60  * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
  61  * @since      Class available since Release 1.0.0
  62  */
  63 class PHPUnit_Framework_MockObject_Matcher_InvokedAtIndex implements PHPUnit_Framework_MockObject_Matcher_Invocation
  64 {
  65     /**
  66      * @var integer
  67      */
  68     protected $sequenceIndex;
  69
  70     /**
  71      * @var integer
  72      */
  73     protected $currentIndex = -1;
  74
  75     /**
  76      * @param integer $sequenceIndex
  77      */
  78     public function __construct($sequenceIndex)
  79     {
  80         $this->sequenceIndex = $sequenceIndex;
  81     }
  82
  83     /**
  84      * @return string
  85      */
  86     public function toString()
  87     {
  88         return 'invoked at sequence index ' . $this->sequenceIndex;
  89     }
  90
  91     /**
  92      * @param  PHPUnit_Framework_MockObject_Invocation $invocation
  93      * @return boolean
  94      */
  95     public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
  96     {
  97         $this->currentIndex++;
  98
  99         return $this->currentIndex == $this->sequenceIndex;
 100     }
 101
 102     /**
 103      * @param PHPUnit_Framework_MockObject_Invocation $invocation
 104      */
 105     public function invoked(PHPUnit_Framework_MockObject_Invocation $invocation)
 106     {
 107     }
 108
 109     /**
 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.
 112      *
 113      * @throws PHPUnit_Framework_ExpectationFailedException
 114      */
 115     public function verify()
 116     {
 117         if ($this->currentIndex < $this->sequenceIndex) {
 118             throw new PHPUnit_Framework_ExpectationFailedException(
 119               sprintf(
 120                 'The expected invocation at index %s was never reached.',
 121
 122                 $this->sequenceIndex
 123               )
 124             );
 125         }
 126     }
 127 }