jbouzekri/config-knp-menu-bundle

Configure your knp menus with yaml files accross your project bundles

Installs: 24 730

Dependents: 0

Suggesters: 0

Stars: 5

Watchers: 1

Forks: 9

Open Issues: 0

Type:symfony-bundle

4.2 2019-07-03 05:18 UTC

README

Build Status SensioLabsInsight

Introduction

This bundle provides a way to configure your knp menus in your bundles yml configuration.

For more information on knp menu, read :

This bundle was inspired by the OroNavigationBundle in oro crm.

Installation

You can use composer for installation.

Add the repository to the composer.json file of your project and run the update or install command.

{
    "require": {
        "jbouzekri/config-knp-menu-bundle": "3.0.0"
    }
}

Then enable it in your AppKernel.php with the KnpMenuBundle :

$bundles = array(
    ...
    new Knp\Bundle\MenuBundle\KnpMenuBundle(),
    new Jb\Bundle\ConfigKnpMenuBundle\JbConfigKnpMenuBundle(),
);

Documentation

In order to use this bundle, you must define your menu configuration in a navigation.yml file in your bundle.

Example :

my_mega_menu:
    tree:
        first_level_item:
            label: My first label
            children:
                second_level_item:
                    label: My second level

It will configure a provider for knp menu factory. You can then use your my_mega_menu in twig as a classic knp menu :

{{ knp_menu_render('my_mega_menu') }}

Configuration

This is the available configuration definition for an item.

my_mega_menu:
    childrenAttributes: An array of attributes passed to the root ul tag
    tree:
        first_level_item:
            uri: "An uri. Use it if you do not define route parameter"
            route: "A sf2 route without @"
            routeParameters: "an array of parameters to pass to the route"
            label: "My first label"
            order: An integer to sort the item in his level.
            attributes: An array of attributes passed to the knp item
            linkAttributes: An array of attributes passed to the a tag
            childrenAttributes: An array of attributes passed to the chidlren block
            labelAttributes: An array of attributes passed to the label tag
            display: boolean to hide the item
            displayChildren: boolean to hide the children
            roles: array of item (string roles) passed to isGranted securityContext method to check if user has rights in menu items
            extras: An array of extra parameters (for example icon img, additional content etc.)
            children: # An array of subitems
                second_level_item:
                    label: My second level

This configuration matches the methods available in the Knp Menu Item class

Menu security

Security context is injected in menu item provider.

For root menu item, display or hide it in your twig template. For children items, if you didn't add the roles key, they will be displayed. Else it will passed the array of key to the isGranted method and check if you have rights on the the item.

Issues

  • tree sub configuration property : In the navigation.yml file, you must defined a tree key below your menu name. It provides another level to keep the first level item key after configuration parsing. If someone know how to remove it, let me know.