POC to reuse MenuBlock (#1112)

composer.json

@@ -57,7 +57,7 @@
         "phpunit/phpunit": "^9.5.13",
         "psalm/plugin-phpunit": "^0.16",
         "psalm/plugin-symfony": "^3.0",
-        "rector/rector": "^0.13",
+        "rector/rector": "^0.14",
         "sonata-project/doctrine-extensions": "^1.10.1",
         "symfony/browser-kit": "^4.4 || ^5.4 || ^6.0",
         "symfony/debug": "^4.4 || ^5.4 || ^6.0",

src/Block/Service/AbstractMenuBlockService.php

@@ -0,0 +1,190 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\BlockBundle\Block\Service;
+
+use Knp\Menu\ItemInterface;
+use Sonata\BlockBundle\Block\BlockContextInterface;
+use Sonata\BlockBundle\Form\Mapper\FormMapper;
+use Sonata\BlockBundle\Model\BlockInterface;
+use Sonata\Form\Type\ImmutableArrayType;
+use Sonata\Form\Validator\ErrorElement;
+use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormTypeInterface;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+abstract class AbstractMenuBlockService extends AbstractBlockService implements EditableBlockService
+{
+    public function execute(BlockContextInterface $blockContext, ?Response $response = null): Response
+    {
+        $template = $blockContext->getTemplate();
+        \assert(null !== $template);
+
+        $responseSettings = [
+            'menu' => $this->getMenu($blockContext),
+            'menu_options' => $this->getMenuOptions($blockContext->getSettings()),
+            'block' => $blockContext->getBlock(),
+            'context' => $blockContext,
+        ];
+
+        // NEXT_MAJOR: remove
+        if ('private' === $blockContext->getSetting('cache_policy')) {
+            return $this->renderPrivateResponse($template, $responseSettings, $response);
+        }
+
+        return $this->renderResponse($template, $responseSettings, $response);
+    }
+
+    public function configureCreateForm(FormMapper $form, BlockInterface $block): void
+    {
+        $this->configureEditForm($form, $block);
+    }
+
+    public function configureEditForm(FormMapper $form, BlockInterface $block): void
+    {
+        $form->add('settings', ImmutableArrayType::class, [
+            'keys' => $this->getFormSettingsKeys(),
+            'translation_domain' => 'SonataBlockBundle',
+        ]);
+    }
+
+    public function validate(ErrorElement $errorElement, BlockInterface $block): void
+    {
+    }
+
+    public function configureSettings(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'title' => '',
+            // NEXT_MAJOR: Remove.
+            'cache_policy' => 'public',
+            'template' => '@SonataBlock/Block/block_core_menu.html.twig',
+            'safe_labels' => false,
+            'current_class' => 'active',
+            'first_class' => false,
+            'last_class' => false,
+            'menu_template' => null,
+        ]);
+
+        // NEXT_MAJOR: Remove setDeprecated.
+        $resolver->setDeprecated(
+            'cache_policy',
+            ...$this->deprecationParameters(
+                '4.12',
+                'Option "cache_policy" is deprecated since sonata-project/block-bundle 4.12 and will be removed in 5.0.'
+            )
+        );
+    }
+
+    /**
+     * @return array<array{string, class-string<FormTypeInterface>, array<string, mixed>}>
+     */
+    protected function getFormSettingsKeys(): array
+    {
+        return [
+            ['title', TextType::class, [
+                'required' => false,
+                'label' => 'form.label_title',
+                'translation_domain' => 'SonataBlockBundle',
+            ]],
+            ['cache_policy', ChoiceType::class, [
+                'label' => 'form.label_cache_policy',
+                'translation_domain' => 'SonataBlockBundle',
+                'choices' => ['public', 'private'],
+            ]],
+            ['safe_labels', CheckboxType::class, [
+                'required' => false,
+                'label' => 'form.label_safe_labels',
+                'translation_domain' => 'SonataBlockBundle',
+            ]],
+            ['current_class', TextType::class, [
+                'required' => false,
+                'label' => 'form.label_current_class',
+                'translation_domain' => 'SonataBlockBundle',
+            ]],
+            ['first_class', TextType::class, [
+                'required' => false,
+                'label' => 'form.label_first_class',
+                'translation_domain' => 'SonataBlockBundle',
+            ]],
+            ['last_class', TextType::class, [
+                'required' => false,
+                'label' => 'form.label_last_class',
+                'translation_domain' => 'SonataBlockBundle',
+            ]],
+            ['menu_template', TextType::class, [
+                'required' => false,
+                'label' => 'form.label_menu_template',
+                'translation_domain' => 'SonataBlockBundle',
+            ]],
+        ];
+    }
+
+    /**
+     * Gets the menu to render.
+     *
+     * @return ItemInterface|string
+     */
+    abstract protected function getMenu(BlockContextInterface $blockContext);
+
+    /**
+     * Replaces setting keys with knp menu item options keys.
+     *
+     * @param array<string, mixed> $settings
+     *
+     * @return array<string, mixed>
+     */
+    private function getMenuOptions(array $settings): array
+    {
+        $mapping = [
+            'current_class' => 'currentClass',
+            'first_class' => 'firstClass',
+            'last_class' => 'lastClass',
+            'safe_labels' => 'allow_safe_labels',
+            'menu_template' => 'template',
+        ];
+
+        $options = [];
+
+        foreach ($settings as $key => $value) {
+            if (\array_key_exists($key, $mapping) && null !== $value) {
+                $options[$mapping[$key]] = $value;
+            }
+        }
+
+        return $options;
+    }
+
+    /**
+     * This class is a BC layer for deprecation messages for symfony/options-resolver < 5.1.
+     * Remove this class when dropping support for symfony/options-resolver < 5.1.
+     *
+     * @return mixed[]
+     */
+    private function deprecationParameters(string $version, string $message): array
+    {
+        // @phpstan-ignore-next-line
+        if (method_exists(OptionsResolver::class, 'define')) {
+            return [
+                'sonata-project/block-bundle',
+                $version,
+                $message,
+            ];
+        }
+
+        return [$message];
+    }
+}

src/Block/Service/ContainerBlockService.php

@@ -46,16 +46,20 @@ public function configureEditForm(FormMapper $form, BlockInterface $block): void
                 ['code', TextType::class, [
                     'required' => false,
                     'label' => 'form.label_code',
+                    'translation_domain' => 'SonataBlockBundle',
                 ]],
                 ['layout', TextareaType::class, [
                     'label' => 'form.label_layout',
+                    'translation_domain' => 'SonataBlockBundle',
                 ]],
                 ['class', TextType::class, [
                     'required' => false,
                     'label' => 'form.label_class',
+                    'translation_domain' => 'SonataBlockBundle',
                 ]],
                 ['template', ContainerTemplateType::class, [
                     'label' => 'form.label_template',
+                    'translation_domain' => 'SonataBlockBundle',
                 ]],
             ],
             'translation_domain' => 'SonataBlockBundle',