vendor/ezsystems/ezplatform-admin-ui/src/lib/Tab/Event/Subscriber/OrderedTabSubscriber.php line 38

Open in your IDE?
  1. <?php
  3. /**
  4.  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  5.  * @license For full copyright and license information view LICENSE file distributed with this source code.
  6.  */
  7. declare(strict_types=1);
  9. namespace EzSystems\EzPlatformAdminUi\Tab\Event\Subscriber;
  11. use EzSystems\EzPlatformAdminUi\Tab\Event\TabEvents;
  12. use EzSystems\EzPlatformAdminUi\Tab\Event\TabGroupEvent;
  13. use EzSystems\EzPlatformAdminUi\Tab\OrderedTabInterface;
  14. use EzSystems\EzPlatformAdminUi\Tab\TabInterface;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  17. /**
  18.  * Reorders tabs according to their Order value (Tabs implementing OrderedTabInterface).
  19.  * Tabs without order specified are pushed to the end of the group.
  20.  *
  21.  * @see OrderedTabInterface
  22.  */
  23. class OrderedTabSubscriber implements EventSubscriberInterface
  24. {
  25.     /**
  26.      * @return array
  27.      */
  28.     public static function getSubscribedEvents(): array
  29.     {
  30.         return [
  31.             TabEvents::TAB_GROUP_PRE_RENDER => ['onTabGroupPreRender'],
  32.         ];
  33.     }
  35.     /**
  36.      * @param TabGroupEvent $tabGroupEvent
  37.      */
  38.     public function onTabGroupPreRender(TabGroupEvent $tabGroupEvent)
  39.     {
  40.         $tabGroup = $tabGroupEvent->getData();
  41.         $tabs = $tabGroup->getTabs();
  43.         $tabs = $this->reorderTabs($tabs);
  45.         $tabGroup->setTabs($tabs);
  46.         $tabGroupEvent->setData($tabGroup);
  47.     }
  49.     /**
  50.      * @param TabInterface[] $tabs
  51.      *
  52.      * @return array
  53.      */
  54.     private function reorderTabs($tabs): array
  55.     {
  56.         $orderedTabs = [];
  57.         foreach ($tabs as $tab) {
  58.             if ($tab instanceof OrderedTabInterface) {
  59.                 $orderedTabs[$tab->getIdentifier()] = $tab;
  60.                 unset($tabs[$tab->getIdentifier()]);
  61.             }
  62.         }
  64.         uasort($orderedTabs, [$this, 'sortTabs']);
  66.         return array_merge($orderedTabs, $tabs);
  67.     }
  69.     /**
  70.      * @param OrderedTabInterface $tab1
  71.      * @param OrderedTabInterface $tab2
  72.      *
  73.      * @return int
  74.      */
  75.     private function sortTabs(OrderedTabInterface $tab1, OrderedTabInterface $tab2): int
  76.     {
  77.         return $tab1->getOrder() <=> $tab2->getOrder();
  78.     }
  79. }