Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Expanding and correcting doc block for router::connect.
  • Loading branch information
markstory committed Nov 29, 2009
1 parent 7216925 commit 889e367
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 8 deletions.
39 changes: 34 additions & 5 deletions cake/libs/router.php
Expand Up @@ -222,11 +222,40 @@ function getNamedExpressions() {
}

/**
* Returns this object's routes array. Returns false if there are no routes available.
*
* @param string $route An empty string, or a route string "/"
* @param array $default NULL or an array describing the default route
* @param array $params An array matching the named elements in the route to regular expressions which that element should match.
* Connects a new Route in the router.
*
* Routes are a way of connecting request urls to objects in your application. At their core routes
* are a set or regular expressions that are used to match requests to destinations.
*
* Examples:
*
* `Router::connect('/:controller/:action/*');`
*
* The first parameter will be used as a controller name while the second is used as the action name.
* the '/*' syntax makes this route greedy in that it will match requests like `/posts/index` as well as requests
* like `/posts/edit/1/foo/bar`.
*
* `Router::connect('/home-page', array('controller' => 'pages', 'action' => 'display', 'home'));`
*
* The above shows the use of route parameter defaults. And providing routing parameters for a static route.
*
* {{{
* Router::connect(
* '/:lang/:controller/:action/:id',
* array('controller' => 'testing4'),
* array('id' => '[0-9]+', 'lang' => '[a-z]{3}')
* );
* }}}
*
* Shows connecting a route with custom route parameters as well as providing patterns for those parameters.
* Patterns for routing parameters do not need capturing groups, as one will be added for each route params.
*
* @param string $route A string describing the template of the route
* @param array $default An array describing the default route parameters. These parameters will be used by default
* and can supply routing parameters that are not dynamic. See above.
* @param array $params An array matching the named elements in the route to regular expressions which that
* element should match. Also contains additional parameters such as which routed parameters should be
* shifted into the passed arguments. As well as supplying patterns for routing parameters.
* @see routes
* @return array Array of routes
* @access public
Expand Down
6 changes: 3 additions & 3 deletions cake/tests/cases/libs/router.test.php
Expand Up @@ -1785,9 +1785,9 @@ function testPassedArgsOrder() {
));

Router::connect('/protected/:controller/:action/*', array(
'controller' => 'users',
'action' => 'index',
'prefix' => 'protected'
'controller' => 'users',
'action' => 'index',
'prefix' => 'protected'
));

Router::parse('/');
Expand Down

0 comments on commit 889e367

Please sign in to comment.