The Symfony CMF Book

More documents

Recommendations

Info

Listing 4-1 Concept Chapter 4 Menu No CMS system is complete without a menu system that allows users to navigate between content pages and perform certain actions. While it usually maps the actual content tree structure, menus often have a logic of their own, include options not mapped by content or exist in multiple contexts with multiple options, thus making them a complex problem themselves. Symfony CMF Menu System Symfony CMF SE includes the MenuBundle, a tool that allow you to dynamically define your menus. It extends the KnpMenuBundle 1 , with a set of hierarchical, multi language menu elements, along with the tools to persist them in the chosen content store. It also includes the administration panel definitions and related services needed for integration with the SonataDoctrinePhpcrAdminBundle 2 . Usage The MenuBundle extends and greatly relies on the KnpMenuBundle 3 , so you should carefully read KnpMenuBundle's documentation 4 . For the rest of this page we assume you have done so and are familiar with concepts like Menu Providers and Menu Factories. The MenuBundle uses KnpMenuBundle's default renderers and helpers to print out menus. You can refer to the respective documentation page 5 for more information on the subject, but a basic call would be: 1. https://github.com/knplabs/KnpMenuBundle 2. https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle 3. https://github.com/knplabs/KnpMenuBundle 4. https://github.com/KnpLabs/KnpMenuBundle/blob/master/Resources/doc/index.md 5. https://github.com/KnpLabs/KnpMenuBundle/blob/master/Resources/doc/index.md#rendering-menus PDF brought to you by generated on June 13, 2013 Chapter 4: Menu | 16
Listing 4-2 1 {{ knp_menu_render('simple') }} The provided menu name will be passed on to MenuProviderInterface implementation, which will use it to identify which menu you want rendered in this specific section. The Provider The core of the MenuBundle is PHPCRMenuProvider, a MenuProviderInterface implementation that's responsible for dynamically loading menus from a PHPCR database. The default provider service is configured with a menu_basepath to know where in the PHPCR tree it will find menus. The menu name is given when rendering the menu and must be a direct child of the menu base path. This allows the PHPCRMenuProvider to handle several menu hierarchies using a single storage mechanism. To give a concrete example, if we have the configuration as given below and render the menu simple, the menu root node must be stored at /cms/menu/simple. 1 2 cmf_menu: menu_basepath: /cms/menu If you need multiple menu roots, you can create further PHPCRMenuProvider instances and register them with KnpMenu - see the CMF MenuBundle DependencyInjection code for the details. The menu element fetched using this process is used as the menu root node, and its children will be loaded progressively as the full menu structure is rendered by the MenuFactory. The Factory The ContentAwareFactory is a FactoryInterface implementation, which generates the full MenuItem hierarchy from the provided MenuNode. The data generated this way is later used to generate the actual HTML representation of the menu. The included implementation focuses on generating MenuItem instances from NodeInterface instances, as this is usually the best approach to handle tree-like structures typically used by a CMS. Other approaches are implemented in the base classes, and their respective documentation pages can be found in KnpMenuBundle 6 's page. ContentAwareFactory is responsible for loading the full menu hierarchy and transforming the MenuNode instances from the root node it receives from the MenuProviderInterface implementation. It is also responsible for determining which (if any) menu item is currently being viewed by the user. It supports a voter mechanism to have custom code decide what menu item is the current item. KnpMenu already includes a specific factory targeted at Symfony2's Routing component, which this bundle extends, to add support for: • Route instances stored in a database (refer to RoutingBundle's RouteProvider for more details on this) • Route instances with associated content (more on this on respective RoutingBundle's section) As mentioned before, ContentAwareFactory is responsible for loading all the menu nodes from the provided root element. The actual loaded nodes can be of any class, even if it's different from the root's, but all must implement NodeInterface in order to be included in the generated menu. 6. https://github.com/knplabs/KnpMenuBundle PDF brought to you by generated on June 13, 2013 Chapter 4: Menu | 17
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 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: Listing 3-1 1 2 3 4 5 use Doctrine\
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:
Listing 20-1 Listing 20-2 Chapter 2
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:
Listing 29-1 Listing 29-2 Chapter 2
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?