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
|
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.request-parse-body" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>request_parse_body</refname>
<refpurpose>Read and parse the request body and return the result</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>request_parse_body</methodname>
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
This function reads the request body and parses it according to the
<literal>Content-Type</literal> header. Currently, two content types are
supported:
</simpara>
<itemizedlist>
<listitem>
<simpara>
<literal>application/x-www-form-urlencoded</literal>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>multipart/form-data</literal>
</simpara>
</listitem>
</itemizedlist>
<simpara>
This function is used primarily to parse
<literal>multipart/form-data</literal> requests with HTTP verbs other than
<literal>POST</literal> which do not automatically populate the
<varname>$_POST</varname> and <varname>$_FILES</varname> superglobals.
</simpara>
<caution>
<simpara>
<function>request_parse_body</function> consumes the request body without
buffering it to the <literal>php://input</literal> stream.
</simpara>
</caution>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<simpara>
The <parameter>options</parameter> parameter accepts an associative array
to override the following global &php.ini; settings for parsing of the
request body.
</simpara>
<itemizedlist>
<listitem><simpara><literal>max_file_uploads</literal></simpara></listitem>
<listitem><simpara><literal>max_input_vars</literal></simpara></listitem>
<listitem><simpara><literal>max_multipart_body_parts</literal></simpara></listitem>
<listitem><simpara><literal>post_max_size</literal></simpara></listitem>
<listitem><simpara><literal>upload_max_filesize</literal></simpara></listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
<function>request_parse_body</function> returns an array pair with the
equivalent of <varname>$_POST</varname> at index <literal>0</literal> and
<varname>$_FILES</varname> at index <literal>1</literal>.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simpara>
When the request body is invalid,
according to the <literal>Content-Type</literal> header,
a <exceptionname>RequestParseBodyException</exceptionname> is thrown.
</simpara>
<simpara>
A <exceptionname>ValueError</exceptionname> is thrown when
<parameter>options</parameter> contains invalid keys,
or invalid values for the corresponding key.
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="function.request-parse-body.example.basic">
<title><function>request_parse_body</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Parse request and store result in the $_POST and $_FILES superglobals.
[$_POST, $_FILES] = request_parse_body();
// Echo the content of some transferred file
echo file_get_contents($_FILES['file_name']['tmp_name']);
?>
]]>
</programlisting>
</example>
<example xml:id="function.request-parse-body.example.options">
<title><function>request_parse_body</function> example with customized options</title>
<programlisting role="php">
<![CDATA[
<?php
// form.php
assert_logged_in();
// Only for this form, we allow a bigger upload size.
[$_POST, $_FILES] = request_parse_body([
'post_max_size' => '10M',
'upload_max_filesize' => '10M',
]);
// Do something with the uploaded files.
?>
]]>
</programlisting>
</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
-->
|
