wiki/content/20201109142351-prefix_all_controller_route_names.md

64 lines
1.5 KiB
Markdown

---
date: 20201109
id: 0fae8bc3-e520-4515-b3ca-7d8b1003d132
title: Prefix all controller route names
---
# Introduction
From [Symfony 4.0](20201109140137-symfony_4_0) the class of a controller
can define the `@Route` annotation to set a common prefix for the URLs
used by the action methods:
# Syntax
``` php
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
/**
* @Route("/blog")
*/
class BlogController extends Controller
{
/**
* @Route("/", defaults={"page": "1"}, name="blog_index")
* @Route("/page/{page}", name="blog_index_paginated")
*/
public function indexAction($page, $_format) { ... }
/**
* @Route("/posts/{slug}", name="blog_post")
*/
public function showAction(Post $post) { ... }
}
```
Add a `name` property to the `@Route` annotation of the controller class
and that will be considered the prefix of all route names. The following
is equivalent to the previous example:
``` php
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
/**
* @Route("/blog", name="blog_")
*/
class BlogController extends Controller
{
/**
* @Route("/", defaults={"page": "1"}, name="index")
* @Route("/page/{page}", name="index_paginated")
*/
public function indexAction($page, $_format) { ... }
/**
* @Route("/posts/{slug}", name="post")
*/
public function showAction(Post $post) { ... }
}
```
# name~prefix~ option
In [Symfony 4.1](20201110152518-symfony_4_1) a new
[name~prefix~](20201110153351-name_prefix) option was added.