doc-fr/reference/hash/functions/hash-init.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ac6b36357e5f5294a2c0577b85d193d84f0017ff Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.hash-init" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>hash_init</refname>
  <refpurpose>Initialise un contexte de hachage incrémental</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>HashContext</type><methodname>hash_init</methodname>
   <methodparam><type>string</type><parameter>algo</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>key</parameter><initializer>""</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>algo</parameter></term>
     <listitem>
      <para>
       Nom de l'algorithme de hachage sélectionné (c'est-à-dire "md5",
       "sha256", "haval160,4", etc.). Pour une liste des algorithmes
       supportés, reportez-vous à la documentation sur la fonction
       <function>hash_algos</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Configurations optionnelles pour la génération du hachage, supporte
       actuellement seulement une option :
       <constant>HASH_HMAC</constant>. Lorsque cette option est spécifiée, le paramètre
       <parameter>key</parameter> <emphasis>doit</emphasis> être spécifié.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       Lorsque <constant>HASH_HMAC</constant> est spécifiée pour <parameter>flags</parameter>,
       une clé secrète partagée qui sera utilisée avec la méthode de hachage
       HMAC doit être fournie dans ce paramètre.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Un tableau d'options pour les algorithmes dives de hachage.
       Actuellement, seul le paramètre "seed" est supporté pour les variantes MurmurHash.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne le contexte de hachage HashContext pour utilisation avec
   <function>hash_update</function>, <function>hash_update_stream</function>,
   <function>hash_update_file</function> et <function>hash_final</function>.
  </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>8.1.0</entry>
       <entry>Le paramètre <parameter>options</parameter> a été ajouté.</entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>L'usage de fonction de hachage non-cryptographique (adler32, crc32, crc32b, fnv132, fnv1a32, fnv164, fnv1a64, joaat) avec <constant>HASH_HMAC</constant> a été désactivé.</entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        Retourne une <classname>HashContext</classname> au lieu d'une ressource.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple de hachage incrémental</title>
    <programlisting role="php">
<![CDATA[
<?php
$ctx = hash_init('md5');
hash_update($ctx, 'Le rapide goupil brun ');
hash_update($ctx, 'sauta par dessus le chien paresseux.');
echo hash_final($ctx);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
2dfe052a8caca3db869ede6ae544cd5d
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>hash</function></member>
    <member><function>hash_algos</function></member>
    <member><function>hash_file</function></member>
    <member><function>hash_hmac</function></member>
    <member><function>hash_hmac_file</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
-->