vendor/easycorp/easyadmin-bundle/src/Dto/MenuItemDto.php line 10

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Dto;
  5. use Symfony\Contracts\Translation\TranslatableInterface;
  7. /**
  8.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  9.  */
  10. final class MenuItemDto
  11. {
  12.     public const TYPE_CRUD = 'crud';
  13.     public const TYPE_URL = 'url';
  14.     public const TYPE_SECTION = 'section';
  15.     public const TYPE_EXIT_IMPERSONATION = 'exit_impersonation';
  16.     public const TYPE_DASHBOARD = 'dashboard';
  17.     public const TYPE_LOGOUT = 'logout';
  18.     public const TYPE_SUBMENU = 'submenu';
  19.     public const TYPE_ROUTE = 'route';
  21.     private ?string $type = null;
  22.     private bool $selected = false;
  23.     private bool $expanded = false;
  24.     private TranslatableInterface|string|null $label = null;
  25.     private ?string $icon = null;
  26.     private string $cssClass = '';
  27.     private ?string $permission = null;
  28.     private ?string $routeName = null;
  29.     private ?array $routeParameters = null;
  30.     private ?string $linkUrl = null;
  31.     private string $linkRel = '';
  32.     private string $linkTarget = '_self';
  33.     private array $translationParameters = [];
  34.     private ?MenuItemBadgeDto $badge = null;
  35.     /** @var MenuItemDto[] */
  36.     private array $subItems = [];
  38.     public function getType(): string
  39.     {
  40.         return $this->type;
  41.     }
  43.     public function setType(string $type): void
  44.     {
  45.         $this->type = $type;
  46.     }
  48.     /** @deprecated This was used in the past to get the selected menu item
  49.      *              Now the active menu item is detected automatically via the Request data
  50.      */
  51.     public function getIndex(): int
  52.     {
  53.         return -1;
  54.     }
  56.     /** @deprecated This was used in the past to set the selected menu item
  57.      *              Now the active menu item is detected automatically via the Request data
  58.      */
  59.     public function setIndex(int $index): void
  60.     {
  61.         // do nothing...
  62.     }
  64.     /** @deprecated This was used in the past to get the selected menu subitem
  65.      *              Now the active menu item is detected automatically via the Request data
  66.      */
  67.     public function getSubIndex(): int
  68.     {
  69.         return -1;
  70.     }
  72.     /** @deprecated This was used in the past to set the selected menu subitem
  73.      *              Now the active menu item is detected automatically via the Request data
  74.      */
  75.     public function setSubIndex(int $subIndex): void
  76.     {
  77.         // do nothing
  78.     }
  80.     /**
  81.      * @return bool Returns true when this menu item is the selected one
  82.      */
  83.     public function isSelected(): bool
  84.     {
  85.         return $this->selected;
  86.     }
  88.     public function setSelected(bool $isSelected): void
  89.     {
  90.         $this->selected = $isSelected;
  91.     }
  93.     /**
  94.      * @return bool Returns true when any of its subitems is selected
  95.      */
  96.     public function isExpanded(): bool
  97.     {
  98.         return $this->expanded;
  99.     }
  101.     public function setExpanded(bool $isExpanded): void
  102.     {
  103.         $this->expanded = $isExpanded;
  104.     }
  106.     public function getLabel(): TranslatableInterface|string
  107.     {
  108.         return $this->label;
  109.     }
  111.     public function setLabel(TranslatableInterface|string $label): void
  112.     {
  113.         $this->label = $label;
  114.     }
  116.     public function getIcon(): ?string
  117.     {
  118.         return $this->icon;
  119.     }
  121.     public function setIcon(?string $icon): void
  122.     {
  123.         $this->icon = $icon;
  124.     }
  126.     public function getLinkUrl(): ?string
  127.     {
  128.         return $this->linkUrl;
  129.     }
  131.     public function setLinkUrl(?string $linkUrl): void
  132.     {
  133.         $this->linkUrl = $linkUrl;
  134.     }
  136.     public function getRouteName(): ?string
  137.     {
  138.         return $this->routeName;
  139.     }
  141.     public function setRouteName(?string $routeName): void
  142.     {
  143.         $this->routeName = $routeName;
  144.     }
  146.     public function getRouteParameters(): ?array
  147.     {
  148.         return $this->routeParameters;
  149.     }
  151.     public function setRouteParameter(string $parameterName, mixed $parameterValue): void
  152.     {
  153.         $this->routeParameters[$parameterName] = $parameterValue;
  154.     }
  156.     public function setRouteParameters(?array $routeParameters): void
  157.     {
  158.         $this->routeParameters = $routeParameters;
  159.     }
  161.     public function getPermission(): ?string
  162.     {
  163.         return $this->permission;
  164.     }
  166.     public function setPermission(?string $permission): void
  167.     {
  168.         $this->permission = $permission;
  169.     }
  171.     public function getCssClass(): string
  172.     {
  173.         return $this->cssClass;
  174.     }
  176.     public function setCssClass(string $cssClass): void
  177.     {
  178.         $this->cssClass = $cssClass;
  179.     }
  181.     public function getLinkRel(): string
  182.     {
  183.         return $this->linkRel;
  184.     }
  186.     public function setLinkRel(string $linkRel): void
  187.     {
  188.         $this->linkRel = $linkRel;
  189.     }
  191.     public function getLinkTarget(): string
  192.     {
  193.         return $this->linkTarget;
  194.     }
  196.     public function setLinkTarget(string $linkTarget): void
  197.     {
  198.         $this->linkTarget = $linkTarget;
  199.     }
  201.     public function getTranslationParameters(): array
  202.     {
  203.         return $this->translationParameters;
  204.     }
  206.     public function setTranslationParameters(array $translationParameters): void
  207.     {
  208.         $this->translationParameters = $translationParameters;
  209.     }
  211.     public function getBadge(): ?MenuItemBadgeDto
  212.     {
  213.         return $this->badge;
  214.     }
  216.     public function setBadge(mixed $content, string $style): void
  217.     {
  218.         $this->badge = new MenuItemBadgeDto($content, trim($style));
  219.     }
  221.     /**
  222.      * @return MenuItemDto[]
  223.      */
  224.     public function getSubItems(): array
  225.     {
  226.         return $this->subItems;
  227.     }
  229.     /**
  230.      * @param MenuItemDto[] $subItems
  231.      */
  232.     public function setSubItems(array $subItems): void
  233.     {
  234.         $this->subItems = $subItems;
  235.     }
  237.     public function hasSubItems(): bool
  238.     {
  239.         return self::TYPE_SUBMENU === $this->type && \count($this->subItems) > 0;
  240.     }
  242.     public function isMenuSection(): bool
  243.     {
  244.         return self::TYPE_SECTION === $this->type;
  245.     }
  246. }