Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages showcasing Symfony with Docker, APIs, queues & async tasks, Webpack, SPAs, etc.

  1. Home
  2. Documentation
  3. Cookbook
  4. Controller
  5. How to define Controllers as Services
WARNING:

You are browsing the documentation for Symfony 2.1 which is not maintained anymore.

Consider upgrading your projects to Symfony 5.2.

How to define Controllers as Services

2.1 version
Unmaintained
2.0 2.1 2.2 2.3 2.4 2.5 2.6

How to define Controllers as Services

In the book, you’ve learned how easily a controller can be used when it extends the base Symfony\Bundle\FrameworkBundle\Controller\Controller class. While this works fine, controllers can also be specified as services.

To refer to a controller that’s defined as a service, use the single colon (:) notation. For example, suppose you’ve defined a service called my_controller and you want to forward to a method called indexAction() inside the service:

$this->forward('my_controller:indexAction', array('foo' => $bar));

You need to use the same notation when defining the route _controller value:

1
2
3
my_controller:
    pattern:   /
    defaults:  { _controller: my_controller:indexAction }

To use a controller in this way, it must be defined in the service container configuration. For more information, see the Service Container chapter.

When using a controller defined as a service, it will most likely not extend the base Controller class. Instead of relying on its shortcut methods, you’ll interact directly with the services that you need. Fortunately, this is usually pretty easy and the base Controller class itself is a great source on how to perform many common tasks.

Note

Specifying a controller as a service takes a little bit more work. The primary advantage is that the entire controller or any services passed to the controller can be modified via the service container configuration. This is especially useful when developing an open-source bundle or any bundle that will be used in many different projects. So, even if you don’t specify your controllers as services, you’ll likely see this done in some open-source Symfony2 bundles.

Using Annotation Routing

When using annotations to setup routing when using a controller defined as a service, you need to specify your service as follows:

/**
 * @Route("/blog", service="my_bundle.annot_controller")
 * @Cache(expires="tomorrow")
 */
class AnnotController extends Controller
{
}

In this example, my_bundle.annot_controller should be the id of the AnnotController instance defined in the service container. This is documented in the @Routing chapter.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.