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

Open in your IDE?
  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Dto;
  5. /**
  6.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  7.  */
  8. final class MenuItemDto
  9. {
  10.     public const TYPE_CRUD = 'crud';
  11.     public const TYPE_URL = 'url';
  12.     public const TYPE_SECTION = 'section';
  13.     public const TYPE_EXIT_IMPERSONATION = 'exit_impersonation';
  14.     public const TYPE_DASHBOARD = 'dashboard';
  15.     public const TYPE_LOGOUT = 'logout';
  16.     public const TYPE_SUBMENU = 'submenu';
  17.     public const TYPE_ROUTE = 'route';
  19.     private $type;
  20.     private $index;
  21.     private $subIndex;
  22.     private $label;
  23.     private $icon;
  24.     private $cssClass;
  25.     private $permission;
  26.     private $routeName;
  27.     private $routeParameters;
  28.     private $linkUrl;
  29.     private $linkRel;
  30.     private $linkTarget;
  31.     private $translationParameters;
  32.     /** @var MenuItemBadgeDto|null */
  33.     private $badge;
  34.     /** @var MenuItemDto[] */
  35.     private $subItems;
  37.     public function __construct()
  38.     {
  39.         $this->cssClass = '';
  40.         $this->translationParameters = [];
  41.         $this->linkRel = '';
  42.         $this->linkTarget = '_self';
  43.         $this->badge = null;
  44.         $this->subItems = [];
  45.     }
  47.     public function getType(): string
  48.     {
  49.         return $this->type;
  50.     }
  52.     public function setType(string $type): void
  53.     {
  54.         $this->type = $type;
  55.     }
  57.     public function getIndex(): int
  58.     {
  59.         return $this->index;
  60.     }
  62.     public function setIndex(int $index): void
  63.     {
  64.         $this->index = $index;
  65.     }
  67.     public function getSubIndex(): int
  68.     {
  69.         return $this->subIndex;
  70.     }
  72.     public function setSubIndex(int $subIndex): void
  73.     {
  74.         $this->subIndex = $subIndex;
  75.     }
  77.     public function getLabel(): string
  78.     {
  79.         return $this->label;
  80.     }
  82.     public function setLabel(string $label): void
  83.     {
  84.         $this->label = $label;
  85.     }
  87.     public function getIcon(): ?string
  88.     {
  89.         return $this->icon;
  90.     }
  92.     public function setIcon(?string $icon): void
  93.     {
  94.         $this->icon = $icon;
  95.     }
  97.     public function getLinkUrl(): ?string
  98.     {
  99.         return $this->linkUrl;
  100.     }
  102.     public function setLinkUrl(?string $linkUrl): void
  103.     {
  104.         $this->linkUrl = $linkUrl;
  105.     }
  107.     public function getRouteName(): ?string
  108.     {
  109.         return $this->routeName;
  110.     }
  112.     public function setRouteName(?string $routeName): void
  113.     {
  114.         $this->routeName = $routeName;
  115.     }
  117.     public function getRouteParameters(): ?array
  118.     {
  119.         return $this->routeParameters;
  120.     }
  122.     public function setRouteParameter(string $parameterName, $parameterValue): void
  123.     {
  124.         $this->routeParameters[$parameterName] = $parameterValue;
  125.     }
  127.     public function setRouteParameters(?array $routeParameters): void
  128.     {
  129.         $this->routeParameters = $routeParameters;
  130.     }
  132.     public function getPermission(): ?string
  133.     {
  134.         return $this->permission;
  135.     }
  137.     public function setPermission(?string $permission): void
  138.     {
  139.         $this->permission = $permission;
  140.     }
  142.     public function getCssClass(): string
  143.     {
  144.         return $this->cssClass;
  145.     }
  147.     public function setCssClass(string $cssClass): void
  148.     {
  149.         $this->cssClass = $cssClass;
  150.     }
  152.     public function getLinkRel(): string
  153.     {
  154.         return $this->linkRel;
  155.     }
  157.     public function setLinkRel(string $linkRel): void
  158.     {
  159.         $this->linkRel = $linkRel;
  160.     }
  162.     public function getLinkTarget(): string
  163.     {
  164.         return $this->linkTarget;
  165.     }
  167.     public function setLinkTarget(string $linkTarget): void
  168.     {
  169.         $this->linkTarget = $linkTarget;
  170.     }
  172.     public function getTranslationParameters(): array
  173.     {
  174.         return $this->translationParameters;
  175.     }
  177.     public function setTranslationParameters(array $translationParameters): void
  178.     {
  179.         $this->translationParameters = $translationParameters;
  180.     }
  182.     public function getBadge(): ?MenuItemBadgeDto
  183.     {
  184.         return $this->badge;
  185.     }
  187.     public function setBadge($content, string $style): void
  188.     {
  189.         $this->badge = new MenuItemBadgeDto($content, trim($style));
  190.     }
  192.     /**
  193.      * @return MenuItemDto[]
  194.      */
  195.     public function getSubItems(): array
  196.     {
  197.         return $this->subItems;
  198.     }
  200.     /**
  201.      * @param MenuItemDto[] $subItems
  202.      */
  203.     public function setSubItems(array $subItems): void
  204.     {
  205.         $this->subItems = $subItems;
  206.     }
  208.     public function hasSubItems(): bool
  209.     {
  210.         return self::TYPE_SUBMENU === $this->type && \count($this->subItems) > 0;
  211.     }
  213.     public function isMenuSection(): bool
  214.     {
  215.         return self::TYPE_SECTION === $this->type;
  216.     }
  217. }