1<?php
2/**
3 * PHPUnit
4 *
5 * Copyright (c) 2010-2013, 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-2013 Sebastian Bergmann <sb@sebastian-bergmann.de>
40 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
41 * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
42 * @since      File available since Release 1.0.0
43 */
44
45/**
46 * Builder interface for stubs which are actions replacing an invocation.
47 *
48 * @package    PHPUnit_MockObject
49 * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
50 * @copyright  2010-2013 Sebastian Bergmann <sb@sebastian-bergmann.de>
51 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
52 * @version    Release: @package_version@
53 * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
54 * @since      Interface available since Release 1.0.0
55 */
56interface PHPUnit_Framework_MockObject_Builder_Stub extends PHPUnit_Framework_MockObject_Builder_Identity
57{
58    /**
59     * Stubs the matching method with the stub object $stub. Any invocations of
60     * the matched method will now be handled by the stub instead.
61     *
62     * @param PHPUnit_Framework_MockObject_Stub $stub The stub object.
63     * @return PHPUnit_Framework_MockObject_Builder_Identity
64     */
65    public function will(PHPUnit_Framework_MockObject_Stub $stub);
66}
67