archived-doc-de/reference/hash/functions/hash.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 539a9823a805ac29cab7fa4baf3ae3a28116a2f5 Maintainer: raphaelm Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 4b4c8b47408da359d4d0ab39f19673f006895908 Reviewer: samesch -->
<!-- Credits: reinders -->
<refentry xml:id="function.hash" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>hash</refname>
  <refpurpose>Berechnet den Hash einer Nachricht</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>hash</methodname>
   <methodparam><type>string</type><parameter>algo</parameter></methodparam>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>binary</parameter><initializer>&false;</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>
       Der Name des gewählten Hash-Algorithmus (&zb;
       <literal>"sha256"</literal>). Für eine Liste der unterstützten
       Algorithmen, siehe <function>hash_algos</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Die Nachricht, die gehasht werden soll.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>binary</parameter></term>
     <listitem>
      <para>
       Ist dieser Parameter auf &true; gesetzt, werden direkt Binärdaten
       zurückgegeben. Bei &false; werden kleingeschriebene Hexadezimalzeichen
       zurückgegeben.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Ein Array mit Optionen für die verschiedenen Hash-Algorithmen. Derzeit
       wird von den MurmurHash-Varianten nur der Parameter
       <literal>"seed"</literal> unterstützt.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt eine Zeichenkette zurück, die den berechneten Hash als
   kleingeschriebene Hexadezimalzeichen enthält, außer
   <parameter>binary</parameter> ist auf true gesetzt, in diesem Fall wird die
   binäre Darstellung des Hashes zurückgegeben.
  </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>
        Der Parameter <parameter>options</parameter> wurde hinzugefügt.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        Wenn <parameter>algo</parameter> unbekannt ist, löst
        <function>hash</function> nun eine
        <classname>ValueError</classname>-Exception aus; zuvor wurde
        stattdessen &false; zurückgegeben.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>hash</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
echo hash('sha256', 'Franz jagt im komplett verwahrlosten Taxi quer durch Bayern.');
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
0b3a381e71cda8f3abe88b1dc3eb9aa2a53fa033e9802878edd1959c267281a2
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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