vendor/sulu/form-bundle/Entity/Form.php line 20

  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\Entity;
  14. use Doctrine\Common\Collections\ArrayCollection;
  15. use Doctrine\Common\Collections\Collection;
  17. /**
  18.  * Form entity.
  19.  */
  20. class Form
  21. {
  22.     public const RESOURCE_KEY = 'forms';
  24.     /**
  25.      * @var null|int
  26.      */
  27.     private $id;
  29.     /**
  30.      * @var string
  31.      */
  32.     private $defaultLocale;
  34.     /**
  35.      * @var Collection<int, FormTranslation>
  36.      */
  37.     private $translations;
  39.     /**
  40.      * @var Collection<int, FormField>
  41.      */
  42.     private $fields;
  44.     public function __construct()
  45.     {
  46.         $this->translations = new ArrayCollection();
  47.         $this->fields = new ArrayCollection();
  48.     }
  50.     public function getId(): ?int
  51.     {
  52.         return $this->id;
  53.     }
  55.     public function getDefaultLocale(): string
  56.     {
  57.         return $this->defaultLocale;
  58.     }
  60.     public function setDefaultLocale(string $defaultLocale): self
  61.     {
  62.         $this->defaultLocale = $defaultLocale;
  64.         return $this;
  65.     }
  67.     public function addTranslation(FormTranslation $translation): self
  68.     {
  69.         $this->translations[] = $translation;
  71.         return $this;
  72.     }
  74.     public function removeTranslation(FormTranslation $translation): self
  75.     {
  76.         $this->translations->removeElement($translation);
  78.         return $this;
  79.     }
  81.     /**
  82.      * Get translations.
  83.      *
  84.      * @return Collection<int, FormTranslation>
  85.      */
  86.     public function getTranslations()
  87.     {
  88.         return $this->translations;
  89.     }
  91.     public function getTranslation(string $locale, bool $create = false, bool $fallback = false): ?FormTranslation
  92.     {
  93.         foreach ($this->translations as $translation) {
  94.             if ($translation->getLocale() == $locale) {
  95.                 return $translation;
  96.             }
  97.         }
  99.         if ($create) {
  100.             $translation = new FormTranslation();
  101.             $translation->setLocale($locale);
  102.             $this->addTranslation($translation);
  103.             $translation->setForm($this);
  105.             return $translation;
  106.         }
  108.         if ($fallback) {
  109.             return $this->getTranslation($this->getDefaultLocale());
  110.         }
  112.         return null;
  113.     }
  115.     public function addField(FormField $field): self
  116.     {
  117.         $this->fields[] = $field;
  119.         return $this;
  120.     }
  122.     public function removeField(FormField $field): self
  123.     {
  124.         $this->fields->removeElement($field);
  126.         return $this;
  127.     }
  129.     /**
  130.      * @return Collection<int, FormField>
  131.      */
  132.     public function getFields()
  133.     {
  134.         return $this->fields;
  135.     }
  137.     /**
  138.      * @return FormField[]
  139.      */
  140.     public function getFieldsByType(string $type): array
  141.     {
  142.         $fields = [];
  144.         foreach ($this->fields as $field) {
  145.             if ($field->getType() === $type) {
  146.                 $fields[] = $field;
  147.             }
  148.         }
  150.         return $fields;
  151.     }
  153.     public function getField(?string $key): ?FormField
  154.     {
  155.         foreach ($this->fields as $field) {
  156.             if ($field->getKey() == $key) {
  157.                 return $field;
  158.             }
  159.         }
  161.         return null;
  162.     }
  164.     public function getFieldType(string $key): ?string
  165.     {
  166.         $field = $this->getField($key);
  168.         if (!$field) {
  169.             return null;
  170.         }
  172.         return $field->getType();
  173.     }
  175.     /**
  176.      * Get fields not in array.
  177.      *
  178.      * @param string[] $keys
  179.      *
  180.      * @return FormField[]
  181.      */
  182.     public function getFieldsNotInArray(array $keys): array
  183.     {
  184.         $fields = [];
  186.         foreach ($this->fields as $field) {
  187.             if (!\in_array($field->getKey(), $keys)) {
  188.                 $fields[] = $field;
  189.             }
  190.         }
  192.         return $fields;
  193.     }
  195.     /**
  196.      * Return a localized array of the object.
  197.      *
  198.      * @return mixed[]
  199.      */
  200.     public function serializeForLocale(string $locale, ?Dynamic $dynamic = null): array
  201.     {
  202.         $fields = [];
  204.         foreach ($this->fields as $field) {
  205.             $fieldTranslation = $field->getTranslation($locale, false, true);
  206.             $value = null;
  208.             if ($dynamic) {
  209.                 $value = $dynamic->getField($field->getKey());
  210.             }
  212.             $fields[$field->getOrder()] = [
  213.                 'key' => $field->getKey(),
  214.                 'type' => $field->getType(),
  215.                 'title' => $fieldTranslation->getTitle(),
  216.                 'options' => $fieldTranslation->getOptions(),
  217.                 'defaultValue' => $fieldTranslation->getDefaultValue(),
  218.                 'placeholder' => $fieldTranslation->getPlaceholder(),
  219.                 'shortTitle' => $fieldTranslation->getShortTitle(),
  220.                 'value' => $value,
  221.             ];
  223.             \ksort($fields);
  224.         }
  226.         $translation = $this->getTranslation($locale, false, true);
  228.         return [
  229.             'id' => $dynamic ? $dynamic->getId() : null,
  230.             'formId' => $this->getId(),
  231.             'title' => $translation->getTitle(),
  232.             'subject' => $translation->getSubject(),
  233.             'mailText' => $translation->getMailText(),
  234.             'submitLabel' => $translation->getSubmitLabel(),
  235.             'successText' => $translation->getSuccessText(),
  236.             'fromEmail' => $translation->getFromEmail(),
  237.             'fromName' => $translation->getFromName(),
  238.             'toEmail' => $translation->getToEmail(),
  239.             'toName' => $translation->getToName(),
  240.             'fields' => $fields,
  241.             'created' => $dynamic ? $dynamic->getCreated() : null,
  242.         ];
  243.     }
  244. }