Thelia 3 support, menus addressed by code (2.0.0)

Api/Resource/CustomFrontMenu.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+/*************************************************************************************/
+/*      This file is part of the Thelia package.                                     */
+/*                                                                                   */
+/*      Copyright (c) OpenStudio                                                     */
+/*      email : dev@thelia.net                                                       */
+/*      web : http://www.thelia.net                                                  */
+/*                                                                                   */
+/*      For the full copyright and license information, please view the LICENSE.txt  */
+/*************************************************************************************/
+
+namespace CustomFrontMenu\Api\Resource;
+
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use CustomFrontMenu\Api\State\CustomFrontMenuProvider;
+use Symfony\Component\Serializer\Attribute\Groups;
+
+/**
+ * One composed menu, as the normalised tree the front renders.
+ *
+ * Read-only: composing a menu is a back-office operation, done through the module's
+ * configuration screen, not through this resource.
+ */
+#[ApiResource(
+    operations: [
+        new Get(
+            uriTemplate: '/front/custom-front-menus/{code}',
+            uriVariables: ['code'],
+            normalizationContext: ['groups' => [self::GROUP_FRONT_READ]],
+            provider: CustomFrontMenuProvider::class,
+        ),
+    ],
+)]
+class CustomFrontMenu
+{
+    public const GROUP_FRONT_READ = 'custom_front_menu:front:read';
+
+    /**
+     * The code the shop owner gave the menu, which is also how a theme addresses it.
+     *
+     * The identifier of the resource, so the IRI is stable across installations: the
+     * numeric id of a menu is not, it comes from an autoincrement shared with the entries.
+     */
+    #[ApiProperty(identifier: true)]
+    #[Groups([self::GROUP_FRONT_READ])]
+    public string $code = '';
+
+    /**
+     * Nodes of {id, title, href, children}, children nested to any depth.
+     *
+     * @var list<array<string, mixed>>
+     */
+    #[Groups([self::GROUP_FRONT_READ])]
+    public array $items = [];
+}

Api/State/CustomFrontMenuProvider.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+/*************************************************************************************/
+/*      This file is part of the Thelia package.                                     */
+/*                                                                                   */
+/*      Copyright (c) OpenStudio                                                     */
+/*      email : dev@thelia.net                                                       */
+/*      web : http://www.thelia.net                                                  */
+/*                                                                                   */
+/*      For the full copyright and license information, please view the LICENSE.txt  */
+/*************************************************************************************/
+
+namespace CustomFrontMenu\Api\State;
+
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\State\ProviderInterface;
+use CustomFrontMenu\Api\Resource\CustomFrontMenu;
+use CustomFrontMenu\Service\Front\MenuTreeResolver;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+use Thelia\Domain\Localization\Service\LangService;
+
+/**
+ * @implements ProviderInterface<CustomFrontMenu>
+ */
+final readonly class CustomFrontMenuProvider implements ProviderInterface
+{
+    public function __construct(
+        private MenuTreeResolver $treeResolver,
+        private LangService $langService,
+    ) {
+    }
+
+    /**
+     * @param array<string, mixed> $uriVariables
+     * @param array<string, mixed> $context
+     */
+    public function provide(Operation $operation, array $uriVariables = [], array $context = []): CustomFrontMenu
+    {
+        $code = trim((string) ($uriVariables['code'] ?? ''));
+
+        if ('' === $code) {
+            throw new NotFoundHttpException('Menu not found');
+        }
+
+        $items = $this->treeResolver->resolve($code, $this->langService->getLocale() ?? 'en_US');
+
+        if (null === $items) {
+            throw new NotFoundHttpException('Menu not found');
+        }
+
+        $menu = new CustomFrontMenu();
+        $menu->code = $code;
+        $menu->items = $items;
+
+        return $menu;
+    }
+}

Config/TheliaMain.sql

@@ -12,12 +12,14 @@ DROP TABLE IF EXISTS `custom_front_menu_item`;
 CREATE TABLE `custom_front_menu_item`
 (
     `id` INTEGER NOT NULL AUTO_INCREMENT,
+    `code` VARCHAR(255),
     `view` VARCHAR(255),
     `view_id` INTEGER,
     `tree_left` INTEGER,
     `tree_right` INTEGER,
     `tree_level` INTEGER,
-    PRIMARY KEY (`id`)
+    PRIMARY KEY (`id`),
+    UNIQUE INDEX `custom_front_menu_item_code_unique` (`code`)
 ) ENGINE=InnoDB;
 
 -- ---------------------------------------------------------------------

Config/module.xml

@@ -20,7 +20,7 @@
         <language>en_US</language>
         <language>fr_FR</language>
     </languages>
-    <version>1.2.0</version>
+    <version>2.0.0</version>
     <authors>
         <author>
             <name>Delage Mathis</name>
@@ -44,7 +44,7 @@
         <module version="&gt;0.2">HookSearch</module>
     </required>
     -->
-    <thelia>2.4.0</thelia>
+    <thelia>3.0.0</thelia>
     <stability>other</stability>
     <mandatory>0</mandatory>
     <hidden>0</hidden>

Config/schema.xml

@@ -5,10 +5,18 @@
 
     <table name="custom_front_menu_item" namespace="CustomFrontMenu\Model">
         <column autoIncrement="true" name="id" primaryKey="true" required="true" type="INTEGER"/>
+        <!-- Only a menu (tree level 1) carries a code: it is the name a theme calls the
+             menu by, so it must survive a reinstall, which an autoincrement id does not.
+             Entries keep it null; MySQL allows many nulls under a unique index. -->
+        <column name="code" size="255" type="VARCHAR"/>
         <column name="view" size="255" type="VARCHAR"/>
         <column name="view_id" type="INTEGER"/>
         <column name="title" size="255" type="VARCHAR"/>
         <column name="url" size="255" type="VARCHAR"/>
+        <unique name="custom_front_menu_item_code_unique">
+            <unique-column name="code"/>
+        </unique>
+
         <behavior name="nested_set" />
         <behavior name="i18n">
             <parameter name="i18n_columns" value="title, url" />