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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.17 $ -->
<refentry xml:id="function.parse-url" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>parse_url</refname>
<refpurpose>Parse a URL and return its components</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>parse_url</methodname>
<methodparam><type>string</type><parameter>url</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>component</parameter></methodparam>
</methodsynopsis>
<para>
This function parses a URL and returns an associative array containing any
of the various components of the URL that are present.
</para>
<para>
This function is <emphasis role="strong">not</emphasis> meant to validate
the given URL, it only breaks it up into the above listed parts. Partial
URLs are also accepted, <function>parse_url</function> tries its best to
parse them correctly.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
<para>
The URL to parse
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><parameter>component</parameter></term>
<listitem>
<para>
Specify one of <constant>PHP_URL_SCHEME</constant>,
<constant>PHP_URL_HOST</constant>, <constant>PHP_URL_PORT</constant>,
<constant>PHP_URL_USER</constant>, <constant>PHP_URL_PASS</constant>,
<constant>PHP_URL_PATH</constant>, <constant>PHP_URL_QUERY</constant>
or <constant>PHP_URL_FRAGMENT</constant> to retrieve just a specific
URL component as a <type>string</type>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
On seriously malformed URLs, <function>parse_url</function> may return
&false; and emit a <constant>E_WARNING</constant>. Otherwise an associative
array is returned, whose components may be (at least one):
<itemizedlist>
<listitem>
<simpara>
<varname remap="structfield">scheme</varname> - e.g. http
</simpara>
</listitem>
<listitem>
<simpara>
<varname remap="structfield">host</varname>
</simpara>
</listitem>
<listitem>
<simpara>
<varname remap="structfield">port</varname>
</simpara>
</listitem>
<listitem>
<simpara>
<varname remap="structfield">user</varname>
</simpara>
</listitem>
<listitem>
<simpara>
<varname remap="structfield">pass</varname>
</simpara>
</listitem>
<listitem>
<simpara>
<varname remap="structfield">path</varname>
</simpara>
</listitem>
<listitem>
<simpara>
<varname remap="structfield">query</varname> - after the question mark <literal>?</literal>
</simpara>
</listitem>
<listitem>
<simpara>
<varname remap="structfield">fragment</varname> - after the hashmark <literal>#</literal>
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
If the <parameter>component</parameter> parameter is specified a
<type>string</type> is returned instead of an <type>array</type>.
</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.1.2</entry>
<entry>Added the <parameter>component</parameter> parameter</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>parse_url</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$url = 'http://username:password@hostname/path?arg=value#anchor';
print_r(parse_url($url));
echo parse_url($url, PHP_URL_PATH);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[scheme] => http
[host] => hostname
[user] => username
[pass] => password
[path] => /path
[query] => arg=value
[fragment] => anchor
)
/path
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function doesn't work with relative URLs.
</para>
</note>
<note>
<para>
This function is intended specifically for the purpose of parsing URLs
and not URIs. However, to comply with PHP's backwards compatibility
requirements it makes an exception for the file:// scheme where tripple
slashes (file:///...) are allowed. For any other scheme this is invalid.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pathinfo</function></member>
<member><function>parse_str</function></member>
<member><function>http_build_query</function></member>
<member><function>dirname</function></member>
<member><function>basename</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:"../../../../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
-->
|
