The Symfony CMF Book

More documents

Recommendations

Info

Chapter 2 Routing This is an introduction to understand the concepts behind CMF routing. For the reference documentation please see Routing and The RoutingBundle. Concept Why a new Routing Mechanism? CMS are highly dynamic sites, where most of the content is managed by the administrators rather than developers. The number of available pages can easily reach the thousands, which is usually multiplied by the number of available translations. Best accessibility and SEO practices, as well as user preferences dictate that the URLs should be definable by the content managers. The default Symfony2 routing mechanism, with its configuration file approach, is not the best solution for this problem. It does not provide a way of handling dynamic, user-defined routes, nor does it scale well to a large number of routes. The Solution In order to address these issues, a new routing system was developed that takes into account the typical needs of CMS routing: • User-defined URLs; • Multi-site; • Multi-language; • Tree-like structure for easier management; • Content, Menu and Route separation for added flexibility. With these requirements in mind, the Symfony CMF Routing component was developed. PDF brought to you by generated on June 13, 2013 Chapter 2: Routing | 8
Listing 2-1 Listing 2-2 Listing 2-3 The ChainRouter At the core of Symfony CMF's Routing component sits the ChainRouter. It is used as a replacement for Symfony2's default routing system and, like the Symfony2 router, is responsible for determining which Controller will handle each request. The ChainRouter works by accepting a set of prioritized routing strategies, RouterInterface 1 implementations, commonly referred to as "Routers". The routers are responsible for matching an incoming request to an actual Controller and, to do so, the ChainRouter iterates over the configured Routers according to their configured priority: 1 2 3 4 5 6 7 8 9 10 # app/config/config.yml cmf_routing: chain: routers_by_id: # enable the DynamicRouter with high priority to allow overwriting # configured routes with content cmf_routing.dynamic_router: 200 # enable the symfony default router with a lower priority router.default: 100 You can also load Routers using tagged services, by using the router tag and an optional priority. The higher the priority, the earlier your router will be asked to match the route. If you do not specify the priority, your router will come last. If there are several routers with the same priority, the order between them is undetermined. The tagged service will look like this: 1 2 3 4 5 services: my_namespace.my_router: class: "%my_namespace.my_router_class%" tags: - { name: router, priority: 300 } The Symfony CMF Routing system adds a new DynamicRouter, which complements the default Router found in Symfony2. The Default Symfony2 Router Although it replaces the default routing mechanism, Symfony CMF Routing allows you to keep using the existing system. In fact, the default routing is enabled by default, so you can keep using the routes you declared in your configuration files, or as declared by other bundles. The DynamicRouter This Router can dynamically load Route instances from a given provider. It then uses a matching process to the incoming request to a specific Route, which in turn is used to determine which Controller to forward the request to. The bundle's default configuration states that DynamicRouter is disabled by default. To activate it, just add the following to your configuration file: 1. http://api.symfony.com/master/Symfony/Component/Routing/RouterInterface.html PDF brought to you by generated on June 13, 2013 Chapter 2: Routing | 9
Page 1 and 2: The Symfony CMF Book for Symfony ma
Page 3 and 4: Contents at a Glance Installing the
Page 5 and 6: Listing 1-1 Listing 1-2 Listing 1-3
Page 7: Listing 1-8 Listing 1-9 Listing 1-1
Page 11 and 12: Listing 2-4 Listing 2-5 1 2 3 4 5 6
Page 13 and 14: Listing 2-7 Listing 2-8 Integrating
Page 15 and 16: Listing 3-1 1 2 3 4 5 use Doctrine\
Page 17 and 18: Listing 4-2 1 {{ knp_menu_render('s
Page 19 and 20: Concept Chapter 5 SimpleCMS In the
Page 21 and 22: Listing 5-2 Listing 5-3 NestedMatch
Page 23 and 24: Configuration This bundle is config
Page 25 and 26: additional semantic meaning. So a C
Page 27 and 28: PHPCR ODM As mentioned above using
Page 31 and 32: Chapter 8 Installing and Configurin
Page 35 and 36: Listing 8-10 Listing 8-11 Listing 8
Page 37 and 38: 4 5 6 7 8 9 10 11 12 13 14 15 16 17
Page 39 and 40: Listing 9-3 Listing 9-4 1 $ php com
Page 41 and 42: Listing 10-3 Listing 10-4 1 2 3 4 5
Page 43 and 44: Listing 10-7 1 2 3 4 5 6 7 8 9 10
Page 47 and 48: Listing 11-11 Listing 11-12 Listing
Page 55 and 56: Listing 12-1 Chapter 12 Handling Mu
Page 59 and 60:
Listing 13-1 Listing 13-2 Chapter 1
Page 61 and 62:
Listing 13-4 Listing 13-5 • An ex
Page 63 and 64:
• The execute method of the corre
Page 65 and 66:
Listing 14-2 Listing 14-3 • Defin
Page 67 and 68:
6 7 items: - cmf_block.slideshow_ad
Page 69 and 70:
Listing 15-3 15 16 17 18 Listing 15
Page 71 and 72:
Listing 16-1 Listing 16-2 1 2 3 4 5
Page 73 and 74:
Listing 16-3 • The computed cache
Page 75 and 76:
Chapter 17 Relation to Sonata Block
Page 77 and 78:
Listing 18-2 Listing 18-3 Listing 1
Page 79 and 80:
4 5 {% block content %} {% endblock
Page 81 and 82:
Page 83 and 84:
3 4 5 6 7 8 9 10 11 12 13 14 15 16
Page 85 and 86:
Page 87 and 88:
Listing 21-10 Configuration 1 2 3 4
Page 89 and 90:
Listing 21-14 Listing 21-15 Listing
Page 91 and 92:
Chapter 22 The DoctrinePHPCRBundle
Page 93 and 94:
Listing 22-3 Listing 22-4 # its hig
Page 95 and 96:
Page 97 and 98:
Listing 22-12 Listing 22-13 Service
Page 99 and 100:
Page 101 and 102:
Listing 22-20 Listing 22-21 Fixture
Page 103 and 104:
Listing 23-1 Chapter 23 The MenuBun
Page 105 and 106:
Listing 23-3 21 22 23 24 25 26 27 2
Page 107 and 108:
Listing 23-7 Listing 23-8 1 2 3 4 5
Page 109 and 110:
Chapter 24 The RoutingBundle The Ro
Page 111 and 112:
Listing 24-3 The minimum configurat
Page 113 and 114:
Page 115 and 116:
If you use an ODM / ORM different t
Page 117 and 118:
Listing 25-1 2. By separating the r
Page 119 and 120:
Page 121 and 122:
Page 123 and 124:
Listing 25-16 8 9 10 11 12 13 14 15
Page 125 and 126:
Chapter 27 The SimpleCmsBundle The
Page 127 and 128:
Page 129 and 130:
Listing 28-1 Chapter 28 The SonataD
Page 131 and 132:
Page 133 and 134:
Page 135 and 136:
Listing 30-1 Chapter 30 Using a Cus
Page 137 and 138:
Listing 31-2 24 25 26 27 28 29 30 3
Page 139 and 140:
Page 141 and 142:
Page 143 and 144:
Chapter 33 Routing The Symfony CMF
Page 145 and 146:
the DynamicRouter constructor. As p
Page 147 and 148:
Customization Under PHPCR-ODM, Rout
Page 149 and 150:
Chapter 35 Licensing The Symfony2 C
show all

The Symfony CMF Book

Create successful ePaper yourself

Delete template?

Save as template?