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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.func-get-arg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>func_get_arg</refname>
<refpurpose>Return an item from the argument list</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>func_get_arg</methodname>
<methodparam><type>int</type><parameter>arg_num</parameter></methodparam>
</methodsynopsis>
<para>
Gets the specified argument from a user-defined function's argument list.
</para>
<para>
This function may be used in conjunction with
<function>func_get_args</function> and <function>func_num_args</function>
to allow user-defined functions to accept variable-length argument lists.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>arg_num</parameter></term>
<listitem>
<para>
The argument offset. Function arguments are counted starting from
zero.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the specified argument, or &false; on error.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.3.0</entry>
<entry>
This function can now be used in parameter lists.
</entry>
</row>
<row>
<entry>5.3.0</entry>
<entry>
If this function is called from the outtermost scope of a file
which has been included by calling <function>include</function>
or <function>require</function> from within a function in the
calling file, it now generates a warning and returns &false;.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Generates a warning if called from outside of a user-defined function, or
if <parameter>arg_num</parameter> is greater than the number of arguments
actually passed.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>func_get_arg</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
function foo()
{
$numargs = func_num_args();
echo "Number of arguments: $numargs<br />\n";
if ($numargs >= 2) {
echo "Second argument is: " . func_get_arg(1) . "<br />\n";
}
}
foo (1, 2, 3);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title><function>func_get_arg</function> example before and
after PHP 5.3</title>
<programlisting role="php">
<![CDATA[
test.php
<?php
function foo() {
include './fga.inc';
}
foo('First arg', 'Second arg');
?>
fga.php
<?php
$arg = func_get_arg(1);
var_export($arg);
?>
]]>
</programlisting>
<para>
Output previous to PHP 5.3:
</para>
<screen>
<![CDATA[
'Second arg'
]]>
</screen>
<para>
Output in PHP 5.3 and later:
</para>
<screen>
<![CDATA[
Warning: func_get_arg(): Called from the global scope - no function
context in /home/torben/Desktop/code/ml/fga.inc on line 3
false
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
¬e.funcnoparam;
<note>
<simpara>
This function returns a copy of the passed arguments only, and does not
account for default (non-passed) arguments.
</simpara>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>func_get_args</function></member>
<member><function>func_num_args</function></member>
</simplelist>
</para>
</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
-->
|
