vendor/easycorp/easyadmin-bundle/src/Dto/FieldDto.php line 26

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Dto;
  5. use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
  6. use EasyCorp\Bundle\EasyAdminBundle\Config\KeyValueStore;
  7. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\EaFormFieldsetType;
  8. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormColumnCloseType;
  9. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormColumnGroupCloseType;
  10. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormColumnGroupOpenType;
  11. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormColumnOpenType;
  12. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormFieldsetCloseType;
  13. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormFieldsetOpenType;
  14. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormTabListType;
  15. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormTabPaneCloseType;
  16. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormTabPaneGroupCloseType;
  17. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormTabPaneGroupOpenType;
  18. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormTabPaneOpenType;
  19. use Symfony\Component\ExpressionLanguage\Expression;
  20. use Symfony\Component\Uid\Ulid;
  21. use Symfony\Contracts\Translation\TranslatableInterface;
  23. /**
  24.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  25.  */
  26. final class FieldDto
  27. {
  28.     private ?string $fieldFqcn = null;
  29.     private ?string $propertyName = null;
  30.     private mixed $value = null;
  31.     private mixed $formattedValue = null;
  32.     private $formatValueCallable;
  33.     private $label;
  34.     private ?string $formType = null;
  35.     private KeyValueStore $formTypeOptions;
  36.     private ?bool $sortable = null;
  37.     private ?bool $virtual = null;
  38.     private string|Expression|null $permission = null;
  39.     private ?string $textAlign = null;
  40.     private $help;
  41.     private string $cssClass = '';
  42.     // how many columns the field takes when rendering
  43.     // (defined as Bootstrap 5 grid classes; e.g. 'col-md-6 col-xxl-3')
  44.     private ?string $columns = null;
  45.     // same as $columns but used when the user doesn't define columns explicitly
  46.     private string $defaultColumns = '';
  47.     private array $translationParameters = [];
  48.     private ?string $templateName = 'crud/field/text';
  49.     private ?string $templatePath = null;
  50.     private array $formThemePaths = [];
  51.     private AssetsDto $assets;
  52.     private KeyValueStore $customOptions;
  53.     private KeyValueStore $doctrineMetadata;
  54.     /** @internal */
  55.     private $uniqueId;
  56.     private KeyValueStore $displayedOn;
  58.     public function __construct()
  59.     {
  60.         $this->uniqueId = new Ulid();
  61.         $this->assets = new AssetsDto();
  62.         $this->formTypeOptions = KeyValueStore::new();
  63.         $this->customOptions = KeyValueStore::new();
  64.         $this->doctrineMetadata = KeyValueStore::new();
  65.         $this->displayedOn = KeyValueStore::new([
  66.             Crud::PAGE_INDEX => Crud::PAGE_INDEX,
  67.             Crud::PAGE_DETAIL => Crud::PAGE_DETAIL,
  68.             Crud::PAGE_EDIT => Crud::PAGE_EDIT,
  69.             Crud::PAGE_NEW => Crud::PAGE_NEW,
  70.         ]);
  71.     }
  73.     public function __clone()
  74.     {
  75.         $this->uniqueId = new Ulid();
  76.         $this->assets = clone $this->assets;
  77.         $this->formTypeOptions = clone $this->formTypeOptions;
  78.         $this->customOptions = clone $this->customOptions;
  79.         $this->doctrineMetadata = clone $this->doctrineMetadata;
  80.         $this->displayedOn = clone $this->displayedOn;
  81.     }
  83.     public function getUniqueId(): string
  84.     {
  85.         return $this->uniqueId;
  86.     }
  88.     public function setUniqueId(string $uniqueId): void
  89.     {
  90.         $this->uniqueId = $uniqueId;
  91.     }
  93.     public function isFormDecorationField(): bool
  94.     {
  95.         trigger_deprecation(
  96.             'easycorp/easyadmin-bundle',
  97.             '4.8.0',
  98.             '"FieldDto::isFormDecorationField()" has been deprecated in favor of "FieldDto::isFormLayoutField()" and it will be removed in 5.0.0.',
  99.         );
  101.         return $this->isFormLayoutField();
  102.     }
  104.     public function isFormLayoutField(): bool
  105.     {
  106.         $formLayoutFieldClasses = [
  107.             EaFormTabListType::class,
  108.             EaFormTabPaneGroupOpenType::class,
  109.             EaFormTabPaneGroupCloseType::class,
  110.             EaFormTabPaneOpenType::class,
  111.             EaFormTabPaneCloseType::class,
  112.             EaFormColumnGroupOpenType::class,
  113.             EaFormColumnGroupCloseType::class,
  114.             EaFormColumnOpenType::class,
  115.             EaFormColumnCloseType::class,
  116.             EaFormFieldsetOpenType::class,
  117.             EaFormFieldsetCloseType::class,
  118.         ];
  120.         return \in_array($this->formType, $formLayoutFieldClasses, true);
  121.     }
  123.     public function isFormFieldset(): bool
  124.     {
  125.         return \in_array($this->formType, [EaFormFieldsetType::class, EaFormFieldsetOpenType::class], true);
  126.     }
  128.     public function isFormTab(): bool
  129.     {
  130.         return EaFormTabPaneOpenType::class === $this->formType;
  131.     }
  133.     public function isFormColumn(): bool
  134.     {
  135.         return EaFormColumnOpenType::class === $this->formType;
  136.     }
  138.     public function getFieldFqcn(): ?string
  139.     {
  140.         return $this->fieldFqcn;
  141.     }
  143.     /**
  144.      * @internal Don't use this method yourself. EasyAdmin uses it internally
  145.      *           to set the field FQCN. It's OK to use getFieldFqcn() to get this value.
  146.      */
  147.     public function setFieldFqcn(string $fieldFqcn): void
  148.     {
  149.         $this->fieldFqcn = $fieldFqcn;
  150.     }
  152.     public function getProperty(): string
  153.     {
  154.         return $this->propertyName;
  155.     }
  157.     public function setProperty(string $propertyName): void
  158.     {
  159.         $this->propertyName = $propertyName;
  160.     }
  162.     /**
  163.      * Returns the original unmodified value stored in the entity field.
  164.      */
  165.     public function getValue(): mixed
  166.     {
  167.         return $this->value;
  168.     }
  170.     public function setValue(mixed $value): void
  171.     {
  172.         $this->value = $value;
  173.     }
  175.     /**
  176.      * Returns the value to be displayed for the field (it could be the
  177.      * same as the value stored in the field or not).
  178.      */
  179.     public function getFormattedValue(): mixed
  180.     {
  181.         return $this->formattedValue;
  182.     }
  184.     public function setFormattedValue(mixed $formattedValue): void
  185.     {
  186.         $this->formattedValue = $formattedValue;
  187.     }
  189.     public function getFormatValueCallable(): ?callable
  190.     {
  191.         return $this->formatValueCallable;
  192.     }
  194.     public function setFormatValueCallable(?callable $callable): void
  195.     {
  196.         $this->formatValueCallable = $callable;
  197.     }
  199.     /**
  200.      * @return TranslatableInterface|string|false|null
  201.      */
  202.     public function getLabel()
  203.     {
  204.         return $this->label;
  205.     }
  207.     /**
  208.      * @param TranslatableInterface|string|false|null $label
  209.      */
  210.     public function setLabel($label): void
  211.     {
  212.         if (!\is_string($label) && !$label instanceof TranslatableInterface && false !== $label && null !== $label) {
  213.             trigger_deprecation(
  214.                 'easycorp/easyadmin-bundle',
  215.                 '4.0.5',
  216.                 'Argument "%s" for "%s" must be one of these types: %s. Passing type "%s" will cause an error in 5.0.0.',
  217.                 '$label',
  218.                 __METHOD__,
  219.                 '"TranslatableInterface", "string", "false" or "null"',
  220.                 \gettype($label)
  221.             );
  222.         }
  224.         $this->label = $label;
  225.     }
  227.     public function getFormType(): ?string
  228.     {
  229.         return $this->formType;
  230.     }
  232.     public function setFormType(string $formTypeFqcn): void
  233.     {
  234.         $this->formType = $formTypeFqcn;
  235.     }
  237.     public function getFormTypeOptions(): array
  238.     {
  239.         return $this->formTypeOptions->all();
  240.     }
  242.     public function getFormTypeOption(string $optionName)
  243.     {
  244.         return $this->formTypeOptions->get($optionName);
  245.     }
  247.     public function setFormTypeOptions(array $formTypeOptions): void
  248.     {
  249.         foreach ($formTypeOptions as $optionName => $optionValue) {
  250.             $this->setFormTypeOption($optionName, $optionValue);
  251.         }
  252.     }
  254.     /**
  255.      * @param string $optionName You can use "dot" notation to set nested options (e.g. 'attr.class')
  256.      */
  257.     public function setFormTypeOption(string $optionName, mixed $optionValue): void
  258.     {
  259.         $this->formTypeOptions->set($optionName, $optionValue);
  260.     }
  262.     /**
  263.      * @param string $optionName You can use "dot" notation to set nested options (e.g. 'attr.class')
  264.      */
  265.     public function setFormTypeOptionIfNotSet(string $optionName, mixed $optionValue): void
  266.     {
  267.         $this->formTypeOptions->setIfNotSet($optionName, $optionValue);
  268.     }
  270.     public function isSortable(): ?bool
  271.     {
  272.         return $this->sortable;
  273.     }
  275.     public function setSortable(bool $isSortable): void
  276.     {
  277.         $this->sortable = $isSortable;
  278.     }
  280.     public function isVirtual(): ?bool
  281.     {
  282.         return $this->virtual;
  283.     }
  285.     public function setVirtual(bool $isVirtual): void
  286.     {
  287.         $this->virtual = $isVirtual;
  288.     }
  290.     public function getTextAlign(): ?string
  291.     {
  292.         return $this->textAlign;
  293.     }
  295.     public function setTextAlign(string $textAlign): void
  296.     {
  297.         $this->textAlign = $textAlign;
  298.     }
  300.     public function getPermission(): string|Expression|null
  301.     {
  302.         return $this->permission;
  303.     }
  305.     public function setPermission(string|Expression $permission): void
  306.     {
  307.         $this->permission = $permission;
  308.     }
  310.     public function getHelp(): TranslatableInterface|string|null
  311.     {
  312.         return $this->help;
  313.     }
  315.     public function setHelp(TranslatableInterface|string $help): void
  316.     {
  317.         $this->help = $help;
  318.     }
  320.     public function getCssClass(): string
  321.     {
  322.         return $this->cssClass;
  323.     }
  325.     public function setCssClass(string $cssClass): void
  326.     {
  327.         $this->cssClass = trim($cssClass);
  328.     }
  330.     public function getColumns(): ?string
  331.     {
  332.         return $this->columns;
  333.     }
  335.     public function setColumns(?string $columnCssClasses): void
  336.     {
  337.         $this->columns = $columnCssClasses;
  338.     }
  340.     public function getDefaultColumns(): string
  341.     {
  342.         return $this->defaultColumns;
  343.     }
  345.     public function setDefaultColumns(string $columnCssClasses): void
  346.     {
  347.         $this->defaultColumns = $columnCssClasses;
  348.     }
  350.     public function getTranslationParameters(): array
  351.     {
  352.         return $this->translationParameters;
  353.     }
  355.     public function setTranslationParameters(array $translationParameters): void
  356.     {
  357.         $this->translationParameters = $translationParameters;
  358.     }
  360.     public function getTemplateName(): ?string
  361.     {
  362.         return $this->templateName;
  363.     }
  365.     public function setTemplateName(?string $templateName): void
  366.     {
  367.         $this->templateName = $templateName;
  368.     }
  370.     public function getTemplatePath(): ?string
  371.     {
  372.         return $this->templatePath;
  373.     }
  375.     public function setTemplatePath(?string $templatePath): void
  376.     {
  377.         $this->templatePath = $templatePath;
  378.     }
  380.     public function addFormTheme(string $formThemePath): void
  381.     {
  382.         $this->formThemePaths[] = $formThemePath;
  383.     }
  385.     public function getFormThemes(): array
  386.     {
  387.         return $this->formThemePaths;
  388.     }
  390.     public function setFormThemes(array $formThemePaths): void
  391.     {
  392.         $this->formThemePaths = $formThemePaths;
  393.     }
  395.     public function getAssets(): AssetsDto
  396.     {
  397.         return $this->assets;
  398.     }
  400.     public function setAssets(AssetsDto $assets): void
  401.     {
  402.         $this->assets = $assets;
  403.     }
  405.     public function addAssetMapperEncoreAsset(AssetDto $assetDto): void
  406.     {
  407.         $this->assets->addAssetMapperAsset($assetDto);
  408.     }
  410.     public function addWebpackEncoreAsset(AssetDto $assetDto): void
  411.     {
  412.         $this->assets->addWebpackEncoreAsset($assetDto);
  413.     }
  415.     public function addCssAsset(AssetDto $assetDto): void
  416.     {
  417.         $this->assets->addCssAsset($assetDto);
  418.     }
  420.     public function addJsAsset(AssetDto $assetDto): void
  421.     {
  422.         $this->assets->addJsAsset($assetDto);
  423.     }
  425.     public function addHtmlContentToHead(string $htmlContent): void
  426.     {
  427.         $this->assets->addHtmlContentToHead($htmlContent);
  428.     }
  430.     public function addHtmlContentToBody(string $htmlContent): void
  431.     {
  432.         $this->assets->addHtmlContentToBody($htmlContent);
  433.     }
  435.     public function getCustomOptions(): KeyValueStore
  436.     {
  437.         return $this->customOptions;
  438.     }
  440.     public function getCustomOption(string $optionName): mixed
  441.     {
  442.         return $this->customOptions->get($optionName);
  443.     }
  445.     public function setCustomOptions(array $customOptions): void
  446.     {
  447.         $this->customOptions = KeyValueStore::new($customOptions);
  448.     }
  450.     public function setCustomOption(string $optionName, mixed $optionValue): void
  451.     {
  452.         $this->customOptions->set($optionName, $optionValue);
  453.     }
  455.     public function getDoctrineMetadata(): KeyValueStore
  456.     {
  457.         return $this->doctrineMetadata;
  458.     }
  460.     public function setDoctrineMetadata(array $metadata): void
  461.     {
  462.         $this->doctrineMetadata = KeyValueStore::new($metadata);
  463.     }
  465.     public function getDisplayedOn(): KeyValueStore
  466.     {
  467.         return $this->displayedOn;
  468.     }
  470.     public function setDisplayedOn(KeyValueStore $displayedOn): void
  471.     {
  472.         $this->displayedOn = $displayedOn;
  473.     }
  475.     public function isDisplayedOn(string $pageName): bool
  476.     {
  477.         return $this->displayedOn->has($pageName);
  478.     }
  479. }