count.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 2e60c5134e7a847c99f81eb3f7ecee1f5efeeace Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.count" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>count</refname>
  <refpurpose>Compte tous les éléments d'un tableau ou dans un objet <interfacename>Countable</interfacename></refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>count</methodname>
   <methodparam><type class="union"><type>Countable</type><type>array</type></type><parameter>value</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>COUNT_NORMAL</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   Compte tous les éléments dans un tableau quand utilisé avec un &array;.
   Quand utilisé avec un objet qui implémente l'interface
   <interfacename>Countable</interfacename>, ceci retourne la valeur de la
   méthode <methodname>Countable::count</methodname>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Un tableau ou un objet <interfacename>Countable</interfacename>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Si le paramètre optionnel <parameter>mode</parameter> vaut
       <constant>COUNT_RECURSIVE</constant> (ou 1), <function>count</function>
       va compter récursivement les tableaux. C'est particulièrement utile
       pour compter tous les éléments d'un tableau multidimensionnel.
      </para>
      <caution>
       <para>
        La fonction <function>count</function> peut détecter les récursions
        afin d'éviter les boucles infinies, mais émettra une alerte de type
        <constant>E_WARNING</constant> à chaque fois qu'une boucle infinie surviendra
        (dans le cas où un tableau se contient lui-même plus d'une fois)
        et retournera un compteur plus grand que l'attendu.
       </para>
      </caution>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne le nombre d'éléments dans <parameter>value</parameter>.
   Antérieur à PHP 8.0.0, si le paramètre n'est ni un &array;, ni un &object;
   qui implémente l'interface <interfacename>Countable</interfacename>,
   <literal>1</literal> était retourné, sauf si <parameter>value</parameter>
   était &null;, auquel cas <literal>0</literal> était retourné.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <function>count</function> lance désormais une <classname>TypeError</classname>
       pour des types dénombrables invalides passés au paramètre
       <parameter>value</parameter>.
      </entry>
     </row>
     <row>
      <entry>7.2.0</entry>
      <entry>
       <function>count</function> génère désormais un avertissement pour
       des types dénombrables invalides passés au paramètre
       <parameter>value</parameter>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example xml:id="count.example.basic">
    <title>Exemple avec <function>count</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$a[0] = 1;
$a[1] = 3;
$a[2] = 5;
var_dump(count($a));

$b[0]  = 7;
$b[5]  = 9;
$b[10] = 11;
var_dump(count($b));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
int(3)
int(3)
]]>
    </screen>
   </example>
  </para>
  <para>
   <example xml:id="count.example.badexample">
    <title>Exemple de <function>count</function> avec un argument non Countable|array (contre-exemple - ne pas faire ceci)</title>
    <programlisting role="php" annotations="non-interactive">
<![CDATA[
<?php
$b[0]  = 7;
$b[5]  = 9;
$b[10] = 11;
var_dump(count($b));

var_dump(count(null));

var_dump(count(false));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
int(3)

Fatal error: Uncaught TypeError: count(): Argument #1 ($var) must be of type Countable .. on line 12
]]>
    </screen>
   </example>
  </para>
  <para>
   <example xml:id="count.example.recursive">
    <title>Exemple de récursivité avec <function>count</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$food = array('fruits' => array('orange', 'banana', 'apple'),
              'veggie' => array('carrot', 'collard', 'pea'));

// count récursif
var_dump(count($food, COUNT_RECURSIVE));

// count normal
var_dump(count($food));

?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
int(8)
int(2)
]]>
    </screen>
   </example>
  </para>
  <para>
   <example xml:id="count.example.countable">
    <title>Objet <interfacename>Countable</interfacename></title>
    <programlisting role="php">
<![CDATA[
<?php
class CountOfMethods implements Countable
{
    private function someMethod()
    {
    }
    public function count(): int
    {
        return count(get_class_methods($this));
    }
}
$obj = new CountOfMethods();
var_dump(count($obj));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
int(2)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>is_array</function></member>
    <member><function>isset</function></member>
    <member><function>empty</function></member>
    <member><function>strlen</function></member>
    <member><function>is_countable</function></member>
    <member><link linkend="language.types.array">Les tableaux</link></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
-->