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 * Mocker for invocations which are sent from
47 * PHPUnit_Framework_MockObject_MockObject objects.
49 * Keeps track of all expectations and stubs as well as registering
50 * identifications for builders.
52 * @package PHPUnit_MockObject
53 * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
54 * @copyright 2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
55 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
56 * @version Release: 1.0.9
57 * @link http://github.com/sebastianbergmann/phpunit-mock-objects
58 * @since Class available since Release 1.0.0
60 class PHPUnit_Framework_MockObject_InvocationMocker implements PHPUnit_Framework_MockObject_Stub_MatcherCollection, PHPUnit_Framework_MockObject_Invokable, PHPUnit_Framework_MockObject_Builder_Namespace
63 * @var PHPUnit_Framework_MockObject_Matcher_Invocation[]
65 protected $matchers = array();
68 * @var PHPUnit_Framework_MockObject_Builder_Match[]
70 protected $builderMap = array();
73 * @param PHPUnit_Framework_MockObject_Matcher_Invocation $matcher
75 public function addMatcher(PHPUnit_Framework_MockObject_Matcher_Invocation $matcher)
77 $this->matchers[] = $matcher;
82 * @return boolean|null
84 public function lookupId($id)
86 if (isset($this->builderMap[$id])) {
87 return $this->builderMap[$id];
95 * @param PHPUnit_Framework_MockObject_Builder_Match $builder
96 * @throws PHPUnit_Framework_Exception
98 public function registerId($id, PHPUnit_Framework_MockObject_Builder_Match $builder)
100 if (isset($this->builderMap[$id])) {
101 throw new PHPUnit_Framework_Exception(
102 'Match builder with id <' . $id . '> is already registered.'
106 $this->builderMap[$id] = $builder;
110 * @param PHPUnit_Framework_MockObject_Matcher_Invocation $matcher
111 * @return PHPUnit_Framework_MockObject_Builder_InvocationMocker
113 public function expects(PHPUnit_Framework_MockObject_Matcher_Invocation $matcher)
115 return new PHPUnit_Framework_MockObject_Builder_InvocationMocker(
121 * @param PHPUnit_Framework_MockObject_Invocation $invocation
124 public function invoke(PHPUnit_Framework_MockObject_Invocation $invocation)
127 $hasReturnValue = FALSE;
129 if (strtolower($invocation->methodName) == '__tostring') {
135 foreach ($this->matchers as $match) {
137 if ($match->matches($invocation)) {
138 $value = $match->invoked($invocation);
140 if (!$hasReturnValue) {
141 $returnValue = $value;
142 $hasReturnValue = TRUE;
147 catch (Exception $e) {
152 if ($exception !== NULL) {
160 * @param PHPUnit_Framework_MockObject_Invocation $invocation
163 public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
165 foreach($this->matchers as $matcher) {
166 if (!$matcher->matches($invocation)) {
177 public function verify()
179 foreach($this->matchers as $matcher) {