mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-06-18 05:26:57 +08:00
263 lines
20 KiB
HTML
263 lines
20 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
||
<title>生成 URL-encode 之后的请求字符串</title>
|
||
</head>
|
||
<body class="docs"><div id="layout">
|
||
<div id="layout-content"><div id="function.http-build-query" class="refentry">
|
||
<div class="refnamediv">
|
||
<h1 class="refname">http_build_query</h1>
|
||
<p class="verinfo">(PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">http_build_query</span> — <span class="dc-title">生成 URL-encode 之后的请求字符串</span></p>
|
||
|
||
</div>
|
||
|
||
<div class="refsect1 description" id="refsect1-function.http-build-query-description">
|
||
<h3 class="title">说明</h3>
|
||
<div class="methodsynopsis dc-description">
|
||
<span class="methodname"><strong>http_build_query</strong></span>
|
||
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$query_data</code></span>
|
||
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$numeric_prefix</code></span>
|
||
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$arg_separator</code></span>
|
||
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$enc_type</code><span class="initializer"> = <strong><code>PHP_QUERY_RFC1738</code></strong></span></span>
|
||
]]] ) : <span class="type">string</span></div>
|
||
|
||
<p class="para rdfs-comment">
|
||
使用给出的关联（或下标）数组生成一个经过
|
||
URL-encode 的请求字符串。
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 parameters" id="refsect1-function.http-build-query-parameters">
|
||
<h3 class="title">参数</h3>
|
||
<p class="para">
|
||
<dl>
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">query_data</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
可以是数组或包含属性的对象。
|
||
</p>
|
||
<p class="para">
|
||
一个
|
||
<code class="parameter">query_data</code>
|
||
数组可以是简单的一维结构，也可以是由数组组成的数组（其依次可以包含其它数组）。
|
||
</p>
|
||
<p class="para">
|
||
如果 <code class="parameter">query_data</code> 是一个对象，只有 public 的属性会加入结果。
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">numeric_prefix</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
如果在基础数组中使用了数字下标同时给出了该参数，此参数值将会作为基础数组中的数字下标元素的前缀。
|
||
</p>
|
||
<p class="para">
|
||
这是为了让
|
||
PHP 或其它 CGI
|
||
程序在稍后对数据进行解码时获取合法的变量名。
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">arg_separator</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
除非指定并使用了这个参数，否则会用 <a href="ini.core.html#ini.arg-separator.output" class="link">arg_separator.output</a> 来分隔参数。
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">enc_type</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
默认使用 <strong><code>PHP_QUERY_RFC1738</code></strong>。
|
||
</p>
|
||
<p class="para">
|
||
如果 <code class="parameter">enc_type</code> 是
|
||
<strong><code>PHP_QUERY_RFC1738</code></strong>，则编码将会以 <a href="http://www.faqs.org/rfcs/rfc1738" class="link external">» RFC 1738</a> 标准和 <em>application/x-www-form-urlencoded</em> 媒体类型进行编码，空格会被编码成加号（<em>+</em>）。
|
||
</p>
|
||
<p class="para">
|
||
如果 <code class="parameter">enc_type</code> 是
|
||
<strong><code>PHP_QUERY_RFC3986</code></strong>，将根据 <a href="http://www.faqs.org/rfcs/rfc3986" class="link external">» RFC 3986</a> 编码，空格会被百分号编码（<em>%20</em>）。
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
</dl>
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 returnvalues" id="refsect1-function.http-build-query-returnvalues">
|
||
<h3 class="title">返回值</h3>
|
||
<p class="para">
|
||
返回一个 URL 编码后的字符串。
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 changelog" id="refsect1-function.http-build-query-changelog">
|
||
<h3 class="title">更新日志</h3>
|
||
<p class="para">
|
||
<table class="doctable informaltable">
|
||
|
||
<thead>
|
||
<tr>
|
||
<th>版本</th>
|
||
<th>说明</th>
|
||
</tr>
|
||
|
||
</thead>
|
||
|
||
<tbody class="tbody">
|
||
<tr>
|
||
<td>5.4.0</td>
|
||
<td>
|
||
加入了 <code class="parameter">enc_type</code> 参数。
|
||
</td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td>5.1.3</td>
|
||
<td>
|
||
方括号也会被转义。
|
||
</td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td>5.1.2</td>
|
||
<td>
|
||
加入了参数 <code class="parameter">arg_separator</code>。
|
||
</td>
|
||
</tr>
|
||
|
||
</tbody>
|
||
|
||
</table>
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 examples" id="refsect1-function.http-build-query-examples">
|
||
<h3 class="title">范例</h3>
|
||
<div class="example" id="example-4887">
|
||
<p><strong>Example #1 <span class="function"><strong>http_build_query()</strong></span> 使用示例</strong></p>
|
||
<div class="example-contents">
|
||
<div class="phpcode"><pre><span style="color: #000000">
|
||
<span style="color: #0000BB"><?php<br />$data </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">=></span><span style="color: #DD0000">'bar'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'baz'</span><span style="color: #007700">=></span><span style="color: #DD0000">'boom'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'cow'</span><span style="color: #007700">=></span><span style="color: #DD0000">'milk'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'php'</span><span style="color: #007700">=></span><span style="color: #DD0000">'hypertext processor'</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">http_build_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">http_build_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">, </span><span style="color: #DD0000">''</span><span style="color: #007700">, </span><span style="color: #DD0000">'&amp;'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
|
||
</span>
|
||
</pre></div>
|
||
</div>
|
||
|
||
<div class="example-contents"><p>以上例程会输出：</p></div>
|
||
<div class="example-contents screen">
|
||
<div class="cdata"><pre>
|
||
foo=bar&baz=boom&cow=milk&php=hypertext+processor
|
||
foo=bar&amp;baz=boom&amp;cow=milk&amp;php=hypertext+processor
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="example" id="example-4888">
|
||
<p><strong>Example #2 <span class="function"><strong>http_build_query()</strong></span> 使用数字下标的元素</strong></p>
|
||
<div class="example-contents">
|
||
<div class="phpcode"><pre><span style="color: #000000">
|
||
<span style="color: #0000BB"><?php<br />$data </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">, </span><span style="color: #DD0000">'bar'</span><span style="color: #007700">, </span><span style="color: #DD0000">'baz'</span><span style="color: #007700">, </span><span style="color: #DD0000">'boom'</span><span style="color: #007700">, </span><span style="color: #DD0000">'cow' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'milk'</span><span style="color: #007700">, </span><span style="color: #DD0000">'php' </span><span style="color: #007700">=></span><span style="color: #DD0000">'hypertext processor'</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">http_build_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">http_build_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">, </span><span style="color: #DD0000">'myvar_'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
|
||
</span>
|
||
</pre></div>
|
||
</div>
|
||
|
||
<div class="example-contents"><p>以上例程会输出：</p></div>
|
||
<div class="example-contents screen">
|
||
<div class="cdata"><pre>
|
||
0=foo&1=bar&2=baz&3=boom&cow=milk&php=hypertext+processor
|
||
myvar_0=foo&myvar_1=bar&myvar_2=baz&myvar_3=boom&cow=milk&php=hypertext+processor
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="example" id="example-4889">
|
||
<p><strong>Example #3 <span class="function"><strong>http_build_query()</strong></span> 使用复杂的数组</strong></p>
|
||
<div class="example-contents">
|
||
<div class="phpcode"><pre><span style="color: #000000">
|
||
<span style="color: #0000BB"><?php<br />$data </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'user'</span><span style="color: #007700">=>array(</span><span style="color: #DD0000">'name'</span><span style="color: #007700">=></span><span style="color: #DD0000">'Bob Smith'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'age'</span><span style="color: #007700">=></span><span style="color: #0000BB">47</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'sex'</span><span style="color: #007700">=></span><span style="color: #DD0000">'M'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'dob'</span><span style="color: #007700">=></span><span style="color: #DD0000">'5/12/1956'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'pastimes'</span><span style="color: #007700">=>array(</span><span style="color: #DD0000">'golf'</span><span style="color: #007700">, </span><span style="color: #DD0000">'opera'</span><span style="color: #007700">, </span><span style="color: #DD0000">'poker'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rap'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'children'</span><span style="color: #007700">=>array(</span><span style="color: #DD0000">'bobby'</span><span style="color: #007700">=>array(</span><span style="color: #DD0000">'age'</span><span style="color: #007700">=></span><span style="color: #0000BB">12</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'sex'</span><span style="color: #007700">=></span><span style="color: #DD0000">'M'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'sally'</span><span style="color: #007700">=>array(</span><span style="color: #DD0000">'age'</span><span style="color: #007700">=></span><span style="color: #0000BB">8</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'sex'</span><span style="color: #007700">=></span><span style="color: #DD0000">'F'</span><span style="color: #007700">)),<br /> </span><span style="color: #DD0000">'CEO'</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">http_build_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">, </span><span style="color: #DD0000">'flags_'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
|
||
</span>
|
||
</pre></div>
|
||
</div>
|
||
|
||
<div class="example-contents"><p>
|
||
这会输出：（为了可读性，字已经换行了）
|
||
</p></div>
|
||
<div class="example-contents screen">
|
||
<div class="cdata"><pre>
|
||
user%5Bname%5D=Bob+Smith&user%5Bage%5D=47&user%5Bsex%5D=M&
|
||
user%5Bdob%5D=5%2F12%2F1956&pastimes%5B0%5D=golf&pastimes%5B1%5D=opera&
|
||
pastimes%5B2%5D=poker&pastimes%5B3%5D=rap&children%5Bbobby%5D%5Bage%5D=12&
|
||
children%5Bbobby%5D%5Bsex%5D=M&children%5Bsally%5D%5Bage%5D=8&
|
||
children%5Bsally%5D%5Bsex%5D=F&flags_0=CEO
|
||
</pre></div>
|
||
</div>
|
||
<div class="example-contents"><p>
|
||
<blockquote class="note"><p><strong class="note">Note</strong>:
|
||
<p class="para">
|
||
只有基础数组中的数字下标元素“CEO”才获取了前缀，其它数字下标元素（如
|
||
pastimes 下的元素）则不需要为了合法的变量名而加上前缀。
|
||
</p>
|
||
</p></blockquote>
|
||
</p></div>
|
||
</div>
|
||
|
||
<div class="example" id="example-4890">
|
||
<p><strong>Example #4 <span class="function"><strong>http_build_query()</strong></span> 使用对象</strong></p>
|
||
<div class="example-contents">
|
||
<div class="phpcode"><pre><span style="color: #000000">
|
||
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">parentClass </span><span style="color: #007700">{<br /> public </span><span style="color: #0000BB">$pub </span><span style="color: #007700">= </span><span style="color: #DD0000">'publicParent'</span><span style="color: #007700">;<br /> protected </span><span style="color: #0000BB">$prot </span><span style="color: #007700">= </span><span style="color: #DD0000">'protectedParent'</span><span style="color: #007700">;<br /> private </span><span style="color: #0000BB">$priv </span><span style="color: #007700">= </span><span style="color: #DD0000">'privateParent'</span><span style="color: #007700">;<br /> public </span><span style="color: #0000BB">$pub_bar </span><span style="color: #007700">= </span><span style="color: #0000BB">Null</span><span style="color: #007700">;<br /> protected </span><span style="color: #0000BB">$prot_bar </span><span style="color: #007700">= </span><span style="color: #0000BB">Null</span><span style="color: #007700">;<br /> private </span><span style="color: #0000BB">$priv_bar </span><span style="color: #007700">= </span><span style="color: #0000BB">Null</span><span style="color: #007700">;<br /><br /> public function </span><span style="color: #0000BB">__construct</span><span style="color: #007700">(){<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">pub_bar </span><span style="color: #007700">= new </span><span style="color: #0000BB">childClass</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">prot_bar </span><span style="color: #007700">= new </span><span style="color: #0000BB">childClass</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">priv_bar </span><span style="color: #007700">= new </span><span style="color: #0000BB">childClass</span><span style="color: #007700">();<br /> }<br />}<br /><br />class </span><span style="color: #0000BB">childClass </span><span style="color: #007700">{<br /> public </span><span style="color: #0000BB">$pub </span><span style="color: #007700">= </span><span style="color: #DD0000">'publicChild'</span><span style="color: #007700">;<br /> protected </span><span style="color: #0000BB">$prot </span><span style="color: #007700">= </span><span style="color: #DD0000">'protectedChild'</span><span style="color: #007700">;<br /> private </span><span style="color: #0000BB">$priv </span><span style="color: #007700">= </span><span style="color: #DD0000">'privateChild'</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">$parent </span><span style="color: #007700">= new </span><span style="color: #0000BB">parentClass</span><span style="color: #007700">();<br /><br />echo </span><span style="color: #0000BB">http_build_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$parent</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
|
||
</span>
|
||
</pre></div>
|
||
</div>
|
||
|
||
<div class="example-contents"><p>以上例程会输出：</p></div>
|
||
<div class="example-contents screen">
|
||
<div class="cdata"><pre>
|
||
pub=publicParent&pub_bar%5Bpub%5D=publicChild
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 seealso" id="refsect1-function.http-build-query-seealso">
|
||
<h3 class="title">参见</h3>
|
||
<p class="para">
|
||
<ul class="simplelist">
|
||
<li class="member"><span class="function"><a href="parse_str.html" class="function" rel="rdfs-seeAlso">parse_str()</a> - 将字符串解析成多个变量</span></li>
|
||
<li class="member"><span class="function"><a href="parse_url.html" class="function" rel="rdfs-seeAlso">parse_url()</a> - 解析 URL，返回其组成部分</span></li>
|
||
<li class="member"><span class="function"><a href="urlencode.html" class="function" rel="rdfs-seeAlso">urlencode()</a> - 编码 URL 字符串</span></li>
|
||
<li class="member"><span class="function"><a href="array_walk.html" class="function" rel="rdfs-seeAlso">array_walk()</a> - 使用用户自定义函数对数组中的每个元素做回调处理</span></li>
|
||
</ul>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
</div></div></div></body></html> |