vendor/sulu/form-bundle/Form/Type/DynamicFormType.php line 27

  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Bundle\FormBundle\Form\Type;
  14. use Sulu\Bundle\FormBundle\Dynamic\Checksum;
  15. use Sulu\Bundle\FormBundle\Dynamic\FormFieldTypePool;
  16. use Sulu\Bundle\FormBundle\Entity\Dynamic;
  17. use Sulu\Bundle\FormBundle\Entity\Form;
  18. use Sulu\Bundle\FormBundle\Exception\FormNotFoundException;
  19. use Symfony\Component\Form\AbstractType;
  20. use Symfony\Component\Form\Extension\Core\Type\EmailType;
  21. use Symfony\Component\Form\Extension\Core\Type\HiddenType;
  22. use Symfony\Component\Form\Extension\Core\Type\SubmitType;
  23. use Symfony\Component\Form\FormBuilderInterface;
  24. use Symfony\Component\OptionsResolver\OptionsResolver;
  25. use Symfony\Component\Validator\Constraints\NotBlank;
  27. class DynamicFormType extends AbstractType
  28. {
  29.     /**
  30.      * @var FormFieldTypePool
  31.      */
  32.     private $typePool;
  34.     /**
  35.      * @var Checksum
  36.      */
  37.     private $checksum;
  39.     /**
  40.      * @var string|null
  41.      */
  42.     private $honeyPotField;
  44.     /**
  45.      * DynamicFormType constructor.
  46.      */
  47.     public function __construct(
  48.         FormFieldTypePool $typePool,
  49.         Checksum $checksum,
  50.         ?string $honeyPotField = null
  51.     ) {
  52.         $this->typePool = $typePool;
  53.         $this->checksum = $checksum;
  54.         $this->honeyPotField = $honeyPotField;
  55.     }
  57.     /**
  58.      * @return void
  59.      */
  60.     public function buildForm(FormBuilderInterface $builder, array $options)
  61.     {
  62.         /** @var Form $formEntity */
  63.         $formEntity = $options['formEntity'];
  64.         /** @var string $locale */
  65.         $locale = $options['locale'];
  66.         /** @var string $type */
  67.         $type = $options['type'];
  68.         /** @var string $typeId */
  69.         $typeId = $options['typeId'];
  70.         /** @var string $name */
  71.         $name = $options['name'];
  73.         if (!$translation = $formEntity->getTranslation($locale)) {
  74.             throw new FormNotFoundException($formEntity->getId(), $locale);
  75.         }
  77.         $currentWidthValue = 0;
  78.         $fields = $formEntity->getFields();
  80.         foreach ($fields as $key => $field) {
  81.             $fieldTranslation = $field->getTranslation($locale);
  83.             if (!$fieldTranslation) {
  84.                 continue;
  85.             }
  87.             $options = [
  88.                 'constraints' => [],
  89.                 'attr' => [],
  90.                 'translation_domain' => false,
  91.                 'property_path' => 'data[' . $field->getKey() . ']',
  92.             ];
  94.             $title = $fieldTranslation->getTitle();
  95.             $placeholder = $fieldTranslation->getPlaceholder();
  96.             $width = $field->getWidth() ?: 'full';
  98.             $nextField = null;
  99.             $nextWidth = 'full';
  100.             if (isset($fields[$key + 1])) {
  101.                 $nextWidth = $fields[$key + 1]->getWidth();
  102.             }
  104.             $lastWidth = $this->getLastWidth($currentWidthValue, $width, $nextWidth);
  106.             $options['label'] = $title ?: false;
  107.             $options['required'] = $field->getRequired();
  108.             $options['attr']['width'] = $width;
  109.             $options['attr']['widthNumber'] = $this->getItemWidthNumber($width);
  110.             $options['attr']['lastWidth'] = $lastWidth;
  112.             if ($placeholder) {
  113.                 $options['attr']['placeholder'] = $placeholder;
  114.             }
  116.             // required
  117.             if ($field->getRequired()) {
  118.                 $options['constraints'][] = new NotBlank();
  119.             }
  121.             $this->typePool->get($field->getType())->build($builder, $field, $locale, $options);
  122.         }
  124.         // Add hidden locale. (de, en, ...)
  125.         $builder->add('locale', HiddenType::class, [
  126.             'data' => $locale,
  127.             'mapped' => false,
  128.         ]);
  130.         // Add hidden type field. (page, article, event, blog, ...)
  131.         $builder->add('type', HiddenType::class, [
  132.             'data' => $type,
  133.             'mapped' => false,
  134.         ]);
  136.         // Add hidden typeId field. (UUID, Database id, ...)
  137.         $builder->add('typeId', HiddenType::class, [
  138.             'data' => $typeId,
  139.             'mapped' => false,
  140.         ]);
  142.         // Add hidden formId. (id, uuid,…)
  143.         $builder->add('formId', HiddenType::class, [
  144.             'data' => $formEntity->getId(),
  145.             'mapped' => false,
  146.         ]);
  148.         // Add hidden formName field. (Name of "form_select"-content-type.)
  149.         $builder->add('formName', HiddenType::class, [
  150.             'data' => $name,
  151.             'mapped' => false,
  152.         ]);
  154.         // Add hidden formName field. (Name of "form_select"-content-type.)
  155.         $checksum = $this->checksum->get($type, $typeId, $formEntity->getId(), $name);
  156.         $builder->add('checksum', HiddenType::class, [
  157.             'data' => $checksum,
  158.             'mapped' => false,
  159.         ]);
  161.         if ($this->honeyPotField) {
  162.             $builder->add(
  163.                 \str_replace(' ', '_', \strtolower($this->honeyPotField)),
  164.                 EmailType::class,
  165.                 [
  166.                     'label' => $this->honeyPotField,
  167.                     'mapped' => false,
  168.                     'block_prefix' => 'honeypot',
  169.                     'required' => false,
  170.                 ]
  171.             );
  172.         }
  174.         // Add submit button.
  175.         $builder->add(
  176.             'submit',
  177.             SubmitType::class,
  178.             [
  179.                 'label' => $translation->getSubmitLabel(),
  180.                 'translation_domain' => false,
  181.                 'attr' => [
  182.                     'width' => 'full',
  183.                     'widthNumber' => $this->getItemWidthNumber('full'),
  184.                     'lastWidth' => true,
  185.                 ],
  186.             ]
  187.         );
  188.     }
  190.     /**
  191.      * @return void
  192.      */
  193.     public function configureOptions(OptionsResolver $resolver)
  194.     {
  195.         $defaults = [];
  197.         $defaults['csrf_protection'] = true;
  198.         $defaults['csrf_field_name'] = '_token';
  199.         $defaults['data_class'] = Dynamic::class;
  201.         $resolver->setDefaults($defaults);
  203.         $resolver->setRequired('locale');
  204.         $resolver->setRequired('type');
  205.         $resolver->setRequired('typeId');
  206.         $resolver->setRequired('name');
  207.         $resolver->setRequired('formEntity');
  208.     }
  210.     public function getBlockPrefix()
  211.     {
  212.         return 'dynamic';
  213.     }
  215.     private function getItemWidthNumber(string $width): int
  216.     {
  217.         switch ($width) {
  218.             case 'one-sixth':
  219.                 $itemWidth = 2;
  220.                 break;
  221.             case 'five-sixths':
  222.                 $itemWidth = 10;
  223.                 break;
  224.             case 'one-quarter':
  225.                 $itemWidth = 3;
  226.                 break;
  227.             case 'three-quarters':
  228.                 $itemWidth = 9;
  229.                 break;
  230.             case 'one-third':
  231.                 $itemWidth = 4;
  232.                 break;
  233.             case 'two-thirds':
  234.                 $itemWidth = 8;
  235.                 break;
  236.             case 'half':
  237.                 $itemWidth = 6;
  238.                 break;
  239.             case 'full':
  240.                 $itemWidth = 12;
  241.                 break;
  242.             default:
  243.                 $itemWidth = 12;
  244.         }
  246.         return $itemWidth;
  247.     }
  249.     private function getLastWidth(int &$currentWidthValue, string $width, string $nextWidth): bool
  250.     {
  251.         $widthNumber = $this->getItemWidthNumber($width);
  252.         $nextWidthNumber = $this->getItemWidthNumber($nextWidth);
  254.         $currentWidthValue += $widthNumber;
  256.         if (0 == $currentWidthValue % 12) {
  257.             return true;
  258.         }
  260.         // if next item has no space in current row the current item is last
  261.         if (($currentWidthValue % 12) + $nextWidthNumber > 12) {
  262.             $currentWidthValue += 12 - $currentWidthValue % 12;
  264.             return true;
  265.         }
  267.         return false;
  268.     }
  269. }