Wallogit.com
2017 © Pedro Peláez
Use objects to generate routes
, (*1)
Let's say you have a blog application with route like this:, (*2)
/**
* @Route("/{id}", name="post_detailed")
*/
public function indexAction(Post $post)
{...}
then your templates will have this:, (*3)
<a href="{{ path('post_detailed', {'id': new_post.id}) }}">View post</a>
For this simple case, ParamConverter is automatically applied., (*4)
Now imagine you want to change it to use {slug} instead of {id} in your URL. Updating controller is simple, but updating all the templates is not so., (*5)
This bundle acts as ReverseParamConverter. Check this example:, (*6)
/**
* @Route("/{id}", name="post_detailed")
* @RewireParams(requires={"post"}, rewire={"id"="post.id"})
*/
public function indexAction(Post $post)
{...}
and the template:, (*7)
<a href="{{ path('post_detailed', {'post': new_post}) }}">View post</a>
Now instead of new_post.id you can use object itself and this bundle will use it to generate {id} needed for route., (*8)
So if you want to slug instead of id in your route, just update your controller:, (*9)
/**
* @Route("/{slug}", name="post_detailed")
* @RewireParams(requires={"post"}, rewire={"slug"="post.slug"})
*/
public function indexAction(Post $post)
{...}
and that's all, template doesn't require any changes., (*10)
If you install this bundle, you don't have to change all your templates immediatelly. So both these combinations would still work:, (*11)
<a href="{{ path('post_detailed', {'id': new_post.id}) }}">View post</a>
<a href="{{ path('post_detailed', {'post': new_post}) }}">View post</a>
The above example is pretty simple so let's try something more complex. For this, imagine we wanted to add {category_slug} to URL for better SEO., (*12)
The old way:, (*13)
/**
* @Route("/{category_slug}/{slug}", name="post_detailed")
*/
public function indexAction(Post $post)
{...}
<a href="{{ path('post_detailed', {'category_slug': new_post.category.slug, 'slug': new_post.slug}) }}">View post</a>
For this fictional blog application, generated route would be something like /conspiracy-theories/why-they-suck. You can see why updating templates can be a problem., (*14)
With this bundle:, (*15)
/**
* @Route("/{category_slug}/{slug}", name="post_detailed")
* @RewireParams(requires={"post"}, rewire={"category_slug"="post.category.slug", "slug": post.slug})
*/
public function indexAction(Post $post)
{...}
your template doesn't require any changes, it would remain the same:, (*16)
<a href="{{ path('post_detailed', {'post': new_post}) }}">View post</a>
The @RewireParams annotation has 2 properties:, (*17)
post is used in all examples.While there is perfomance hit, I didn't notice any on page with 106 routes (largest I have). It is probably too small to spot it but more testing is needed., (*18)
Program works by caching @RewireParams annotations and later using it in Router decorator class. Given this bundle is built in a day, I am sure improvements can be made., (*19)
composer require wjb/rewire-bundle
If you are on Symfony4, you don't have to do anything else. For Symfony3, enable the bundle in your AppKernel:, (*20)
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = [
...
new wjb\RewireBundle\wjbRewireBundle(),
...
Use objects to generate routes
MIT
Use objects to generate routes
MIT
Use objects to generate routes
MIT