{"id":2199,"date":"2013-08-11T07:36:31","date_gmt":"2013-08-11T07:36:31","guid":{"rendered":"https:\/\/intelligentbee.com\/blog\/?p=2199"},"modified":"2024-05-31T09:06:15","modified_gmt":"2024-05-31T09:06:15","slug":"symfony2-jobeet-day-5-the-routing","status":"publish","type":"post","link":"https:\/\/intelligentbee.com\/blog\/symfony2-jobeet-day-5-the-routing\/","title":{"rendered":"Symfony2 Jobeet Day 5: The Routing"},"content":{"rendered":"

* This article is part of the original Jobeet Tutorial<\/a>, created by Fabien Potencier, for Symfony 1.4.<\/span><\/p>\n

URLs<\/h2>\n

If you click on a job on the Jobeet homepage, the URL looks like this: \/job\/1\/show<\/code>. If you have already developed PHP websites, you are probably more accustomed to URLs like \/job.php?id=1<\/code>. How does Symfony make it work? How does Symfony determine the action to call based on this URL? Why is the id of the job retrieved with the $id<\/code> parameter in the action? Here, we will answer all these questions.<\/span><\/p>\n

You have already seen the following code in the src\/Ibw\/JobeetBundle\/Resources\/views\/Job\/index.html.twig<\/code> template:<\/p>\n

{{ path('ibw_job_show', { 'id': entity.id }) }}<\/pre>\n
This uses the path<\/code> template helper function to generate the url for the job which has the id 1<\/code>. The ibw_job_show<\/code> is the name of the route used, defined in the configuration as you will see below.<\/p>\n
Routing Configuration<\/h3>\n
In Symfony2, routing configuration is usually done in the app\/config\/routing.yml<\/code>. This imports specific bundle routing configuration. In our case, the src\/Ibw\/JobeetBundle\/Resources\/config\/routing.yml<\/code> file is imported:<\/p>\n
ibw_jobeet:\r\n    resource: \"@IbwJobeetBundle\/Resources\/config\/routing.yml\"\r\n    prefix:   \/<\/pre>\n
Now, if you look in the JobeetBundle routing.yml<\/code> you will see that it imports another routing file, the one for the Job controller and defines a route called ibw_jobeet_homepage <\/code>for the \/hello\/{name}<\/code> URL pattern:<\/p>\n
IbwJobeetBundle_job:\r\n    resource: \"@IbwJobeetBundle\/Resources\/config\/routing\/job.yml\"\r\n    prefix: \/job\r\n\r\nibw_jobeet_homepage:\r\n    pattern:  \/hello\/{name}\r\n    defaults: { _controller: IbwJobeetBundle:Default:index }<\/pre>\n
ibw_job:\r\n    pattern:  \/\r\n    defaults: { _controller: \"IbwJobeetBundle:Job:index\" }\r\n\r\nibw_job_show:\r\n    pattern:  \/{id}\/show\r\n    defaults: { _controller: \"IbwJobeetBundle:Job:show\" }\r\n\r\nibw_job_new:\r\n    pattern:  \/new\r\n    defaults: { _controller: \"IbwJobeetBundle:Job:new\" }\r\n\r\nibw_job_create:\r\n    pattern:  \/create\r\n    defaults: { _controller: \"IbwJobeetBundle:Job:create\" }\r\n    requirements: { _method: post }\r\n\r\nibw_job_edit:\r\n    pattern:  \/{id}\/edit\r\n    defaults: { _controller: \"IbwJobeetBundle:Job:edit\" }\r\n\r\nibw_job_update:\r\n    pattern:  \/{id}\/update\r\n    defaults: { _controller: \"IbwJobeetBundle:Job:update\" }\r\n    requirements: { _method: post|put }\r\n\r\nibw_job_delete:\r\n    pattern:  \/{id}\/delete\r\n    defaults: { _controller: \"IbwJobeetBundle:Job:delete\" }\r\n    requirements: { _method: post|delete }<\/pre>\n
Let\u2019s have a closer look to the ibw_job_show<\/code> route. The pattern defined by the ibw_job_show <\/code>route acts like \/*\/show<\/code> where the wildcard is given the name id<\/code>. For the URL \/1\/show<\/code>, the id <\/code>variable gets a value of 1, which is available for you to use in your controller. The _controller <\/code>parameter is a special key that tells Symfony which controller\/action should be executed when a URL matches this route, in our case it should execute the showAction<\/code> from the JobController<\/code> in the IbwJobeetBundle<\/code>.<\/p>\n
The route parameters (e.g. {id}<\/code>) are especially important because each is made available as an argument to the controller method.<\/p>\n
Routing Configuration in Dev Environment<\/h3>\n
The dev environment loads the app\/config\/routing_dev.yml<\/code> file that contains the routes used by the Web Debug Toolbar<\/strong> (you already deleted the routes for the AcmeDemoBundle<\/code> from \/app\/config\/routing_dev.php<\/code> \u2013 see Day 1, How to remove the AcmeDemoBundle<\/strong>). This file loads, at the end, the main routing.yml<\/code> configuration file.<\/p>\n
Route Customizations<\/h3>\n
For now, when you request the \/ URL in a browser, you will get a 404 Not Found error. That\u2019s because this URL does not match any routes defined. We have a ibw_jobeet_homepage<\/code> route that matches the \/hello\/jobeet<\/code> URL and sends us to the DefaultController<\/code>, index<\/code> action. Let\u2019s change it to match the \/<\/code> URL and to call the index action from the JobController<\/code>. To make the change, modify it to the following:<\/p>\n
# ...\r\nibw_jobeet_homepage:\r\n    pattern:  \/\r\n    defaults: { _controller: IbwJobeetBundle:Job:index }<\/pre>\n
Now, if you clear the cache and go to http:\/\/jobeet.local from your browser, you will see the Job<\/code> homepage. We can now change the link of the Jobeet logo in the layout to use the ibw_jobeet_homepage<\/code> route:<\/p>\n
<!-- ... -->    \r\n    <h1><a href=\"{{ path('ibw_jobeet_homepage') }}\">\r\n        <img alt=\"Jobeet Job Board\" src=\"{{ asset('bundles\/ibwjobeet\/images\/logo.jpg') }}\" \/>\r\n    <\/a><\/h1>\r\n<!-- ... --><\/pre>\n
For something a bit more involved, let\u2019s change the job page URL to something more meaningful:<\/p>\n
\/job\/sensio-labs\/paris-france\/1\/web-developer<\/pre>\n
Without knowing anything about Jobeet, and without looking at the page, you can understand from the URL that Sensio Labs is looking for a Web developer to work in Paris, France.<\/p>\n
The following pattern matches such a URL:<\/p>\n
\/job\/{company}\/{location}\/{id}\/{position}<\/pre>\n
Edit the ibw_job_show<\/code> route from the job.yml<\/code> file:<\/p>\n
# ...\r\n\r\nibw_job_show:\r\n    pattern:  \/{company}\/{location}\/{id}\/{position}\r\n    defaults: { _controller: \"IbwJobeetBundle:Job:show\" }<\/pre>\n
Now, we need to pass all the parameters for the changed route for it to work:<\/p>\n
<!-- ... -->\r\n<a href=\"{{ path('ibw_job_show', { 'id': entity.id, 'company': entity.company, 'location': entity.location, 'position': entity.position }) }}\">\r\n    {{ entity.position }}\r\n<\/a>\r\n<!-- ... --><\/pre>\n
If you have a look at generated URLs, they are not quite yet as we want them to be:<\/p>\n
\n
\n\n\n\n
http:\/\/jobeet.local\/app_dev.php\/job\/Sensio Labs\/Paris,France\/1\/Web Developer<\/code><\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n
\n
We need to \u201cslugify\u201d the column values by replacing all non ASCII characters by a -. Open the <\/span>Job.php<\/code> file and add the following methods to the class:<\/span><\/div>\n
\n
\/\/ ...\r\nuse IbwJobeetBundleUtilsJobeet as Jobeet;\r\n\r\nclass Job\r\n{\r\n    \/\/ ...\r\n\r\n    public function getCompanySlug()\r\n    {\r\n        return Jobeet::slugify($this->getCompany());\r\n    }\r\n\r\n    public function getPositionSlug()\r\n    {\r\n        return Jobeet::slugify($this->getPosition());\r\n    }\r\n\r\n    public function getLocationSlug()\r\n    {\r\n        return Jobeet::slugify($this->getLocation());\r\n    }\r\n}<\/pre>\n
You must also add the use<\/code> statement before the Job<\/code> class definition.
\nAfter that, create the src\/Ibw\/JobeetBundle\/Utils\/Jobeet.php<\/code> file and add the slugify<\/code> method in it:<\/p>\n
namespace IbwJobeetBundleUtils;\r\n\r\nclass Jobeet\r\n{\r\n    static public function slugify($text)\r\n    {\r\n        \/\/ replace all non letters or digits by -\r\n        $text = preg_replace('\/W+\/', '-', $text);\r\n\r\n        \/\/ trim and lowercase\r\n        $text = strtolower(trim($text, '-'));\r\n\r\n        return $text;\r\n    }\r\n}<\/pre>\n
We have defined three new \u201cvirtual\u201d accessors: getCompanySlug()<\/code>, getPositionSlug()<\/code>, and getLocationSlug()<\/code>. They return their corresponding column value after applying it the slugify()<\/code> method. Now, you can replace the real column names by these virtual ones in the template:<\/p>\n
<!-- ... -->\r\n<a href=\"{{ path('ibw_job_show', { 'id': entity.id, 'company': entity.companyslug, 'location': entity.locationslug, 'position': entity.positionslug}) }}\">\r\n   {{ entity.position }}\r\n<\/a>\r\n<!-- ... --><\/pre>\n
Route Requirements<\/h3>\n
The routing system has a built-in validation feature. Each pattern variable can be validated by a regular expression defined using the requirements entry of a route definition:<\/p>\n
# ...\r\nibw_job_show:\r\n    pattern:  \/{company}\/{location}\/{id}\/{position}\r\n    defaults: { _controller: \"IbwJobeetBundle:Job:show\" }\r\n    requirements:\r\n        id:  d+\r\n\r\n# ...<\/pre>\n
The above requirements entry forces the id to be a numeric value. If not, the route won\u2019t match.<\/p>\n
Route Debugging<\/h3>\n
While adding and customizing routes, it\u2019s helpful to be able to visualize and get detailed information about your routes. A great way to see every route in your application is via the router:debug<\/code> console command. Execute the command by running the following from the root of your project:<\/p>\n
php app\/console router:debug<\/pre>\n
The command will print a helpful list of all the configured routes in your application. You can also get very specific information on a single route by including the route name after the command:<\/p>\n
php app\/console router:debug ibw_job_show<\/pre>\n
Final Thoughts<\/h3>\n
That\u2019s all for today! To learn more about the Symfony2 routing system read the Routing chapter form the book.<\/p>\n<\/div>\n<\/div>\n
\"Creative<\/a>
\nThis work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
* This article is part of the original Jobeet Tutorial, created by Fabien Potencier, for Symfony 1.4. URLs If you […]<\/p>\n","protected":false},"author":4,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[82],"tags":[],"yst_prominent_words":[275,422,564,1013,1038,1236,1355,1948],"post_mailing_queue_ids":[],"_links":{"self":[{"href":"https:\/\/intelligentbee.com\/blog\/wp-json\/wp\/v2\/posts\/2199"}],"collection":[{"href":"https:\/\/intelligentbee.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/intelligentbee.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/intelligentbee.com\/blog\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/intelligentbee.com\/blog\/wp-json\/wp\/v2\/comments?post=2199"}],"version-history":[{"count":3,"href":"https:\/\/intelligentbee.com\/blog\/wp-json\/wp\/v2\/posts\/2199\/revisions"}],"predecessor-version":[{"id":133054,"href":"https:\/\/intelligentbee.com\/blog\/wp-json\/wp\/v2\/posts\/2199\/revisions\/133054"}],"wp:attachment":[{"href":"https:\/\/intelligentbee.com\/blog\/wp-json\/wp\/v2\/media?parent=2199"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/intelligentbee.com\/blog\/wp-json\/wp\/v2\/categories?post=2199"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/intelligentbee.com\/blog\/wp-json\/wp\/v2\/tags?post=2199"},{"taxonomy":"yst_prominent_words","embeddable":true,"href":"https:\/\/intelligentbee.com\/blog\/wp-json\/wp\/v2\/yst_prominent_words?post=2199"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}