Creating Custom Routes in Silverstripe 3.1

Wed, 31 Jul 2013 00:00:00 +0000

We wanted to create a Route to our custom Products Controller in our products module for SilverStripe 3.1, such as: “http://www.examplesite.com/products/”

However looking at the Controller Documentation it was not clear how to create a route without an Action being supplied. In our example above the action is not specified, as we just want to use ‘view’.

Solution:

Create a /_config/routes.yml file containing the following:

---
Name: productsroutes
After: 'framework/routes#coreroutes'
---
Director:
 rules:
 'product': 'Product_Controller'
---

The above will redirect any Url that starts with “/product” to our Product_Controller. Note that everything after the rule, so after “/product”, is used in the next bit for matching.

Now we need to add private static $url_handers to Product_Controller to match our path, so in this example we need to match “$Slug!” which will match “”. Note the ! means the slug is required. Of course we want to direct this to a specific action, in this case “view”, this gives us:

private static $url_handlers = array(
 '$Slug!' => 'view',
);

Now just add “view” to the $allow_actions and add the “view” function. This gives the final Product_Controller as follows:

class Product_Controller extends Page_Controller
{
 private static $url_handlers = array(
 '$Slug!' => 'view',
 );

 private static $allowed_actions = array('view');

 public function view(SS_HTTPRequest $request)
 {
 // Your action code goes here
 return $this->render();
 }
}

Handy note:

You can put ?debug_request=1 on the end of your URL to see how it determines which Controller to use.

Routes on PHP Boy Scout

Creating Custom Routes in Silverstripe 3.1