Browse Source

Added documentation on Zend_Application_Router_Resource. Fixes #ZF-6491

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@18418 44c647ce-9c0f-0410-b52a-842ac1e357ba
freak 16 years ago
parent
commit
edd5391dd5

+ 36 - 0
documentation/manual/en/module_specs/Zend_Application-AvailableResources-Router.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Reviewed: no -->
+<sect2 id="zend.application.available-resources.router">
+    <title>Zend_Application_Resource_Router</title>
+
+    <para>
+        <classname>Zend_Application_Resource_Router</classname> can be used to 
+        configure the router as it is registered with the Front Controller.
+        Configuration options are per <link 
+        linkend="zend.controller.router.routes.standard">the
+            <classname>Zend_Controller_Router_Route</classname> options</link>.
+    </para>
+
+    <example id="zend.application.available-resources.router.configExample">
+        <title>Sample Router Resource configuration</title>
+
+        <para>
+            Below is a sample <acronym>INI</acronym> snippet showing how to
+            configure the router resource.
+        </para>
+
+        <programlisting language="ini"><![CDATA[
+resources.router.routes.route_id.route = "/login"
+resources.router.routes.route_id.defaults.module = "user"
+resources.router.routes.route_id.defaults.controller = "login"
+resources.router.routes.route_id.defaults.action = "index"
+
+; Optionally you can also set a Chain Name Separator:
+resources.router.chainNameSeparator = "_"
+]]></programlisting>
+        
+        <para>For more information on the Chain Name Separator, please see
+            <link linkend="zend.controller.router.routes.chain.config">its section</link>.
+        </para>
+    </example>
+</sect2>

+ 1 - 2
library/Zend/Application/Resource/Router.php

@@ -65,14 +65,13 @@ class Zend_Application_Resource_Router
                 $options['routes'] = array();
             }
 
-
             if (isset($options['chainNameSeparator'])) {
                 $this->_router->setChainNameSeparator($options['chainNameSeparator']);
             }
 
-
             $this->_router->addConfig(new Zend_Config($options['routes']));
         }
+        
         return $this->_router;
     }
 }