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

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Dto;
  5. use Symfony\Component\ExpressionLanguage\Expression;
  6. use Symfony\Contracts\Translation\TranslatableInterface;
  8. /**
  9.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  10.  */
  11. final class MenuItemDto
  12. {
  13.     public const TYPE_CRUD = 'crud';
  14.     public const TYPE_URL = 'url';
  15.     public const TYPE_SECTION = 'section';
  16.     public const TYPE_EXIT_IMPERSONATION = 'exit_impersonation';
  17.     public const TYPE_DASHBOARD = 'dashboard';
  18.     public const TYPE_LOGOUT = 'logout';
  19.     public const TYPE_SUBMENU = 'submenu';
  20.     public const TYPE_ROUTE = 'route';
  22.     private ?string $type = null;
  23.     private bool $selected = false;
  24.     private bool $expanded = false;
  25.     private TranslatableInterface|string|null $label = null;
  26.     private ?string $icon = null;
  27.     private string $cssClass = '';
  28.     private string|Expression|null $permission = null;
  29.     private ?string $routeName = null;
  30.     private ?array $routeParameters = null;
  31.     private ?string $linkUrl = null;
  32.     private string $linkRel = '';
  33.     private string $linkTarget = '_self';
  34.     private array $translationParameters = [];
  35.     private ?MenuItemBadgeDto $badge = null;
  36.     /** @var MenuItemDto[] */
  37.     private array $subItems = [];
  38.     private array $htmlAttributes = [];
  40.     public function getType(): string
  41.     {
  42.         return $this->type;
  43.     }
  45.     public function setType(string $type): void
  46.     {
  47.         $this->type = $type;
  48.     }
  50.     /** @deprecated This was used in the past to get the selected menu item
  51.      *              Now the active menu item is detected automatically via the Request data
  52.      */
  53.     public function getIndex(): int
  54.     {
  55.         return -1;
  56.     }
  58.     /** @deprecated This was used in the past to set the selected menu item
  59.      *              Now the active menu item is detected automatically via the Request data
  60.      */
  61.     public function setIndex(int $index): void
  62.     {
  63.         // do nothing...
  64.     }
  66.     /** @deprecated This was used in the past to get the selected menu subitem
  67.      *              Now the active menu item is detected automatically via the Request data
  68.      */
  69.     public function getSubIndex(): int
  70.     {
  71.         return -1;
  72.     }
  74.     /** @deprecated This was used in the past to set the selected menu subitem
  75.      *              Now the active menu item is detected automatically via the Request data
  76.      */
  77.     public function setSubIndex(int $subIndex): void
  78.     {
  79.         // do nothing
  80.     }
  82.     /**
  83.      * @return bool Returns true when this menu item is the selected one
  84.      */
  85.     public function isSelected(): bool
  86.     {
  87.         return $this->selected;
  88.     }
  90.     public function setSelected(bool $isSelected): void
  91.     {
  92.         $this->selected = $isSelected;
  93.     }
  95.     /**
  96.      * @return bool Returns true when any of its subitems is selected
  97.      */
  98.     public function isExpanded(): bool
  99.     {
  100.         return $this->expanded;
  101.     }
  103.     public function setExpanded(bool $isExpanded): void
  104.     {
  105.         $this->expanded = $isExpanded;
  106.     }
  108.     public function getLabel(): TranslatableInterface|string
  109.     {
  110.         return $this->label;
  111.     }
  113.     public function setLabel(TranslatableInterface|string $label): void
  114.     {
  115.         $this->label = $label;
  116.     }
  118.     public function getIcon(): ?string
  119.     {
  120.         return $this->icon;
  121.     }
  123.     public function setIcon(?string $icon): void
  124.     {
  125.         $this->icon = $icon;
  126.     }
  128.     public function getLinkUrl(): ?string
  129.     {
  130.         return $this->linkUrl;
  131.     }
  133.     public function setLinkUrl(?string $linkUrl): void
  134.     {
  135.         $this->linkUrl = $linkUrl;
  136.     }
  138.     public function getRouteName(): ?string
  139.     {
  140.         return $this->routeName;
  141.     }
  143.     public function setRouteName(?string $routeName): void
  144.     {
  145.         $this->routeName = $routeName;
  146.     }
  148.     public function getRouteParameters(): ?array
  149.     {
  150.         return $this->routeParameters;
  151.     }
  153.     public function setRouteParameter(string $parameterName, mixed $parameterValue): void
  154.     {
  155.         $this->routeParameters[$parameterName] = $parameterValue;
  156.     }
  158.     public function setRouteParameters(?array $routeParameters): void
  159.     {
  160.         $this->routeParameters = $routeParameters;
  161.     }
  163.     public function getPermission(): string|Expression|null
  164.     {
  165.         return $this->permission;
  166.     }
  168.     public function setPermission(string|Expression|null $permission): void
  169.     {
  170.         $this->permission = $permission;
  171.     }
  173.     public function getCssClass(): string
  174.     {
  175.         return $this->cssClass;
  176.     }
  178.     public function setCssClass(string $cssClass): void
  179.     {
  180.         $this->cssClass = $cssClass;
  181.     }
  183.     public function getLinkRel(): string
  184.     {
  185.         return $this->linkRel;
  186.     }
  188.     public function setLinkRel(string $linkRel): void
  189.     {
  190.         $this->linkRel = $linkRel;
  191.     }
  193.     public function getLinkTarget(): string
  194.     {
  195.         return $this->linkTarget;
  196.     }
  198.     public function setLinkTarget(string $linkTarget): void
  199.     {
  200.         $this->linkTarget = $linkTarget;
  201.     }
  203.     public function getTranslationParameters(): array
  204.     {
  205.         return $this->translationParameters;
  206.     }
  208.     public function setTranslationParameters(array $translationParameters): void
  209.     {
  210.         $this->translationParameters = $translationParameters;
  211.     }
  213.     public function getBadge(): ?MenuItemBadgeDto
  214.     {
  215.         return $this->badge;
  216.     }
  218.     public function setBadge(mixed $content, string $style, array $htmlAttributes = []): void
  219.     {
  220.         $this->badge = new MenuItemBadgeDto($content, trim($style), $htmlAttributes);
  221.     }
  223.     /**
  224.      * @return MenuItemDto[]
  225.      */
  226.     public function getSubItems(): array
  227.     {
  228.         return $this->subItems;
  229.     }
  231.     /**
  232.      * @param MenuItemDto[] $subItems
  233.      */
  234.     public function setSubItems(array $subItems): void
  235.     {
  236.         $this->subItems = $subItems;
  237.     }
  239.     public function hasSubItems(): bool
  240.     {
  241.         return self::TYPE_SUBMENU === $this->type && \count($this->subItems) > 0;
  242.     }
  244.     public function isMenuSection(): bool
  245.     {
  246.         return self::TYPE_SECTION === $this->type;
  247.     }
  249.     public function getHtmlAttributes(): array
  250.     {
  251.         return $this->htmlAttributes;
  252.     }
  254.     public function setHtmlAttribute(string $attribute, mixed $value): void
  255.     {
  256.         $this->htmlAttributes[$attribute] = $value;
  257.     }
  258. }