Skip to content

mention routing from the database #6021

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 1 commit into from
Feb 16, 2016
Merged
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions cookbook/map.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@
* :doc:`/cookbook/routing/custom_route_loader`
* :doc:`/cookbook/routing/redirect_trailing_slash`
* :doc:`/cookbook/routing/extra_information`
* :doc:`/cookbook/routing/routing_from_database`

* :doc:`Security Authentication (Identifying/Logging in the User) </cookbook/security/index>`

Expand Down
1 change: 1 addition & 0 deletions cookbook/routing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Routing
custom_route_loader
redirect_trailing_slash
extra_information
routing_from_database
Copy link
Member

Choose a reason for hiding this comment

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

You also need to add a reference to /cookbook/routing/map.rst.inc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

41 changes: 41 additions & 0 deletions cookbook/routing/routing_from_database.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.. index::
single: Routing; Extra Information

Looking up Routes from a Database: Symfony CMF DynamicRouter
============================================================

The core Symfony Routing System is excellent at handling complex sets
of routes. A highly optimized routing cache is dumped during
deployments.

However, when working with large amounts of data that each need a nice
readable URL (e.g. for search engine optimization purposes), the routing
can get slowed down. Additionally, if routes need to be edited by users,
the route cache would need to be rebuilt frequently.

For these cases, the ``DynamicRouter`` offers an alternative approach:

* Routes are stored in a database;
* There is a database index on the path field, the lookup scales to huge
numbers of different routes;
* Writes only affect the index of the database, which is very efficient.

When all routes are known during deploy time and the number is not too
high, using a :doc:`custom route loader <custom_route_loader>` is the
preferred way to add more routes. When working with just one type of
objects, a slug parameter on the object and the ``@ParamConverter``
annotation work fine (see FrameworkExtraBundle_) .

The ``DynamicRouter`` is useful when you need ``Route`` objects with
the full feature set of Symfony. Each route can define a specific
controller so you can decouple the URL structure from your application
logic.

The DynamicRouter comes with built-in support for Doctrine ORM and Doctrine
PHPCR-ODM but offers the ``ContentRepositoryInterface`` to write a custom
loader, e.g. for another database type or a REST API or anything else.

The DynamicRouter is explained in the `Symfony CMF documentation`_.

.. _FrameworkExtraBundle: https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html
.. _`Symfony CMF documentation`: http://symfony.com/doc/master/cmf/book/routing.html