Skip to content

[Cookbook] Apache Router usage example #1347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 19, 2012
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions cookbook/configuration/apache_router.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
.. index::
single: Apache Router

How to use Apache Router
========================

Symfony2, 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 Symfony2 for this task.

Change Router Configuration Parameters
--------------------------------------
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change Router Configuration Parameters

I'm not perfect about it, but we basically try to capitalize nouns, but not verbs and adjectives/adverbs. In this case, I think case, by that definition, I think router and configuration should be lowercase, but I think it just looks funny.


To to be to dump Apache routes we must first tweak configuration parameters and tell
Symfony2 to use ApacheUrlMatcher instead of the default one:

.. code-block:: yaml

# app/config/config_prod.yml
parameters:
router.options.matcher.cache_class: ~ # disable router cache
router.options.matcher_class: Symfony\Component\Routing\Matcher\ApacheUrlMatcher

.. tip::

Note that :class: `Symfony\\Component\\Routing\\Matcher\\ApacheUrlMatcher` extends :class: `Symfony\\Component\\Routing\\Matcher\\UrlMatcher` so even if you don't regenerate
the url_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, let's create a very basic route for demo bundle:

.. code-block:: yaml

# app/config/routing.yml
hello:
pattern: /hello/{name}
defaults: { _controller: AcmeDemoBundle:Demo:hello }


Now we generate **url_rewrite** rules:

.. code-block:: bash

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

Which should roughly output the following:

.. code-block:: apache

# 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:AcmeDemoBundle\:Demo\:hello]

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

.. code-block:: text
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pygments (used by Sphinx for the syntax highlighting) supports apache as format to highlight the syntax of apache configuration files


<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:AcmeDemoBundle\:Demo\:hello]
</IfModule>

.. note::

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 Route rules.

Additional tweaks
-----------------

To save a little bit of processing time, change in **web/app.php** occurences of **Request** into **ApacheRequest**::

// 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();