tests/PHPUnit/PHPUnit/Framework/MockObject/Stub/ConsecutiveCalls.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     Patrick Müller <elias0@gmx.net>
  39  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
  43  * @since      File available since Release 1.0.0
  44  */
  45
  46 /**
  47  * Stubs a method by returning a user-defined stack of values.
  48  *
  49  * @package    PHPUnit_MockObject
  50  * @author     Patrick Müller <elias0@gmx.net>
  51  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  52  * @copyright  2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  53  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  54  * @version    Release: 1.0.8
  55  * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
  56  * @since      Class available since Release 1.0.0
  57  */
  58 class PHPUnit_Framework_MockObject_Stub_ConsecutiveCalls implements PHPUnit_Framework_MockObject_Stub
  59 {
  60     protected $stack;
  61     protected $value;
  62
  63     public function __construct($stack)
  64     {
  65         $this->stack = $stack;
  66     }
  67
  68     public function invoke(PHPUnit_Framework_MockObject_Invocation $invocation)
  69     {
  70         $this->value = array_shift($this->stack);
  71
  72         if ($this->value instanceof PHPUnit_Framework_MockObject_Stub) {
  73             $this->value = $this->value->invoke($invocation);
  74         }
  75
  76         return $this->value;
  77     }
  78
  79     public function toString()
  80     {
  81         return sprintf(
  82           'return user-specified value %s',
  83
  84           PHPUnit_Util_Type::toString($this->value)
  85         );
  86     }
  87 }