vendor/sonata-project/block-bundle/src/Block/Service/MenuBlockService.php line 66

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\BlockBundle\Block\Service;
  16. use Knp\Menu\ItemInterface;
  17. use Knp\Menu\Provider\MenuProviderInterface;
  18. use Sonata\AdminBundle\Form\FormMapper;
  19. use Sonata\BlockBundle\Block\BlockContextInterface;
  20. use Sonata\BlockBundle\Menu\MenuRegistry;
  21. use Sonata\BlockBundle\Menu\MenuRegistryInterface;
  22. use Sonata\BlockBundle\Meta\Metadata;
  23. use Sonata\BlockBundle\Model\BlockInterface;
  24. use Sonata\Form\Type\ImmutableArrayType;
  25. use Sonata\Form\Validator\ErrorElement;
  26. use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
  27. use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
  28. use Symfony\Component\Form\Extension\Core\Type\TextType;
  29. use Symfony\Component\Form\FormTypeInterface;
  30. use Symfony\Component\HttpFoundation\Response;
  31. use Symfony\Component\OptionsResolver\OptionsResolver;
  32. use Symfony\Component\Templating\EngineInterface;
  34. /**
  35.  * @final since sonata-project/block-bundle 3.0
  36.  *
  37.  * @author Hugo Briand <briand@ekino.com>
  38.  */
  39. class MenuBlockService extends AbstractAdminBlockService
  40. {
  41.     /**
  42.      * @var MenuProviderInterface
  43.      */
  44.     protected $menuProvider;
  46.     /**
  47.      * NEXT_MAJOR: remove property.
  48.      *
  49.      * @var array
  50.      *
  51.      * @deprecated since sonata-project/block-bundle 3.3, to be removed in 4.0
  52.      */
  53.     protected $menus;
  55.     /**
  56.      * @var MenuRegistryInterface
  57.      */
  58.     protected $menuRegistry;
  60.     /**
  61.      * @param string                     $name
  62.      * @param MenuRegistryInterface|null $menuRegistry
  63.      */
  64.     public function __construct($name, EngineInterface $templating, MenuProviderInterface $menuProvider, $menuRegistry = null)
  65.     {
  66.         parent::__construct($name, $templating);
  68.         $this->menuProvider = $menuProvider;
  70.         if ($menuRegistry instanceof MenuRegistryInterface) {
  71.             $this->menuRegistry = $menuRegistry;
  72.         } elseif (null === $menuRegistry) {
  73.             $this->menuRegistry = new MenuRegistry();
  74.         } elseif (\is_array($menuRegistry)) { //NEXT_MAJOR: Remove this case
  75.             @trigger_error(
  76.                 'Initializing '.__CLASS__.' with an array parameter is deprecated since 3.3 and will be removed in 4.0.',
  77.                 E_USER_DEPRECATED
  78.             );
  79.             $this->menuRegistry = new MenuRegistry();
  80.             foreach ($menuRegistry as $menu) {
  81.                 $this->menuRegistry->add($menu);
  82.             }
  83.         } else {
  84.             throw new \InvalidArgumentException(sprintf(
  85.                 'MenuRegistry must be either null or instance of %s',
  86.                 MenuRegistryInterface::class
  87.             ));
  88.         }
  89.     }
  91.     public function execute(BlockContextInterface $blockContext, ?Response $response = null)
  92.     {
  93.         $responseSettings = [
  94.             'menu' => $this->getMenu($blockContext),
  95.             'menu_options' => $this->getMenuOptions($blockContext->getSettings()),
  96.             'block' => $blockContext->getBlock(),
  97.             'context' => $blockContext,
  98.         ];
  100.         if ('private' === $blockContext->getSetting('cache_policy')) {
  101.             return $this->renderPrivateResponse($blockContext->getTemplate(), $responseSettings, $response);
  102.         }
  104.         return $this->renderResponse($blockContext->getTemplate(), $responseSettings, $response);
  105.     }
  107.     public function buildEditForm(FormMapper $form, BlockInterface $block)
  108.     {
  109.         $form->add('settings', ImmutableArrayType::class, [
  110.             'keys' => $this->getFormSettingsKeys(),
  111.             'translation_domain' => 'SonataBlockBundle',
  112.         ]);
  113.     }
  115.     public function validateBlock(ErrorElement $errorElement, BlockInterface $block)
  116.     {
  117.         if (($name = $block->getSetting('menu_name')) && '' !== $name && !$this->menuProvider->has($name)) {
  118.             // If we specified a menu_name, check that it exists
  119.             $errorElement->with('menu_name')
  120.                 ->addViolation('sonata.block.menu.not_existing', ['%name%' => $name])
  121.             ->end();
  122.         }
  123.     }
  125.     public function configureSettings(OptionsResolver $resolver)
  126.     {
  127.         $resolver->setDefaults([
  128.             'title' => $this->getName(),
  129.             'cache_policy' => 'public',
  130.             'template' => '@SonataBlock/Block/block_core_menu.html.twig',
  131.             'menu_name' => '',
  132.             'safe_labels' => false,
  133.             'current_class' => 'active',
  134.             'first_class' => false,
  135.             'last_class' => false,
  136.             'current_uri' => null,
  137.             'menu_class' => 'list-group',
  138.             'children_class' => 'list-group-item',
  139.             'menu_template' => null,
  140.         ]);
  141.     }
  143.     public function getBlockMetadata($code = null)
  144.     {
  145.         return new Metadata($this->getName(), (null !== $code ? $code : $this->getName()), false, 'SonataBlockBundle', [
  146.             'class' => 'fa fa-bars',
  147.         ]);
  148.     }
  150.     /**
  151.      * @return array
  152.      */
  153.     protected function getFormSettingsKeys()
  154.     {
  155.         $choiceOptions = [
  156.             'required' => false,
  157.             'label' => 'form.label_url',
  158.             'choice_translation_domain' => 'SonataBlockBundle',
  159.         ];
  161.         // choice_as_value options is not needed in SF 3.0+
  162.         if (method_exists(FormTypeInterface::class, 'setDefaultOptions')) {
  163.             $choiceOptions['choices_as_values'] = true;
  164.         }
  166.         $choiceOptions['choices'] = array_flip($this->menuRegistry->getAliasNames());
  168.         return [
  169.             ['title', TextType::class, [
  170.                 'required' => false,
  171.                 'label' => 'form.label_title',
  172.             ]],
  173.             ['cache_policy', ChoiceType::class, [
  174.                 'label' => 'form.label_cache_policy',
  175.                 'choices' => ['public', 'private'],
  176.             ]],
  177.             ['menu_name', ChoiceType::class, $choiceOptions],
  178.             ['safe_labels', CheckboxType::class, [
  179.                 'required' => false,
  180.                 'label' => 'form.label_safe_labels',
  181.             ]],
  182.             ['current_class', TextType::class, [
  183.                 'required' => false,
  184.                 'label' => 'form.label_current_class',
  185.             ]],
  186.             ['first_class', TextType::class, [
  187.                 'required' => false,
  188.                 'label' => 'form.label_first_class',
  189.             ]],
  190.             ['last_class', TextType::class, [
  191.                 'required' => false,
  192.                 'label' => 'form.label_last_class',
  193.             ]],
  194.             ['menu_class', TextType::class, [
  195.                 'required' => false,
  196.                 'label' => 'form.label_menu_class',
  197.             ]],
  198.             ['children_class', TextType::class, [
  199.                 'required' => false,
  200.                 'label' => 'form.label_children_class',
  201.             ]],
  202.             ['menu_template', TextType::class, [
  203.                 'required' => false,
  204.                 'label' => 'form.label_menu_template',
  205.             ]],
  206.         ];
  207.     }
  209.     /**
  210.      * Gets the menu to render.
  211.      *
  212.      * @return ItemInterface|string
  213.      */
  214.     protected function getMenu(BlockContextInterface $blockContext)
  215.     {
  216.         $settings = $blockContext->getSettings();
  218.         return $settings['menu_name'];
  219.     }
  221.     /**
  222.      * Replaces setting keys with knp menu item options keys.
  223.      *
  224.      * @return array
  225.      */
  226.     protected function getMenuOptions(array $settings)
  227.     {
  228.         $mapping = [
  229.             'current_class' => 'currentClass',
  230.             'first_class' => 'firstClass',
  231.             'last_class' => 'lastClass',
  232.             'safe_labels' => 'allow_safe_labels',
  233.             'menu_template' => 'template',
  234.         ];
  236.         $options = [];
  238.         foreach ($settings as $key => $value) {
  239.             if (\array_key_exists($key, $mapping) && null !== $value) {
  240.                 $options[$mapping[$key]] = $value;
  241.             }
  242.         }
  244.         return $options;
  245.     }
  246. }