refactor(menu): change MenuHooks class

Changes MenuHooks into MenuIcons.
Extracts abstract MenuItemFilter class.

Author: szaleq

config/app.php

@@ -53,7 +53,7 @@
         BlockSpacing\BlockSpacingHooks::class,
 
         // Menu
-        Menu\MenuHooks::class,
+        Menu\MenuIcons::class,
         Menu\MenuRegistrar::class,
 
         // Post Type

src/classes/Common/Menu/MenuHooks.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoWStarterTheme\Common\Menu;
+
+use DoWStarterTheme\Common\Helpers\SVG;
+
+/**
+ * Adds icons support to menu items.
+ *
+ * @phpstan-import-type MenuItem from MenuItemFilter
+ */
+class MenuIcons extends MenuItemFilter
+{
+    /**
+      * Class constructor.
+      *
+      * @param SVG $svg SVG helper instance.
+      */
+    public function __construct(
+        private SVG $svg,
+    ) {
+    }
+
+    /**
+     * Adds icon to menu item.
+     *
+     * @param MenuItem $item Menu item.
+     * @return MenuItem customized menu item with icon.
+     */
+    public function filterItem($item) {
+        $icon = get_field('icon', $item);
+
+        if (! is_numeric($icon)) {
+            return $item;
+        }
+
+        // @phpstan-ignore assign.propertyReadOnly
+        $item->title = sprintf(
+            '%s%s',
+            $this->svg->getAttachment((int)$icon),
+            $item->title
+        );
+
+        return $item;
+    }
+}

src/classes/Common/Menu/MenuIcons.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoWStarterTheme\Common\Menu;
+
+use DoWStarterTheme\Common\Contracts\Hookable;
+use DoWStarterTheme\Deps\Illuminate\Support\Collection;
+
+/**
+ * Handles url placeholders for auth links, like login, register, and logout.
+ *
+ * @phpstan-type MenuItem \WP_Post & object{
+ *    attr_title: string,
+ *    classes: array<string>,
+ *    db_id: int,
+ *    description: string,
+ *    menu_item_parent: int,
+ *    object: string,
+ *    object_id: int,
+ *    post_parent: int,
+ *    target: string,
+ *    title: string,
+ *    type: string,
+ *    type_label: string,
+ *    url: string,
+ *    xfn: string,
+ *    _invalid: string,
+ * }
+ */
+abstract class MenuItemFilter implements Hookable
+{
+    /**
+     * Replaces URLs in menu items.
+     *
+     * @filter wp_nav_menu_objects
+     *
+     * @param array<MenuItem> $items Menu items.
+     * @return array<MenuItem> customized menu items with icons.
+     */
+    public function filter(array $items) {
+        return Collection::make($items)
+            ->map(
+                fn ($item) => $this->filterItem($item)
+            )
+            ->all();
+    }
+
+    /**
+     * Filter a single menu item.
+     *
+     * @param MenuItem $item The menu item to filter.
+     * @return MenuItem
+     */
+    abstract public function filterItem($item);
+}