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

  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\LocaleDto;
  14. use EasyCorp\Bundle\EasyAdminBundle\Dto\MainMenuDto;
  15. use EasyCorp\Bundle\EasyAdminBundle\Dto\SearchDto;
  16. use EasyCorp\Bundle\EasyAdminBundle\Dto\UserMenuDto;
  17. use EasyCorp\Bundle\EasyAdminBundle\Factory\MenuFactory;
  18. use EasyCorp\Bundle\EasyAdminBundle\Registry\CrudControllerRegistry;
  19. use EasyCorp\Bundle\EasyAdminBundle\Registry\TemplateRegistry;
  20. use Symfony\Component\HttpFoundation\Request;
  21. use Symfony\Component\Security\Core\User\UserInterface;
  23. /**
  24.  * A context object that stores all the state and config of the current admin request.
  25.  *
  26.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  27.  */
  28. final class AdminContext
  29. {
  30.     private Request $request;
  31.     private ?UserInterface $user;
  32.     private I18nDto $i18nDto;
  33.     private CrudControllerRegistry $crudControllers;
  34.     private ?EntityDto $entityDto;
  35.     private DashboardDto $dashboardDto;
  36.     private DashboardControllerInterface $dashboardControllerInstance;
  37.     private AssetsDto $assetDto;
  38.     private ?CrudDto $crudDto;
  39.     private ?SearchDto $searchDto;
  40.     private MenuFactory $menuFactory;
  41.     private TemplateRegistry $templateRegistry;
  42.     private ?MainMenuDto $mainMenuDto = null;
  43.     private ?UserMenuDto $userMenuDto = null;
  45.     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)
  46.     {
  47.         $this->request = $request;
  48.         $this->user = $user;
  49.         $this->i18nDto = $i18nDto;
  50.         $this->crudControllers = $crudControllers;
  51.         $this->dashboardDto = $dashboardDto;
  52.         $this->dashboardControllerInstance = $dashboardController;
  53.         $this->crudDto = $crudDto;
  54.         $this->assetDto = $assetDto;
  55.         $this->entityDto = $entityDto;
  56.         $this->searchDto = $searchDto;
  57.         $this->menuFactory = $menuFactory;
  58.         $this->templateRegistry = $templateRegistry;
  59.     }
  61.     public function getRequest(): Request
  62.     {
  63.         return $this->request;
  64.     }
  66.     public function getReferrer(): ?string
  67.     {
  68.         return $this->request->query->get(EA::REFERRER);
  69.     }
  71.     public function getI18n(): I18nDto
  72.     {
  73.         return $this->i18nDto;
  74.     }
  76.     public function getCrudControllers(): CrudControllerRegistry
  77.     {
  78.         return $this->crudControllers;
  79.     }
  81.     public function getEntity(): EntityDto
  82.     {
  83.         return $this->entityDto;
  84.     }
  86.     public function getUser(): ?UserInterface
  87.     {
  88.         return $this->user;
  89.     }
  91.     public function getAssets(): AssetsDto
  92.     {
  93.         return $this->assetDto;
  94.     }
  96.     public function getSignedUrls(): bool
  97.     {
  98.         return $this->dashboardDto->getSignedUrls();
  99.     }
  101.     public function getAbsoluteUrls(): bool
  102.     {
  103.         return $this->dashboardDto->getAbsoluteUrls();
  104.     }
  106.     public function getDashboardTitle(): string
  107.     {
  108.         return $this->dashboardDto->getTitle();
  109.     }
  111.     public function getDashboardFaviconPath(): string
  112.     {
  113.         return $this->dashboardDto->getFaviconPath();
  114.     }
  116.     public function getDashboardControllerFqcn(): string
  117.     {
  118.         return \get_class($this->dashboardControllerInstance);
  119.     }
  121.     public function getDashboardRouteName(): string
  122.     {
  123.         return $this->dashboardDto->getRouteName();
  124.     }
  126.     public function getDashboardContentWidth(): string
  127.     {
  128.         return $this->dashboardDto->getContentWidth();
  129.     }
  131.     public function getDashboardSidebarWidth(): string
  132.     {
  133.         return $this->dashboardDto->getSidebarWidth();
  134.     }
  136.     public function getDashboardHasDarkModeEnabled(): bool
  137.     {
  138.         return $this->dashboardDto->isDarkModeEnabled();
  139.     }
  141.     /**
  142.      * @return LocaleDto[]
  143.      */
  144.     public function getDashboardLocales(): array
  145.     {
  146.         return $this->dashboardDto->getLocales();
  147.     }
  149.     public function getMainMenu(): MainMenuDto
  150.     {
  151.         if (null !== $this->mainMenuDto) {
  152.             return $this->mainMenuDto;
  153.         }
  155.         $configuredMenuItems = $this->dashboardControllerInstance->configureMenuItems();
  156.         $mainMenuItems = \is_array($configuredMenuItems) ? $configuredMenuItems : iterator_to_array($configuredMenuItems, false);
  158.         return $this->mainMenuDto = $this->menuFactory->createMainMenu($mainMenuItems);
  159.     }
  161.     public function getUserMenu(): UserMenuDto
  162.     {
  163.         if (null !== $this->userMenuDto) {
  164.             return $this->userMenuDto;
  165.         }
  167.         if (null === $this->user) {
  168.             return UserMenu::new()->getAsDto();
  169.         }
  171.         $userMenu = $this->dashboardControllerInstance->configureUserMenu($this->user);
  173.         return $this->userMenuDto = $this->menuFactory->createUserMenu($userMenu);
  174.     }
  176.     public function getCrud(): ?CrudDto
  177.     {
  178.         return $this->crudDto;
  179.     }
  181.     public function getSearch(): ?SearchDto
  182.     {
  183.         return $this->searchDto;
  184.     }
  186.     public function getTemplatePath(string $templateName): string
  187.     {
  188.         return $this->templateRegistry->get($templateName);
  189.     }
  190. }