5 * Copyright (c) 2010-2011, Sebastian Bergmann <sb@sebastian-bergmann.de>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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.
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.
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
46 * Interface for classes which matches an invocation based on its
47 * method name, argument, order or call count.
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
57 interface PHPUnit_Framework_MockObject_Matcher_Invocation extends PHPUnit_Framework_SelfDescribing, PHPUnit_Framework_MockObject_Verifiable
60 * Registers the invocation $invocation in the object as being invoked.
61 * This will only occur after matches() returns true which means the
62 * current invocation is the correct one.
64 * The matcher can store information from the invocation which can later
65 * be checked in verify(), or it can check the values directly and throw
66 * and exception if an expectation is not met.
68 * If the matcher is a stub it will also have a return value.
70 * @param PHPUnit_Framework_MockObject_Invocation $invocation
71 * Object containing information on a mocked or stubbed method which
75 public function invoked(PHPUnit_Framework_MockObject_Invocation $invocation);
78 * Checks if the invocation $invocation matches the current rules. If it does
79 * the matcher will get the invoked() method called which should check if an
82 * @param PHPUnit_Framework_MockObject_Invocation $invocation
83 * Object containing information on a mocked or stubbed method which
87 public function matches(PHPUnit_Framework_MockObject_Invocation $invocation);