mirror of
https://github.com/php/doc-fr.git
synced 2026-03-25 07:32:17 +01:00
292 lines
7.6 KiB
XML
292 lines
7.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- EN-Revision: eaec4ab10a65c4515ee2fb899d06e89bae3754b0 Maintainer: yannick Status: ready -->
|
||
<!-- Reviewed: no -->
|
||
<!-- CREDITS: DavidA. -->
|
||
|
||
<refentry xml:id="function.list" xmlns="http://docbook.org/ns/docbook">
|
||
<refnamediv>
|
||
<refname>list</refname>
|
||
<refpurpose>Assigne des variables comme si elles étaient un tableau</refpurpose>
|
||
</refnamediv>
|
||
<refsect1 role="description">
|
||
&reftitle.description;
|
||
<methodsynopsis>
|
||
<type>array</type><methodname>list</methodname>
|
||
<methodparam><type>mixed</type><parameter>var</parameter></methodparam>
|
||
<methodparam rep="repeat" choice="opt"><type>mixed</type><parameter>vars</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
Tout comme <function>array</function>, <function>list</function> n'est pas une
|
||
véritable fonction, mais un élément de langage, qui permet de rassembler
|
||
les variables <parameter>varname</parameter>, <parameter>...</parameter>
|
||
sous forme de tableau, pour les assigner en une seule ligne.
|
||
Seuls les tableaux et les objets qui implémentent <link linkend="class.arrayaccess">ArrayAccess</link> peuvent être déstructurés.
|
||
Les expressions <function>list</function> ne peuvent pas être complètement vides.
|
||
</para>
|
||
<note>
|
||
<para>
|
||
Antérieur à PHP 7.1.0, <function>list</function> fonctionne uniquement sur un tableau
|
||
d'indice numérique et suppose que l'indice numérique commence à 0.
|
||
</para>
|
||
</note>
|
||
<para>
|
||
À partir de PHP 7.1.0, <function>list</function> peut également contenir des clés explicites, permettant ainsi la
|
||
déstructuration de tableaux avec des clés non entières ou non séquentielles. Pour plus de détails sur
|
||
la déstructuration de tableaux, voir la <link linkend="language.types.array.syntax.destructuring">section sur la déstructuration des tableaux</link>.
|
||
</para>
|
||
<note>
|
||
<para>
|
||
Tenter d’accéder à une clé de tableau qui n’a pas été définie est
|
||
équivalent à accéder à toute autre variable non définie :
|
||
un message d’erreur de niveau <constant>E_WARNING</constant>
|
||
(<constant>E_NOTICE</constant> avant PHP 8.0.0) sera émis,
|
||
et le résultat sera &null;.
|
||
</para>
|
||
<para>
|
||
Tenter de déstructurer un scalaire affecte &null; à toutes les variables.
|
||
Tenter de déstructurer un objet qui n’implémente pas ArrayAccess est une erreur fatale.
|
||
</para>
|
||
</note>
|
||
</refsect1>
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<para>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>var</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Une variable.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>vars</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Variables supplémentaires.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
Retourne le tableau assigné.
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="changelog">
|
||
&reftitle.changelog;
|
||
<para>
|
||
<informaltable>
|
||
<tgroup cols="2">
|
||
<thead>
|
||
<row>
|
||
<entry>&Version;</entry>
|
||
<entry>&Description;</entry>
|
||
</row>
|
||
</thead>
|
||
<tbody>
|
||
<row>
|
||
<entry>7.3.0</entry>
|
||
<entry>
|
||
Le support pour l'assignement par référence dans la déstructuration
|
||
de tableau a été ajouté.
|
||
</entry>
|
||
</row>
|
||
<row>
|
||
<entry>7.1.0</entry>
|
||
<entry>
|
||
Il est maintenant possible de spécifier les clés dans la
|
||
<function>list</function>. Cela permet de déstructurer des tableaux
|
||
avec des clés non-entières ou non séquentielles.
|
||
</entry>
|
||
</row>
|
||
</tbody>
|
||
</tgroup>
|
||
</informaltable>
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="examples">
|
||
&reftitle.examples;
|
||
<para>
|
||
<example>
|
||
<title>Exemple avec <function>list</function></title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
|
||
$info = array('coffee', 'brown', 'caffeine');
|
||
|
||
// Liste toutes les variables
|
||
list($drink, $color, $power) = $info;
|
||
echo "$drink is $color and $power makes it special.\n";
|
||
|
||
// Liste certaines variables
|
||
list($drink, , $power) = $info;
|
||
echo "$drink has $power.\n";
|
||
|
||
// Ou bien, n'utilisons que le troisième
|
||
list( , , $power) = $info;
|
||
echo "I need $power!\n";
|
||
|
||
// list() ne fonctionne pas avec les chaînes de caractères
|
||
list($bar) = "abcde";
|
||
var_dump($bar); // NULL
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
</example>
|
||
</para>
|
||
<para>
|
||
<example>
|
||
<title>Exemple d'utilisation de <function>list</function></title>
|
||
<programlisting role="php" annotations="non-interactive">
|
||
<![CDATA[
|
||
<?php
|
||
$result = $pdo->query("SELECT id, name FROM employees");
|
||
while (list($id, $name) = $result->fetch(PDO::FETCH_NUM)) {
|
||
echo "id: $id, name: $name\n";
|
||
}
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
</example>
|
||
</para>
|
||
<para>
|
||
<example>
|
||
<title>Utilisation d'un sous-<function>list</function></title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
|
||
list($a, list($b, $c)) = array(1, array(2, 3));
|
||
|
||
var_dump($a, $b, $c);
|
||
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
&example.outputs;
|
||
<screen>
|
||
<![CDATA[
|
||
int(1)
|
||
int(2)
|
||
int(3)
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
</para>
|
||
<para>
|
||
L'ordre dans lequel les indices d'un tableau à traiter par
|
||
<function>list</function> sont définis est non pertinent.
|
||
</para>
|
||
<para>
|
||
<example>
|
||
<title><function>list</function> et l'ordre de définition des index</title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$foo = array(2 => 'a', 'foo' => 'b', 0 => 'c');
|
||
$foo[1] = 'd';
|
||
list($x, $y, $z) = $foo;
|
||
var_dump($foo, $x, $y, $z);
|
||
]]>
|
||
</programlisting>
|
||
<para>
|
||
Étant donné la sortie suivante (notez l'ordre des éléments comparés
|
||
et dans quel ordre ils ont été écrits dans la syntaxe
|
||
de la <function>list</function>) :
|
||
</para>
|
||
<screen>
|
||
<![CDATA[
|
||
array(4) {
|
||
[2]=>
|
||
string(1) "a"
|
||
["foo"]=>
|
||
string(1) "b"
|
||
[0]=>
|
||
string(1) "c"
|
||
[1]=>
|
||
string(1) "d"
|
||
}
|
||
string(1) "c"
|
||
string(1) "d"
|
||
string(1) "a"
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
</para>
|
||
<para>
|
||
<example>
|
||
<title><function>list</function> avec des clés</title>
|
||
<simpara>
|
||
À partir de PHP 7.1.0 <function>list</function> peut maintenant contenir également
|
||
des clés explicites, qui peuvent être donnés comme des expressions arbitraires.
|
||
Le mixage des clés &integer; et &string; est autorisé; Toutefois, les éléments
|
||
avec et sans clés ne peuvent pas être mélangés.
|
||
</simpara>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$data = [
|
||
["id" => 1, "name" => 'Tom'],
|
||
["id" => 2, "name" => 'Fred'],
|
||
];
|
||
foreach ($data as ["id" => $id, "name" => $name]) {
|
||
echo "id: $id, name: $name\n";
|
||
}
|
||
echo PHP_EOL;
|
||
list(1 => $second, 3 => $fourth) = [1, 2, 3, 4];
|
||
echo "$second, $fourth\n";
|
||
]]>
|
||
</programlisting>
|
||
&example.outputs;
|
||
<screen>
|
||
<![CDATA[
|
||
id: 1, name: Tom
|
||
id: 2, name: Fred
|
||
|
||
2, 4
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="seealso">
|
||
&reftitle.seealso;
|
||
<para>
|
||
<simplelist>
|
||
<member><function>each</function></member>
|
||
<member><function>array</function></member>
|
||
<member><function>extract</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
|
||
-->
|