[PHP-DOC] cvs: phpdoc /en/reference/spl/functions spl-object-hash.xml

[Stanislav Malyshev]

stas            Fri Nov 10 21:12:19 2006 UTC

  Added files:                 
    /phpdoc/en/reference/spl/functions  spl-object-hash.xml 
  Log:
  document spl_object_hash()
  
  

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/functions/spl-object-hash.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/spl/functions/spl-object-hash.xml
+++ phpdoc/en/reference/spl/functions/spl-object-hash.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
  <refentry id="function.spl-object-hash">
   <refnamediv>
    <refname>spl_object_hash</refname>
    <refpurpose>
     Return hash id for given object
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>string</type><methodname>spl_object_hash</methodname>
     <methodparam><type>object</type><parameter>obj</parameter></methodparam>
    </methodsynopsis>
    <para>
     This function returns an unique identifier for the object. This id can be
     used as a hash key for storing objects or for identifying an object.
    </para>
   </refsect1>
   <refsect1 role="parameters">
     &reftitle.parameters;
     <para>
      <variablelist>
       <varlistentry>
        <term><parameter>class</parameter></term>
        <listitem>
         <para>
          Any object. 
         </para>
        </listitem>
       </varlistentry>
      </variablelist>
     </para>
   </refsect1>

   <refsect1 role="returnvalues">
    &reftitle.returnvalues;
    <para>
     Returns string that is unique for each object and is always the same for
     the same object.
    </para>
   </refsect1>

   <refsect1 role="examples">
     &reftitle.examples;
      <para>
       <example>
        <title><function>functionname</function> example</title>
         <programlisting role="php">
<![CDATA[
<?php
$id = spl_object_hash($object);
$storage[$id] = $object;
?>
]]>
         </programlisting>
        </example>
       </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
-->