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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.uopz-set-return" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>uopz_set_return</refname>
<refpurpose>Provide a return value for an existing function</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>uopz_set_return</methodname>
<methodparam><type>string</type><parameter>function</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>execute</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>uopz_set_return</methodname>
<methodparam><type>string</type><parameter>class</parameter></methodparam>
<methodparam><type>string</type><parameter>function</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>execute</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Sets the return value of the <parameter>function</parameter> to <parameter>value</parameter>. If <parameter>value</parameter>
is a Closure and <parameter>execute</parameter> is set, the Closure will be executed in place of the original function.
It is possible to call the original function from the Closure.
</para>
<note>
<para>
This function replaces <methodname>uopz_rename</methodname>.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class containing the function
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
The name of an existing function
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The value the function should return. If a Closure is provided and the execute flag is set, the Closure will be executed in place of the original function.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>execute</parameter></term>
<listitem>
<para>
If true, and a Closure was provided as the value, the Closure will be executed in place of the original function.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
True if succeeded, false otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>uopz_set_return</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
uopz_set_return("strlen", 42);
echo strlen("Banana");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
42
]]>
</screen>
</example>
<example>
<title><function>uopz_set_return</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
uopz_set_return("strlen", function($str) { return strlen($str) * 2; }, true );
echo strlen("Banana");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
12
]]>
</screen>
</example>
<example>
<title><function>uopz_set_return</function> class example</title>
<programlisting role="php">
<![CDATA[
<?php
class My {
public static function strlen($arg) {
return strlen($arg);
}
}
uopz_set_return(My::class, "strlen", function($str) { return strlen($str) * 2; }, true );
echo My::strlen("Banana");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
12
]]>
</screen>
</example>
</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
-->
|
