spl-object-id.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.spl-object-id" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>spl_object_id</refname>
  <refpurpose>
   Return the integer object handle for given object
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>spl_object_id</methodname>
   <methodparam><type>object</type><parameter>object</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function returns a unique identifier for the object. The object id is
   unique for the lifetime of the object. Once the object is destroyed, its id
   may be reused for other objects. This behavior is similar to
   <function>spl_object_hash</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
   &reftitle.parameters;
   <para>
    <variablelist>
     <varlistentry>
      <term><parameter>object</parameter></term>
      <listitem>
       <para>
        Any object. 
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An integer identifier that is unique for each currently existing object and
   is always the same for each object.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>spl_object_id</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$id = spl_object_id($object);
$storage[$id] = $object;
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    When an object is destroyed, its id may be reused for other objects.
   </para>
  </note>
 </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
-->