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\Contracts\Factory\MenuFactoryInterface;
  9. use EasyCorp\Bundle\EasyAdminBundle\Dto\AssetsDto;
  10. use EasyCorp\Bundle\EasyAdminBundle\Dto\CrudDto;
  11. use EasyCorp\Bundle\EasyAdminBundle\Dto\DashboardDto;
  12. use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
  13. use EasyCorp\Bundle\EasyAdminBundle\Dto\I18nDto;
  14. use EasyCorp\Bundle\EasyAdminBundle\Dto\LocaleDto;
  15. use EasyCorp\Bundle\EasyAdminBundle\Dto\MainMenuDto;
  16. use EasyCorp\Bundle\EasyAdminBundle\Dto\SearchDto;
  17. use EasyCorp\Bundle\EasyAdminBundle\Dto\UserMenuDto;
  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 MenuFactoryInterface $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, MenuFactoryInterface $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.         $referrer = $this->request->query->get(EA::REFERRER);
  70.         return '' !== $referrer ? $referrer : null;
  71.     }
  73.     public function getI18n(): I18nDto
  74.     {
  75.         return $this->i18nDto;
  76.     }
  78.     public function getCrudControllers(): CrudControllerRegistry
  79.     {
  80.         return $this->crudControllers;
  81.     }
  83.     public function getEntity(): EntityDto
  84.     {
  85.         return $this->entityDto;
  86.     }
  88.     public function getUser(): ?UserInterface
  89.     {
  90.         return $this->user;
  91.     }
  93.     public function getAssets(): AssetsDto
  94.     {
  95.         return $this->assetDto;
  96.     }
  98.     public function getSignedUrls(): bool
  99.     {
  100.         return $this->dashboardDto->getSignedUrls();
  101.     }
  103.     public function getAbsoluteUrls(): bool
  104.     {
  105.         return $this->dashboardDto->getAbsoluteUrls();
  106.     }
  108.     public function getDashboardTitle(): string
  109.     {
  110.         return $this->dashboardDto->getTitle();
  111.     }
  113.     public function getDashboardFaviconPath(): string
  114.     {
  115.         return $this->dashboardDto->getFaviconPath();
  116.     }
  118.     public function getDashboardControllerFqcn(): string
  119.     {
  120.         return \get_class($this->dashboardControllerInstance);
  121.     }
  123.     public function getDashboardRouteName(): string
  124.     {
  125.         return $this->dashboardDto->getRouteName();
  126.     }
  128.     public function getDashboardContentWidth(): string
  129.     {
  130.         return $this->dashboardDto->getContentWidth();
  131.     }
  133.     public function getDashboardSidebarWidth(): string
  134.     {
  135.         return $this->dashboardDto->getSidebarWidth();
  136.     }
  138.     public function getDashboardHasDarkModeEnabled(): bool
  139.     {
  140.         return $this->dashboardDto->isDarkModeEnabled();
  141.     }
  143.     /**
  144.      * @return LocaleDto[]
  145.      */
  146.     public function getDashboardLocales(): array
  147.     {
  148.         return $this->dashboardDto->getLocales();
  149.     }
  151.     public function getMainMenu(): MainMenuDto
  152.     {
  153.         if (null !== $this->mainMenuDto) {
  154.             return $this->mainMenuDto;
  155.         }
  157.         $configuredMenuItems = $this->dashboardControllerInstance->configureMenuItems();
  158.         $mainMenuItems = \is_array($configuredMenuItems) ? $configuredMenuItems : iterator_to_array($configuredMenuItems, false);
  160.         return $this->mainMenuDto = $this->menuFactory->createMainMenu($mainMenuItems);
  161.     }
  163.     public function getUserMenu(): UserMenuDto
  164.     {
  165.         if (null !== $this->userMenuDto) {
  166.             return $this->userMenuDto;
  167.         }
  169.         if (null === $this->user) {
  170.             return UserMenu::new()->getAsDto();
  171.         }
  173.         $userMenu = $this->dashboardControllerInstance->configureUserMenu($this->user);
  175.         return $this->userMenuDto = $this->menuFactory->createUserMenu($userMenu);
  176.     }
  178.     public function getCrud(): ?CrudDto
  179.     {
  180.         return $this->crudDto;
  181.     }
  183.     public function getSearch(): ?SearchDto
  184.     {
  185.         return $this->searchDto;
  186.     }
  188.     public function getTemplatePath(string $templateName): string
  189.     {
  190.         return $this->templateRegistry->get($templateName);
  191.     }
  192. }