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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.filter-input-array" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<refnamediv>
<refname>filter_input_array</refname>
<refpurpose>Gets external variables and optionally filters them</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type><type>null</type></type><methodname>filter_input_array</methodname>
<methodparam><type>int</type><parameter>type</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>int</type></type><parameter>options</parameter><initializer><constant>FILTER_DEFAULT</constant></initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>add_empty</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
This function is useful for retrieving many values without
repetitively calling <function>filter_input</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<simpara>
One of the <constant>INPUT_<replaceable>*</replaceable></constant> constants.
</simpara>
<warning>
<simpara>
The content of the superglobal that is being filtered is the original
"raw" content provided by the <acronym>SAPI</acronym>,
prior to any user modification to the superglobal.
To filter a modified superglobal use
<function>filter_var_array</function> instead.
</simpara>
</warning>
</listitem>
</varlistentry>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.filter-var-array')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='options']]]/.)">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.filter-var-array')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='add_empty']]]/.)">
<xi:fallback/>
</xi:include>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
On success, an &array; containing the values of the requested variables.
</simpara>
<simpara>
On failure, &false; is returned.
Except if the failure is that the input array designated by
<parameter>type</parameter> is not populated where &null; is returned
if the <constant>FILTER_NULL_ON_FAILURE</constant> flag is used.
</simpara>
<simpara>
Missing entries from the input array will be populated into the returned
&array; if <parameter>add_empty</parameter> is &true;.
In which case, missing entries will be set to &null;,
unless the <constant>FILTER_NULL_ON_FAILURE</constant> flag is used,
in which case it will be &false;.
</simpara>
<simpara>
An entry of the returned &array; will be &false; if the filter fails,
unless the <constant>FILTER_NULL_ON_FAILURE</constant> flag is used,
in which case it will be &null;.
</simpara>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
There is no <literal>REQUEST_TIME</literal> key in
<constant>INPUT_SERVER</constant> array because it is inserted into the
<varname>$_SERVER</varname> later.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>filter_input</function></member>
<member><function>filter_var</function></member>
<member><function>filter_var_array</function></member>
<member>
Validation filters
<constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>
</member>
<member>
Sanitization filters
<constant>FILTER_SANITIZE_<replaceable>*</replaceable></constant>
</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
-->
|
