- STORES
-
COUPONS & DEALS
Close
What's New
Special Sections
Popular Searches
Hot Brands & Products
Special Offers
Shop By Category
Today’s Featured Stores
- GROCERY
- FREE DEALS
- BLOG
Inside DealTaker
Kohana PHP 3.0 (KO3) Tutorial Part 6
Welcome to the sixth part in this series on how to develop with Kohana PHP V3 (KO3). If you haven’t read any of previous parts yet, I would search for and read them before going on. In this tutorial we will be going over Routes and Routing.
What is Routing? Well Routing is nothing more than taking a request, looking at it and directing it to the right place. Think of it Kohana’s version of the .htaccess file. So why would you want to use routing you might ask. Well there are so many reasons why you would want to use routing, so I’m not going to over all of them, but give you a couple examples of how to setup routes for different scenarios.
So what does a route look like? Open up “bootstrap.php” located in “application/”, and scroll down to the comment that says:
[php]/**
* Set the routes. Each route must have a minimum of a name, a URI and a set of
* defaults for the URI.
*/[/php]
The next thing you should see is something like this:
[php]Route::set(‘default’, ‘(<controller>(/<action>(/<id>)))’)
->defaults(array(‘controller’ => ‘welcome’,
‘action’ => ‘index’));[/php]
So we have a route setup initially for us, but what does this tell us. If we break it down we get:
1. Set a route with the name “default”
2. ‘((/(/)))’ Tells the route the controller, action and id are optional. The parentheses are containers that denote if an option is opional or not and the less / greater than symbols tell the the router to assign the value to the variable of the value in-between the less / greater than symbols.
3. The default values for the controller is “welcome” and the default value for the action is “index”
So when we go to “http://yourserver/mykohana3/”, the router see that we have not set a controller nor an action in our URL. It will go through the route rules that we have set to find a match. In our case, we have a default route, which is named “default”. This default route will replace the missing controller with “welcome” and the action with “index” and the rest of the system will process it. Simple so far?
If we were to to “http://yourserver/mykohana3/hmvc/”, the router would notice that the controller has been set, but not the action. The router then assign the default action value of “index” for us.
You might have noticed the optional “id” in the route. This I would say is pretty commonly used and we could pass an ID on to our action. Example:
“http://yourserver/mykohana3/hmvc/index/111″. Of course this example will not do anything special since we didn’t set up any logic to handle it. Now what if we browsed to “http://yourserver/mykohana3/hmvc/index/111/222″? We get an error. This is because our router rule is strict and says we can only route for upwards of 3 segments (action/controller/id) and the /222 creates a fourth. To over come this we can though in a overflow handler rule into our default route.
[php]Route::set(‘default’, ‘(<controller>(/<action>(/<id>(/<overflow>))))’, array(‘overflow’ => ‘.*?’))
->defaults(array(‘controller’ => ‘welcome’,
‘action’ => ‘index’));[/php]
If you save the ‘bootstrap.php’ file and reload, you should not see an error now.
You might notice that we’ve added in an extra array “array(‘overflow’ => ‘.*?’)”. This basically sets up a REGEX rules for the “overflow” option which tell the router to capture everything, including slashes and pass it as our “overflow” argument. So if slashes are captured, the router will no longer try to split out the options on slashes.
Lets go back to this “id” option we see in our route. Well, anything we put in that area will be passed to our action. If our id’s are integers, we might want to error out if we pass a non integer. One way we can do this is with the route:
[php]Route::set(‘default’, ‘(<controller>(/<action>(/<id>(/<overflow>))))’, array(‘id’ => ‘[[:digit:]]{1,}’, ‘overflow’ => ‘.*?’))
->defaults(array(‘controller’ => ‘welcome’,
‘action’ => ‘index’));[/php]
So now if you were go to: “http://yourserver/mykohana3/hmvc/index/xxx”, you would get an error about not being able to find the route, which should translate to a 404 in a production environment. Of course you could check the id for an integer inside the action action and decide how to handle it.
Now lets create a route that isn’t our default route. Add the following to the “bootstrap.php” before the default route:
[php]Route::set(‘monkeys’, ‘monkeys(/<action>(/<id>))’)
->defaults(array(‘controller’ => ‘ko3′,
‘action’ => ‘posts’));[/php]
Now if you were open up “http://yourserver/mykohana3/monkeys”, you would end up with the “posts” action of the “ko3″ controller. If you notice, the “monkeys” in the controller spot is not enclosed by parentheses, meaning that is not optional. So the router see “monkeys” in the controller spot and triggers this rule set.
Here’s an example you might want to use to serve up some static pages (Totally stole this from the Unofficial Kohana 3.0 Wiki):
[php]Route::set(‘static’, ‘<page>’, array(‘page’ => ‘about|faq|locations’))
->defaults(array(‘controller’ => ‘page’,
‘action’ => ‘static’));[/php]
There is a bit more you could do with routes, but the above should cover the majority of things you would want to use route for.
Until next time when we will go over modules and helpers, happy coding.
Sources used: Unofficial Kohana 3 Wiki
Post a New Comment
Comments and Reviews:
March 4, 2010 at 10:17 am
March 4, 2010 at 9:04 pm
March 5, 2010 at 4:54 am
March 10, 2010 at 11:17 am
March 10, 2010 at 2:57 pm
March 10, 2010 at 4:34 pm
March 14, 2010 at 12:25 pm
March 14, 2010 at 12:26 pm
March 20, 2010 at 12:11 am
March 21, 2010 at 5:07 pm
March 29, 2010 at 4:28 am
March 29, 2010 at 8:11 am
March 29, 2010 at 8:49 am
May 18, 2010 at 10:34 am
May 19, 2010 at 12:43 pm
June 1, 2010 at 10:47 am
June 5, 2010 at 10:58 am
July 9, 2011 at 1:41 pm
January 26, 2012 at 11:34 pm