archived-doc-fr/reference/array/functions/compact.xml

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

<refentry xml:id="function.compact" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>compact</refname>
  <refpurpose>Crée un tableau à partir de variables et de leur valeur</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>compact</methodname>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>var_name</parameter></methodparam>
   <methodparam rep="repeat"><type class="union"><type>array</type><type>string</type></type><parameter>var_names</parameter></methodparam>
  </methodsynopsis>
  <para>
   Crée un tableau à partir de variables et de leur valeur.
  </para>
  <para>
   Pour chacun des arguments <parameter>varname</parameter>, <parameter>...</parameter>,
   <function>compact</function> recherche une variable
   avec un même nom dans la table courante des symboles, et
   l'ajoute dans le tableau, de manière à avoir la relation nom =&gt;
   'valeur de variable'. En bref, c'est le contraire de la fonction
   <function>extract</function>.
  </para>
  <note>
   <para>
    Avant PHP 7.3, toutes les chaînes qui ne sont pas définies était ignorées en silence.
   </para>
  </note>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>var_name</parameter></term>
     <term><parameter>var_names</parameter></term>
     <listitem>
      <para>
       <function>compact</function> accepte différents paramètres <parameter>varname</parameter>. 
       Les paramètres peuvent être des variables contenant des chaînes,
       ou un tableau de chaînes, qui peut contenir d'autres tableaux de noms de
       variables, que <function>compact</function> traitera récursivement.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne le tableau de sortie contenant toutes les variables ajoutées.
  </para>
 </refsect1>
 
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <function>compact</function> émet une erreur de niveau E_NOTICE si une 
   chaîne donnée fait référence à une variable non définie.
  </para>
 </refsect1>
 
 <refsect1 role="changelog"><!-- {{{ -->
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>7.3.0</entry>
      <entry>
       <function>compact</function> émet maintenant une erreur de niveau E_NOTICE 
       si une chaîne donnée fait référence à une variable non définie. Autrefois, 
       ces chaînes ont été silencieusement ignorées.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1><!-- }}} -->
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>compact</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$city  = "San Francisco";
$state = "CA";
$event = "SIGGRAPH";

$location_vars = array("city", "state");

$result = compact("event", $location_vars);
print_r($result);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
Array
(
    [event] => SIGGRAPH
    [city] => San Francisco
    [state] => CA
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>Erreur commune</title>
   <para>
    Parce que les <link linkend="language.variables.variable">variables
    variables</link> ne doivent pas être utilisées avec les
    <link linkend="language.variables.superglobals">tableaux superglobaux</link>
    dans des fonctions, les tableaux Superglobaux ne doivent pas être passés
    dans la fonction <function>compact</function>.
   </para>
  </note>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <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
-->