Recent changes to Home

WikiPage Home modified by James Watts

James Watts — Thu, 05 Apr 2012 16:59:29 -0000

--- v4 
+++ v5 
@@ -40,3 +40,7 @@
 This would search for files ending in **.class.php**, for example:
 
 ***path/to/files/Solfenix/AutoLoad/AutoLoad.class.php***
+
+The file paths of the loaded classes are stored internally by the **AutoLoad** class.
+
+***AutoLoad::getClasses();***

WikiPage Home modified by James Watts

James Watts — Wed, 04 Apr 2012 17:08:04 -0000

--- v3 
+++ v4 
@@ -1,7 +1,7 @@
 PHP AutoLoad
 ============
 
-The ***AutoLoad*** class provides a [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) compatible method to load required classes using namespaces for PHP 5.3+. For a class to the comply with the standard the following criteria must be met:
+The **AutoLoad** class provides a [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) compatible method to load required classes using namespaces for PHP 5.3+. For a class to the comply with the standard the following criteria must be met:
 
 * A fully-qualified namespace and class must have the following structure **\<Vendor Name>\(<Namespace>\)*<Class Name>**
 * Each namespace must have a top-level namespace ("Vendor Name").

WikiPage Home modified by James Watts

James Watts — Wed, 04 Apr 2012 17:07:05 -0000

--- v2 
+++ v3 
@@ -1,7 +1,7 @@
 PHP AutoLoad
 ============
 
-The AutoLoad class provides a [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) compatible method to load required classes using namespaces for PHP 5.3+. For a class to the comply with the standard the following criteria must be met:
+The ***AutoLoad*** class provides a [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) compatible method to load required classes using namespaces for PHP 5.3+. For a class to the comply with the standard the following criteria must be met:
 
 * A fully-qualified namespace and class must have the following structure **\<Vendor Name>\(<Namespace>\)*<Class Name>**
 * Each namespace must have a top-level namespace ("Vendor Name").

WikiPage Home modified by James Watts

James Watts — Tue, 03 Apr 2012 23:08:57 -0000

--- v1 
+++ v2 
@@ -1,8 +1,42 @@
-Welcome to your wiki!
-
-This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].
-
-The wiki uses [Markdown](/p/php-autoload/wiki/markdown_syntax/) syntax.
-
-[[project_admins]]
-[[download_button]]
+PHP AutoLoad
+============
+
+The AutoLoad class provides a [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) compatible method to load required classes using namespaces for PHP 5.3+. For a class to the comply with the standard the following criteria must be met:
+
+* A fully-qualified namespace and class must have the following structure **\<Vendor Name>\(<Namespace>\)*<Class Name>**
+* Each namespace must have a top-level namespace ("Vendor Name").
+* Each namespace can have as many sub-namespaces as it wishes.
+* Each namespace separator is converted to a **DIRECTORY_SEPARATOR** when loading from the file system.
+* Each _ character in the CLASS NAME is converted to a **DIRECTORY_SEPARATOR**. The _ character has no special meaning in the namespace.
+* The fully-qualified namespace and class is suffixed with ".php" when loading from the file system.
+* Alphabetic characters in vendor names, namespaces, and class names may be of any combination of lower case and upper case.
+
+Installation
+------------
+
+To use the autoloader first include the class:
+
+***require 'Solfenix/AutoLoad/AutoLoad.php';***
+
+Once the class is available the autoloader needs to be registered, for example:
+
+***spl_autoload_register( 'Solfenix\AutoLoad\AutoLoad::run' );***
+
+Configuration
+-------------
+
+The base path where your classes are located can be set if needed, for example:
+
+***AutoLoad::setPath( array( 'path', 'to', 'files' ) );***
+
+This would resolve to **path/to/files/<Vendor Name>/(<Namespace>/)*<Class Name>**, however, the namespace would remain the same:
+
+***use <Vendor Name>\(<Namespace>\)*<Class Name>;***
+
+The extension used for your classes can also be set, for example:
+
+***AutoLoad::setExtension( 'class.php' );***
+
+This would search for files ending in **.class.php**, for example:
+
+***path/to/files/Solfenix/AutoLoad/AutoLoad.class.php***

WikiPage Home modified by James Watts

James Watts — Sun, 01 Apr 2012 22:21:21 -0000

Welcome to your wiki! This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage]. The wiki uses [Markdown](/p/php-autoload/wiki/markdown_syntax/) syntax. [[project_admins]] [[download_button]]