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

Open in your IDE?
  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 ?int $index = null;
  23.     private ?int $subIndex = null;
  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.     public function getIndex(): int
  49.     {
  50.         return $this->index;
  51.     }
  53.     public function setIndex(int $index): void
  54.     {
  55.         $this->index = $index;
  56.     }
  58.     public function getSubIndex(): int
  59.     {
  60.         return $this->subIndex;
  61.     }
  63.     public function setSubIndex(int $subIndex): void
  64.     {
  65.         $this->subIndex = $subIndex;
  66.     }
  68.     public function getLabel(): TranslatableInterface|string
  69.     {
  70.         return $this->label;
  71.     }
  73.     public function setLabel(TranslatableInterface|string $label): void
  74.     {
  75.         $this->label = $label;
  76.     }
  78.     public function getIcon(): ?string
  79.     {
  80.         return $this->icon;
  81.     }
  83.     public function setIcon(?string $icon): void
  84.     {
  85.         $this->icon = $icon;
  86.     }
  88.     public function getLinkUrl(): ?string
  89.     {
  90.         return $this->linkUrl;
  91.     }
  93.     public function setLinkUrl(?string $linkUrl): void
  94.     {
  95.         $this->linkUrl = $linkUrl;
  96.     }
  98.     public function getRouteName(): ?string
  99.     {
  100.         return $this->routeName;
  101.     }
  103.     public function setRouteName(?string $routeName): void
  104.     {
  105.         $this->routeName = $routeName;
  106.     }
  108.     public function getRouteParameters(): ?array
  109.     {
  110.         return $this->routeParameters;
  111.     }
  113.     public function setRouteParameter(string $parameterName, mixed $parameterValue): void
  114.     {
  115.         $this->routeParameters[$parameterName] = $parameterValue;
  116.     }
  118.     public function setRouteParameters(?array $routeParameters): void
  119.     {
  120.         $this->routeParameters = $routeParameters;
  121.     }
  123.     public function getPermission(): ?string
  124.     {
  125.         return $this->permission;
  126.     }
  128.     public function setPermission(?string $permission): void
  129.     {
  130.         $this->permission = $permission;
  131.     }
  133.     public function getCssClass(): string
  134.     {
  135.         return $this->cssClass;
  136.     }
  138.     public function setCssClass(string $cssClass): void
  139.     {
  140.         $this->cssClass = $cssClass;
  141.     }
  143.     public function getLinkRel(): string
  144.     {
  145.         return $this->linkRel;
  146.     }
  148.     public function setLinkRel(string $linkRel): void
  149.     {
  150.         $this->linkRel = $linkRel;
  151.     }
  153.     public function getLinkTarget(): string
  154.     {
  155.         return $this->linkTarget;
  156.     }
  158.     public function setLinkTarget(string $linkTarget): void
  159.     {
  160.         $this->linkTarget = $linkTarget;
  161.     }
  163.     public function getTranslationParameters(): array
  164.     {
  165.         return $this->translationParameters;
  166.     }
  168.     public function setTranslationParameters(array $translationParameters): void
  169.     {
  170.         $this->translationParameters = $translationParameters;
  171.     }
  173.     public function getBadge(): ?MenuItemBadgeDto
  174.     {
  175.         return $this->badge;
  176.     }
  178.     public function setBadge(mixed $content, string $style): void
  179.     {
  180.         $this->badge = new MenuItemBadgeDto($content, trim($style));
  181.     }
  183.     /**
  184.      * @return MenuItemDto[]
  185.      */
  186.     public function getSubItems(): array
  187.     {
  188.         return $this->subItems;
  189.     }
  191.     /**
  192.      * @param MenuItemDto[] $subItems
  193.      */
  194.     public function setSubItems(array $subItems): void
  195.     {
  196.         $this->subItems = $subItems;
  197.     }
  199.     public function hasSubItems(): bool
  200.     {
  201.         return self::TYPE_SUBMENU === $this->type && \count($this->subItems) > 0;
  202.     }
  204.     public function isMenuSection(): bool
  205.     {
  206.         return self::TYPE_SECTION === $this->type;
  207.     }
  208. }