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

  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\Dto\ActionConfigDto;
  13. use EasyCorp\Bundle\EasyAdminBundle\Dto\AssetsDto;
  14. use EasyCorp\Bundle\EasyAdminBundle\Dto\CrudDto;
  15. use EasyCorp\Bundle\EasyAdminBundle\Dto\DashboardDto;
  16. use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
  17. use EasyCorp\Bundle\EasyAdminBundle\Dto\FilterConfigDto;
  18. use EasyCorp\Bundle\EasyAdminBundle\Dto\I18nDto;
  19. use EasyCorp\Bundle\EasyAdminBundle\Dto\SearchDto;
  20. use EasyCorp\Bundle\EasyAdminBundle\Registry\CrudControllerRegistry;
  21. use EasyCorp\Bundle\EasyAdminBundle\Registry\TemplateRegistry;
  22. use Symfony\Component\HttpFoundation\Request;
  23. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  24. use Symfony\Component\Security\Core\User\UserInterface;
  25. use function Symfony\Component\String\u;
  26. use function Symfony\Component\Translation\t;
  27. use Symfony\Contracts\Translation\TranslatableInterface;
  29. /**
  30.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  31.  */
  32. final class AdminContextFactory
  33. {
  34.     private string $cacheDir;
  35.     private ?TokenStorageInterface $tokenStorage;
  36.     private MenuFactory $menuFactory;
  37.     private CrudControllerRegistry $crudControllers;
  38.     private EntityFactory $entityFactory;
  40.     public function __construct(string $cacheDir, ?TokenStorageInterface $tokenStorage, MenuFactory $menuFactory, CrudControllerRegistry $crudControllers, EntityFactory $entityFactory)
  41.     {
  42.         $this->cacheDir = $cacheDir;
  43.         $this->tokenStorage = $tokenStorage;
  44.         $this->menuFactory = $menuFactory;
  45.         $this->crudControllers = $crudControllers;
  46.         $this->entityFactory = $entityFactory;
  47.     }
  49.     public function create(Request $request, DashboardControllerInterface $dashboardController, ?CrudControllerInterface $crudController): AdminContext
  50.     {
  51.         $crudAction = $request->query->get(EA::CRUD_ACTION);
  52.         $validPageNames = [Crud::PAGE_INDEX, Crud::PAGE_DETAIL, Crud::PAGE_EDIT, Crud::PAGE_NEW];
  53.         $pageName = \in_array($crudAction, $validPageNames, true) ? $crudAction : null;
  55.         $dashboardDto = $this->getDashboardDto($request, $dashboardController);
  56.         $assetDto = $this->getAssetDto($dashboardController, $crudController, $pageName);
  57.         $actionConfigDto = $this->getActionConfig($dashboardController, $crudController, $pageName);
  58.         $filters = $this->getFilters($dashboardController, $crudController);
  60.         $crudDto = $this->getCrudDto($this->crudControllers, $dashboardController, $crudController, $actionConfigDto, $filters, $crudAction, $pageName);
  61.         $entityDto = $this->getEntityDto($request, $crudDto);
  62.         $searchDto = $this->getSearchDto($request, $crudDto);
  63.         $i18nDto = $this->getI18nDto($request, $dashboardDto, $crudDto, $entityDto);
  64.         $templateRegistry = $this->getTemplateRegistry($dashboardController, $crudDto);
  65.         $user = $this->getUser($this->tokenStorage);
  67.         return new AdminContext($request, $user, $i18nDto, $this->crudControllers, $dashboardDto, $dashboardController, $assetDto, $crudDto, $entityDto, $searchDto, $this->menuFactory, $templateRegistry);
  68.     }
  70.     private function getDashboardDto(Request $request, DashboardControllerInterface $dashboardControllerInstance): DashboardDto
  71.     {
  72.         $dashboardRoutesCachePath = $this->cacheDir.'/'.CacheWarmer::DASHBOARD_ROUTES_CACHE;
  73.         $dashboardControllerRoutes = !file_exists($dashboardRoutesCachePath) ? [] : require $dashboardRoutesCachePath;
  74.         $dashboardController = $dashboardControllerInstance::class.'::index';
  75.         $dashboardRouteName = null;
  77.         foreach ($dashboardControllerRoutes as $routeName => $controller) {
  78.             if ($controller === $dashboardController) {
  79.                 // if present, remove the suffix of i18n route names (it's a two-letter locale at the end
  80.                 // of the route name; e.g. 'dashboard.en' -> remove '.en', 'admin.index.es' -> remove '.es')
  81.                 $dashboardRouteName = preg_replace('~\.\w{2}$~', '', $routeName);
  83.                 break;
  84.             }
  85.         }
  87.         if (null === $dashboardRouteName) {
  88.             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));
  89.         }
  91.         $dashboardDto = $dashboardControllerInstance->configureDashboard()->getAsDto();
  92.         $dashboardDto->setRouteName($dashboardRouteName);
  94.         return $dashboardDto;
  95.     }
  97.     private function getAssetDto(DashboardControllerInterface $dashboardController, ?CrudControllerInterface $crudController, ?string $pageName): AssetsDto
  98.     {
  99.         $defaultAssets = $dashboardController->configureAssets();
  101.         if (null === $crudController) {
  102.             return $defaultAssets->getAsDto();
  103.         }
  105.         return $crudController->configureAssets($defaultAssets)->getAsDto()->loadedOn($pageName);
  106.     }
  108.     private function getCrudDto(CrudControllerRegistry $crudControllers, DashboardControllerInterface $dashboardController, ?CrudControllerInterface $crudController, ActionConfigDto $actionConfigDto, FilterConfigDto $filters, ?string $crudAction, ?string $pageName): ?CrudDto
  109.     {
  110.         if (null === $crudController) {
  111.             return null;
  112.         }
  114.         $defaultCrud = $dashboardController->configureCrud();
  115.         $crudDto = $crudController->configureCrud($defaultCrud)->getAsDto();
  117.         $entityFqcn = $crudControllers->findEntityFqcnByCrudFqcn($crudController::class);
  119.         $crudDto->setControllerFqcn($crudController::class);
  120.         $crudDto->setActionsConfig($actionConfigDto);
  121.         $crudDto->setFiltersConfig($filters);
  122.         $crudDto->setCurrentAction($crudAction);
  123.         $crudDto->setEntityFqcn($entityFqcn);
  124.         $crudDto->setPageName($pageName);
  126.         return $crudDto;
  127.     }
  129.     private function getActionConfig(DashboardControllerInterface $dashboardController, ?CrudControllerInterface $crudController, ?string $pageName): ActionConfigDto
  130.     {
  131.         if (null === $crudController) {
  132.             return new ActionConfigDto();
  133.         }
  135.         $defaultActionConfig = $dashboardController->configureActions();
  137.         return $crudController->configureActions($defaultActionConfig)->getAsDto($pageName);
  138.     }
  140.     private function getFilters(DashboardControllerInterface $dashboardController, ?CrudControllerInterface $crudController): FilterConfigDto
  141.     {
  142.         if (null === $crudController) {
  143.             return new FilterConfigDto();
  144.         }
  146.         $defaultFilterConfig = $dashboardController->configureFilters();
  148.         return $crudController->configureFilters($defaultFilterConfig)->getAsDto();
  149.     }
  151.     private function getTemplateRegistry(DashboardControllerInterface $dashboardController, ?CrudDto $crudDto): TemplateRegistry
  152.     {
  153.         $templateRegistry = TemplateRegistry::new();
  155.         $defaultCrudDto = $dashboardController->configureCrud()->getAsDto();
  156.         $templateRegistry->setTemplates($defaultCrudDto->getOverriddenTemplates());
  158.         if (null !== $crudDto) {
  159.             $templateRegistry->setTemplates($crudDto->getOverriddenTemplates());
  160.         }
  162.         return $templateRegistry;
  163.     }
  165.     private function getI18nDto(Request $request, DashboardDto $dashboardDto, ?CrudDto $crudDto, ?EntityDto $entityDto): I18nDto
  166.     {
  167.         $locale = $request->getLocale();
  169.         $configuredTextDirection = $dashboardDto->getTextDirection();
  170.         $localePrefix = strtolower(substr($locale, 0, 2));
  171.         $defaultTextDirection = \in_array($localePrefix, ['ar', 'fa', 'he'], true) ? TextDirection::RTL : TextDirection::LTR;
  172.         $textDirection = $configuredTextDirection ?? $defaultTextDirection;
  174.         $translationDomain = $dashboardDto->getTranslationDomain();
  176.         $translationParameters = [];
  177.         if (null !== $crudDto) {
  178.             $translationParameters['%entity_name%'] = $entityName = basename(str_replace('\\', '/', $crudDto->getEntityFqcn()));
  179.             $translationParameters['%entity_as_string%'] = null === $entityDto ? '' : $entityDto->toString();
  180.             $translationParameters['%entity_id%'] = $entityId = $request->query->get(EA::ENTITY_ID);
  181.             $translationParameters['%entity_short_id%'] = null === $entityId ? null : u($entityId)->truncate(7)->toString();
  183.             $entityInstance = null === $entityDto ? null : $entityDto->getInstance();
  184.             $pageName = $crudDto->getCurrentPage();
  186.             $singularLabel = $crudDto->getEntityLabelInSingular($entityInstance, $pageName);
  187.             if (!$singularLabel instanceof TranslatableInterface) {
  188.                 $singularLabel = t($singularLabel ?? $entityName, $translationParameters, $translationDomain);
  189.             }
  191.             $pluralLabel = $crudDto->getEntityLabelInPlural($entityInstance, $pageName);
  192.             if (!$pluralLabel instanceof TranslatableInterface) {
  193.                 $pluralLabel = t($pluralLabel ?? $entityName, $translationParameters, $translationDomain);
  194.             }
  196.             $crudDto->setEntityLabelInSingular($singularLabel);
  197.             $crudDto->setEntityLabelInPlural($pluralLabel);
  199.             $translationParameters['%entity_label_singular%'] = $singularLabel;
  200.             $translationParameters['%entity_label_plural%'] = $pluralLabel;
  201.         }
  203.         return new I18nDto($locale, $textDirection, $translationDomain, $translationParameters);
  204.     }
  206.     public function getSearchDto(Request $request, ?CrudDto $crudDto): ?SearchDto
  207.     {
  208.         if (null === $crudDto) {
  209.             return null;
  210.         }
  212.         $queryParams = $request->query->all();
  213.         $searchableProperties = $crudDto->getSearchFields();
  214.         $query = $queryParams[EA::QUERY] ?? null;
  215.         $defaultSort = $crudDto->getDefaultSort();
  216.         $customSort = $queryParams[EA::SORT] ?? [];
  217.         $appliedFilters = $queryParams[EA::FILTERS] ?? [];
  219.         return new SearchDto($request, $searchableProperties, $query, $defaultSort, $customSort, $appliedFilters);
  220.     }
  222.     // Copied from https://github.com/symfony/twig-bridge/blob/master/AppVariable.php
  223.     // (c) Fabien Potencier <fabien@symfony.com> - MIT License
  224.     private function getUser(?TokenStorageInterface $tokenStorage): ?UserInterface
  225.     {
  226.         if (null === $token = $tokenStorage?->getToken()) {
  227.             return null;
  228.         }
  230.         $user = $token->getUser();
  232.         return \is_object($user) ? $user : null;
  233.     }
  235.     private function getEntityDto(Request $request, ?CrudDto $crudDto): ?EntityDto
  236.     {
  237.         if (null === $crudDto) {
  238.             return null;
  239.         }
  241.         return $this->entityFactory->create($crudDto->getEntityFqcn(), $request->query->get(EA::ENTITY_ID), $crudDto->getEntityPermission());
  242.     }
  243. }