vendor/easycorp/easyadmin-bundle/src/Factory/AdminContextFactory.php line 56

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Factory;
  5. use EasyCorp\Bundle\EasyAdminBundle\Cache\CacheWarmer;
  6. use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
  7. use EasyCorp\Bundle\EasyAdminBundle\Config\Option\EA;
  8. use EasyCorp\Bundle\EasyAdminBundle\Config\Option\TextDirection;
  9. use EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext;
  10. use EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\CrudControllerInterface;
  11. use EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\DashboardControllerInterface;
  12. use EasyCorp\Bundle\EasyAdminBundle\Contracts\Factory\MenuFactoryInterface;
  13. use EasyCorp\Bundle\EasyAdminBundle\Dto\ActionConfigDto;
  14. use EasyCorp\Bundle\EasyAdminBundle\Dto\AssetsDto;
  15. use EasyCorp\Bundle\EasyAdminBundle\Dto\CrudDto;
  16. use EasyCorp\Bundle\EasyAdminBundle\Dto\DashboardDto;
  17. use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
  18. use EasyCorp\Bundle\EasyAdminBundle\Dto\FilterConfigDto;
  19. use EasyCorp\Bundle\EasyAdminBundle\Dto\I18nDto;
  20. use EasyCorp\Bundle\EasyAdminBundle\Dto\SearchDto;
  21. use EasyCorp\Bundle\EasyAdminBundle\Registry\CrudControllerRegistry;
  22. use EasyCorp\Bundle\EasyAdminBundle\Registry\TemplateRegistry;
  23. use Symfony\Component\HttpFoundation\Request;
  24. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  25. use Symfony\Component\Security\Core\User\UserInterface;
  26. use function Symfony\Component\String\u;
  27. use function Symfony\Component\Translation\t;
  28. use Symfony\Contracts\Translation\TranslatableInterface;
  30. /**
  31.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  32.  */
  33. final class AdminContextFactory
  34. {
  35.     private string $cacheDir;
  36.     private ?TokenStorageInterface $tokenStorage;
  37.     private MenuFactoryInterface $menuFactory;
  38.     private CrudControllerRegistry $crudControllers;
  39.     private EntityFactory $entityFactory;
  41.     public function __construct(string $cacheDir, ?TokenStorageInterface $tokenStorage, MenuFactoryInterface $menuFactory, CrudControllerRegistry $crudControllers, EntityFactory $entityFactory)
  42.     {
  43.         $this->cacheDir = $cacheDir;
  44.         $this->tokenStorage = $tokenStorage;
  45.         $this->menuFactory = $menuFactory;
  46.         $this->crudControllers = $crudControllers;
  47.         $this->entityFactory = $entityFactory;
  48.     }
  50.     public function create(Request $request, DashboardControllerInterface $dashboardController, ?CrudControllerInterface $crudController): AdminContext
  51.     {
  52.         $crudAction = $request->query->get(EA::CRUD_ACTION);
  53.         $validPageNames = [Crud::PAGE_INDEX, Crud::PAGE_DETAIL, Crud::PAGE_EDIT, Crud::PAGE_NEW];
  54.         $pageName = \in_array($crudAction, $validPageNames, true) ? $crudAction : null;
  56.         $dashboardDto = $this->getDashboardDto($request, $dashboardController);
  57.         $assetDto = $this->getAssetDto($dashboardController, $crudController, $pageName);
  58.         $actionConfigDto = $this->getActionConfig($dashboardController, $crudController, $pageName);
  59.         $filters = $this->getFilters($dashboardController, $crudController);
  61.         $crudDto = $this->getCrudDto($this->crudControllers, $dashboardController, $crudController, $actionConfigDto, $filters, $crudAction, $pageName);
  62.         $entityDto = $this->getEntityDto($request, $crudDto);
  63.         $searchDto = $this->getSearchDto($request, $crudDto);
  64.         $i18nDto = $this->getI18nDto($request, $dashboardDto, $crudDto, $entityDto);
  65.         $templateRegistry = $this->getTemplateRegistry($dashboardController, $crudDto);
  66.         $user = $this->getUser($this->tokenStorage);
  68.         return new AdminContext($request, $user, $i18nDto, $this->crudControllers, $dashboardDto, $dashboardController, $assetDto, $crudDto, $entityDto, $searchDto, $this->menuFactory, $templateRegistry);
  69.     }
  71.     private function getDashboardDto(Request $request, DashboardControllerInterface $dashboardControllerInstance): DashboardDto
  72.     {
  73.         $dashboardRoutesCachePath = $this->cacheDir.'/'.CacheWarmer::DASHBOARD_ROUTES_CACHE;
  74.         $dashboardControllerRoutes = !file_exists($dashboardRoutesCachePath) ? [] : require $dashboardRoutesCachePath;
  75.         $dashboardController = $dashboardControllerInstance::class.'::index';
  76.         $dashboardRouteName = null;
  78.         foreach ($dashboardControllerRoutes as $routeName => $controller) {
  79.             if ($controller === $dashboardController) {
  80.                 // if present, remove the suffix of i18n route names (it's the content after the last dot
  81.                 // in the route name; e.g. 'dashboard.en' -> remove '.en', 'admin.index.en_US' -> remove '.en_US')
  82.                 $dashboardRouteName = preg_replace('~\.[a-z]{2}(_[A-Z]{2})?$~', '', $routeName);
  84.                 break;
  85.             }
  86.         }
  88.         if (null === $dashboardRouteName) {
  89.             throw new \RuntimeException(sprintf('The name of the route associated to "%s" cannot be determined. Clear the application cache to run the EasyAdmin cache warmer, which generates the needed data to find this route.', $dashboardController));
  90.         }
  92.         $dashboardDto = $dashboardControllerInstance->configureDashboard()->getAsDto();
  93.         $dashboardDto->setRouteName($dashboardRouteName);
  95.         return $dashboardDto;
  96.     }
  98.     private function getAssetDto(DashboardControllerInterface $dashboardController, ?CrudControllerInterface $crudController, ?string $pageName): AssetsDto
  99.     {
  100.         $defaultAssets = $dashboardController->configureAssets();
  102.         if (null === $crudController) {
  103.             return $defaultAssets->getAsDto();
  104.         }
  106.         return $crudController->configureAssets($defaultAssets)->getAsDto()->loadedOn($pageName);
  107.     }
  109.     private function getCrudDto(CrudControllerRegistry $crudControllers, DashboardControllerInterface $dashboardController, ?CrudControllerInterface $crudController, ActionConfigDto $actionConfigDto, FilterConfigDto $filters, ?string $crudAction, ?string $pageName): ?CrudDto
  110.     {
  111.         if (null === $crudController) {
  112.             return null;
  113.         }
  115.         $defaultCrud = $dashboardController->configureCrud();
  116.         $crudDto = $crudController->configureCrud($defaultCrud)->getAsDto();
  118.         $entityFqcn = $crudControllers->findEntityFqcnByCrudFqcn($crudController::class);
  120.         $crudDto->setControllerFqcn($crudController::class);
  121.         $crudDto->setActionsConfig($actionConfigDto);
  122.         $crudDto->setFiltersConfig($filters);
  123.         $crudDto->setCurrentAction($crudAction);
  124.         $crudDto->setEntityFqcn($entityFqcn);
  125.         $crudDto->setPageName($pageName);
  127.         return $crudDto;
  128.     }
  130.     private function getActionConfig(DashboardControllerInterface $dashboardController, ?CrudControllerInterface $crudController, ?string $pageName): ActionConfigDto
  131.     {
  132.         if (null === $crudController) {
  133.             return new ActionConfigDto();
  134.         }
  136.         $defaultActionConfig = $dashboardController->configureActions();
  138.         return $crudController->configureActions($defaultActionConfig)->getAsDto($pageName);
  139.     }
  141.     private function getFilters(DashboardControllerInterface $dashboardController, ?CrudControllerInterface $crudController): FilterConfigDto
  142.     {
  143.         if (null === $crudController) {
  144.             return new FilterConfigDto();
  145.         }
  147.         $defaultFilterConfig = $dashboardController->configureFilters();
  149.         return $crudController->configureFilters($defaultFilterConfig)->getAsDto();
  150.     }
  152.     private function getTemplateRegistry(DashboardControllerInterface $dashboardController, ?CrudDto $crudDto): TemplateRegistry
  153.     {
  154.         $templateRegistry = TemplateRegistry::new();
  156.         $defaultCrudDto = $dashboardController->configureCrud()->getAsDto();
  157.         $templateRegistry->setTemplates($defaultCrudDto->getOverriddenTemplates());
  159.         if (null !== $crudDto) {
  160.             $templateRegistry->setTemplates($crudDto->getOverriddenTemplates());
  161.         }
  163.         return $templateRegistry;
  164.     }
  166.     private function getI18nDto(Request $request, DashboardDto $dashboardDto, ?CrudDto $crudDto, ?EntityDto $entityDto): I18nDto
  167.     {
  168.         $locale = $request->getLocale();
  170.         $configuredTextDirection = $dashboardDto->getTextDirection();
  171.         $localePrefix = strtolower(substr($locale, 0, 2));
  172.         $defaultTextDirection = \in_array($localePrefix, ['ar', 'fa', 'he'], true) ? TextDirection::RTL : TextDirection::LTR;
  173.         $textDirection = $configuredTextDirection ?? $defaultTextDirection;
  175.         $translationDomain = $dashboardDto->getTranslationDomain();
  177.         $translationParameters = [];
  178.         if (null !== $crudDto) {
  179.             $translationParameters['%entity_name%'] = $entityName = basename(str_replace('\\', '/', $crudDto->getEntityFqcn()));
  180.             $translationParameters['%entity_as_string%'] = null === $entityDto ? '' : $entityDto->toString();
  181.             $translationParameters['%entity_id%'] = $entityId = $request->query->get(EA::ENTITY_ID);
  182.             $translationParameters['%entity_short_id%'] = null === $entityId ? null : u($entityId)->truncate(7)->toString();
  184.             $entityInstance = null === $entityDto ? null : $entityDto->getInstance();
  185.             $pageName = $crudDto->getCurrentPage();
  187.             $singularLabel = $crudDto->getEntityLabelInSingular($entityInstance, $pageName);
  188.             if (!$singularLabel instanceof TranslatableInterface) {
  189.                 $singularLabel = t($singularLabel ?? $entityName, $translationParameters, $translationDomain);
  190.             }
  192.             $pluralLabel = $crudDto->getEntityLabelInPlural($entityInstance, $pageName);
  193.             if (!$pluralLabel instanceof TranslatableInterface) {
  194.                 $pluralLabel = t($pluralLabel ?? $entityName, $translationParameters, $translationDomain);
  195.             }
  197.             $crudDto->setEntityLabelInSingular($singularLabel);
  198.             $crudDto->setEntityLabelInPlural($pluralLabel);
  200.             $translationParameters['%entity_label_singular%'] = $singularLabel;
  201.             $translationParameters['%entity_label_plural%'] = $pluralLabel;
  202.         }
  204.         return new I18nDto($locale, $textDirection, $translationDomain, $translationParameters);
  205.     }
  207.     public function getSearchDto(Request $request, ?CrudDto $crudDto): ?SearchDto
  208.     {
  209.         if (null === $crudDto) {
  210.             return null;
  211.         }
  213.         $queryParams = $request->query->all();
  214.         $searchableProperties = $crudDto->getSearchFields();
  215.         $query = $queryParams[EA::QUERY] ?? null;
  216.         $defaultSort = $crudDto->getDefaultSort();
  217.         $customSort = $queryParams[EA::SORT] ?? [];
  218.         $appliedFilters = $queryParams[EA::FILTERS] ?? [];
  219.         $searchMode = $crudDto->getSearchMode();
  221.         return new SearchDto($request, $searchableProperties, $query, $defaultSort, $customSort, $appliedFilters, $searchMode);
  222.     }
  224.     // Copied from https://github.com/symfony/twig-bridge/blob/master/AppVariable.php
  225.     // (c) Fabien Potencier <fabien@symfony.com> - MIT License
  226.     private function getUser(?TokenStorageInterface $tokenStorage): ?UserInterface
  227.     {
  228.         if (null === $token = $tokenStorage?->getToken()) {
  229.             return null;
  230.         }
  232.         $user = $token->getUser();
  234.         return \is_object($user) ? $user : null;
  235.     }
  237.     private function getEntityDto(Request $request, ?CrudDto $crudDto): ?EntityDto
  238.     {
  239.         if (null === $crudDto) {
  240.             return null;
  241.         }
  243.         return $this->entityFactory->create($crudDto->getEntityFqcn(), $request->query->get(EA::ENTITY_ID), $crudDto->getEntityPermission());
  244.     }
  245. }