Merge pull request #53 from lanfisis/2.x

Add enabled / disabled capability for menu items for Sylius 2

Author: lanfisis

.gitignore

@@ -16,3 +16,4 @@
 /.phpunit.result.cache
 /node_modules
 /yarn.lock
+/.php-cs-fixer.cache

Makefile

@@ -8,7 +8,7 @@ CONSOLE=${SYMFONY} console
 export COMPOSE_PROJECT_NAME=menu
 PLUGIN_NAME=sylius-${COMPOSE_PROJECT_NAME}-plugin
 COMPOSE=docker compose
-YARN=$$(command -v n >/dev/null 2>&1 && echo "n --download exec auto yarn" || echo "yarn")
+YARN=yarn
 
 ###
 ### DEVELOPMENT

src/DataProvider/Tree/MenuItemTreeProvider.php

@@ -48,6 +48,7 @@ public function getArrayResult(MenuInterface $menu): array
                 'mni.parent_id as parent_id',
                 'mm.id as menu_id',
                 'COALESCE(current_translation.label, fallback_translation.label) as name',
+                'mni.enabled as enabled',
             ])
             ->from('monsieurbiz_menu_item', 'mni')
             ->join(

src/Entity/MenuItem.php

@@ -49,6 +49,8 @@ class MenuItem implements MenuItemInterface
 
     protected bool $nofollow = false;
 
+    protected bool $enabled = true;
+
     /**
      * MenuItem constructor.
      */
@@ -228,4 +230,20 @@ protected function createTranslation(): MenuItemTranslationInterface
     {
         return new MenuItemTranslation();
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function isEnabled(): bool
+    {
+        return $this->enabled;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function setEnabled(bool $enabled): void
+    {
+        $this->enabled = $enabled;
+    }
 }

src/Entity/MenuItemInterface.php

@@ -66,4 +66,8 @@ public function setNofollow(bool $nofollow): void;
     public function getLabel(): ?string;
 
     public function getUrl(): ?string;
+
+    public function isEnabled(): bool;
+
+    public function setEnabled(bool $enabled): void;
 }

src/Fixture/Factory/MenuFixtureFactory.php

@@ -83,6 +83,7 @@ private function createMenuItem(array $item, int $position, MenuInterface $menu,
         $menuItem->setPosition($position);
         $menuItem->setMenu($menu);
 
+        $menuItem->setEnabled($item['enabled'] ?? true);
         $menuItem->setTargetBlank($item['targetBlank'] ?? false);
         $menuItem->setNoreferrer($item['noreferrer'] ?? false);
         $menuItem->setNoopener($item['noopener'] ?? false);

src/Fixture/MenuFixture.php

@@ -44,6 +44,7 @@ public function configureResourceNode(ArrayNodeDefinition $resourceNode): void
                                         ->end()
                                     ->end()
                                 ->end()
+                                ->booleanNode('enabled')->defaultTrue()->end()
                                 ->booleanNode('targetBlank')->defaultFalse()->end()
                                 ->booleanNode('noreferrer')->defaultFalse()->end()
                                 ->booleanNode('noopener')->defaultFalse()->end()

src/Form/Type/MenuItemType.php

@@ -39,6 +39,10 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 /** @var MenuItemInterface $item */
                 Assert::isInstanceOf($item, MenuItemInterface::class);
                 $event->getForm()
+                    ->add('enabled', CheckboxType::class, [
+                        'label' => 'monsieurbiz_menu.ui.enabled',
+                        'required' => false,
+                    ])
                     ->add('parent', EntityType::class, [
                         'class' => $this->dataClass,
                         'required' => false,

src/Migrations/Version20250717143849.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Menu plugin for Sylius.
+ *
+ * (c) Monsieur Biz <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusMenuPlugin\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20250717143849 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE monsieurbiz_menu_item ADD enabled TINYINT(1) DEFAULT 1 NOT NULL, CHANGE target_blank target_blank TINYINT(1) DEFAULT 0 NOT NULL, CHANGE noreferrer noreferrer TINYINT(1) DEFAULT 0 NOT NULL, CHANGE noopener noopener TINYINT(1) DEFAULT 0 NOT NULL, CHANGE nofollow nofollow TINYINT(1) DEFAULT 0 NOT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE monsieurbiz_menu_item DROP enabled, CHANGE target_blank target_blank TINYINT(1) NOT NULL, CHANGE noreferrer noreferrer TINYINT(1) NOT NULL, CHANGE noopener noopener TINYINT(1) NOT NULL, CHANGE nofollow nofollow TINYINT(1) NOT NULL');
+    }
+}

src/Repository/MenuRepository.php

@@ -28,8 +28,10 @@ public function findOneByLocaleAndCode(string $localeCode, string $code): ?MenuI
             ->innerJoin('o.items', 'item')
             ->innerJoin('item.translations', 'item_translation', 'WITH', 'item_translation.locale = :locale')
             ->where('o.code = :code')
+            ->andWhere('item.enabled = :enabled')
             ->setParameter('locale', $localeCode)
             ->setParameter('code', $code)
+            ->setParameter('enabled', true)
         ;
 
         /** @phpstan-ignore-next-line */