123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183 |
- <?php
- /*
- * This file is part of the Sonata Project package.
- *
- * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Sonata\AdminBundle\Menu\Provider;
- use Knp\Menu\FactoryInterface;
- use Knp\Menu\Provider\MenuProviderInterface;
- use Sonata\AdminBundle\Admin\Pool;
- /**
- * Menu provider based on group options.
- *
- * @author Alexandru Furculita <alex@furculita.net>
- */
- class GroupMenuProvider implements MenuProviderInterface
- {
- /**
- * @var FactoryInterface
- */
- private $menuFactory;
- /**
- * @var Pool
- */
- private $pool;
- /**
- * NEXT_MAJOR: Use AuthorizationCheckerInterface when bumping requirements to >=Symfony 2.6.
- *
- * @var \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface|\Symfony\Component\Security\Core\SecurityContextInterface
- */
- private $checker;
- /**
- * NEXT_MAJOR: Remove default value null of $checker.
- * NEXT_MAJOR: Allow only injection of AuthorizationCheckerInterface when bumping requirements to >=Symfony 2.6.
- *
- * @param FactoryInterface $menuFactory
- * @param Pool $pool
- * @param \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface|
- * \Symfony\Component\Security\Core\SecurityContextInterface|null $checker
- */
- public function __construct(FactoryInterface $menuFactory, Pool $pool, $checker = null)
- {
- $this->menuFactory = $menuFactory;
- $this->pool = $pool;
- /*
- * NEXT_MAJOR: Remove this if blocks.
- * NEXT_MAJOR: Remove instance type checking when bumping requirements to >=Symfony 2.6.
- */
- if (null === $checker) {
- @trigger_error(
- 'Passing no 3rd argument is deprecated since version 3.10 and will be mandatory in 4.0.
- Pass Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface as 3rd argument.',
- E_USER_DEPRECATED
- );
- } elseif (!$checker instanceof \Symfony\Component\Security\Core\SecurityContextInterface
- && !$checker instanceof \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface
- ) {
- throw new \InvalidArgumentException(
- 'Argument 3 must be an instance of either \Symfony\Component\Security\Core\SecurityContextInterface or
- \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface'
- );
- }
- $this->checker = $checker;
- }
- /**
- * Retrieves the menu based on the group options.
- *
- * @param string $name
- * @param array $options
- *
- * @return \Knp\Menu\ItemInterface
- *
- * @throws \InvalidArgumentException if the menu does not exists
- */
- public function get($name, array $options = array())
- {
- $group = $options['group'];
- $menuItem = $this->menuFactory->createItem(
- $options['name'],
- array(
- 'label' => $group['label'],
- )
- );
- if (empty($group['on_top'])) {
- foreach ($group['items'] as $item) {
- if (isset($item['admin']) && !empty($item['admin'])) {
- $admin = $this->pool->getInstance($item['admin']);
- // skip menu item if no `list` url is available or user doesn't have the LIST access rights
- if (!$admin->hasRoute('list') || !$admin->hasAccess('list')) {
- continue;
- }
- $label = $admin->getLabel();
- $options = $admin->generateMenuUrl('list', array(), $item['route_absolute']);
- $options['extras'] = array(
- 'label_catalogue' => $admin->getTranslationDomain(),
- 'admin' => $admin,
- );
- } else {
- //NEXT_MAJOR: Remove if statement of null checker.
- if (null !== $this->checker) {
- if ((!empty($item['roles']) && !$this->checker->isGranted($item['roles']))
- || (!empty($group['roles']) && !$this->checker->isGranted($group['roles'], $item['route']))
- ) {
- continue;
- }
- }
- $label = $item['label'];
- $options = array(
- 'route' => $item['route'],
- 'routeParameters' => $item['route_params'],
- 'routeAbsolute' => $item['route_absolute'],
- 'extras' => array(
- 'label_catalogue' => $group['label_catalogue'],
- ),
- );
- }
- $menuItem->addChild($label, $options);
- }
- if (false === $menuItem->hasChildren()) {
- $menuItem->setDisplay(false);
- } elseif (!empty($group['keep_open'])) {
- $menuItem->setAttribute('class', 'keep-open');
- $menuItem->setExtra('keep_open', $group['keep_open']);
- }
- } else {
- foreach ($group['items'] as $item) {
- if (isset($item['admin']) && !empty($item['admin'])) {
- $admin = $this->pool->getInstance($item['admin']);
- // Do not display group if no `list` url is available or user doesn't have the LIST access rights
- if (!$admin->hasRoute('list') || !$admin->hasAccess('list')) {
- $menuItem->setDisplay(false);
- continue;
- }
- $options = $admin->generateUrl('list');
- $menuItem->setExtra('route', $admin->getBaseRouteName().'_list');
- $menuItem->setExtra('on_top', $group['on_top']);
- $menuItem->setUri($options);
- } else {
- $router = $this->pool->getContainer()->get('router');
- $menuItem->setUri($router->generate($item['route']));
- }
- }
- }
- return $menuItem;
- }
- /**
- * Checks whether a menu exists in this provider.
- *
- * @param string $name
- * @param array $options
- *
- * @return bool
- */
- public function has($name, array $options = array())
- {
- return 'sonata_group_menu' === $name;
- }
- }
|