doc-fr/reference/array/functions/array-column.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: beb09db76bd516580d32b751c5cb3b8388774b85 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.array-column" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_column</refname>
  <refpurpose>Retourne les valeurs d'une colonne d'un tableau d'entrée</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_column</methodname>
   <methodparam><type>array</type><parameter>input</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>column_key</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>index_key</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>array_column</function> retourne les valeurs d'une colonne du
   tableau d'entrée <parameter>input</parameter>, identifiée par la clé
   <parameter>column_key</parameter>. Optionnellement, vous pouvez fournir
   un paramètre <parameter>index_key</parameter> pour indexer les valeurs dans le
   tableau retourné par les valeurs de la colonne <parameter>index_key</parameter>
   du tableau d'entrée.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>input</parameter></term>
     <listitem>
      <para>
       Un tableau multi-dimensionnel depuis lequel la colonne de valeurs
       sera prélevée.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>column_key</parameter></term>
     <listitem>
      <para>
       La colonne de valeurs à retourner. Cette valeur peut être la clé
       entière de la colonne que vous souhaitez récupérer, ou bien le nom
       de la clé pour un tableau associatif. Il peut aussi valoir &null;
       pour retourner le tableau complet (utile en conjonction du paramètre
       <parameter>index_key</parameter> pour ré-indexer le tableau).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>index_key</parameter></term>
     <listitem>
      <para>
       La colonne à utiliser comme index/clé pour le tableau retourné.
       Cette valeur peut être la clé entière de la colonne, ou le nom
       de la clé.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un tableau de valeurs représentant une seule colonne depuis le
   tableau d'entrée.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Récupère la colonne des prénoms</title>
    <programlisting role="php">
<![CDATA[
<?php
// Tableau représentant un jeu d'enregistrements issu d'une base de données
$records = array(
    array(
        'id' => 2135,
        'first_name' => 'John',
        'last_name' => 'Doe',
    ),
    array(
        'id' => 3245,
        'first_name' => 'Sally',
        'last_name' => 'Smith',
    ),
    array(
        'id' => 5342,
        'first_name' => 'Jane',
        'last_name' => 'Jones',
    ),
    array(
        'id' => 5623,
        'first_name' => 'Peter',
        'last_name' => 'Doe',
    )
);
 
$first_names = array_column($records, 'first_name');
print_r($first_names);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
Array
(
    [0] => John
    [1] => Sally
    [2] => Jane
    [3] => Peter
)
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>
     Récupère la colonne des noms, indexé par la colonne "id"
    </title>
    <programlisting role="php">
<![CDATA[
<?php
// En utilisant le tableau de l'exemple #1
$last_names = array_column($records, 'last_name', 'id');
print_r($last_names);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
Array
(
    [2135] => Doe
    [3245] => Smith
    [5342] => Jones
    [5623] => Doe
)
]]>
    </screen>
   </example>
  </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
-->