vendor/easycorp/easyadmin-bundle/src/Dto/ActionDto.php line 11

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Dto;
  5. use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
  6. use Symfony\Contracts\Translation\TranslatableInterface;
  8. /**
  9.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  10.  */
  11. final class ActionDto
  12. {
  13.     private ?string $type = null;
  14.     private ?string $name = null;
  15.     private TranslatableInterface|string|null $label = null;
  16.     private ?string $icon = null;
  17.     private string $cssClass = '';
  18.     private string $addedCssClass = '';
  19.     private ?string $htmlElement = null;
  20.     private array $htmlAttributes = [];
  21.     private ?string $linkUrl = null;
  22.     private ?string $templatePath = null;
  23.     private ?string $crudActionName = null;
  24.     private ?string $routeName = null;
  25.     private $routeParameters = [];
  26.     /* @var callable|string|null */
  27.     private $url;
  28.     private array $translationParameters = [];
  29.     private $displayCallable;
  31.     public function getType(): string
  32.     {
  33.         return $this->type;
  34.     }
  36.     public function setType(string $type): void
  37.     {
  38.         $this->type = $type;
  39.     }
  41.     public function isEntityAction(): bool
  42.     {
  43.         return Action::TYPE_ENTITY === $this->type;
  44.     }
  46.     public function isGlobalAction(): bool
  47.     {
  48.         return Action::TYPE_GLOBAL === $this->type;
  49.     }
  51.     public function isBatchAction(): bool
  52.     {
  53.         return Action::TYPE_BATCH === $this->type;
  54.     }
  56.     public function getName(): string
  57.     {
  58.         return $this->name;
  59.     }
  61.     public function setName(string $name): void
  62.     {
  63.         $this->name = $name;
  64.     }
  66.     public function getLabel(): TranslatableInterface|string|false|null
  67.     {
  68.         return $this->label;
  69.     }
  71.     public function setLabel(TranslatableInterface|string|false|null $label): void
  72.     {
  73.         $this->label = $label;
  74.     }
  76.     public function getIcon(): ?string
  77.     {
  78.         return $this->icon;
  79.     }
  81.     public function setIcon(?string $icon): void
  82.     {
  83.         $this->icon = $icon;
  84.     }
  86.     public function getCssClass(): string
  87.     {
  88.         return trim($this->cssClass);
  89.     }
  91.     public function setCssClass(string $cssClass): void
  92.     {
  93.         $this->cssClass = $cssClass;
  94.     }
  96.     public function getAddedCssClass(): string
  97.     {
  98.         return trim($this->addedCssClass);
  99.     }
  101.     public function setAddedCssClass(string $cssClass): void
  102.     {
  103.         $this->addedCssClass .= ' '.$cssClass;
  104.     }
  106.     public function getHtmlElement(): string
  107.     {
  108.         return $this->htmlElement;
  109.     }
  111.     public function setHtmlElement(string $htmlElement): void
  112.     {
  113.         $this->htmlElement = $htmlElement;
  114.     }
  116.     public function getHtmlAttributes(): array
  117.     {
  118.         return $this->htmlAttributes;
  119.     }
  121.     public function addHtmlAttributes(array $htmlAttributes): void
  122.     {
  123.         $this->htmlAttributes = array_merge($this->htmlAttributes, $htmlAttributes);
  124.     }
  126.     public function setHtmlAttributes(array $htmlAttributes): void
  127.     {
  128.         $this->htmlAttributes = $htmlAttributes;
  129.     }
  131.     public function setHtmlAttribute(string $attributeName, string $attributeValue): void
  132.     {
  133.         $this->htmlAttributes[$attributeName] = $attributeValue;
  134.     }
  136.     public function getTemplatePath(): ?string
  137.     {
  138.         return $this->templatePath;
  139.     }
  141.     public function setTemplatePath(string $templatePath): void
  142.     {
  143.         $this->templatePath = $templatePath;
  144.     }
  146.     public function getLinkUrl(): string
  147.     {
  148.         return $this->linkUrl;
  149.     }
  151.     public function setLinkUrl(string $linkUrl): void
  152.     {
  153.         $this->linkUrl = $linkUrl;
  154.     }
  156.     public function getCrudActionName(): ?string
  157.     {
  158.         return $this->crudActionName;
  159.     }
  161.     public function setCrudActionName(string $crudActionName): void
  162.     {
  163.         $this->crudActionName = $crudActionName;
  164.     }
  166.     public function getRouteName(): ?string
  167.     {
  168.         return $this->routeName;
  169.     }
  171.     public function setRouteName(string $routeName): void
  172.     {
  173.         $this->routeName = $routeName;
  174.     }
  176.     /**
  177.      * @return array|callable
  178.      */
  179.     public function getRouteParameters()/* : array|callable */
  180.     {
  181.         return $this->routeParameters;
  182.     }
  184.     /**
  185.      * @param array|callable $routeParameters
  186.      */
  187.     public function setRouteParameters($routeParameters): void
  188.     {
  189.         if (!\is_array($routeParameters) && !\is_callable($routeParameters)) {
  190.             trigger_deprecation(
  191.                 'easycorp/easyadmin-bundle',
  192.                 '4.0.5',
  193.                 'Argument "%s" for "%s" must be one of these types: %s. Passing type "%s" will cause an error in 5.0.0.',
  194.                 '$routeParameters',
  195.                 __METHOD__,
  196.                 '"array" or "callable"',
  197.                 \gettype($routeParameters)
  198.             );
  199.         }
  201.         $this->routeParameters = $routeParameters;
  202.     }
  204.     /**
  205.      * @return string|callable|null
  206.      */
  207.     public function getUrl()
  208.     {
  209.         return $this->url;
  210.     }
  212.     /**
  213.      * @param string|callable $url
  214.      */
  215.     public function setUrl($url): void
  216.     {
  217.         if (!\is_string($url) && !\is_callable($url)) {
  218.             trigger_deprecation(
  219.                 'easycorp/easyadmin-bundle',
  220.                 '4.0.5',
  221.                 'Argument "%s" for "%s" must be one of these types: %s. Passing type "%s" will cause an error in 5.0.0.',
  222.                 '$url',
  223.                 __METHOD__,
  224.                 '"string" or "callable"',
  225.                 \gettype($url)
  226.             );
  227.         }
  229.         $this->url = $url;
  230.     }
  232.     public function getTranslationParameters(): array
  233.     {
  234.         return $this->translationParameters;
  235.     }
  237.     public function setTranslationParameters(array $translationParameters): void
  238.     {
  239.         $this->translationParameters = $translationParameters;
  240.     }
  242.     public function shouldBeDisplayedFor(EntityDto $entityDto): bool
  243.     {
  244.         trigger_deprecation(
  245.             'easycorp/easyadmin-bundle',
  246.             '4.9.4',
  247.             'The "%s" method is deprecated and it will be removed in 5.0.0 because it\'s been replaced by the method "isDisplayed()" of the same class.',
  248.             __METHOD__,
  249.         );
  251.         return $this->isDisplayed($entityDto);
  252.     }
  254.     public function isDisplayed(?EntityDto $entityDto = null): bool
  255.     {
  256.         return null === $this->displayCallable || (bool) \call_user_func($this->displayCallable, $entityDto?->getInstance());
  257.     }
  259.     public function setDisplayCallable(callable $displayCallable): void
  260.     {
  261.         $this->displayCallable = $displayCallable;
  262.     }
  264.     /**
  265.      * @internal
  266.      */
  267.     public function getAsConfigObject(): Action
  268.     {
  269.         $action = Action::new($this->name, $this->label, $this->icon);
  270.         $action->setCssClass($this->cssClass);
  271.         $action->addCssClass($this->addedCssClass);
  272.         $action->setHtmlAttributes($this->htmlAttributes);
  273.         $action->setTranslationParameters($this->translationParameters);
  275.         if (null !== $this->templatePath) {
  276.             $action->setTemplatePath($this->templatePath);
  277.         }
  279.         if ($this->isGlobalAction()) {
  280.             $action->createAsGlobalAction();
  281.         } elseif ($this->isBatchAction()) {
  282.             $action->createAsBatchAction();
  283.         }
  285.         if ('a' === $this->htmlElement) {
  286.             $action->displayAsLink();
  287.         } else {
  288.             $action->displayAsButton();
  289.         }
  291.         if (null !== $this->crudActionName) {
  292.             $action->linkToCrudAction($this->crudActionName);
  293.         }
  295.         if (null !== $this->routeName) {
  296.             $action->linkToRoute($this->routeName, $this->routeParameters);
  297.         }
  299.         if (null !== $this->displayCallable) {
  300.             $action->displayIf($this->displayCallable);
  301.         }
  303.         return $action;
  304.     }
  305. }