vendor/sonata-project/admin-bundle/src/Menu/Provider/GroupMenuProvider.php line 102

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the Sonata Project package.
  7.  *
  8.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Sonata\AdminBundle\Menu\Provider;
  16. use Knp\Menu\FactoryInterface;
  17. use Knp\Menu\ItemInterface;
  18. use Knp\Menu\Provider\MenuProviderInterface;
  19. use Sonata\AdminBundle\Admin\Pool;
  20. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  21. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  23. /**
  24.  * Menu provider based on group options.
  25.  *
  26.  * @author Alexandru Furculita <alex@furculita.net>
  27.  *
  28.  * @phpstan-import-type Item from Pool
  29.  * @phpstan-import-type Group from Pool
  30.  */
  31. final class GroupMenuProvider implements MenuProviderInterface
  32. {
  33.     public function __construct(
  34.         private FactoryInterface $menuFactory,
  35.         private Pool $pool,
  36.         private AuthorizationCheckerInterface $checker,
  37.     ) {
  38.     }
  40.     /**
  41.      * Retrieves the menu based on the group options.
  42.      *
  43.      * @param array<string, mixed> $options
  44.      *
  45.      * @throws \InvalidArgumentException if the menu does not exist
  46.      */
  47.     public function get(string $name, array $options = []): ItemInterface
  48.     {
  49.         if (!isset($options['name']) || !\is_string($options['name'])) {
  50.             throw new \InvalidArgumentException('The option "name" is required.');
  51.         }
  52.         $menuItem = $this->menuFactory->createItem($options['name']);
  54.         if (!isset($options['group'])) {
  55.             throw new \InvalidArgumentException('The option "group" is required.');
  56.         }
  57.         /** @phpstan-var Group $group */
  58.         $group = $options['group'];
  60.         if (false === $group['on_top']) {
  61.             foreach ($group['items'] as $item) {
  62.                 if ($this->canGenerateMenuItem($item, $group)) {
  63.                     $menuItem->addChild($this->generateMenuItem($item, $group));
  64.                 }
  65.             }
  67.             if (false === $menuItem->hasChildren()) {
  68.                 $menuItem->setDisplay(false);
  69.             } elseif ($group['keep_open']) {
  70.                 $menuItem->setAttribute('class', 'keep-open');
  71.                 $menuItem->setExtra('keep_open', $group['keep_open']);
  72.             }
  73.         } elseif (
  74.             1 === \count($group['items'])
  75.             && $this->canGenerateMenuItem($group['items'][0], $group)
  76.         ) {
  77.             $menuItem = $this->generateMenuItem($group['items'][0], $group);
  78.             $menuItem->setExtra('on_top', $group['on_top']);
  79.         } else {
  80.             $menuItem->setDisplay(false);
  81.         }
  83.         $menuItem->setLabel($group['label']);
  85.         return $menuItem;
  86.     }
  88.     /**
  89.      * Checks whether a menu exists in this provider.
  90.      *
  91.      * @param mixed[] $options
  92.      */
  93.     public function has(string $name, array $options = []): bool
  94.     {
  95.         return 'sonata_group_menu' === $name;
  96.     }
  98.     /**
  99.      * @phpstan-param Item $item
  100.      * @phpstan-param Group $group
  101.      */
  102.     private function canGenerateMenuItem(array $item, array $group): bool
  103.     {
  104.         // NEXT_MAJOR: Remove the '' check
  105.         if (isset($item['admin']) && '' !== $item['admin']) {
  106.             $admin = $this->pool->getInstance($item['admin']);
  108.             // skip menu item if no `list` url is available or user doesn't have the LIST access rights
  109.             return $admin->hasRoute('list') && $admin->hasAccess('list');
  110.         }
  112.         // Making the checker behave affirmatively even if it's globally unanimous
  113.         // Still must be granted unanimously to group and item
  115.         $isItemGranted = true;
  116.         if (isset($item['roles']) && [] !== $item['roles']) {
  117.             $isItemGranted = false;
  118.             foreach ($item['roles'] as $role) {
  119.                 if ($this->checker->isGranted($role)) {
  120.                     $isItemGranted = true;
  121.                     break;
  122.                 }
  123.             }
  124.         }
  126.         $isGroupGranted = true;
  127.         if (isset($group['roles']) && [] !== $group['roles']) {
  128.             $isGroupGranted = false;
  129.             foreach ($group['roles'] as $role) {
  130.                 if ($this->checker->isGranted($role)) {
  131.                     $isGroupGranted = true;
  132.                     break;
  133.                 }
  134.             }
  135.         }
  137.         return $isItemGranted && $isGroupGranted;
  138.     }
  140.     /**
  141.      * @phpstan-param Item $item
  142.      * @phpstan-param Group $group
  143.      */
  144.     private function generateMenuItem(array $item, array $group): ItemInterface
  145.     {
  146.         // NEXT_MAJOR: Remove the '' check
  147.         if (isset($item['admin']) && '' !== $item['admin']) {
  148.             $admin = $this->pool->getInstance($item['admin']);
  150.             $options = $admin->generateMenuUrl(
  151.                 'list',
  152.                 $item['route_params'],
  153.                 $item['route_absolute'] ? UrlGeneratorInterface::ABSOLUTE_URL : UrlGeneratorInterface::ABSOLUTE_PATH
  154.             );
  155.             $options['extras'] = [
  156.                 'label_catalogue' => $admin->getTranslationDomain(), // NEXT_MAJOR: Remove this line.
  157.                 'translation_domain' => $admin->getTranslationDomain(),
  158.                 'admin' => $admin,
  159.             ];
  161.             return $this->menuFactory->createItem($admin->getLabel() ?? '', $options);
  162.         }
  164.         \assert(isset($item['label']));
  165.         \assert(isset($item['route']));
  167.         return $this->menuFactory->createItem($item['label'], [
  168.             'route' => $item['route'],
  169.             'routeParameters' => $item['route_params'],
  170.             'routeAbsolute' => $item['route_absolute'],
  171.             'extras' => [
  172.                 'translation_domain' => $group['translation_domain'],
  173.                 'label_catalogue' => $group['label_catalogue'] ?? '', // NEXT_MAJOR: Remove this line.
  174.             ],
  175.         ]);
  176.     }
  177. }