Solve phpstan level 7 issue in case of UserMenuDto

Author: VincentLanglet

src/Config/UserMenu.php

@@ -3,6 +3,7 @@
 namespace EasyCorp\Bundle\EasyAdminBundle\Config;
 
 use EasyCorp\Bundle\EasyAdminBundle\Contracts\Menu\MenuItemInterface;
+use EasyCorp\Bundle\EasyAdminBundle\Dto\MenuItemDto;
 use EasyCorp\Bundle\EasyAdminBundle\Dto\UserMenuDto;
 
 /**
@@ -65,7 +66,12 @@ public function setGravatarEmail(string $emailAddress): self
      */
     public function addMenuItems(array $items): self
     {
-        $this->dto->setItems(array_merge($items, $this->dto->getItems()));
+        $itemsDto = array_map(
+            static fn (MenuItemInterface $item): MenuItemDto => $item->getAsDto(),
+            $items
+        );
+
+        $this->dto->setItems(array_merge($itemsDto, $this->dto->getItems()));
 
         return $this;
     }
@@ -75,7 +81,12 @@ public function addMenuItems(array $items): self
      */
     public function setMenuItems(array $items): self
     {
-        $this->dto->setItems($items);
+        $itemsDto = array_map(
+            static fn (MenuItemInterface $item): MenuItemDto => $item->getAsDto(),
+            $items
+        );
+
+        $this->dto->setItems($itemsDto);
 
         return $this;
     }

src/Dto/UserMenuDto.php

@@ -2,8 +2,6 @@
 
 namespace EasyCorp\Bundle\EasyAdminBundle\Dto;
 
-use EasyCorp\Bundle\EasyAdminBundle\Contracts\Menu\MenuItemInterface;
-
 /**
  * @author Javier Eguiluz <[email protected]>
  */
@@ -13,7 +11,7 @@ final class UserMenuDto
     private bool $displayAvatar = true;
     private ?string $name = null;
     private ?string $avatarUrl = null;
-    /** @var MenuItemInterface[]|MenuItemDto[] */
+    /** @var array<MenuItemDto> */
     private array $items = [];
 
     public function isNameDisplayed(): bool
@@ -57,22 +55,33 @@ public function setAvatarUrl(?string $url): void
     }
 
     /**
-     * @return MenuItemInterface[]|MenuItemDto[]
+     * @return array<MenuItemDto>
      */
     public function getItems(): array
     {
         return $this->items;
     }
 
     /**
-     * When configuring the application, you are passed an array of
-     * MenuItemInterface objects; after building the user menu contents,
-     * this method is called with MenuItemDto objects.
-     *
-     * @param MenuItemInterface[]|MenuItemDto[] $items
+     * @param array<MenuItemDto> $items
      */
     public function setItems(array $items): void
     {
+        foreach ($items as $item) {
+            if (!$item instanceof MenuItemDto) {
+                trigger_deprecation(
+                    'easycorp/easyadmin-bundle',
+                    '4.25.0',
+                    'Argument "%s" for "%s" must be one of these types: %s. Passing type %s will cause an error in 5.0.0.',
+                    '$items',
+                    __METHOD__,
+                    '"array<MenuItemDto>"',
+                    '"array<MenuItemInterface>"'
+                );
+                break;
+            }
+        }
+
         $this->items = $items;
     }
 }

src/Factory/MenuFactory.php

@@ -52,7 +52,7 @@ public function createUserMenu(UserMenu $userMenu): UserMenuDto
     }
 
     /**
-     * @param MenuItemInterface[] $menuItems
+     * @param array<MenuItemDto|MenuItemInterface> $menuItems
      *
      * @return MenuItemDto[]
      */
@@ -63,14 +63,19 @@ private function buildMenuItems(array $menuItems): array
         $translationDomain = $adminContext->getI18n()->getTranslationDomain() ?? '';
 
         $builtItems = [];
-        foreach ($menuItems as $i => $menuItem) {
-            $menuItemDto = $menuItem->getAsDto();
+        foreach ($menuItems as $menuItem) {
+            if ($menuItem instanceof MenuItemDto) {
+                $menuItemDto = $menuItem;
+            } else {
+                $menuItemDto = $menuItem->getAsDto();
+            }
+
             if (false === $this->authChecker->isGranted(Permission::EA_VIEW_MENU_ITEM, $menuItemDto)) {
                 continue;
             }
 
             $subItems = [];
-            foreach ($menuItemDto->getSubItems() as $j => $menuSubItemDto) {
+            foreach ($menuItemDto->getSubItems() as $menuSubItemDto) {
                 if (false === $this->authChecker->isGranted(Permission::EA_VIEW_MENU_ITEM, $menuSubItemDto)) {
                     continue;
                 }