documentation for the MapClassLoader class

xabbuh · xabbuh · commit 0c17e5b70070 · 2013-08-19T12:18:40.000+02:00
diff --git a/components/class_loader/index.rst b/components/class_loader/index.rst
@@ -5,5 +5,6 @@ Class Loader
     :maxdepth: 2
     
     class_loader
+    map_class_loader
     cache_class_loader
     debug_class_loader
diff --git a/components/class_loader/map_class_loader.rst b/components/class_loader/map_class_loader.rst
@@ -0,0 +1,28 @@
+.. index::
+    single: Class Loader; MapClassLoader
+    
+MapClassLoader
+==============
+
+Additionally to any dynamic class loader (like the :doc:`PSR-0 class loader <class_loader>`)
+you can use the :class:`Symfony\\Component\\ClassLoader\\MapClassLoader` to statically
+map classes to files. Using it is as easy as passing your mapping to its constructor
+when creating an instance of the ``MapClassLoader`` class::
+
+    require_once '/path/to/src/Symfony/Component/ClassLoader/MapClassLoader';
+    
+    $mapping = array(
+        'Foo' => '/path/to/Foo',
+        'Bar' => '/path/to/Bar',
+    );
+    
+    $loader = new MapClassLoader($mapping);
+    
+    $loader->register();
+    
+.. note::
+
+    The default behavior is to append the ``MapClassLoader`` on the autoload
+    stack. If you want to use it as the default autoloader, pass ``true``
+    when calling the ``register()`` method. Your class loader will then be
+    prepended on the autoload stack.
diff --git a/components/map.rst.inc b/components/map.rst.inc
@@ -3,6 +3,7 @@
 * **Class Loader**
 
   * :doc:`/components/class_loader/class_loader`
+  * :doc:`/components/class_loader/map_class_loader`
   * :doc:`/components/class_loader/cache_class_loader`
   * :doc:`/components/class_loader/debug_class_loader`
 
