tests/PHPUnit/PHPUnit/Framework/MockObject/Stub.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  * An object that stubs the process of a normal method for a mock object.
  47  *
  48  * The stub object will replace the code for the stubbed method and return a
  49  * specific value instead of the original value.
  50  *
  51  * @package    PHPUnit_MockObject
  52  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  53  * @copyright  2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  54  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  55  * @version    Release: 1.0.9
  56  * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
  57  * @since      Interface available since Release 1.0.0
  58  */
  59 interface PHPUnit_Framework_MockObject_Stub extends PHPUnit_Framework_SelfDescribing
  60 {
  61     /**
  62      * Fakes the processing of the invocation $invocation by returning a
  63      * specific value.
  64      *
  65      * @param  PHPUnit_Framework_MockObject_Invocation $invocation
  66      *         The invocation which was mocked and matched by the current method
  67      *         and argument matchers.
  68      * @return mixed
  69      */
  70     public function invoke(PHPUnit_Framework_MockObject_Invocation $invocation);
  71 }