- Add docu

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@213744 c90b9560-bf6c-de11-be94-00142212c4b1

reference/spl/functions/spl-autoload-call.xml

@@ -0,0 +1,43 @@
+<?xml version='1.0' encoding='iso-8859-1'?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.spl-autoload-call">
+   <refnamediv>
+    <refname>spl_autoload-call</refname>
+    <refpurpose>
+     Try all registerd autoload function to load the requested class
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>void</type><methodname>spl_autoload-call</methodname>
+     <methodparam><type>string</type><parameter>class_name</parameter></methodparam>
+     <void/>
+    </methodsynopsis>
+    <para>
+     This function can be used to manually search for a class or interface 
+     using the registered __autoload functions.
+    </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
+-->

reference/spl/functions/spl-autoload-extensions.xml

@@ -0,0 +1,47 @@
+<?xml version='1.0' encoding='iso-8859-1'?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.spl-autoload-extensions">
+   <refnamediv>
+    <refname>spl_autoload_extensions</refname>
+    <refpurpose>
+     Register and return default file extensions for spl_autoload */
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>string</type><methodname>spl_autoload_extensions</methodname>
+     <methodparam choice="opt"><type>string</type><parameter>file_extensions</parameter></methodparam> 
+     <void/>
+    </methodsynopsis>
+    <para>
+     This function allows to modify and check the file extensions the built in 
+     __autoload fallback function spl_autoload will be using. When calling 
+     without an argument it simply returns the current list of extensions each
+     separated by comma. To modify the list of file extensions simply invoke 
+     the functions with the new list of file extensions to use in a single 
+     string with each extensions separated by comma.
+    </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
+-->

reference/spl/functions/spl-autoload-functions.xml

@@ -0,0 +1,43 @@
+<?xml version='1.0' encoding='iso-8859-1'?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.spl-autoload-functions">
+   <refnamediv>
+    <refname>spl_autoload-functions</refname>
+    <refpurpose>
+     Return all registered __autoload() functionns
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>array</type><methodname>spl_autoload_functions</methodname>
+     <void/>
+    </methodsynopsis>
+    <para>
+     This function returns an array of all registered __autoload functions.
+     If the autoload stack if not activated then the return value is false.
+     If no function is registered the return value will be an empty array.
+    </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
+-->

reference/spl/functions/spl-autoload-register.xml

@@ -0,0 +1,52 @@
+<?xml version='1.0' encoding='iso-8859-1'?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.spl-autoload-register">
+   <refnamediv>
+    <refname>spl_autoload_register</refname>
+    <refpurpose>
+     Register given function as __autoload() implementation
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>bool</type><methodname>spl_autoload_register</methodname>
+     <methodparam choice="opt"><type>mixed</type><parameter>autoload_function</parameter></methodparam>
+     <void/>
+    </methodsynopsis>
+    <para>
+     Register a function with the spl provided __autoload stack. If the stack 
+     is not yet activated it will be activated. If no parameter is provided 
+     the default implementation spl_autoload will be registered. When 
+     registering is successful the return value is true and upon failure false
+     is being returned.
+    </para>
+    <para>
+     If your code has an existing __autoload function then this function must 
+     explicity registered on the __autoload stack. This is because 
+     spl_autoload_register() will effectively replace the engine cache for
+     the __autoload function by either spl_autoload() or spl_autoload_call().
+    </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
+-->

reference/spl/functions/spl-autoload-unregister.xml

@@ -0,0 +1,48 @@
+<?xml version='1.0' encoding='iso-8859-1'?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.spl-autoload-unregister">
+   <refnamediv>
+    <refname>spl_autoload_unregister</refname>
+    <refpurpose>
+     Unregister given function as __autoload() implementation
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>bool</type><methodname>spl_autoload_unregister</methodname>
+     <methodparam><type>mixed</type><parameter>autoload_function</parameter></methodparam>
+    </methodsynopsis>
+    <para>
+     Unregister a function from the spl provided __autoload stack. If the stack 
+     is activated and empty after unregistering the given function then it will
+     be deactivated. When unregistering is successful the return value is true 
+     and upon failure false is being returned.
+    </para>
+    <para>
+     When this function results in the autoload stack being activated an 
+     existing __autoload function will not be reactivated.
+    </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
+-->

reference/spl/functions/spl-autoload.xml

@@ -0,0 +1,48 @@
+<?xml version='1.0' encoding='iso-8859-1'?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.spl-autoload">
+   <refnamediv>
+    <refname>spl_autoload</refname>
+    <refpurpose>
+     Default implementation for __autoload()
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <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></methodparam> 
+     <void/>
+    </methodsynopsis>
+    <para>
+     This function is intended to be used as a default implementation for 
+     __autoload(). If nothing else is specified and autoload_register() is 
+     called without any parameters then this functions will be used for any
+     later call to __autoload(). By default it checks all include paths to 
+     contain failnames built up by the lowercase class name appended by the
+     filename extensions .inc and .php.
+    </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
+-->