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 $htmlElement = null;
  19.     private array $htmlAttributes = [];
  20.     private ?string $linkUrl = null;
  21.     private ?string $templatePath = null;
  22.     private ?string $crudActionName = null;
  23.     private ?string $routeName = null;
  24.     private $routeParameters = [];
  25.     /* @var callable|string|null */
  26.     private $url;
  27.     private array $translationParameters = [];
  28.     private $displayCallable;
  30.     public function getType(): string
  31.     {
  32.         return $this->type;
  33.     }
  35.     public function setType(string $type): void
  36.     {
  37.         $this->type = $type;
  38.     }
  40.     public function isEntityAction(): bool
  41.     {
  42.         return Action::TYPE_ENTITY === $this->type;
  43.     }
  45.     public function isGlobalAction(): bool
  46.     {
  47.         return Action::TYPE_GLOBAL === $this->type;
  48.     }
  50.     public function isBatchAction(): bool
  51.     {
  52.         return Action::TYPE_BATCH === $this->type;
  53.     }
  55.     public function getName(): string
  56.     {
  57.         return $this->name;
  58.     }
  60.     public function setName(string $name): void
  61.     {
  62.         $this->name = $name;
  63.     }
  65.     public function getLabel(): TranslatableInterface|string|false|null
  66.     {
  67.         return $this->label;
  68.     }
  70.     public function setLabel(TranslatableInterface|string|false|null $label): void
  71.     {
  72.         $this->label = $label;
  73.     }
  75.     public function getIcon(): ?string
  76.     {
  77.         return $this->icon;
  78.     }
  80.     public function setIcon(?string $icon): void
  81.     {
  82.         $this->icon = $icon;
  83.     }
  85.     public function getCssClass(): string
  86.     {
  87.         return $this->cssClass;
  88.     }
  90.     public function setCssClass(string $cssClass): void
  91.     {
  92.         $this->cssClass = $cssClass;
  93.     }
  95.     public function getHtmlElement(): string
  96.     {
  97.         return $this->htmlElement;
  98.     }
  100.     public function setHtmlElement(string $htmlElement): void
  101.     {
  102.         $this->htmlElement = $htmlElement;
  103.     }
  105.     public function getHtmlAttributes(): array
  106.     {
  107.         return $this->htmlAttributes;
  108.     }
  110.     public function addHtmlAttributes(array $htmlAttributes): void
  111.     {
  112.         $this->htmlAttributes = array_merge($this->htmlAttributes, $htmlAttributes);
  113.     }
  115.     public function setHtmlAttributes(array $htmlAttributes): void
  116.     {
  117.         $this->htmlAttributes = $htmlAttributes;
  118.     }
  120.     public function setHtmlAttribute(string $attributeName, string $attributeValue): void
  121.     {
  122.         $this->htmlAttributes[$attributeName] = $attributeValue;
  123.     }
  125.     public function getTemplatePath(): ?string
  126.     {
  127.         return $this->templatePath;
  128.     }
  130.     public function setTemplatePath(string $templatePath): void
  131.     {
  132.         $this->templatePath = $templatePath;
  133.     }
  135.     public function getLinkUrl(): string
  136.     {
  137.         return $this->linkUrl;
  138.     }
  140.     public function setLinkUrl(string $linkUrl): void
  141.     {
  142.         $this->linkUrl = $linkUrl;
  143.     }
  145.     public function getCrudActionName(): ?string
  146.     {
  147.         return $this->crudActionName;
  148.     }
  150.     public function setCrudActionName(string $crudActionName): void
  151.     {
  152.         $this->crudActionName = $crudActionName;
  153.     }
  155.     public function getRouteName(): ?string
  156.     {
  157.         return $this->routeName;
  158.     }
  160.     public function setRouteName(string $routeName): void
  161.     {
  162.         $this->routeName = $routeName;
  163.     }
  165.     /**
  166.      * @return array|callable
  167.      */
  168.     public function getRouteParameters()/* : array|callable */
  169.     {
  170.         return $this->routeParameters;
  171.     }
  173.     public function setRouteParameters(/* @var array|callable */ $routeParameters): void
  174.     {
  175.         if (!\is_array($routeParameters) && !\is_callable($routeParameters)) {
  176.             trigger_deprecation(
  177.                 'easycorp/easyadmin-bundle',
  178.                 '4.0.5',
  179.                 'Argument "%s" for "%s" must be one of these types: %s. Passing type "%s" will cause an error in 5.0.0.',
  180.                 '$routeParameters',
  181.                 __METHOD__,
  182.                 '"array" or "callable"',
  183.                 \gettype($routeParameters)
  184.             );
  185.         }
  187.         $this->routeParameters = $routeParameters;
  188.     }
  190.     /**
  191.      * @return string|callable|null
  192.      */
  193.     public function getUrl()/* : string|callable */
  194.     {
  195.         return $this->url;
  196.     }
  198.     public function setUrl(/* @var string|callable */ $url): void
  199.     {
  200.         if (!\is_string($url) && !\is_callable($url)) {
  201.             trigger_deprecation(
  202.                 'easycorp/easyadmin-bundle',
  203.                 '4.0.5',
  204.                 'Argument "%s" for "%s" must be one of these types: %s. Passing type "%s" will cause an error in 5.0.0.',
  205.                 '$url',
  206.                 __METHOD__,
  207.                 '"string" or "callable"',
  208.                 \gettype($url)
  209.             );
  210.         }
  212.         $this->url = $url;
  213.     }
  215.     public function getTranslationParameters(): array
  216.     {
  217.         return $this->translationParameters;
  218.     }
  220.     public function setTranslationParameters(array $translationParameters): void
  221.     {
  222.         $this->translationParameters = $translationParameters;
  223.     }
  225.     public function shouldBeDisplayedFor(EntityDto $entityDto): bool
  226.     {
  227.         return null === $this->displayCallable || (bool) \call_user_func($this->displayCallable, $entityDto->getInstance());
  228.     }
  230.     public function setDisplayCallable(callable $displayCallable): void
  231.     {
  232.         $this->displayCallable = $displayCallable;
  233.     }
  235.     /**
  236.      * @internal
  237.      */
  238.     public function getAsConfigObject(): Action
  239.     {
  240.         $action = Action::new($this->name, $this->label, $this->icon);
  241.         $action->setCssClass($this->cssClass);
  242.         $action->setHtmlAttributes($this->htmlAttributes);
  243.         $action->setTranslationParameters($this->translationParameters);
  245.         if (null !== $this->templatePath) {
  246.             $action->setTemplatePath($this->templatePath);
  247.         }
  249.         if ($this->isGlobalAction()) {
  250.             $action->createAsGlobalAction();
  251.         } elseif ($this->isBatchAction()) {
  252.             $action->createAsBatchAction();
  253.         }
  255.         if ('a' === $this->htmlElement) {
  256.             $action->displayAsLink();
  257.         } else {
  258.             $action->displayAsButton();
  259.         }
  261.         if (null !== $this->crudActionName) {
  262.             $action->linkToCrudAction($this->crudActionName);
  263.         }
  265.         if (null !== $this->routeName) {
  266.             $action->linkToRoute($this->routeName, $this->routeParameters);
  267.         }
  269.         if (null !== $this->displayCallable) {
  270.             $action->displayIf($this->displayCallable);
  271.         }
  273.         return $action;
  274.     }
  275. }