Creating Menu Builders as Services

Creating Menu Builders as Services

This bundle gives you a really convenient way to create menus by following a convention and - if needed - injecting the entire container.

However, if you want to, you can instead choose to create a service for your menu builder. The advantage of this method is that you can inject the exact dependencies that your menu builder needs, instead of injecting the entire service container. This can lead to code that is more testable and also potentially more reusable. The disadvantage is that it needs just a little more setup.

Start by creating a builder for your menu. You can stick as many menus into a builder as you want, so you may only have one (or just a few) of these builder classes in your application:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
// src/AppBundle/Menu/MenuBuilder.php

namespace AppBundle\Menu;

use Knp\Menu\FactoryInterface;

class MenuBuilder
{
    private $factory;

    /**
     * @param FactoryInterface $factory
     *
     * Add any other dependency you need
     */
    public function __construct(FactoryInterface $factory)
    {
        $this->factory = $factory;
    }

    public function createMainMenu(array $options)
    {
        $menu = $this->factory->createItem('root');

        $menu->addChild('Home', ['route' => 'homepage']);
        // ... add more children

        return $menu;
    }
}

Next, register your menu builder as service and register its createMainMenu method as a menu builder:

1
2
3
4
5
6
7
8
9
# app/config/services.yml
services:
    app.menu_builder:
        class: AppBundle\Menu\MenuBuilder
        arguments: ["@knp_menu.factory"]
        tags:
            - { name: knp_menu.menu_builder, method: createMainMenu, alias: main } # The alias is what is used to retrieve the menu

    # ...

Note

The menu service must be public as it will be retrieved at runtime to keep it lazy-loaded.

You can now render the menu directly in a template via the name given in the alias key above:

1
{{ knp_menu_render('main') }}

Suppose now we need to create a second menu for the sidebar. The process is simple! Start by adding a new method to your builder:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
// src/AppBundle/Menu/MenuBuilder.php

// ...

class MenuBuilder
{
    // ...

    public function createSidebarMenu(array $options)
    {
        $menu = $this->factory->createItem('sidebar');

        if (isset($options['include_homepage']) && $options['include_homepage']) {
            $menu->addChild('Home', ['route' => 'homepage']);
        }

        // ... add more children

        return $menu;
    }
}

Now, create a service for just your new menu, giving it a new name, like sidebar:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# app/config/services.yml
services:
    app.menu_builder:
        class: AppBundle\Menu\MenuBuilder
        arguments: ["@knp_menu.factory"]
        tags:
            - { name: knp_menu.menu_builder, method: createMainMenu, alias: main } # the previous menu
            - { name: knp_menu.menu_builder, method: createSidebarMenu, alias: sidebar } # Named "sidebar" this time

    # ...

It can now be rendered, just like the other menu:

1
2
{% set menu = knp_menu_get('sidebar', [], {include_homepage: false}) %}
{{ knp_menu_render(menu) }}

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.