dahovitech/menu-bundle

Symfony Menu Bundle by Dahovitech

v1.0.0 2025-07-31 12:12 UTC

Requires

• php: >=8.1
• symfony/config: ^6.0 || ^7.0
• symfony/dependency-injection: ^6.0 || ^7.0
• symfony/http-kernel: ^6.0 || ^7.0
• symfony/twig-bundle: ^6.0 || ^7.0

MIT

• Your Name

README

Ce bundle Symfony fournit un moyen simple et flexible de gérer et d'afficher des menus dans vos applications Symfony.

Nouveautés et Améliorations

Cette version apporte des améliorations significatives :

• Attributs HTML Dynamiques : Personnalisez les attributs HTML (class, id, data-*) de chaque élément de menu.
• Paramètres de Route : Générez des URLs complexes en passant des paramètres aux routes Symfony.
• Templates Multiples : Définissez un template Twig spécifique pour chaque menu.
• Voters de Visibilité : Contrôlez dynamiquement la visibilité des éléments de menu (e.g., basé sur les rôles utilisateur).
• Système d'Événements : Modifiez les menus de manière programmatique après leur construction via des événements.
• Mécanisme de Cache : Améliorez les performances en mettant en cache les menus générés.
• Gestion de l'État Actif : Les éléments de menu actifs reçoivent automatiquement une classe active.
• Accessibilité (ARIA) : Les menus sont générés avec des attributs ARIA pour une meilleure accessibilité.

Installation

1. Ajoutez le bundle à votre projet Symfony via Composer :

   composer config repositories.dahovitech-menu-bundle '{"type": "path", "url": "./dahovitech/menu-bundle"}'
   composer require dahovitech/menu-bundle:dev-main

2. Activez le bundle dans votre config/bundles.php :

   return [
       // ...
       Dahovitech\MenuBundle\DahovitechMenuBundle::class => ["all" => true],
   ];

Configuration

Configurez vos menus dans config/packages/dahovitech_menu.yaml :

dahovitech_menu:
    menus:
        main_menu:
            template: '@DahovitechMenu/menu.html.twig' # Optionnel, utilise le template par défaut si non spécifié
            items:
                - label: 'Accueil'
                  route: 'app_homepage'
                - label: 'À propos'
                  url: '/about'
                - label: 'Services'
                  children:
                      - label: 'Service 1'
                        route: 'app_service1'
                      - label: 'Service 2'
                        url: '/services/service2'
                - label: 'Contact'
                  route: 'app_contact'
                  attributes:
                      class: 'contact-link'
        admin_menu:
            template: '@DahovitechMenu/admin_menu.html.twig'
            items:
                - label: 'Dashboard'
                  route: 'admin_dashboard'
                - label: 'Utilisateurs'
                  route: 'admin_users_list'
                  route_params:
                      page: 1
                  attributes:
                      data-toggle: 'tooltip'
                      title: 'Gérer les utilisateurs'

Utilisation dans Twig

Pour afficher un menu dans vos templates Twig, utilisez la fonction dahovitech_menu :

{{ dahovitech_menu('main_menu') }}

Vous pouvez également passer des options supplémentaires au template (par exemple, pour ajouter une classe à la balise <ul> racine) :

{{ dahovitech_menu('main_menu', {'ul_class': 'navbar-nav'}) }}

Utilisation des Voters (Visibilité)

Pour contrôler la visibilité d'un élément de menu, vous pouvez utiliser le système de voters de Symfony. Par défaut, tous les éléments sont visibles. Vous pouvez créer vos propres voters en implémentant Symfony\Component\Security\Core\Authorization\Voter\VoterInterface et en les taguant avec security.voter.

Exemple de Voter simple (pour les administrateurs) :

// src/Voter/AdminMenuItemVoter.php
namespace App\Voter;

use Dahovitech\MenuBundle\Model\MenuItem;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Authorization\Voter\Voter;

class AdminMenuItemVoter extends Voter
{
    protected function supports(string $attribute, mixed $subject): bool
    {
        return $attribute === 'view' && $subject instanceof MenuItem && $subject->getLabel() === 'Dashboard Admin';
    }

    protected function voteOnAttribute(string $attribute, mixed $subject, TokenInterface $token): bool
    {
        // Seuls les utilisateurs avec le rôle ROLE_ADMIN peuvent voir cet élément
        return $token->getUser() && in_array('ROLE_ADMIN', $token->getUser()->getRoles());
    }
}

Ensuite, dans votre configuration de menu, vous pouvez définir la visibilité :

dahovitech_menu:
    menus:
        admin_menu:
            items:
                - label: 'Dashboard Admin'
                  route: 'admin_dashboard'
                  # Cet élément sera filtré par AdminMenuItemVoter

Utilisation des Événements (Modification)

Vous pouvez écouter l'événement dahovitech_menu.build pour modifier les menus après leur construction initiale. Créez un service qui implémente Symfony\Component\EventDispatcher\EventSubscriberInterface.

Exemple d'Event Subscriber :

// src/EventSubscriber/MenuSubscriber.php
namespace App\EventSubscriber;

use Dahovitech\MenuBundle\Event\MenuBuildEvent;
use Dahovitech\MenuBundle\Model\MenuItem;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class MenuSubscriber implements EventSubscriberInterface
{
    public static function getSubscribedEvents(): array
    {
        return [
            MenuBuildEvent::NAME => 'onMenuBuild',
        ];
    }

    public function onMenuBuild(MenuBuildEvent $event):
    {
        if ($event->getMenuName() === 'main_menu') {
            $menuItems = $event->getMenuItems();
            $menuItems[] = new MenuItem('Nouveau Lien Ajouté', '/new-link');
            $event->setMenuItems($menuItems);
        }
    }
}

N'oubliez pas de déclarer votre service dans services.yaml :

# config/services.yaml
services:
    App\EventSubscriber\MenuSubscriber:
        tags: [kernel.event_subscriber]

Tests

Des tests unitaires et fonctionnels ont été ajoutés pour couvrir les nouvelles fonctionnalités et garantir la stabilité du bundle.