count-chars.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: eb3c7d0d67625bae5fad478f5e11eebb71b397c8 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.count-chars" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>count_chars</refname>
  <refpurpose>Retourne des statistiques sur les caractères utilisés dans une chaîne</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>string</type></type><methodname>count_chars</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>count_chars</function> compte le nombre d'occurrences de
   tous les octets présents dans la chaîne <parameter>string</parameter> 
   et retourne différentes statistiques.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       La chaîne analysée.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Voir les valeurs retournées.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Suivant la valeur de <parameter>mode</parameter>, <function>count_chars</function>
   retourne les informations suivantes :
   <itemizedlist>
    <listitem>
     <simpara>
      0 : un tableau avec l'octet en index, et la fréquence
      correspondante pour chaque octet.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      1 : identique à 0, mais seules les fréquences supérieures à
      zéro sont listées.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      2 : identique à 0, mais seules les fréquences nulles sont listées.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      3 : une chaîne contenant tous les octets utilisés est retournée.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      4 : une chaîne contenant tous les octets non utilisés est retournée.
     </simpara>
    </listitem>
   </itemizedlist>
  </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>
       Antérieur à cette version, la fonction retournait &false; en cas d'échec.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>count_chars</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$data = "Deux D et un F.";

foreach (count_chars($data, 1) as $i => $val) {
   echo "Il y a $val occurence(s) de \"" , chr($i) , "\" dans la phrase.\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Il y a 4 occurrence(s) de " " dans la phrase.
Il y a 1 occurrence(s) de "." dans la phrase.
Il y a 2 occurrence(s) de "D" dans la phrase.
Il y a 1 occurrence(s) de "F" dans la phrase.
Il y a 2 occurrence(s) de "e" dans la phrase.
Il y a 1 occurrence(s) de "n" dans la phrase.
Il y a 1 occurrence(s) de "t" dans la phrase.
Il y a 2 occurrence(s) de "u" dans la phrase.
Il y a 1 occurrence(s) de "x" dans la phrase.
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>strpos</function></member>
    <member><function>substr_count</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
-->