Changeset 3381 for trunk/system/config/routes.php

Timestamp:

08/28/2008 03:10:50 PM (3 months ago)

Author:

Shadowhand

Message:

Follow up to r3366:

• Updated config and routes configuration comments
  
• Added "prefix" to routes, to allow prefixes to be added to any route key
  
• Removed slash-to-underscore modification to controller and method keys...that was a bit of a hack, anyways
  

Files:

• trunk/system/config/routes.php (modified) (1 diff)

trunk/system/config/routes.php

@@ -4 +4 @@
  * @package  Core
  *
- * Sets default routing, allowing up to 3 segments to be used:
- *  - controller, defaults to "welcome"
- *  - method, defaults to "index"
- *  - id, no default
+ * Sets default routing, allowing up to 3 segments to be used.
+ *
+ *     $config['default'] = array
+ *     (
+ *         // Default routing
+ *         :controller/:method/:id.xml',
+ *    
+ *         // Defaults for route keys
+ *         'controller' => 'welcome',
+ *         'method' => 'index',
+ *     );
  *
  * The converted regex for this route is:
  *
  *     (?:([^/]+)(?:/([^/]+)(?:/([^/]+))?)?)?
+ *
+ * To define a specific pattern for a key, you can use the special "regex" key:
+ *
+ *     $config['default'] = array
+ *     (
+ *         // Limit the controller to letters and underscores
+ *         'regex' => array('controller' => '[a-z_]+'),
+ *     );
+ *
+ * To add a prefix to any key, you can use the special "prefix" key:
+ *
+ *     $config['admin'] = array
+ *     (
+ *         'admin/:controller/:method/:id',
+ *
+ *         // Will change all controllers to admin_:controller
+ *         'prefix' => array('controller' => 'admin_'),
+ *     );
  *
  */