1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.uopz-set-mock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>uopz_set_mock</refname>
<refpurpose>Use mock instead of class for new objects</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>uopz_set_mock</methodname>
<methodparam><type>string</type><parameter>class</parameter></methodparam>
<methodparam><type>mixed</type><parameter>mock</parameter></methodparam>
</methodsynopsis>
<para>
If <parameter>mock</parameter> is a string containing the name of a class then it will be instantiated instead of
<parameter>class</parameter>. <parameter>mock</parameter> can also be an object.
</para>
<note>
<para>
Only dynamic access to properties and methods will use the <parameter>mock</parameter> object.
Static access still uses the original <parameter>class</parameter>.
See <link linkend="uopz_set_mock.example.static">example</link> below.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class to be mocked.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mock</parameter></term>
<listitem>
<para>
The mock to use in the form of a string containing the name of the class to use or an object.
If a string is passed, it has to be the fully qualified class name. It is
recommended to use the <code>::class</code> magic constant in this case.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL uopz 6.0.0</entry>
<entry>
Mocking static members is no longer supported by this function.
<function>uopz_redefine</function> and <function>uopz_set_return</function>,
or <link linkend="book.componere">Componere</link> can be used instead.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>uopz_set_mock</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
class A {
public function who() {
echo "A";
}
}
class mockA {
public function who() {
echo "mockA";
}
}
uopz_set_mock(A::class, mockA::class);
(new A)->who();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
mockA
]]>
</screen>
</example>
<example>
<title><function>uopz_set_mock</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
class A {
public function who() {
echo "A";
}
}
uopz_set_mock(A::class, new class {
public function who() {
echo "mockA";
}
});
(new A)->who();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
mockA
]]>
</screen>
</example>
<example xml:id="uopz_set_mock.example.static">
<title><function>uopz_set_mock</function> and static members</title>
<para>
As of uopz 6.0.0 mocking static members is no longer supported.
</para>
<programlisting role="php">
<![CDATA[
<?php
class A {
const CON = 'A';
public static function who() {
echo "A";
}
}
uopz_set_mock(A::class, new class {
const CON = 'mockA';
public static function who() {
echo "mockA";
}
});
echo A::CON, PHP_EOL;
A::who();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
A
A
]]>
</screen>
<para>
Output of the above example in uopz 5:
</para>
<screen>
<![CDATA[
mockA
mockA
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>uopz_get_mock</function></member>
<member><function>uopz_unset_mock</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
