Skip to content
  • About
    • What is Symfony?
    • Community
    • News
    • Contributing
    • Support
  • Documentation
    • Symfony Docs
    • Symfony Book
    • Screencasts
    • Symfony Bundles
    • Symfony Cloud
    • Training
  • Services
    • SensioLabs Professional services to help you with Symfony
    • Platform.sh for Symfony Best platform to deploy Symfony apps
    • SymfonyInsight Automatic quality checks for your apps
    • Symfony Certification Prove your knowledge and boost your career
    • Blackfire Profile and monitor performance of your apps
  • Other
  • Blog
  • Download
sponsored by SensioLabs
  1. Home
  2. Documentation
  3. Configuration
  4. How to Use the Apache Router
  • Documentation
  • Book
  • Reference
  • Bundles
  • Cloud

Table of Contents

  • Change Router Configuration Parameters
  • Generating mod_rewrite Rules
  • Additional Tweaks

How to Use the Apache Router

Edit this page

Warning: You are browsing the documentation for Symfony 2.7, which is no longer maintained.

Read the updated version of this page for Symfony 6.2 (the current stable version).

How to Use the Apache Router

Caution

Using the Apache Router is no longer considered a good practice. The small increase obtained in the application routing performance is not worth the hassle of continuously updating the routes configuration.

The Apache Router will be removed in Symfony 3 and it's highly recommended to not use it in your applications.

Symfony, while fast out of the box, also provides various ways to increase that speed with a little bit of tweaking. One of these ways is by letting Apache handle routes directly, rather than using Symfony for this task.

Caution

Apache router was deprecated in Symfony 2.5 and will be removed in Symfony 3.0. Since the PHP implementation of the Router was improved, performance gains were no longer significant (while it's very hard to replicate the same behavior).

Change Router Configuration Parameters

To dump Apache routes you must first tweak some configuration parameters to tell Symfony to use the ApacheUrlMatcher instead of the default one:

  • YAML
  • XML
  • PHP
1
2
3
4
# app/config/config_prod.yml
parameters:
    router.options.matcher.cache_class: ~ # disable router cache
    router.options.matcher_class: Symfony\Component\Routing\Matcher\ApacheUrlMatcher
1
2
3
4
5
<!-- app/config/config_prod.xml -->
<parameters>
    <parameter key="router.options.matcher.cache_class">null</parameter> <!-- disable router cache -->
    <parameter key="router.options.matcher_class">Symfony\Component\Routing\Matcher\ApacheUrlMatcher</parameter>
</parameters>
1
2
3
4
5
6
// app/config/config_prod.php
$container->setParameter('router.options.matcher.cache_class', null); // disable router cache
$container->setParameter(
    'router.options.matcher_class',
    'Symfony\Component\Routing\Matcher\ApacheUrlMatcher'
);

Tip

Note that ApacheUrlMatcher extends UrlMatcher so even if you don't regenerate the mod_rewrite rules, everything will work (because at the end of ApacheUrlMatcher::match() a call to parent::match() is done).

Generating mod_rewrite Rules

To test that it's working, create a very basic route for the AppBundle:

  • YAML
  • XML
  • PHP
1
2
3
4
# app/config/routing.yml
hello:
    path: /hello/{name}
    defaults: { _controller: AppBundle:Greet:hello }
1
2
3
4
<!-- app/config/routing.xml -->
<route id="hello" path="/hello/{name}">
    <default key="_controller">AppBundle:Greet:hello</default>
</route>
1
2
3
4
// app/config/routing.php
$collection->add('hello', new Route('/hello/{name}', array(
    '_controller' => 'AppBundle:Greet:hello',
)));

Now generate the mod_rewrite rules:

1
$ php app/console router:dump-apache -e=prod --no-debug

Which should roughly output the following:

1
2
3
4
5
6
7
# skip "real" requests
RewriteCond %{REQUEST_FILENAME} -f
RewriteRule .* - [QSA,L]

# hello
RewriteCond %{REQUEST_URI} ^/hello/([^/]+?)$
RewriteRule .* app.php [QSA,L,E=_ROUTING__route:hello,E=_ROUTING_name:%1,E=_ROUTING__controller:AppBundle\:Greet\:hello]

You can now rewrite web/.htaccess to use the new rules, so with this example it should look like this:

1
2
3
4
5
6
7
8
9
10
11
<IfModule mod_rewrite.c>
    RewriteEngine On

    # skip "real" requests
    RewriteCond %{REQUEST_FILENAME} -f
    RewriteRule .* - [QSA,L]

    # hello
    RewriteCond %{REQUEST_URI} ^/hello/([^/]+?)$
    RewriteRule .* app.php [QSA,L,E=_ROUTING__route:hello,E=_ROUTING_name:%1,E=_ROUTING__controller:AppBundle\:Greet\:hello]
</IfModule>

Note

The procedure above should be done each time you add/change a route if you want to take full advantage of this setup.

That's it! You're now all set to use Apache routes.

Additional Tweaks

To save some processing time, change occurrences of Request to ApacheRequest in web/app.php:

1
2
3
4
5
6
7
8
9
10
11
12
// web/app.php

require_once __DIR__.'/../app/bootstrap.php.cache';
require_once __DIR__.'/../app/AppKernel.php';
// require_once __DIR__.'/../app/AppCache.php';

use Symfony\Component\HttpFoundation\ApacheRequest;

$kernel = new AppKernel('prod', false);
$kernel->loadClassCache();
// $kernel = new AppCache($kernel);
$kernel->handle(ApacheRequest::createFromGlobals())->send();
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
TOC
    Version
    We stand with Ukraine.
    Version:
    Become certified from home

    Become certified from home

    Code consumes server resources. Blackfire tells you how

    Code consumes server resources. Blackfire tells you how

    Symfony footer

    ↓ Our footer now uses the colors of the Ukrainian flag because Symfony stands with the people of Ukraine.

    Avatar of Adam Klvač, a Symfony contributor

    Thanks Adam Klvač for being a Symfony contributor

    1 commit • 2 lines changed

    View all contributors that help us make Symfony

    Become a Symfony contributor

    Be an active part of the community and contribute ideas, code and bug fixes. Both experts and newcomers are welcome.

    Learn how to contribute

    Symfony™ is a trademark of Symfony SAS. All rights reserved.

    • What is Symfony?

      • Symfony at a Glance
      • Symfony Components
      • Case Studies
      • Symfony Releases
      • Security Policy
      • Logo & Screenshots
      • Trademark & Licenses
      • symfony1 Legacy
    • Learn Symfony

      • Symfony Docs
      • Symfony Book
      • Reference
      • Bundles
      • Best Practices
      • Training
      • eLearning Platform
      • Certification
    • Screencasts

      • Learn Symfony
      • Learn PHP
      • Learn JavaScript
      • Learn Drupal
      • Learn RESTful APIs
    • Community

      • SymfonyConnect
      • Support
      • How to be Involved
      • Code of Conduct
      • Events & Meetups
      • Projects using Symfony
      • Downloads Stats
      • Contributors
      • Backers
    • Blog

      • Events & Meetups
      • A week of symfony
      • Case studies
      • Cloud
      • Community
      • Conferences
      • Diversity
      • Documentation
      • Living on the edge
      • Releases
      • Security Advisories
      • SymfonyInsight
      • Twig
      • SensioLabs
    • Services

      • SensioLabs services
      • Train developers
      • Manage your project quality
      • Improve your project performance
      • Host Symfony projects

      Deployed on

    Follow Symfony

    Search by Algolia