vendor/umbrella2/corebundle/src/Menu/DTO/MenuItem.php line 8

Open in your IDE?
  1. <?php
  3. namespace Umbrella\CoreBundle\Menu\DTO;
  5. use function Symfony\Component\String\u;
  6. use Umbrella\CoreBundle\Utils\Utils;
  8. class MenuItem implements \Countable, \IteratorAggregate
  9. {
  10.     protected Menu $menu;
  12.     protected string $name;
  14.     protected ?MenuItem $parent = null;
  16.     /**
  17.      * Children map using id as key
  18.      *
  19.      * @var MenuItem[]
  20.      */
  21.     protected array $children = [];
  23.     protected ?string $icon = null;
  25.     protected string $label;
  27.     protected ?string $translationDomain = 'messages';
  29.     protected ?string $badgeLabel = null;
  30.     protected ?string $badgeClass = null;
  32.     protected ?string $target = null;
  34.     protected ?string $url = null;
  36.     protected ?string $route = null;
  38.     protected array $routeParams = [];
  40.     protected array $matchingRoutes = [];
  42.     protected bool $active = false;
  44.     protected bool $visible = true;
  46.     /**
  47.      * MenuItem constructor.
  48.      */
  49.     public function __construct(Menu $menu, string $name)
  50.     {
  51.         $this->menu = $menu;
  52.         $this->name = $name;
  53.         $this->label = Utils::humanize($name);
  54.     }
  56.     public function getName(): string
  57.     {
  58.         return $this->name;
  59.     }
  61.     public function getCssId(): string
  62.     {
  63.         return sprintf('menu-item-%s-%d', u($this->name)->snake(), $this->getLevel());
  64.     }
  66.     public function getMenu(): Menu
  67.     {
  68.         return $this->menu;
  69.     }
  71.     public function getParent(): ?self
  72.     {
  73.         return $this->parent;
  74.     }
  76.     public function setParent(?MenuItem $parent): self
  77.     {
  78.         $this->parent = $parent;
  80.         return $this;
  81.     }
  83.     public function isRoot(): bool
  84.     {
  85.         return null === $this->parent;
  86.     }
  88.     public function getChildren(): array
  89.     {
  90.         return $this->children;
  91.     }
  93.     public function hasChildren(): bool
  94.     {
  95.         return count($this->children) > 0;
  96.     }
  98.     public function addChild(MenuItem $child): self
  99.     {
  100.         $child->parent = $this;
  101.         $this->children[$child->name] = $child;
  103.         return $this;
  104.     }
  106.     public function hasChild(string $name): bool
  107.     {
  108.         return isset($this->children[$name]);
  109.     }
  111.     public function getChild(string $name): self
  112.     {
  113.         return $this->children[$name];
  114.     }
  116.     public function removeChild(string $name): self
  117.     {
  118.         $this->children[$name]->setParent(null);
  119.         unset($this->children[$name]);
  121.         return $this;
  122.     }
  124.     public function getIcon(): ?string
  125.     {
  126.         return $this->icon;
  127.     }
  129.     public function setIcon(?string $icon): self
  130.     {
  131.         $this->icon = $icon;
  133.         return $this;
  134.     }
  136.     public function getLabel(): string
  137.     {
  138.         return $this->label;
  139.     }
  141.     public function setLabel(string $label): self
  142.     {
  143.         $this->label = $label;
  145.         return $this;
  146.     }
  148.     public function getTranslationDomain(): ?string
  149.     {
  150.         return $this->translationDomain;
  151.     }
  153.     public function setTranslationDomain(?string $translationDomain): self
  154.     {
  155.         $this->translationDomain = $translationDomain;
  157.         return $this;
  158.     }
  160.     public function hasBadge(): bool
  161.     {
  162.         return !empty($this->badgeLabel);
  163.     }
  165.     public function setBadge(string $badgeLabel, ?string $badgeClass = null): MenuItem
  166.     {
  167.         $this->badgeLabel = $badgeLabel;
  168.         $this->badgeClass = $badgeClass;
  169.         return $this;
  170.     }
  172.     public function getBadgeLabel(): ?string
  173.     {
  174.         return $this->badgeLabel;
  175.     }
  177.     public function getBadgeClass(): ?string
  178.     {
  179.         return $this->badgeClass;
  180.     }
  182.     public function hasLink(): bool
  183.     {
  184.         return !empty($this->route) || !empty($this->url);
  185.     }
  187.     public function getTarget(): ?string
  188.     {
  189.         return $this->target;
  190.     }
  192.     public function setTarget(?string $target): self
  193.     {
  194.         $this->target = $target;
  195.         return $this;
  196.     }
  198.     public function getUrl(): ?string
  199.     {
  200.         return $this->url;
  201.     }
  203.     public function setUrl(?string $url): self
  204.     {
  205.         $this->url = $url;
  206.         return $this;
  207.     }
  209.     public function getRoute(): ?string
  210.     {
  211.         return $this->route;
  212.     }
  214.     public function getRouteParams(): array
  215.     {
  216.         return $this->routeParams;
  217.     }
  219.     public function setRoute(string $route, array $routeParams = []): self
  220.     {
  221.         if (null !== $this->route) {
  222.             $this->removeMatchingRoute($this->route);
  223.         }
  225.         $this->route = $route;
  226.         $this->routeParams = $routeParams;
  227.         $this->addMatchingRoute($route, $routeParams);
  228.         return $this;
  229.     }
  231.     public function getMatchingRoutes(): array
  232.     {
  233.         return $this->matchingRoutes;
  234.     }
  236.     public function addMatchingRoute(string $route, array $routeParams = []): self
  237.     {
  238.         $this->matchingRoutes[$route] = $routeParams;
  240.         return $this;
  241.     }
  243.     public function removeMatchingRoute(string $route): self
  244.     {
  245.         unset($this->matchingRoutes[$route]);
  247.         return $this;
  248.     }
  250.     public function clearMatchingRoutes(): self
  251.     {
  252.         $this->matchingRoutes = [];
  254.         return $this;
  255.     }
  257.     public function getLevel(): int
  258.     {
  259.         return $this->parent ? $this->parent->getLevel() + 1 : 0;
  260.     }
  262.     public function isActive(): bool
  263.     {
  264.         return $this->active;
  265.     }
  267.     public function setActive(bool $active): self
  268.     {
  269.         $this->active = $active;
  270.         return $this;
  271.     }
  273.     public function isVisible(): bool
  274.     {
  275.         return $this->visible;
  276.     }
  278.     public function setVisible(bool $visible): self
  279.     {
  280.         $this->visible = $visible;
  281.         return $this;
  282.     }
  284.     // Interface implementations
  286.     /**
  287.      * {@inheritdoc}
  288.      */
  289.     public function getIterator(): iterable
  290.     {
  291.         return new \ArrayIterator($this->children);
  292.     }
  294.     /**
  295.      * {@inheritdoc}
  296.      */
  297.     public function count(): int
  298.     {
  299.         return count($this->children);
  300.     }
  301. }