Chris@14: <?php
Chris@14: /*
Chris@14:  * This file is part of the phpunit-mock-objects package.
Chris@14:  *
Chris@14:  * (c) Sebastian Bergmann <sebastian@phpunit.de>
Chris@14:  *
Chris@14:  * For the full copyright and license information, please view the LICENSE
Chris@14:  * file that was distributed with this source code.
Chris@14:  */
Chris@14: namespace PHPUnit\Framework\MockObject;
Chris@14: 
Chris@14: use PHPUnit\Framework\SelfDescribing;
Chris@14: 
Chris@14: /**
Chris@14:  * An object that stubs the process of a normal method for a mock object.
Chris@14:  *
Chris@14:  * The stub object will replace the code for the stubbed method and return a
Chris@14:  * specific value instead of the original value.
Chris@14:  */
Chris@14: interface Stub extends SelfDescribing
Chris@14: {
Chris@14:     /**
Chris@14:      * Fakes the processing of the invocation $invocation by returning a
Chris@14:      * specific value.
Chris@14:      *
Chris@14:      * @param Invocation $invocation The invocation which was mocked and matched by the current method and argument matchers
Chris@14:      *
Chris@14:      * @return mixed
Chris@14:      */
Chris@14:     public function invoke(Invocation $invocation);
Chris@14: }