tests/PHPUnit/PHPUnit/Framework/MockObject/MockObject.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  * Interface for all mock objects which are generated by
  47  * PHPUnit_Framework_MockObject_Mock.
  48  *
  49  * @package    PHPUnit_MockObject
  50  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  51  * @copyright  2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  52  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  53  * @version    Release: 1.0.8
  54  * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
  55  * @since      Interface available since Release 1.0.0
  56  */
  57 interface PHPUnit_Framework_MockObject_MockObject /*extends PHPUnit_Framework_MockObject_Verifiable*/
  58 {
  59     /**
  60      * Registers a new expectation in the mock object and returns the match
  61      * object which can be infused with further details.
  62      *
  63      * @param  PHPUnit_Framework_MockObject_Matcher_Invocation $matcher
  64      * @return PHPUnit_Framework_MockObject_Builder_InvocationMocker
  65      */
  66     public function expects(PHPUnit_Framework_MockObject_Matcher_Invocation $matcher);
  67
  68     /**
  69      * Registers a new static expectation in the mock object and returns the
  70      * match object which can be infused with further details.
  71      *
  72      * @param  PHPUnit_Framework_MockObject_Matcher_Invocation $matcher
  73      * @return PHPUnit_Framework_MockObject_Builder_InvocationMocker
  74      */
  75     public static function staticExpects(PHPUnit_Framework_MockObject_Matcher_Invocation $matcher);
  76
  77     /**
  78      * @return PHPUnit_Framework_MockObject_InvocationMocker
  79      */
  80     public function __phpunit_getInvocationMocker();
  81
  82     /**
  83      * @return PHPUnit_Framework_MockObject_InvocationMocker
  84      */
  85     public static function __phpunit_getStaticInvocationMocker();
  86
  87     /**
  88      * Verifies that the current expectation is valid. If everything is OK the
  89      * code should just return, if not it must throw an exception.
  90      *
  91      * @throws PHPUnit_Framework_ExpectationFailedException
  92      */
  93     public function __phpunit_verify();
  94 }