php-doc-en/reference/strings/functions/md5-file.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.2 -->
  <refentry id="function.md5-file">
   <refnamediv>
    <refname>md5_file</refname>
    <refpurpose>Calculates the md5 hash of a given file</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>md5_file</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
      <methodparam choice='opt'><type>bool</type><parameter>raw_output</parameter></methodparam>
     </methodsynopsis>
    <para>
     Calculates the MD5 hash of the file specified by the
     <parameter>filename</parameter> parameter using the
     <ulink url="&url.rfc;1321">RSA Data Security, Inc. 
     MD5 Message-Digest Algorithm</ulink>, and returns that hash.
     The hash is a 32-character hexadecimal number.  If the optional
     <parameter>raw_output</parameter> is set to &true;, then the md5 digest
     is instead returned in raw binary format with a length of 16.
    </para>
    <note>
     <simpara>
      The optional <parameter>raw_output</parameter> parameter was added in
      PHP 5.0.0 and defaults to &false;
     </simpara>
    </note>
    <para>
     This function has the same purpose of the command line utility
     md5sum.
    </para>
    <para>
     See also <function>md5</function>, 
     <function>crc32</function>, and
     <function>sha1_file</function>.
    </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:"../../../../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
-->