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

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Dto;
  5. use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
  6. use EasyCorp\Bundle\EasyAdminBundle\Config\KeyValueStore;
  7. use function Symfony\Component\String\u;
  8. use Symfony\Component\Uid\Ulid;
  9. use Symfony\Contracts\Translation\TranslatableInterface;
  11. /**
  12.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  13.  */
  14. final class FieldDto
  15. {
  16.     private ?string $fieldFqcn = null;
  17.     private ?string $propertyName = null;
  18.     private mixed $value = null;
  19.     private mixed $formattedValue = null;
  20.     private $formatValueCallable;
  21.     private $label;
  22.     private ?string $formType = null;
  23.     private KeyValueStore $formTypeOptions;
  24.     private ?bool $sortable = null;
  25.     private ?bool $virtual = null;
  26.     private ?string $permission = null;
  27.     private ?string $textAlign = null;
  28.     private $help;
  29.     private string $cssClass = '';
  30.     // how many columns the field takes when rendering
  31.     // (defined as Bootstrap 5 grid classes; e.g. 'col-md-6 col-xxl-3')
  32.     private ?string $columns = null;
  33.     // same as $columns but used when the user doesn't define columns explicitly
  34.     private string $defaultColumns = '';
  35.     private array $translationParameters = [];
  36.     private ?string $templateName = 'crud/field/text';
  37.     private ?string $templatePath = null;
  38.     private array $formThemePaths = [];
  39.     private AssetsDto $assets;
  40.     private KeyValueStore $customOptions;
  41.     private KeyValueStore $doctrineMetadata;
  42.     /** @internal */
  43.     private $uniqueId;
  44.     private KeyValueStore $displayedOn;
  46.     public function __construct()
  47.     {
  48.         $this->uniqueId = new Ulid();
  49.         $this->assets = new AssetsDto();
  50.         $this->formTypeOptions = KeyValueStore::new();
  51.         $this->customOptions = KeyValueStore::new();
  52.         $this->doctrineMetadata = KeyValueStore::new();
  53.         $this->displayedOn = KeyValueStore::new([
  54.             Crud::PAGE_INDEX => Crud::PAGE_INDEX,
  55.             Crud::PAGE_DETAIL => Crud::PAGE_DETAIL,
  56.             Crud::PAGE_EDIT => Crud::PAGE_EDIT,
  57.             Crud::PAGE_NEW => Crud::PAGE_NEW,
  58.         ]);
  59.     }
  61.     public function __clone()
  62.     {
  63.         $this->uniqueId = new Ulid();
  64.         $this->assets = clone $this->assets;
  65.         $this->formTypeOptions = clone $this->formTypeOptions;
  66.         $this->customOptions = clone $this->customOptions;
  67.         $this->doctrineMetadata = clone $this->doctrineMetadata;
  68.         $this->displayedOn = clone $this->displayedOn;
  69.     }
  71.     public function getUniqueId(): string
  72.     {
  73.         return $this->uniqueId;
  74.     }
  76.     public function setUniqueId(string $uniqueId): void
  77.     {
  78.         $this->uniqueId = $uniqueId;
  79.     }
  81.     public function isFormDecorationField(): bool
  82.     {
  83.         return u($this->getCssClass())->containsAny(['field-form_panel', 'field-form_tab']);
  84.     }
  86.     public function getFieldFqcn(): ?string
  87.     {
  88.         return $this->fieldFqcn;
  89.     }
  91.     /**
  92.      * @internal Don't use this method yourself. EasyAdmin uses it internally
  93.      *           to set the field FQCN. It's OK to use getFieldFqcn() to get this value.
  94.      */
  95.     public function setFieldFqcn(string $fieldFqcn): void
  96.     {
  97.         $this->fieldFqcn = $fieldFqcn;
  98.     }
  100.     public function getProperty(): string
  101.     {
  102.         return $this->propertyName;
  103.     }
  105.     public function setProperty(string $propertyName): void
  106.     {
  107.         $this->propertyName = $propertyName;
  108.     }
  110.     /**
  111.      * Returns the original unmodified value stored in the entity field.
  112.      */
  113.     public function getValue(): mixed
  114.     {
  115.         return $this->value;
  116.     }
  118.     public function setValue(mixed $value): void
  119.     {
  120.         $this->value = $value;
  121.     }
  123.     /**
  124.      * Returns the value to be displayed for the field (it could be the
  125.      * same as the value stored in the field or not).
  126.      */
  127.     public function getFormattedValue(): mixed
  128.     {
  129.         return $this->formattedValue;
  130.     }
  132.     public function setFormattedValue(mixed $formattedValue): void
  133.     {
  134.         $this->formattedValue = $formattedValue;
  135.     }
  137.     public function getFormatValueCallable(): ?callable
  138.     {
  139.         return $this->formatValueCallable;
  140.     }
  142.     public function setFormatValueCallable(?callable $callable): void
  143.     {
  144.         $this->formatValueCallable = $callable;
  145.     }
  147.     /**
  148.      * @return TranslatableInterface|string|false|null
  149.      */
  150.     public function getLabel()/* : TranslatableInterface|string|false|null */
  151.     {
  152.         return $this->label;
  153.     }
  155.     public function setLabel(/* @var TranslatableInterface|string|false|null */ $label): void
  156.     {
  157.         if (!\is_string($label) && !$label instanceof TranslatableInterface && false !== $label && null !== $label) {
  158.             trigger_deprecation(
  159.                 'easycorp/easyadmin-bundle',
  160.                 '4.0.5',
  161.                 'Argument "%s" for "%s" must be one of these types: %s. Passing type "%s" will cause an error in 5.0.0.',
  162.                 '$label',
  163.                 __METHOD__,
  164.                 '"TranslatableInterface", "string", "false" or "null"',
  165.                 \gettype($label)
  166.             );
  167.         }
  169.         $this->label = $label;
  170.     }
  172.     public function getFormType(): ?string
  173.     {
  174.         return $this->formType;
  175.     }
  177.     public function setFormType(string $formTypeFqcn): void
  178.     {
  179.         $this->formType = $formTypeFqcn;
  180.     }
  182.     public function getFormTypeOptions(): array
  183.     {
  184.         return $this->formTypeOptions->all();
  185.     }
  187.     public function getFormTypeOption(string $optionName)
  188.     {
  189.         return $this->formTypeOptions->get($optionName);
  190.     }
  192.     public function setFormTypeOptions(array $formTypeOptions): void
  193.     {
  194.         foreach ($formTypeOptions as $optionName => $optionValue) {
  195.             $this->setFormTypeOption($optionName, $optionValue);
  196.         }
  197.     }
  199.     /**
  200.      * @param string $optionName You can use "dot" notation to set nested options (e.g. 'attr.class')
  201.      */
  202.     public function setFormTypeOption(string $optionName, mixed $optionValue): void
  203.     {
  204.         $this->formTypeOptions->set($optionName, $optionValue);
  205.     }
  207.     /**
  208.      * @param string $optionName You can use "dot" notation to set nested options (e.g. 'attr.class')
  209.      */
  210.     public function setFormTypeOptionIfNotSet(string $optionName, mixed $optionValue): void
  211.     {
  212.         $this->formTypeOptions->setIfNotSet($optionName, $optionValue);
  213.     }
  215.     public function isSortable(): ?bool
  216.     {
  217.         return $this->sortable;
  218.     }
  220.     public function setSortable(bool $isSortable): void
  221.     {
  222.         $this->sortable = $isSortable;
  223.     }
  225.     public function isVirtual(): ?bool
  226.     {
  227.         return $this->virtual;
  228.     }
  230.     public function setVirtual(bool $isVirtual): void
  231.     {
  232.         $this->virtual = $isVirtual;
  233.     }
  235.     public function getTextAlign(): ?string
  236.     {
  237.         return $this->textAlign;
  238.     }
  240.     public function setTextAlign(string $textAlign): void
  241.     {
  242.         $this->textAlign = $textAlign;
  243.     }
  245.     public function getPermission(): ?string
  246.     {
  247.         return $this->permission;
  248.     }
  250.     public function setPermission(string $permission): void
  251.     {
  252.         $this->permission = $permission;
  253.     }
  255.     public function getHelp(): TranslatableInterface|string|null
  256.     {
  257.         return $this->help;
  258.     }
  260.     public function setHelp(TranslatableInterface|string $help): void
  261.     {
  262.         $this->help = $help;
  263.     }
  265.     public function getCssClass(): string
  266.     {
  267.         return $this->cssClass;
  268.     }
  270.     public function setCssClass(string $cssClass): void
  271.     {
  272.         $this->cssClass = trim($cssClass);
  273.     }
  275.     public function getColumns(): ?string
  276.     {
  277.         return $this->columns;
  278.     }
  280.     public function setColumns(?string $columnCssClasses): void
  281.     {
  282.         $this->columns = $columnCssClasses;
  283.     }
  285.     public function getDefaultColumns(): string
  286.     {
  287.         return $this->defaultColumns;
  288.     }
  290.     public function setDefaultColumns(string $columnCssClasses): void
  291.     {
  292.         $this->defaultColumns = $columnCssClasses;
  293.     }
  295.     public function getTranslationParameters(): array
  296.     {
  297.         return $this->translationParameters;
  298.     }
  300.     public function setTranslationParameters(array $translationParameters): void
  301.     {
  302.         $this->translationParameters = $translationParameters;
  303.     }
  305.     public function getTemplateName(): ?string
  306.     {
  307.         return $this->templateName;
  308.     }
  310.     public function setTemplateName(?string $templateName): void
  311.     {
  312.         $this->templateName = $templateName;
  313.     }
  315.     public function getTemplatePath(): ?string
  316.     {
  317.         return $this->templatePath;
  318.     }
  320.     public function setTemplatePath(?string $templatePath): void
  321.     {
  322.         $this->templatePath = $templatePath;
  323.     }
  325.     public function addFormTheme(string $formThemePath): void
  326.     {
  327.         $this->formThemePaths[] = $formThemePath;
  328.     }
  330.     public function getFormThemes(): array
  331.     {
  332.         return $this->formThemePaths;
  333.     }
  335.     public function setFormThemes(array $formThemePaths): void
  336.     {
  337.         $this->formThemePaths = $formThemePaths;
  338.     }
  340.     public function getAssets(): AssetsDto
  341.     {
  342.         return $this->assets;
  343.     }
  345.     public function setAssets(AssetsDto $assets): void
  346.     {
  347.         $this->assets = $assets;
  348.     }
  350.     public function addWebpackEncoreAsset(AssetDto $assetDto): void
  351.     {
  352.         $this->assets->addWebpackEncoreAsset($assetDto);
  353.     }
  355.     public function addCssAsset(AssetDto $assetDto): void
  356.     {
  357.         $this->assets->addCssAsset($assetDto);
  358.     }
  360.     public function addJsAsset(AssetDto $assetDto): void
  361.     {
  362.         $this->assets->addJsAsset($assetDto);
  363.     }
  365.     public function addHtmlContentToHead(string $htmlContent): void
  366.     {
  367.         $this->assets->addHtmlContentToHead($htmlContent);
  368.     }
  370.     public function addHtmlContentToBody(string $htmlContent): void
  371.     {
  372.         $this->assets->addHtmlContentToBody($htmlContent);
  373.     }
  375.     public function getCustomOptions(): KeyValueStore
  376.     {
  377.         return $this->customOptions;
  378.     }
  380.     public function getCustomOption(string $optionName): mixed
  381.     {
  382.         return $this->customOptions->get($optionName);
  383.     }
  385.     public function setCustomOptions(array $customOptions): void
  386.     {
  387.         $this->customOptions = KeyValueStore::new($customOptions);
  388.     }
  390.     public function setCustomOption(string $optionName, mixed $optionValue): void
  391.     {
  392.         $this->customOptions->set($optionName, $optionValue);
  393.     }
  395.     public function getDoctrineMetadata(): KeyValueStore
  396.     {
  397.         return $this->doctrineMetadata;
  398.     }
  400.     public function setDoctrineMetadata(array $metadata): void
  401.     {
  402.         $this->doctrineMetadata = KeyValueStore::new($metadata);
  403.     }
  405.     public function getDisplayedOn(): KeyValueStore
  406.     {
  407.         return $this->displayedOn;
  408.     }
  410.     public function setDisplayedOn(KeyValueStore $displayedOn): void
  411.     {
  412.         $this->displayedOn = $displayedOn;
  413.     }
  415.     public function isDisplayedOn(string $pageName): bool
  416.     {
  417.         return $this->displayedOn->has($pageName);
  418.     }
  419. }