1 : <?php
2 : /**
3 : * Mockery
4 : *
5 : * LICENSE
6 : *
7 : * This source file is subject to the new BSD license that is bundled
8 : * with this package in the file LICENSE.txt.
9 : * It is also available through the world-wide-web at this URL:
10 : * http://github.com/padraic/mockery/blob/master/LICENSE
11 : * If you did not receive a copy of the license and are unable to
12 : * obtain it through the world-wide-web, please send an email
13 : * to padraic@php.net so we can send you a copy immediately.
14 : *
15 : * @category Mockery
16 : * @package Mockery
17 : * @copyright Copyright (c) 2010 Pádraic Brady (http://blog.astrumfutura.com)
18 : * @license http://github.com/padraic/mockery/blob/master/LICENSE New BSD License
19 : */
20 :
21 : namespace Mockery;
22 :
23 1 : interface MockInterface
24 : {
25 :
26 : /**
27 : * Alternative setup method to constructor
28 : *
29 : * @param string $name
30 : * @param \Mockery\Container $container
31 : * @param object $partialObject
32 : * @return void
33 : */
34 : public function mockery_init($name, \Mockery\Container $container = null, $partialObject = null);
35 :
36 : /**
37 : * Set expected method calls
38 : *
39 : * @param mixed
40 : * @return \Mockery\Expectation
41 : */
42 : public function shouldReceive();
43 :
44 : /**
45 : * Set mock to ignore unexpected methods and return Undefined class
46 : *
47 : * @return void
48 : */
49 : public function shouldIgnoreMissing();
50 :
51 : /**
52 : * In the event shouldReceive() accepting an array of methods/returns
53 : * this method will switch them from normal expectations to default
54 : * expectations
55 : *
56 : * @return self
57 : */
58 : public function byDefault();
59 :
60 : /**
61 : * Capture calls to this mock and check against expectations
62 : *
63 : * @param string $method
64 : * @param array $args
65 : * @return mixed
66 : */
67 : /**
68 : * Unfortunately we need to allow type hinting agnostic __call()
69 : * definitions since any interface/class being mocked can go either
70 : * way.
71 : */
72 : //public function __call($method, array $args);
73 :
74 : /**
75 : * Iterate across all expectation directors and validate each
76 : *
77 : * @throws \Mockery\CountValidator\Exception
78 : * @return void
79 : */
80 : public function mockery_verify();
81 :
82 : /**
83 : * Tear down tasks for this mock
84 : *
85 : * @return void
86 : */
87 : public function mockery_teardown();
88 :
89 : /**
90 : * Fetch the next available allocation order number
91 : *
92 : * @return int
93 : */
94 : public function mockery_allocateOrder();
95 :
96 : /**
97 : * Set ordering for a group
98 : *
99 : * @param mixed $group
100 : * @param int $order
101 : */
102 : public function mockery_setGroup($group, $order);
103 :
104 : /**
105 : * Fetch array of ordered groups
106 : *
107 : * @return array
108 : */
109 : public function mockery_getGroups();
110 :
111 : /**
112 : * Set current ordered number
113 : *
114 : * @param int $order
115 : */
116 : public function mockery_setCurrentOrder($order);
117 :
118 : /**
119 : * Get current ordered number
120 : *
121 : * @return int
122 : */
123 : public function mockery_getCurrentOrder();
124 :
125 : /**
126 : * Validate the current mock's ordering
127 : *
128 : * @param string $method
129 : * @param int $order
130 : * @throws \Mockery\Exception
131 : * @return void
132 : */
133 : public function mockery_validateOrder($method, $order);
134 :
135 : /**
136 : * Return the expectations director for the given method
137 : *
138 : * @var string $method
139 : * @return \Mockery\ExpectationDirector|null
140 : */
141 : public function mockery_setExpectationsFor($method, \Mockery\ExpectationDirector $director);
142 :
143 : /**
144 : * Return the expectations director for the given method
145 : *
146 : * @var string $method
147 : * @return \Mockery\ExpectationDirector|null
148 : */
149 : public function mockery_getExpectationsFor($method);
150 :
151 : /**
152 : * Find an expectation matching the given method and arguments
153 : *
154 : * @var string $method
155 : * @var array $args
156 : * @return \Mockery\Expectation|null
157 : */
158 : public function mockery_findExpectation($method, array $args);
159 :
160 : /**
161 : * Return the container for this mock
162 : *
163 : * @return \Mockery\Container
164 : */
165 : public function mockery_getContainer();
166 :
167 : /**
168 : * Return the name for this mock
169 : *
170 : * @return string
171 : */
172 : public function mockery_getName();
173 :
174 : }
|