Chris@0: <?php
Chris@0: /*
Chris@0:  * This file is part of the PHPUnit_MockObject package.
Chris@0:  *
Chris@0:  * (c) Sebastian Bergmann <sebastian@phpunit.de>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * An object that stubs the process of a normal method for a mock object.
Chris@0:  *
Chris@0:  * The stub object will replace the code for the stubbed method and return a
Chris@0:  * specific value instead of the original value.
Chris@0:  *
Chris@0:  * @since Interface available since Release 1.0.0
Chris@0:  */
Chris@0: interface PHPUnit_Framework_MockObject_Stub extends PHPUnit_Framework_SelfDescribing
Chris@0: {
Chris@0:     /**
Chris@0:      * Fakes the processing of the invocation $invocation by returning a
Chris@0:      * specific value.
Chris@0:      *
Chris@0:      * @param  PHPUnit_Framework_MockObject_Invocation $invocation
Chris@0:      *                                                             The invocation which was mocked and matched by the current method
Chris@0:      *                                                             and argument matchers.
Chris@0:      * @return mixed
Chris@0:      */
Chris@0:     public function invoke(PHPUnit_Framework_MockObject_Invocation $invocation);
Chris@0: }