Files
doc-fr/reference/mhash/functions/mhash.xml
George Peter Banyard 2c9a8e3528 Apply commit 8a2141dcc084f72feb4e0ae2feaff3b440e5c59e (#109)
Deprecated functions and constants
2021-10-08 10:16:03 +01:00

124 lines
3.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 8a2141dcc084f72feb4e0ae2feaff3b440e5c59e Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mhash" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mhash</refname>
<refpurpose>Calcule un hash</refpurpose>
</refnamediv>
<refsynopsisdiv>
&warn.deprecated.function-8-1-0;
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>mhash</methodname>
<methodparam><type>int</type><parameter>algo</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>key</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>mhash</function> applique la fonction de hash
<parameter>algo</parameter> aux données <parameter>data</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>algo</parameter></term>
<listitem>
<para>
L'identifiant du hash. Une parmi les constantes
<constant>MHASH_hashname</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
L'entrée utilisateur, sous la forme d'une &string;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
Spécifié, la fonction retournera le HMAC résultant. HMAC est un hash indexé
utilisé pour l'identification de message, ou bien un simple rapport de
message, suivant la clé spécifiée. Certains algorithmes supportés dans
mhash ne sont pas compatibles avec le mode HMAC.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne le hash résultant (appelé aussi "digest") ou HMAC, sous la
forme d'une &string; ou &false; si une erreur survient.
</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>
Cette fonction a été rendu obsolète.
Utiliser les <link linkend="ref.hash">fonctions <literal>hash_*()</literal></link> à la place.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>key</parameter> est désormais nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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
-->