spl-autoload.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.spl-autoload" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>spl_autoload</refname>
  <refpurpose>Default implementation for __autoload()</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>spl_autoload</methodname>
   <methodparam><type>string</type><parameter>class_name</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>file_extensions</parameter><initializer>spl_autoload_extensions()</initializer></methodparam>
  </methodsynopsis>
  <para>
   This function is intended to be used as a default implementation for
   <function>__autoload</function>. If nothing else is specified and
   <function>spl_autoload_register</function> is
   called without any parameters then this function will be used for any
   later call to <function>__autoload</function>. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>class_name</parameter></term>
     <listitem>
      <para>
       The lowercased name of the class (and namespace) being instantiated.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>file_extensions</parameter></term>
     <listitem>
      <para>
       By default it checks all include paths to
       contain filenames built up by the lowercase class name appended by the
       filename extensions .inc and .php.       
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
   <para>
    Throws <classname>LogicException</classname> when the class is not found
    and there are no other autoloaders registered.
   </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
-->