vendor/easycorp/easyadmin-bundle/src/Field/FormField.php line 44

Open in your IDE?
  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Field;
  5. use EasyCorp\Bundle\EasyAdminBundle\Contracts\Field\FieldInterface;
  6. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\EaFormRowType;
  7. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormColumnOpenType;
  8. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormFieldsetOpenType;
  9. use EasyCorp\Bundle\EasyAdminBundle\Form\Type\Layout\EaFormTabPaneOpenType;
  10. use Symfony\Component\Uid\Ulid;
  11. use Symfony\Contracts\Translation\TranslatableInterface;
  13. /**
  14.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  15.  */
  16. final class FormField implements FieldInterface
  17. {
  18.     use FieldTrait;
  20.     public const OPTION_ICON = 'icon';
  21.     public const OPTION_COLLAPSIBLE = 'collapsible';
  22.     public const OPTION_COLLAPSED = 'collapsed';
  23.     public const OPTION_ROW_BREAKPOINT = 'rowBreakPoint';
  24.     public const OPTION_TAB_ID = 'tabId';
  25.     public const OPTION_TAB_IS_ACTIVE = 'tabIsActive';
  26.     public const OPTION_TAB_ERROR_COUNT = 'tabErrorCount';
  28.     /**
  29.      * @internal Use the other named constructors instead (addPanel(), etc.)
  30.      *
  31.      * @param TranslatableInterface|string|false|null $label
  32.      */
  33.     public static function new(string $propertyName, $label = null)
  34.     {
  35.         throw new \RuntimeException('Instead of this method, use the "addPanel()" method.');
  36.     }
  38.     /**
  39.      * @param TranslatableInterface|string|false|null $label
  40.      * @param string|null                             $icon  The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
  41.      */
  42.     public static function addPanel($label = false, ?string $icon = null): self
  43.     {
  44.         trigger_deprecation(
  45.             'easycorp/easyadmin-bundle',
  46.             '4.7.7',
  47.             '"FormField::addPanel()" has been deprecated in favor of "FormField::addFieldset()" and it will be removed in 5.0.0.',
  48.         );
  50.         return self::addFieldset($label, $icon);
  51.     }
  53.     /**
  54.      * @param TranslatableInterface|string|false|null $label
  55.      * @param string|null                             $icon  The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
  56.      */
  57.     public static function addFieldset($label = false, ?string $icon = null): self
  58.     {
  59.         $field = new self();
  60.         $icon = $field->fixIconFormat($icon, 'FormField::addFieldset()');
  62.         return $field
  63.             ->setFieldFqcn(__CLASS__)
  64.             ->hideOnIndex()
  65.             ->setProperty('ea_form_fieldset_'.(new Ulid()))
  66.             ->setLabel($label)
  67.             ->setFormType(EaFormFieldsetOpenType::class)
  68.             ->addCssClass('field-form_fieldset')
  69.             ->setFormTypeOptions(['mapped' => false, 'required' => false])
  70.             ->setCustomOption(self::OPTION_ICON, $icon)
  71.             ->setCustomOption(self::OPTION_COLLAPSIBLE, false)
  72.             ->setCustomOption(self::OPTION_COLLAPSED, false)
  73.             ->setValue(true);
  74.     }
  76.     /**
  77.      * @param string $breakpointName The name of the breakpoint where the new row is inserted
  78.      *                               It must be a valid Bootstrap 5 name ('', 'sm', 'md', 'lg', 'xl', 'xxl')
  79.      */
  80.     public static function addRow(string $breakpointName = ''): self
  81.     {
  82.         $field = new self();
  84.         $validBreakpointNames = ['', 'sm', 'md', 'lg', 'xl', 'xxl'];
  85.         if (!\in_array($breakpointName, $validBreakpointNames, true)) {
  86.             throw new \InvalidArgumentException(sprintf('The value passed to the "addRow()" method of "FormField" can only be one of these values: "%s" ("%s" was given).', implode(', ', $validBreakpointNames), $breakpointName));
  87.         }
  89.         return $field
  90.             ->setFieldFqcn(__CLASS__)
  91.             ->hideOnIndex()
  92.             ->setProperty('ea_form_row_'.(new Ulid()))
  93.             ->setFormType(EaFormRowType::class)
  94.             ->addCssClass('field-form_row')
  95.             ->setFormTypeOptions(['mapped' => false, 'required' => false])
  96.             ->setCustomOption(self::OPTION_ROW_BREAKPOINT, $breakpointName)
  97.             ->setValue(true);
  98.     }
  100.     /**
  101.      * @return static
  102.      */
  103.     public static function addTab(TranslatableInterface|string|false|null $label = null, ?string $icon = null): self
  104.     {
  105.         $field = new self();
  106.         $icon = $field->fixIconFormat($icon, 'FormField::addTab()');
  108.         return $field
  109.             ->setFieldFqcn(__CLASS__)
  110.             ->hideOnIndex()
  111.             ->setProperty('ea_form_tab_'.(new Ulid()))
  112.             ->setLabel($label)
  113.             ->setFormType(EaFormTabPaneOpenType::class)
  114.             ->addCssClass('field-form_tab')
  115.             ->setFormTypeOptions(['mapped' => false, 'required' => false])
  116.             ->setCustomOption(self::OPTION_ICON, $icon)
  117.             ->setCustomOption(self::OPTION_TAB_ERROR_COUNT, 0)
  118.             ->setValue(true);
  119.     }
  121.     /**
  122.      * @param int|string $cols Any value compatible with Bootstrap grid system
  123.      *                         (https://getbootstrap.com/docs/5.3/layout/grid/)
  124.      *                         (e.g. 'col-6', 'col-sm-3', 'col-md-6 col-xl-4', etc.)
  125.      *                         (integer values are transformed like this: N -> 'col-N')
  126.      */
  127.     public static function addColumn(int|string $cols = 'col', TranslatableInterface|string|false|null $label = null, ?string $icon = null, ?string $help = null): self
  128.     {
  129.         $field = new self();
  130.         // $icon = $field->fixIconFormat($icon, 'FormField::addTab()');
  132.         return $field
  133.             ->setFieldFqcn(__CLASS__)
  134.             ->hideOnIndex()
  135.             ->setProperty('ea_form_column_'.(new Ulid()))
  136.             ->setLabel($label)
  137.             ->setFormType(EaFormColumnOpenType::class)
  138.             ->addCssClass(sprintf('field-form_column %s', \is_int($cols) ? 'col-md-'.$cols : $cols))
  139.             ->setFormTypeOptions(['mapped' => false, 'required' => false])
  140.             ->setCustomOption(self::OPTION_ICON, $icon)
  141.             ->setValue(true);
  142.     }
  144.     public function setIcon(string $iconCssClass): self
  145.     {
  146.         $iconCssClass = $this->fixIconFormat($iconCssClass, 'FormField::setIcon()');
  147.         $this->setCustomOption(self::OPTION_ICON, $iconCssClass);
  149.         return $this;
  150.     }
  152.     public function collapsible(bool $collapsible = true): self
  153.     {
  154.         if (!$this->hasLabelOrIcon()) {
  155.             throw new \InvalidArgumentException(sprintf('The %s() method used in one of your fieldsets requires that the fieldset defines either a label or an icon, but it defines none of them.', __METHOD__));
  156.         }
  158.         $this->setCustomOption(self::OPTION_COLLAPSIBLE, $collapsible);
  160.         return $this;
  161.     }
  163.     public function renderCollapsed(bool $collapsed = true): self
  164.     {
  165.         if (!$this->hasLabelOrIcon()) {
  166.             throw new \InvalidArgumentException(sprintf('The %s() method used in one of your fieldsets requires that the fieldset defines either a label or an icon, but it defines none of them.', __METHOD__));
  167.         }
  169.         $this->setCustomOption(self::OPTION_COLLAPSIBLE, true);
  170.         $this->setCustomOption(self::OPTION_COLLAPSED, $collapsed);
  172.         return $this;
  173.     }
  175.     private function hasLabelOrIcon(): bool
  176.     {
  177.         // don't use empty() because the label can contain only white spaces (it's a valid edge-case)
  178.         return (null !== $this->dto->getLabel() && '' !== $this->dto->getLabel())
  179.             || null !== $this->dto->getCustomOption(self::OPTION_ICON);
  180.     }
  182.     private function fixIconFormat(?string $icon, string $methodName): ?string
  183.     {
  184.         if (null === $icon) {
  185.             return $icon;
  186.         }
  188.         if (!str_contains($icon, 'fa-') && !str_contains($icon, 'far-') && !str_contains($icon, 'fab-')) {
  189.             trigger_deprecation('easycorp/easyadmin-bundle', '4.4.0', 'The value passed as the $icon argument in "%s" method must be the full FontAwesome CSS class of the icon. For example, if you passed "user" before, you now must pass "fa fa-user" (or any style variant like "fa fa-solid fa-user").', $methodName);
  191.             $icon = sprintf('fa fa-%s', $icon);
  192.         }
  194.         return $icon;
  195.     }
  196. }