Poc to reuse MenuBlock (#1612)

sonata-project · Sep 28, 2022 · ea64eac · ea64eac
1 parent d3b9eaa
commit ea64eac
Show file tree

Hide file tree

Showing 21 changed files with 41 additions and 439 deletions.
diff --git a/composer.json b/composer.json
@@ -26,11 +26,11 @@
         "doctrine/doctrine-bundle": "^2.5",
         "doctrine/persistence": "^2.1 || ^3.0",
         "sonata-project/admin-bundle": "^4.19",
-        "sonata-project/block-bundle": "^4.16.2",
+        "sonata-project/block-bundle": "^4.18",
         "sonata-project/doctrine-extensions": "^1.18 || ^2.1",
         "sonata-project/doctrine-orm-admin-bundle": "^4.0",
         "sonata-project/form-extensions": "^1.4",
-        "sonata-project/seo-bundle": "^3.3",
+        "sonata-project/seo-bundle": "^3.4",
         "sonata-project/twig-extensions": "^1.3 || ^2.0",
         "symfony-cmf/routing-bundle": "^2.1 || ^3.0",
         "symfony/config": "^4.4 || ^5.4 || ^6.0",

diff --git a/src/Block/BreadcrumbBlockService.php b/src/Block/BreadcrumbBlockService.php
@@ -16,36 +16,38 @@
 use Knp\Menu\FactoryInterface;
 use Knp\Menu\ItemInterface;
 use Sonata\BlockBundle\Block\BlockContextInterface;
-use Sonata\BlockBundle\Block\Service\BlockServiceInterface;
 use Sonata\BlockBundle\Block\Service\EditableBlockService;
 use Sonata\BlockBundle\Meta\Metadata;
 use Sonata\BlockBundle\Meta\MetadataInterface;
+use Sonata\BlockBundle\Model\BlockInterface;
+use Sonata\Form\Validator\ErrorElement;
 use Sonata\PageBundle\CmsManager\CmsManagerSelectorInterface;
 use Sonata\PageBundle\Model\PageInterface;
 use Sonata\SeoBundle\Block\Breadcrumb\BaseBreadcrumbMenuBlockService;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 use Twig\Environment;
 
 /**
  * @author Sylvain Deloux <sylvain.deloux@ekino.com>
  */
-final class BreadcrumbBlockService extends BaseBreadcrumbMenuBlockService
+final class BreadcrumbBlockService extends BaseBreadcrumbMenuBlockService implements EditableBlockService
 {
     private CmsManagerSelectorInterface $cmsSelector;
 
-    /**
-     * @param BlockServiceInterface&EditableBlockService $menuBlock
-     */
     public function __construct(
         Environment $twig,
-        object $menuBlock,
         FactoryInterface $factory,
         CmsManagerSelectorInterface $cmsSelector
     ) {
-        parent::__construct($twig, $menuBlock, $factory);
+        parent::__construct($twig, $factory);
 
         $this->cmsSelector = $cmsSelector;
     }
 
+    public function validate(ErrorElement $errorElement, BlockInterface $block): void
+    {
+    }
+
     public function getMetadata(): MetadataInterface
     {
         return new Metadata('sonata.page.block.breadcrumb', null, null, 'SonataPageBundle', [
@@ -58,10 +60,17 @@ public function handleContext(string $context): bool
         return 'page' === $context;
     }
 
-    protected function getMenu(BlockContextInterface $blockContext): ItemInterface
+    public function configureSettings(OptionsResolver $resolver): void
     {
-        $blockContext->setSetting('include_homepage_link', false);
+        parent::configureSettings($resolver);
 
+        $resolver->setDefaults([
+            'include_homepage_link' => false,
+        ]);
+    }
+
+    protected function getMenu(BlockContextInterface $blockContext): ItemInterface
+    {
         $menu = parent::getMenu($blockContext);
 
         $page = $this->getCurrentPage();

diff --git a/src/Block/ChildrenPagesBlockService.php b/src/Block/ChildrenPagesBlockService.php
@@ -121,25 +121,30 @@ public function configureEditForm(FormMapper $form, BlockInterface $block): void
         $form->add('settings', ImmutableArrayType::class, [
             'keys' => [
                 ['title', TextType::class, [
-                  'required' => false,
+                    'required' => false,
                     'label' => 'form.label_title',
+                    'translation_domain' => 'SonataPageBundle',
                 ]],
                 ['translation_domain', TextType::class, [
                     'label' => 'form.label_translation_domain',
+                    'translation_domain' => 'SonataPageBundle',
                     'required' => false,
                 ]],
                 ['icon', TextType::class, [
                     'label' => 'form.label_icon',
+                    'translation_domain' => 'SonataPageBundle',
                     'required' => false,
                 ]],
                 ['current', CheckboxType::class, [
-                  'required' => false,
-                  'label' => 'form.label_current',
+                    'required' => false,
+                    'label' => 'form.label_current',
+                    'translation_domain' => 'SonataPageBundle',
                 ]],
                 $this->getPageSelectorBuilder($form, $block),
                 ['class', TextType::class, [
-                  'required' => false,
-                  'label' => 'form.label_class',
+                    'required' => false,
+                    'label' => 'form.label_class',
+                    'translation_domain' => 'SonataPageBundle',
                 ]],
             ],
             'translation_domain' => 'SonataPageBundle',
@@ -190,6 +195,7 @@ private function getPageSelectorBuilder(AdminFormMapper $form, PageBlockInterfac
             'site' => null !== $page ? $page->getSite() : null,
             'required' => false,
             'label' => 'form.label_page',
+            'translation_domain' => 'SonataPageBundle',
         ]);
         $formBuilder->addModelTransformer(new CallbackTransformer(
             static fn (?PageInterface $value): ?PageInterface => $value,

diff --git a/src/Block/ContainerBlockService.php b/src/Block/ContainerBlockService.php
@@ -51,16 +51,20 @@ public function configureEditForm(FormMapper $form, BlockInterface $block): void
                 ['code', TextType::class, [
                     'required' => false,
                     'label' => 'form.label_code',
+                    'translation_domain' => 'SonataPageBundle',
                 ]],
                 ['layout', TextareaType::class, [
                     'label' => 'form.label_layout',
+                    'translation_domain' => 'SonataPageBundle',
                 ]],
                 ['class', TextType::class, [
                     'required' => false,
                     'label' => 'form.label_class',
+                    'translation_domain' => 'SonataPageBundle',
                 ]],
                 ['template', ContainerTemplateType::class, [
                     'label' => 'form.label_template_code',
+                    'translation_domain' => 'SonataPageBundle',
                 ]],
             ],
             'translation_domain' => 'SonataPageBundle',

diff --git a/src/Block/PageListBlockService.php b/src/Block/PageListBlockService.php
@@ -91,22 +91,27 @@ public function configureEditForm(FormMapper $form, BlockInterface $block): void
             'keys' => [
                 ['title', TextType::class, [
                     'label' => 'form.label_title',
+                    'translation_domain' => 'SonataPageBundle',
                     'required' => false,
                 ]],
                 ['translation_domain', TextType::class, [
                     'label' => 'form.label_translation_domain',
+                    'translation_domain' => 'SonataPageBundle',
                     'required' => false,
                 ]],
                 ['icon', TextType::class, [
                     'label' => 'form.label_icon',
+                    'translation_domain' => 'SonataPageBundle',
                     'required' => false,
                 ]],
                 ['class', TextType::class, [
                     'label' => 'form.label_class',
+                    'translation_domain' => 'SonataPageBundle',
                     'required' => false,
                 ]],
                 ['mode', ChoiceType::class, [
                     'label' => 'form.label_mode',
+                    'translation_domain' => 'SonataPageBundle',
                     'choices' => [
                         'public' => 'form.choice_public',
                         'admin' => 'form.choice_admin',

diff --git a/src/Block/SharedBlockBlockService.php b/src/Block/SharedBlockBlockService.php
@@ -150,6 +150,7 @@ private function getBlockBuilder(AdminFormMapper $form): FormBuilderInterface
             'class' => $this->sharedBlockAdmin->getClass(),
             'model_manager' => $this->sharedBlockAdmin->getModelManager(),
             'label' => 'form.label_block',
+            'translation_domain' => 'SonataPageBundle',
         ]);
         $formBuilder->addModelTransformer(new CallbackTransformer(
             static fn (?PageBlockInterface $value): ?PageBlockInterface => $value,

diff --git a/src/Resources/config/block.php b/src/Resources/config/block.php
@@ -44,7 +44,6 @@
             ->tag('sonata.breadcrumb')
             ->args([
                 new ReferenceConfigurator('twig'),
-                new ReferenceConfigurator('sonata.block.service.menu'),
                 new ReferenceConfigurator('knp_menu.factory'),
                 new ReferenceConfigurator('sonata.page.cms_manager_selector'),
             ])

diff --git a/src/Resources/translations/SonataPageBundle.bg.xliff b/src/Resources/translations/SonataPageBundle.bg.xliff
@@ -847,38 +847,6 @@
         <source>form.label_text</source>
         <target>form.label_text</target>
       </trans-unit>
-      <trans-unit id="form.label_menu_name">
-        <source>form.label_menu_name</source>
-        <target>form.label_menu_name</target>
-      </trans-unit>
-      <trans-unit id="form.label_safe_labels">
-        <source>form.label_safe_labels</source>
-        <target>form.label_safe_labels</target>
-      </trans-unit>
-      <trans-unit id="form.label_current_class">
-        <source>form.label_current_class</source>
-        <target>form.label_current_class</target>
-      </trans-unit>
-      <trans-unit id="form.label_first_class">
-        <source>form.label_first_class</source>
-        <target>form.label_first_class</target>
-      </trans-unit>
-      <trans-unit id="form.label_last_class">
-        <source>form.label_last_class</source>
-        <target>form.label_last_class</target>
-      </trans-unit>
-      <trans-unit id="form.label_menu_class">
-        <source>form.label_menu_class</source>
-        <target>form.label_menu_class</target>
-      </trans-unit>
-      <trans-unit id="form.label_children_class">
-        <source>form.label_children_class</source>
-        <target>form.label_children_class</target>
-      </trans-unit>
-      <trans-unit id="form.label_menu_template">
-        <source>form.label_menu_template</source>
-        <target>form.label_menu_template</target>
-      </trans-unit>
       <trans-unit id="pages.label_no_sites">
         <source>pages.label_no_sites</source>
         <target>pages.label_no_sites</target>

diff --git a/src/Resources/translations/SonataPageBundle.de.xliff b/src/Resources/translations/SonataPageBundle.de.xliff
@@ -850,38 +850,6 @@
         <source>form.label_text</source>
         <target>Text</target>
       </trans-unit>
-      <trans-unit id="form.label_menu_name">
-        <source>form.label_menu_name</source>
-        <target>Menu</target>
-      </trans-unit>
-      <trans-unit id="form.label_safe_labels">
-        <source>form.label_safe_labels</source>
-        <target>Sichere Label Texte</target>
-      </trans-unit>
-      <trans-unit id="form.label_current_class">
-        <source>form.label_current_class</source>
-        <target>Aktuelle CSS Klasse</target>
-      </trans-unit>
-      <trans-unit id="form.label_first_class">
-        <source>form.label_first_class</source>
-        <target>Erste CSS Klasse</target>
-      </trans-unit>
-      <trans-unit id="form.label_last_class">
-        <source>form.label_last_class</source>
-        <target>Letzte CSS Klasse</target>
-      </trans-unit>
-      <trans-unit id="form.label_menu_class">
-        <source>form.label_menu_class</source>
-        <target>Menü CSS Klasse</target>
-      </trans-unit>
-      <trans-unit id="form.label_children_class">
-        <source>form.label_children_class</source>
-        <target>Submenü CSS Klasse</target>
-      </trans-unit>
-      <trans-unit id="form.label_menu_template">
-        <source>form.label_menu_template</source>
-        <target>Menü Template</target>
-      </trans-unit>
       <trans-unit id="pages.label_no_sites">
         <source>pages.label_no_sites</source>
         <target>Keine Seiten konfiguriert</target>

diff --git a/src/Resources/translations/SonataPageBundle.en.xliff b/src/Resources/translations/SonataPageBundle.en.xliff
@@ -855,38 +855,6 @@
         <source>form.label_text</source>
         <target>Text</target>
       </trans-unit>
-      <trans-unit id="form.label_menu_name">
-        <source>form.label_menu_name</source>
-        <target>Menu</target>
-      </trans-unit>
-      <trans-unit id="form.label_safe_labels">
-        <source>form.label_safe_labels</source>
-        <target>Safe labels</target>
-      </trans-unit>
-      <trans-unit id="form.label_current_class">
-        <source>form.label_current_class</source>
-        <target>Current CSS class</target>
-      </trans-unit>
-      <trans-unit id="form.label_first_class">
-        <source>form.label_first_class</source>
-        <target>First CSS class</target>
-      </trans-unit>
-      <trans-unit id="form.label_last_class">
-        <source>form.label_last_class</source>
-        <target>Last CSS class</target>
-      </trans-unit>
-      <trans-unit id="form.label_menu_class">
-        <source>form.label_menu_class</source>
-        <target>Menu CSS class</target>
-      </trans-unit>
-      <trans-unit id="form.label_children_class">
-        <source>form.label_children_class</source>
-        <target>Children CSS class</target>
-      </trans-unit>
-      <trans-unit id="form.label_menu_template">
-        <source>form.label_menu_template</source>
-        <target>Menu template</target>
-      </trans-unit>
       <trans-unit id="pages.label_no_sites">
         <source>pages.label_no_sites</source>
         <target>No sites configured</target>

diff --git a/src/Resources/translations/SonataPageBundle.es.xliff b/src/Resources/translations/SonataPageBundle.es.xliff
@@ -847,38 +847,6 @@
         <source>form.label_text</source>
         <target>form.label_text</target>
       </trans-unit>
-      <trans-unit id="form.label_menu_name">
-        <source>form.label_menu_name</source>
-        <target>form.label_menu_name</target>
-      </trans-unit>
-      <trans-unit id="form.label_safe_labels">
-        <source>form.label_safe_labels</source>
-        <target>form.label_safe_labels</target>
-      </trans-unit>
-      <trans-unit id="form.label_current_class">
-        <source>form.label_current_class</source>
-        <target>form.label_current_class</target>
-      </trans-unit>
-      <trans-unit id="form.label_first_class">
-        <source>form.label_first_class</source>
-        <target>form.label_first_class</target>
-      </trans-unit>
-      <trans-unit id="form.label_last_class">
-        <source>form.label_last_class</source>
-        <target>form.label_last_class</target>
-      </trans-unit>
-      <trans-unit id="form.label_menu_class">
-        <source>form.label_menu_class</source>
-        <target>form.label_menu_class</target>
-      </trans-unit>
-      <trans-unit id="form.label_children_class">
-        <source>form.label_children_class</source>
-        <target>form.label_children_class</target>
-      </trans-unit>
-      <trans-unit id="form.label_menu_template">
-        <source>form.label_menu_template</source>
-        <target>form.label_menu_template</target>
-      </trans-unit>
       <trans-unit id="pages.label_no_sites">
         <source>pages.label_no_sites</source>
         <target>pages.label_no_sites</target>

diff --git a/src/Resources/translations/SonataPageBundle.fr.xliff b/src/Resources/translations/SonataPageBundle.fr.xliff
@@ -856,38 +856,6 @@
         <source>form.label_text</source>
         <target>Text</target>
       </trans-unit>
-      <trans-unit id="form.label_menu_name">
-        <source>form.label_menu_name</source>
-        <target>Nom du menu</target>
-      </trans-unit>
-      <trans-unit id="form.label_safe_labels">
-        <source>form.label_safe_labels</source>
-        <target>Labels</target>
-      </trans-unit>
-      <trans-unit id="form.label_current_class">
-        <source>form.label_current_class</source>
-        <target>Class CSS élément séléctionné</target>
-      </trans-unit>
-      <trans-unit id="form.label_first_class">
-        <source>form.label_first_class</source>
-        <target>Class CSS premier élément</target>
-      </trans-unit>
-      <trans-unit id="form.label_last_class">
-        <source>form.label_last_class</source>
-        <target>Class CSS dernier élément</target>
-      </trans-unit>
-      <trans-unit id="form.label_menu_class">
-        <source>form.label_menu_class</source>
-        <target>Class CSS Menu</target>
-      </trans-unit>
-      <trans-unit id="form.label_children_class">
-        <source>form.label_children_class</source>
-        <target>Class CSS enfant</target>
-      </trans-unit>
-      <trans-unit id="form.label_menu_template">
-        <source>form.label_menu_template</source>
-        <target>Modèle de page</target>
-      </trans-unit>
       <trans-unit id="pages.label_no_sites">
         <source>pages.label_no_sites</source>
         <target>pages.label_no_sites</target>