svn: /phpdoc/en/trunk/reference/url/functions/ http-build-query.xml
| From: | Adam Harvey | Date: | Mon, 10 Jan 2011 04:34:30 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/url/functions/ http-build-query.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7629@lists.php.net to get a copy of this message | ||
aharvey Mon, 10 Jan 2011 04:34:30 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=307323
Log:
Fix build (the xlink namespace wasn't defined); fix indenting; rewrite the
description for the enc_type parameter to make it clearer.
Changed paths:
U phpdoc/en/trunk/reference/url/functions/http-build-query.xml
Modified: phpdoc/en/trunk/reference/url/functions/http-build-query.xml
===================================================================
--- phpdoc/en/trunk/reference/url/functions/http-build-query.xml 2011-01-10 04:28:25 UTC (rev
307322)
+++ phpdoc/en/trunk/reference/url/functions/http-build-query.xml 2011-01-10 04:34:30 UTC (rev
307323)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.http-build-query" xmlns="http://docbook.org/ns/docbook">
+<refentry xml:id="function.http-build-query" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>http_build_query</refname>
<refpurpose>Generate URL-encoded query string</refpurpose>
@@ -13,7 +13,7 @@
<methodparam><type>mixed</type><parameter>query_data</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>numeric_prefix</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>arg_separator</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>enc_type</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>enc_type</parameter><initializer><constant>PHP_QUERY_RFC1738</constant></initializer></methodparam>
</methodsynopsis>
<para>
Generates a URL-encoded query string from the associative (or indexed)
@@ -70,15 +70,21 @@
<term><parameter>enc_type</parameter></term>
<listitem>
<para>
- By default, or ,
- if <constant>PHP_QUERY_RFC1738</constant> is specified,
- RFC1738 based scheme, that is the same way as in
- <literal>application/x-www-form-urlencoded</literal> media type,
- is used. The spaces are encoded as plus (+) signs in this case.
- If <constant>PHP_QUERY_RFC3986</constant> is specified,
- it encodes the given string
- according to <link xlink:href="&url.rfc;3986">RFC 3986</link>.
+ By default, <constant>PHP_QUERY_RFC1738</constant>.
</para>
+ <para>
+ If <parameter>enc_type</parameter> is
+ <constant>PHP_QUERY_RFC1738</constant>, then encoding is performed per
+ <link xlink:href="&url.rfc;1738">RFC 1738</link> and the
+ <literal>application/x-www-form-urlencoded</literal> media type, which
+ implies that spaces are encoded as plus (<literal>+</literal>) signs.
+ </para>
+ <para>
+ If <parameter>enc_type</parameter> is
+ <constant>PHP_QUERY_RFC3986</constant>, then encoding is performed
+ according to <link xlink:href="&url.rfc;3986">RFC 3986</link>, and
+ spaces will be percent encoded (<literal>%20</literal>).
+ </para>
</listitem>
</varlistentry>
</variablelist>
@@ -119,7 +125,7 @@
<row>
<entry>5.3.6</entry>
<entry>
- The <parameter>enc_type</parameter> parameter was added.
+ The <parameter>enc_type</parameter> parameter was added.
</entry>
</row>
</tbody>