-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcalling-user-functions.html
262 lines (262 loc) · 4.92 KB
/
calling-user-functions.html
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
<HTML
><HEAD
><TITLE
>Calling User Functions</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="PHP development"
HREF="phpdevel.html"><LINK
REL="PREVIOUS"
TITLE="PHP development"
HREF="phpdevel.html"><LINK
REL="NEXT"
TITLE="Reporting Errors"
HREF="phpdevel-errors.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="sect1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="phpdevel.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Appendix B. PHP development</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="phpdevel-errors.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="calling-user-functions"
>Calling User Functions</A
></H1
><P
> To call user functions from an internal function, you should use
the <B
CLASS="function"
>call_user_function()</B
> function.
</P
><P
> <B
CLASS="function"
>call_user_function()</B
> returns SUCCESS on success,
and FAILURE in case the function cannot be found. You should check
that return value! If it returns SUCCESS, you are responsible for
destroying the retval pval yourself (or return it as the return value
of your function). If it returns FAILURE, the value of retval is
undefined, and you mustn't touch it.
</P
><P
> All internal functions that call user functions
<I
CLASS="emphasis"
>must</I
> be reentrant. Among other things, this
means they must not use globals or static variables.
</P
><P
> <B
CLASS="function"
>call_user_function()</B
> takes six arguments:
</P
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="calling-user-functions.function-table"
>HashTable *function_table</A
></H2
><P
> This is the hash table in which the function is to be looked up.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="calling-user-functions.object"
>pval *object</A
></H2
><P
> This is a pointer to an object on which the function is invoked.
This should be NULL if a global function is called. If it's not
NULL (i.e. it points to an object), the function_table argument is
ignored, and instead taken from the object's hash. The object *may*
be modified by the function that is invoked on it (that function
will have access to it via $this). If for some reason you don't
want that to happen, send a copy of the object instead.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="calling-user-functions.function-name"
>pval *function_name</A
></H2
><P
> The name of the function to call. Must be a pval of type
IS_STRING with function_name.str.val and function_name.str.len
set to the appropriate values. The function_name is modified by
call_user_function() - it's converted to lowercase. If you need to
preserve the case, send a copy of the function name instead.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="calling-user-functions.retval"
>pval *retval</A
></H2
><P
> A pointer to a pval structure, into which the return value of
the invoked function is saved. The structure must be previously
allocated - <B
CLASS="function"
>call_user_function()</B
> does NOT allocate
it by itself.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="calling-user-functions.param-count"
>int param_count</A
></H2
><P
> The number of parameters being passed to the function.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="calling-user-functions.params"
>pval *params[]</A
></H2
><P
> An array of pointers to values that will be passed as arguments to the
function, the first argument being in offset 0, the second in offset
1, etc. The array is an array of pointers to pval's; The pointers
are sent as-is to the function, which means if the function modifies
its arguments, the original values are changed (passing by reference).
If you don't want that behavior, pass a copy instead.
</P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="phpdevel.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="phpdevel-errors.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>PHP development</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="phpdevel.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Reporting Errors</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>