vendor/easycorp/easyadmin-bundle/src/Factory/ActionFactory.php line 72

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Factory;
  5. use EasyCorp\Bundle\EasyAdminBundle\Collection\ActionCollection;
  6. use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
  7. use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
  8. use EasyCorp\Bundle\EasyAdminBundle\Config\Option\EA;
  9. use EasyCorp\Bundle\EasyAdminBundle\Dto\ActionConfigDto;
  10. use EasyCorp\Bundle\EasyAdminBundle\Dto\ActionDto;
  11. use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
  12. use EasyCorp\Bundle\EasyAdminBundle\Provider\AdminContextProvider;
  13. use EasyCorp\Bundle\EasyAdminBundle\Router\AdminUrlGenerator;
  14. use EasyCorp\Bundle\EasyAdminBundle\Security\Permission;
  15. use EasyCorp\Bundle\EasyAdminBundle\Translation\TranslatableMessageBuilder;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  18. use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
  19. use function Symfony\Component\Translation\t;
  20. use Symfony\Contracts\Translation\TranslatableInterface;
  22. /**
  23.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  24.  */
  25. final class ActionFactory
  26. {
  27.     private AdminContextProvider $adminContextProvider;
  28.     private AuthorizationCheckerInterface $authChecker;
  29.     private AdminUrlGenerator $adminUrlGenerator;
  30.     private ?CsrfTokenManagerInterface $csrfTokenManager;
  32.     public function __construct(AdminContextProvider $adminContextProvider, AuthorizationCheckerInterface $authChecker, AdminUrlGenerator $adminUrlGenerator, ?CsrfTokenManagerInterface $csrfTokenManager = null)
  33.     {
  34.         $this->adminContextProvider = $adminContextProvider;
  35.         $this->authChecker = $authChecker;
  36.         $this->adminUrlGenerator = $adminUrlGenerator;
  37.         $this->csrfTokenManager = $csrfTokenManager;
  38.     }
  40.     public function processEntityActions(EntityDto $entityDto, ActionConfigDto $actionsDto): void
  41.     {
  42.         $currentPage = $this->adminContextProvider->getContext()->getCrud()->getCurrentPage();
  43.         $entityActions = [];
  44.         foreach ($actionsDto->getActions()->all() as $actionDto) {
  45.             if (!$actionDto->isEntityAction()) {
  46.                 continue;
  47.             }
  49.             if (false === $this->authChecker->isGranted(Permission::EA_EXECUTE_ACTION, ['action' => $actionDto, 'entity' => $entityDto])) {
  50.                 continue;
  51.             }
  53.             if (false === $actionDto->shouldBeDisplayedFor($entityDto)) {
  54.                 continue;
  55.             }
  57.             if ('' === $actionDto->getCssClass()) {
  58.                 $defaultCssClass = 'action-'.$actionDto->getName();
  59.                 if (Crud::PAGE_INDEX !== $currentPage) {
  60.                     $defaultCssClass .= ' btn';
  61.                 }
  63.                 $actionDto->setCssClass($defaultCssClass);
  64.             }
  66.             $entityActions[] = $this->processAction($currentPage, $actionDto, $entityDto);
  67.         }
  69.         $entityDto->setActions(ActionCollection::new($entityActions));
  70.     }
  72.     public function processGlobalActions(ActionConfigDto $actionsDto = null): ActionCollection
  73.     {
  74.         if (null === $actionsDto) {
  75.             $actionsDto = $this->adminContextProvider->getContext()->getCrud()->getActionsConfig();
  76.         }
  78.         $currentPage = $this->adminContextProvider->getContext()->getCrud()->getCurrentPage();
  79.         $globalActions = [];
  80.         foreach ($actionsDto->getActions()->all() as $actionDto) {
  81.             if (!$actionDto->isGlobalAction() && !$actionDto->isBatchAction()) {
  82.                 continue;
  83.             }
  85.             if (false === $this->authChecker->isGranted(Permission::EA_EXECUTE_ACTION, ['action' => $actionDto, 'entity' => null])) {
  86.                 continue;
  87.             }
  89.             if (Crud::PAGE_INDEX !== $currentPage && $actionDto->isBatchAction()) {
  90.                 throw new \RuntimeException(sprintf('Batch actions can be added only to the "index" page, but the "%s" batch action is defined in the "%s" page.', $actionDto->getName(), $currentPage));
  91.             }
  93.             if ('' === $actionDto->getCssClass()) {
  94.                 $actionDto->setCssClass('btn action-'.$actionDto->getName());
  95.             }
  97.             $globalActions[] = $this->processAction($currentPage, $actionDto);
  98.         }
  100.         return ActionCollection::new($globalActions);
  101.     }
  103.     private function processAction(string $pageName, ActionDto $actionDto, ?EntityDto $entityDto = null): ActionDto
  104.     {
  105.         $adminContext = $this->adminContextProvider->getContext();
  106.         $translationDomain = $adminContext->getI18n()->getTranslationDomain();
  107.         $defaultTranslationParameters = $adminContext->getI18n()->getTranslationParameters();
  108.         $currentPage = $adminContext->getCrud()->getCurrentPage();
  110.         $actionDto->setHtmlAttribute('data-action-name', $actionDto->getName());
  112.         if (false === $actionDto->getLabel()) {
  113.             $actionDto->setHtmlAttribute('title', $actionDto->getName());
  114.         } elseif (!$actionDto->getLabel() instanceof TranslatableInterface) {
  115.             $translationParameters = array_merge(
  116.                 $defaultTranslationParameters,
  117.                 $actionDto->getTranslationParameters()
  118.             );
  119.             $label = $actionDto->getLabel();
  120.             $translatableActionLabel = (null === $label || '' === $label) ? $label : t($label, $translationParameters, $translationDomain);
  121.             $actionDto->setLabel($translatableActionLabel);
  122.         } else {
  123.             $actionDto->setLabel(TranslatableMessageBuilder::withParameters($actionDto->getLabel(), $defaultTranslationParameters));
  124.         }
  126.         $defaultTemplatePath = $adminContext->getTemplatePath('crud/action');
  127.         $actionDto->setTemplatePath($actionDto->getTemplatePath() ?? $defaultTemplatePath);
  129.         $actionDto->setLinkUrl($this->generateActionUrl($currentPage, $adminContext->getRequest(), $actionDto, $entityDto));
  131.         if (!$actionDto->isGlobalAction() && \in_array($pageName, [Crud::PAGE_EDIT, Crud::PAGE_NEW], true)) {
  132.             $actionDto->setHtmlAttribute('form', sprintf('%s-%s-form', $pageName, $entityDto->getName()));
  133.         }
  135.         if (Action::DELETE === $actionDto->getName()) {
  136.             $actionDto->addHtmlAttributes([
  137.                 'formaction' => $this->adminUrlGenerator->setAction(Action::DELETE)->setEntityId($entityDto->getPrimaryKeyValue())->removeReferrer()->generateUrl(),
  138.                 'data-bs-toggle' => 'modal',
  139.                 'data-bs-target' => '#modal-delete',
  140.             ]);
  141.         }
  143.         if ($actionDto->isBatchAction()) {
  144.             $actionDto->addHtmlAttributes([
  145.                 'data-bs-toggle' => 'modal',
  146.                 'data-bs-target' => '#modal-batch-action',
  147.                 'data-action-csrf-token' => $this->csrfTokenManager?->getToken('ea-batch-action-'.$actionDto->getName()),
  148.                 'data-action-batch' => 'true',
  149.                 'data-entity-fqcn' => $adminContext->getCrud()->getEntityFqcn(),
  150.                 'data-action-url' => $actionDto->getLinkUrl(),
  151.             ]);
  152.         }
  154.         return $actionDto;
  155.     }
  157.     private function generateActionUrl(string $currentAction, Request $request, ActionDto $actionDto, ?EntityDto $entityDto = null): string
  158.     {
  159.         if (null !== $url = $actionDto->getUrl()) {
  160.             if (\is_callable($url)) {
  161.                 return null !== $entityDto ? $url($entityDto->getInstance()) : $url();
  162.             }
  164.             return $url;
  165.         }
  167.         if (null !== $routeName = $actionDto->getRouteName()) {
  168.             $routeParameters = $actionDto->getRouteParameters();
  169.             if (\is_callable($routeParameters) && null !== $entityInstance = $entityDto->getInstance()) {
  170.                 $routeParameters = $routeParameters($entityInstance);
  171.             }
  173.             return $this->adminUrlGenerator->unsetAll()->includeReferrer()->setRoute($routeName, $routeParameters)->generateUrl();
  174.         }
  176.         $requestParameters = [
  177.             EA::CRUD_CONTROLLER_FQCN => $request->query->get(EA::CRUD_CONTROLLER_FQCN),
  178.             EA::CRUD_ACTION => $actionDto->getCrudActionName(),
  179.             EA::REFERRER => $this->generateReferrerUrl($request, $actionDto, $currentAction),
  180.         ];
  182.         if (\in_array($actionDto->getName(), [Action::INDEX, Action::NEW, Action::SAVE_AND_ADD_ANOTHER, Action::SAVE_AND_RETURN], true)) {
  183.             $requestParameters[EA::ENTITY_ID] = null;
  184.         } elseif (null !== $entityDto) {
  185.             $requestParameters[EA::ENTITY_ID] = $entityDto->getPrimaryKeyValueAsString();
  186.         }
  188.         return $this->adminUrlGenerator->unsetAllExcept(EA::FILTERS, EA::PAGE)->setAll($requestParameters)->generateUrl();
  189.     }
  191.     private function generateReferrerUrl(Request $request, ActionDto $actionDto, string $currentAction): ?string
  192.     {
  193.         $nextAction = $actionDto->getName();
  195.         if (Action::DETAIL === $currentAction) {
  196.             if (Action::EDIT === $nextAction) {
  197.                 return $this->adminUrlGenerator->removeReferrer()->generateUrl();
  198.             }
  199.         }
  201.         if (Action::INDEX === $currentAction) {
  202.             return $this->adminUrlGenerator->removeReferrer()->generateUrl();
  203.         }
  205.         if (Action::NEW === $currentAction) {
  206.             return null;
  207.         }
  209.         $referrer = $request->query->get(EA::REFERRER);
  210.         $referrerParts = parse_url((string) $referrer);
  211.         parse_str($referrerParts[EA::QUERY] ?? '', $referrerQueryStringVariables);
  212.         $referrerCrudAction = $referrerQueryStringVariables[EA::CRUD_ACTION] ?? null;
  214.         if (Action::EDIT === $currentAction) {
  215.             if (\in_array($referrerCrudAction, [Action::INDEX, Action::DETAIL], true)) {
  216.                 return $referrer;
  217.             }
  218.         }
  220.         return $this->adminUrlGenerator->removeReferrer()->generateUrl();
  221.     }
  222. }