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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.2 -->
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" xml:id="function.md5-file">
 <refnamediv>
  <refname>md5_file</refname>
  <refpurpose>Calculates the md5 hash of a given file</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <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
   <link xlink:href="&url.rfc;1321">RSA Data Security, Inc. 
   MD5 Message-Digest Algorithm</link>, and returns that hash.
   The hash is a 32-character hexadecimal number.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       The filename
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>raw_output</parameter></term>
     <listitem>
      <para>
       When &true;, returns the digest in raw binary format with a length of
       16. Defaults to &false;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a string on success, &false; otherwise.
  </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>5.0.0</entry>
       <entry>
        Added the <parameter>raw_output</parameter> parameter
       </entry>
      </row>
      <row>
       <entry>5.1.0</entry>
       <entry>
        Changed the function to use the streams API. It means that you can use
        it with wrappers, like <literal>md5_file('http://example.com/..')</literal>
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Usage example of <function>md5_file</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$file = 'php-5.3.0alpha2-Win32-VC9-x64.zip';

echo 'MD5 file hash of ' . $file . ': ' . md5_file($file);
?>
]]>
    </programlisting>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>md5</function></member>
    <member><function>sha1_file</function></member>
    <member><function>crc32</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:"../../../../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
-->