vendor/easycorp/easyadmin-bundle/src/Context/AdminContext.php line 27

Open in your IDE?
  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Context;
  5. use EasyCorp\Bundle\EasyAdminBundle\Config\Option\EA;
  6. use EasyCorp\Bundle\EasyAdminBundle\Config\UserMenu;
  7. use EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\DashboardControllerInterface;
  8. use EasyCorp\Bundle\EasyAdminBundle\Dto\AssetsDto;
  9. use EasyCorp\Bundle\EasyAdminBundle\Dto\CrudDto;
  10. use EasyCorp\Bundle\EasyAdminBundle\Dto\DashboardDto;
  11. use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
  12. use EasyCorp\Bundle\EasyAdminBundle\Dto\I18nDto;
  13. use EasyCorp\Bundle\EasyAdminBundle\Dto\MainMenuDto;
  14. use EasyCorp\Bundle\EasyAdminBundle\Dto\SearchDto;
  15. use EasyCorp\Bundle\EasyAdminBundle\Dto\UserMenuDto;
  16. use EasyCorp\Bundle\EasyAdminBundle\Factory\MenuFactory;
  17. use EasyCorp\Bundle\EasyAdminBundle\Registry\CrudControllerRegistry;
  18. use EasyCorp\Bundle\EasyAdminBundle\Registry\TemplateRegistry;
  19. use Symfony\Component\HttpFoundation\Request;
  20. use Symfony\Component\Security\Core\User\UserInterface;
  22. /**
  23.  * A context object that stores all the state and config of the current admin request.
  24.  *
  25.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  26.  */
  27. final class AdminContext
  28. {
  29.     private Request $request;
  30.     private ?UserInterface $user;
  31.     private I18nDto $i18nDto;
  32.     private CrudControllerRegistry $crudControllers;
  33.     private ?EntityDto $entityDto;
  34.     private DashboardDto $dashboardDto;
  35.     private DashboardControllerInterface $dashboardControllerInstance;
  36.     private AssetsDto $assetDto;
  37.     private ?CrudDto $crudDto;
  38.     private ?SearchDto $searchDto;
  39.     private MenuFactory $menuFactory;
  40.     private TemplateRegistry $templateRegistry;
  41.     private ?MainMenuDto $mainMenuDto = null;
  42.     private ?UserMenuDto $userMenuDto = null;
  44.     public function __construct(Request $request, ?UserInterface $user, I18nDto $i18nDto, CrudControllerRegistry $crudControllers, DashboardDto $dashboardDto, DashboardControllerInterface $dashboardController, AssetsDto $assetDto, ?CrudDto $crudDto, ?EntityDto $entityDto, ?SearchDto $searchDto, MenuFactory $menuFactory, TemplateRegistry $templateRegistry)
  45.     {
  46.         $this->request = $request;
  47.         $this->user = $user;
  48.         $this->i18nDto = $i18nDto;
  49.         $this->crudControllers = $crudControllers;
  50.         $this->dashboardDto = $dashboardDto;
  51.         $this->dashboardControllerInstance = $dashboardController;
  52.         $this->crudDto = $crudDto;
  53.         $this->assetDto = $assetDto;
  54.         $this->entityDto = $entityDto;
  55.         $this->searchDto = $searchDto;
  56.         $this->menuFactory = $menuFactory;
  57.         $this->templateRegistry = $templateRegistry;
  58.     }
  60.     public function getRequest(): Request
  61.     {
  62.         return $this->request;
  63.     }
  65.     public function getReferrer(): ?string
  66.     {
  67.         return $this->request->query->get(EA::REFERRER);
  68.     }
  70.     public function getI18n(): I18nDto
  71.     {
  72.         return $this->i18nDto;
  73.     }
  75.     public function getCrudControllers(): CrudControllerRegistry
  76.     {
  77.         return $this->crudControllers;
  78.     }
  80.     public function getEntity(): EntityDto
  81.     {
  82.         return $this->entityDto;
  83.     }
  85.     public function getUser(): ?UserInterface
  86.     {
  87.         return $this->user;
  88.     }
  90.     public function getAssets(): AssetsDto
  91.     {
  92.         return $this->assetDto;
  93.     }
  95.     public function getSignedUrls(): bool
  96.     {
  97.         return $this->dashboardDto->getSignedUrls();
  98.     }
  100.     public function getAbsoluteUrls(): bool
  101.     {
  102.         return $this->dashboardDto->getAbsoluteUrls();
  103.     }
  105.     public function getDashboardTitle(): string
  106.     {
  107.         return $this->dashboardDto->getTitle();
  108.     }
  110.     public function getDashboardFaviconPath(): string
  111.     {
  112.         return $this->dashboardDto->getFaviconPath();
  113.     }
  115.     public function getDashboardControllerFqcn(): string
  116.     {
  117.         return \get_class($this->dashboardControllerInstance);
  118.     }
  120.     public function getDashboardRouteName(): string
  121.     {
  122.         return $this->dashboardDto->getRouteName();
  123.     }
  125.     public function getDashboardContentWidth(): string
  126.     {
  127.         return $this->dashboardDto->getContentWidth();
  128.     }
  130.     public function getDashboardSidebarWidth(): string
  131.     {
  132.         return $this->dashboardDto->getSidebarWidth();
  133.     }
  135.     public function getDashboardHasDarkModeEnabled(): bool
  136.     {
  137.         return $this->dashboardDto->isDarkModeEnabled();
  138.     }
  140.     public function getMainMenu(): MainMenuDto
  141.     {
  142.         if (null !== $this->mainMenuDto) {
  143.             return $this->mainMenuDto;
  144.         }
  146.         $configuredMenuItems = $this->dashboardControllerInstance->configureMenuItems();
  147.         $mainMenuItems = \is_array($configuredMenuItems) ? $configuredMenuItems : iterator_to_array($configuredMenuItems, false);
  148.         $selectedMenuIndex = $this->request->query->getInt(EA::MENU_INDEX, -1);
  149.         $selectedMenuSubIndex = $this->request->query->getInt(EA::SUBMENU_INDEX, -1);
  151.         return $this->mainMenuDto = $this->menuFactory->createMainMenu($mainMenuItems, $selectedMenuIndex, $selectedMenuSubIndex);
  152.     }
  154.     public function getUserMenu(): UserMenuDto
  155.     {
  156.         if (null !== $this->userMenuDto) {
  157.             return $this->userMenuDto;
  158.         }
  160.         if (null === $this->user) {
  161.             return UserMenu::new()->getAsDto();
  162.         }
  164.         $userMenu = $this->dashboardControllerInstance->configureUserMenu($this->user);
  166.         return $this->userMenuDto = $this->menuFactory->createUserMenu($userMenu);
  167.     }
  169.     public function getCrud(): ?CrudDto
  170.     {
  171.         return $this->crudDto;
  172.     }
  174.     public function getSearch(): ?SearchDto
  175.     {
  176.         return $this->searchDto;
  177.     }
  179.     public function getTemplatePath(string $templateName): string
  180.     {
  181.         return $this->templateRegistry->get($templateName);
  182.     }
  183. }