Permalink
Browse files

Expanding doc blocks for router::url.

  • Loading branch information...
1 parent 30cb38e commit e8be5bac8da79d8396013e678e4b6ab3d02ee3bc @markstory markstory committed Jan 28, 2010
Showing with 9 additions and 0 deletions.
  1. +9 −0 cake/libs/router.php
@@ -717,6 +717,15 @@ function promote($which = null) {
* - '/' - the method will find base URL of application.
* - A combination of controller/action - the method will find url for it.
*
+ * There are a few 'special' parameters that can change the final URL string that is generated
+ *
+ * - `base` - Set to false to remove the base path from the generated url. If your application
+ * is not in the root directory, this can be used to generate urls that are 'cake relative'.
+ * cake relative urls are required when using requestAction.
+ * - `?` - Takes an array of query string parameters
+ * - `#` - Allows you to set url hash fragments.
+ * - `full_base` - If true the `FULL_BASE_URL` constant will be prepended to generated urls.
+ *
* @param mixed $url Cake-relative URL, like "/products/edit/92" or "/presidents/elect/4"
* or an array specifying any of the following: 'controller', 'action',
* and/or 'plugin', in addition to named arguments (keyed array elements),

0 comments on commit e8be5ba

Please sign in to comment.