1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-24 07:02:08 +01:00
Files
Yoshinari Takaoka 0575c44d15 [mhash] sync with en.
2025-08-27 18:55:10 +09:00

128 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9b1673cf114a1e10c4563ab9223cb56aed552b89 Maintainer: hirokawa Status: ready -->
<refentry xml:id="function.mhash" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mhash</refname>
<refpurpose>ハッシュ値を計算する</refpurpose>
</refnamediv>
<refsynopsisdiv>
&warn.deprecated.function-8-1-0;
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier role="attribute">#[\Deprecated]</modifier>
<type>string</type><methodname>mhash</methodname>
<methodparam><type>int</type><parameter>hash</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
<function>mhash</function> は、
<parameter>hash</parameter> で指定したハッシュ関数を
<parameter>data</parameter> に適用します。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>algo</parameter></term>
<listitem>
<para>
ハッシュ ID。<constant>MHASH_ハッシュ名</constant>
定数のいずれかを指定します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
ユーザーが入力した文字列。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
指定した場合は、この関数は結果の HMAC を返します。
HMAC は、メッセージ認証時のキーに基づくハッシュ、
あるいは指定したキーに基づく単なるメッセージダイジェストです。
mhash でサポートしている全てのアルゴリズムが HMAC
モードで使用できるわけではありません。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
結果のハッシュ (あるいはダイジェストとも言います)
あるいは HMAC を表す文字列を返します。
エラー時は &false; を返します。
</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>
この関数は、推奨されなくなりました。
<link linkend="ref.hash"><literal>hash_*()</literal> 関数</link> を代わりに使って下さい。
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>key</parameter> は、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
-->