php-doc-en/reference/url/functions/http-build-query.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<refentry id="function.http-build-query">
 <refnamediv>
  <refname>http_build_query</refname>
  <refpurpose>Generate URL-encoded query string</refpurpose>
 </refnamediv>
 
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>string</type><methodname>http_build_query</methodname>
   <methodparam><type>array</type><parameter>formdata</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>numeric_prefix</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>arg_separator</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   Generates a URL-encoded query string from the associative (or indexed) array provided.
   <parameter>formdata</parameter> may be an array or object containing properties.
   A <parameter>formdata</parameter> array may be a simple one-dimensional structure,
   or an array of arrays (who in turn may contain other arrays).  If numeric indices
   are used in the base array and a <parameter>numeric_prefix</parameter> is provided,
   it will be prepended to the numeric index for elements in the base array only.
   This is to allow for legal variable names when the data is decoded by PHP
   or another CGI application later on.
  </simpara>

  <note>
   <para>
    <link linkend="ini.arg-separator.output">arg_separator.output</link> is
    used to separate arguments, unless the
    <parameter>arg_separator</parameter> parameter is specified, which is then
    used.
   </para>
  </note>

  <example>
   <title>Simple usage of <function>http_build_query</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$data = array('foo'=>'bar',
              'baz'=>'boom',
              'cow'=>'milk',
              'php'=>'hypertext processor');

echo http_build_query($data); // foo=bar&baz=boom&cow=milk&php=hypertext+processor
echo http_build_query($data, '', '&amp;'); // foo=bar&amp;baz=boom&amp;cow=milk&amp;php=hypertext+processor

?>
]]>
   </programlisting>
  </example>

  <example>
   <title><function>http_build_query</function> with numerically index elements.</title>
   <programlisting role="php">
<![CDATA[
<?php
$data = array('foo', 'bar', 'baz', 'boom', 'cow' => 'milk', 'php' =>'hypertext processor');

echo http_build_query($data);
/* Outputs:
      0=foo&1=bar&2=baz&3=boom&cow=milk&php=hypertext+processor
 */

echo http_build_query($data, 'myvar_');
/* Outputs:
      myvar_0=foo&myvar_1=bar&myvar_2=baz&myvar_3=boom&cow=milk&php=hypertext+processor
 */
?>
]]>
   </programlisting>
  </example>

  <example>
   <title><function>http_build_query</function> with complex arrays</title>
   <programlisting role="php">
<![CDATA[
<?php
$data = array('user'=>array('name'=>'Bob Smith',
                            'age'=>47,
                            'sex'=>'M',
                            'dob'=>'5/12/1956'),
              'pastimes'=>array('golf', 'opera', 'poker', 'rap'),
              'children'=>array('bobby'=>array('age'=>12,
                                               'sex'=>'M'),
                                'sally'=>array('age'=>8,
                                               'sex'=>'F')),
              'CEO');

echo http_build_query($data, 'flags_');
?>
]]>
   </programlisting>
   <para>
    this will output : (word wrapped for readability)
   </para>
   <screen>
<![CDATA[
user[name]=Bob+Smith&user[age]=47&user[sex]=M&user[dob]=5%2F12%2F1956&
pastimes[0]=golf&pastimes[1]=opera&pastimes[2]=poker&pastimes[3]=rap&
children[bobby][age]=12&children[bobby][sex]=M&children[sally][age]=8&
children[sally][sex]=F&flags_0=CEO
]]>
   </screen>
   <para>
    <note>
     <para>
      Only the numerically indexed element in the base array "CEO" received a
      prefix.  The other numeric indices, found under pastimes, do not
      require a string prefix to be legal variable names.
     </para>
    </note>
   </para>
  </example>

  <example>
   <title>Using <function>http_build_query</function> with an object</title>
   <programlisting role="php">
<![CDATA[
<?php
class myClass {
    var $foo;
    var $baz;

    function myClass() {
        $this->foo = 'bar';
        $this->baz = 'boom';
    }
}

$data = new myClass();

echo http_build_query($data); // foo=bar&baz=boom

?>
]]>
   </programlisting>
  </example>

  <note>
   <simpara>
    The <parameter>arg_separator</parameter> parameter was added in PHP 5.1.2.
   </simpara>
  </note>

  <simpara>
   See also:
   <function>parse_str</function>,
   <function>parse_url</function>,
   <function>urlencode</function>, and
   <function>array_walk</function>
  </simpara>
 </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
-->