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
|
---
layout: default
title: The Query component
redirect_from:
- /5.0/components/parsers/
---
Parsers
=======
<p class="message-info">Since <code>version 1.5.0</code></p>
The library provides the following classes to ease components parsing:
- `QueryParser` to parse and deserialize a query string.
- `QueryBuilder` to build a query string from a collection of key/value pairs.
<p class="message-notice">The parsers and their functions alias are defined in the <code>League\Uri</code> namespace.</p>
## QueryParser::extract
~~~php
<?php
public QueryParser::extract(string $query[, string $separator = '&' [, int $enc_type = PHP_QUERY_RFC3986]]): array
~~~
This method deserializes the query string parameters into an associative `array` similar to PHP's `parse_str` when used with its optional second argument. This static public method expects the following arguments:
- The query string **required**;
- The query string separator **optional**, by default it is set to `&`;
- The query string encoding. One of the `ComponentInterface` encoding type constant.
The main differences are with `parse_str` usage are the following:
- `QueryParser::extract` accepts a parameter which describes the query string separator
- `QueryParser::extract` does not mangle the query string data.
- `QueryParser::extract` is not affected by PHP `max_input_vars`.
~~~php
<?php
use League\Uri\QueryParser;
$query_string = 'foo.bar=bar&foo_bar=baz';
parse_str($query_string, $out);
var_export($out);
// $out = ["foo_bar" => 'baz'];
$parser = new QueryParser();
$arr =$parser->extract($query_string);
// $arr = ['foo.bar' => 'bar', 'foo_bar' => baz'];
~~~
<p class="message-info">Since version <code>1.2.0</code> The alias function <code>Uri\extract_query</code> is available</p>
~~~php
<?php
use League\Uri;
$query_string = 'foo.bar=bar&foo_bar=baz';
parse_str($query_string, $out);
var_export($out);
// $out = ["foo_bar" => 'baz'];
$arr = Uri\extract_query($query_string);
// $arr = ['foo.bar' => 'bar', 'foo_bar' => baz'];
~~~
## QueryParser::parse
~~~php
<?php
public QueryParser::parse(string $query[, string $separator = '&' [, int $enc_type = PHP_QUERY_RFC3986]]): array
~~~
This method parse the query string into an associative `array` of key/values pairs. The method expects three (3) arguments:
- The query string **required**;
- The query string separator **optional**, by default it is set to `&`;
- The query string encoding. One of the `ComponentInterface` encoding type constant.
The value returned for each pair can be:
- `null`,
- a `string`
- an array of `string` and/or `null` values.
~~~php
<?php
use League\Uri;
$parser = new QueryParser();
$query_string = 'toto.foo=bar&toto.foo=baz&foo&baz=';
$arr = $parser->parse($query_string, '&');
// [
// "toto.foo" => ["bar", "baz"],
// "foo" => null,
// "baz" => "",
// ]
~~~
<p class="message-warning"><code>QueryParser::parse</code> is not simlar to <code>parse_str</code>, <code>QueryParser::extract</code> is.</p>
<p class="message-warning"><code>QueryParser::parse</code> and <code>QueryParser::extract</code> both convert the query string into an array but <code>QueryParser::parse</code> logic don't result in data loss.</p>
<p class="message-info">Since version <code>1.2.0</code> The alias function <code>Uri\parse_query</code> is available</p>
~~~php
<?php
use League\Uri;
$query_string = 'toto.foo=bar&toto.foo=baz&foo&baz=';
$arr = Uri\parse_query($query_string, '&');
// [
// "toto.foo" => ["bar", "baz"],
// "foo" => null,
// "baz" => "",
// ]
~~~
## QueryParser::convert
<p class="message-info">Available since version <code>1.5.0</code>.</p>
~~~php
<?php
public QueryParser::convert(iterable $pairs): array
//function alias
function pairs_to_params(iterable $pairs): array
~~~
The `QueryParser::convert` deserializes a collection of query string key/value pairs into an associative array similar to PHP’s `parse_str` when used with its optional second argument. This method expects a single argument which represents the collection of key/value pairs as an iterable construct.
The main differences are with `parse_str` usage are the following:
- `QueryParser::extract` accepts a parameter which describes the query string separator
- `QueryParser::extract` does not mangle the query string data.
- `QueryParser::extract` is not affected by PHP `max_input_vars`.
You can also use the function alias which is `Uri\pairs_to_params`.
~~~php
<?php
use League\Uri;
$parser = new Uri\QueryParser();
$arr = $parser->convert(['foo.bar' => ['2', 3, true]]);
//or
$arr = Uri\pairs_to_params(['foo.bar' => ['2', 3, true]]);
//in both cases $arr = ['foo.bar' => 'true'];
~~~
## QueryBuilder::build
~~~php
<?php
public QueryBuilder::build(iterable $pairs[, string $separator = '&' [, int $enc_type = PHP_QUERY_RFC3986]]): array
~~~
The `QueryBuilder::build` restores the query string from the result of the `QueryBuilder::parse` method. The method expects at most 3 arguments:
- A valid `iterable` of key/value pairs to convert;
- The query string separator, by default it is set to `&`;
- The query string encoding using one of the `ComponentInterface` constant
<p class="message-info">By default the encoding is set to <code>EncodingInterface::RFC3986_ENCODING</code></p>
<p class="message-info">Since version <code>1.3.0</code> The method accepts any iterable construct.</p>
~~~php
<?php
use League\Uri\QueryBuilder;
use League\Uri\QueryParser;
$builder = new QueryBuilder();
$parser = new QueryParser();
$query_string = 'foo[]=bar&foo[]=baz';
$arr = $parser->parse($query_string, '&', Query::RFC3986_ENCODING);
// $arr include the following data ["foo[]" => ['bar', 'baz']];
$res = $builder->build($arr, '&', false);
// $res = 'foo[]=bar&foo[]=baz'
~~~
<p class="message-warning"><code>QueryBuilder::build</code> is not similar to <code>http_build_query</code>.</p>
<p class="message-info">Since version <code>1.2.0</code> The alias function <code>Uri\build_query</code> is available</p>
<p class="message-info">Since version <code>1.3.0</code> The function accepts any iterable construct.</p>
~~~php
<?php
use League\Uri;
$query_string = 'foo[]=bar&foo[]=baz';
$arr = Query::parse($query_string, '&', Query::RFC3986_ENCODING);
var_export($arr);
// $arr include the following data ["foo[]" => ['bar', 'baz']];
$res = Uri\build_query($arr, '&', false);
// $res = 'foo[]=bar&foo[]=baz'
~~~
|
