mirror of
https://github.com/macintoshplus/doc-fr.git
synced 2026-03-25 17:32:07 +01:00
277 lines
8.0 KiB
XML
277 lines
8.0 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: a1702b5d45ad950c5f7a077878378a37851a2df6 Maintainer: yannick Status: ready -->
|
|
<!-- Reviewed: yes -->
|
|
<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>Génère une chaîne de requête en encodage URL</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>http_build_query</methodname>
|
|
<methodparam><type class="union"><type>array</type><type>object</type></type><parameter>data</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>numeric_prefix</parameter><initializer>""</initializer></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>arg_separator</parameter><initializer>&null;</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>encoding_type</parameter><initializer><constant>PHP_QUERY_RFC1738</constant></initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Génère une chaîne en encodage URL, construite à partir du tableau
|
|
indexé ou associatif <parameter>data</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>data</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Peut être un tableau ou un objet contenant des propriétés.
|
|
</para>
|
|
<para>
|
|
Si <parameter>data</parameter> est un tableau, alors ce peut
|
|
être un tableau à une ou plusieurs dimensions.
|
|
</para>
|
|
<para>
|
|
Si <parameter>data</parameter> est un objet, alors seuls les
|
|
attributs publics seront utilisés dans le résultat.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>numeric_prefix</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Si des indices numériques sont utilisés dans
|
|
le tableau de base et que <parameter>numeric_prefix</parameter> est fourni,
|
|
il sera utilisé pour préfixer les noms des index pour les éléments du tableau
|
|
de base seulement.
|
|
</para>
|
|
<para>
|
|
Cela permet de générer des noms de variables valides, si
|
|
les données sont ensuite décodées par PHP ou une application CGI.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>arg_separator</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<link linkend="ini.arg-separator.output">arg_separator.output</link> est
|
|
utilisée pour séparer les arguments mais peut être modifiée en spécifiant ce
|
|
paramètre.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>encoding_type</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Par défaut, vaut <constant>PHP_QUERY_RFC1738</constant>.
|
|
</para>
|
|
<para>
|
|
Si <parameter>encoding_type</parameter> vaut
|
|
<constant>PHP_QUERY_RFC1738</constant>,
|
|
alors l'encodage est effectué conformément à la
|
|
<link xlink:href="&url.rfc;1738">RFC 1738</link>
|
|
et les espaces du type de média
|
|
<literal>application/x-www-form-urlencoded</literal>, qui
|
|
est impacté par ce choix, seront encodés sous la forme
|
|
d'un signe plus (<literal>+</literal>).
|
|
</para>
|
|
<para>
|
|
Si <parameter>encoding_type</parameter> vaut
|
|
<constant>PHP_QUERY_RFC3986</constant>, alors l'encodage
|
|
est effectué conformément à la
|
|
<link xlink:href="&url.rfc;3986">RFC 3986</link>, et les
|
|
espaces seront encodés en signe pourcent (<literal>%20</literal>).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Retourne une &string; encodée URL.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>Utilisation simple de <function>http_build_query</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$data = array(
|
|
'foo' => 'bar',
|
|
'baz' => 'boom',
|
|
'cow' => 'milk',
|
|
'null' => null,
|
|
'php' => 'hypertext processor'
|
|
);
|
|
|
|
echo http_build_query($data) . "\n";
|
|
echo http_build_query($data, '', '&');
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
foo=bar&baz=boom&cow=milk&php=hypertext+processor
|
|
foo=bar&baz=boom&cow=milk&php=hypertext+processor
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
|
|
<example>
|
|
<title><function>http_build_query</function> avec tableau indexé</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$data = array('foo', 'bar', 'baz', null, 'boom', 'cow' => 'milk', 'php' => 'hypertext processor');
|
|
|
|
echo http_build_query($data) . "\n";
|
|
echo http_build_query($data, 'myvar_');
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
0=foo&1=bar&2=baz&4=boom&cow=milk&php=hypertext+processor
|
|
myvar_0=foo&myvar_1=bar&myvar_2=baz&myvar_4=boom&cow=milk&php=hypertext+processor
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title><function>http_build_query</function> avec tableau complexe</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>
|
|
cet exemple va afficher : (sur plusieurs lignes pour la lisibilité)
|
|
</para>
|
|
<screen>
|
|
<![CDATA[
|
|
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
|
|
]]>
|
|
</screen>
|
|
<para>
|
|
<note>
|
|
<para>
|
|
Seuls les éléments indexés numériquement ("<literal>CEO</literal>")
|
|
dans le tableau de base sont préfixés. Les autres indices numériques à
|
|
d'autres niveaux n'ont pas besoin de l'être pour avoir des noms valides.
|
|
</para>
|
|
</note>
|
|
</para>
|
|
</example>
|
|
|
|
<example>
|
|
<title>Utilisation de <function>http_build_query</function> avec un objet</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
class parentClass {
|
|
public $pub = 'publicParent';
|
|
protected $prot = 'protectedParent';
|
|
private $priv = 'privateParent';
|
|
public $pub_bar = null;
|
|
protected $prot_bar = null;
|
|
private $priv_bar = null;
|
|
|
|
public function __construct(){
|
|
$this->pub_bar = new childClass();
|
|
$this->prot_bar = new childClass();
|
|
$this->priv_bar = new childClass();
|
|
}
|
|
}
|
|
|
|
class childClass {
|
|
public $pub = 'publicChild';
|
|
protected $prot = 'protectedChild';
|
|
private $priv = 'privateChild';
|
|
}
|
|
|
|
$parent = new parentClass();
|
|
|
|
echo http_build_query($parent);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
pub=publicParent&pub_bar%5Bpub%5D=publicChild
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>parse_str</function></member>
|
|
<member><function>parse_url</function></member>
|
|
<member><function>urlencode</function></member>
|
|
<member><function>array_walk</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:"~/.phpdoc/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
|
|
-->
|