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

Open in your IDE?
  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 field entity.
  19. */
  20. class FormField
  21. {
  22. /**
  23. * @var string
  24. */
  25. private $key;
  27. /**
  28. * @var string
  29. */
  30. private $type;
  32. /**
  33. * @var string
  34. */
  35. private $width = 'full';
  37. /**
  38. * @var bool
  39. */
  40. private $required = false;
  42. /**
  43. * @var null|int
  44. */
  45. private $id;
  47. /**
  48. * @var int
  49. */
  50. private $order;
  52. /**
  53. * @var string
  54. */
  55. private $defaultLocale;
  57. /**
  58. * @var Collection<int, FormFieldTranslation>
  59. */
  60. private $translations;
  62. /**
  63. * @var Form
  64. */
  65. private $form;
  67. /**
  68. * Constructor.
  69. */
  70. public function __construct()
  71. {
  72. $this->translations = new ArrayCollection();
  73. }
  75. public function getDefaultLocale(): string
  76. {
  77. return $this->defaultLocale;
  78. }
  80. public function setDefaultLocale(string $defaultLocale): self
  81. {
  82. $this->defaultLocale = $defaultLocale;
  84. return $this;
  85. }
  87. public function getOrder(): int
  88. {
  89. return $this->order;
  90. }
  92. public function setOrder(int $order): self
  93. {
  94. $this->order = $order;
  96. return $this;
  97. }
  99. public function setKey(string $key): self
  100. {
  101. $this->key = $key;
  103. return $this;
  104. }
  106. public function getKey(): string
  107. {
  108. return $this->key;
  109. }
  111. public function setType(string $type): self
  112. {
  113. $this->type = $type;
  115. return $this;
  116. }
  118. public function getType(): string
  119. {
  120. return $this->type;
  121. }
  123. public function setWidth(string $width): self
  124. {
  125. $this->width = $width;
  127. return $this;
  128. }
  130. public function getWidth(): string
  131. {
  132. return $this->width;
  133. }
  135. public function setRequired(bool $required): self
  136. {
  137. $this->required = $required;
  139. return $this;
  140. }
  142. public function getRequired(): bool
  143. {
  144. return $this->required;
  145. }
  147. public function getId(): ?int
  148. {
  149. return $this->id;
  150. }
  152. /**
  153. * @return FormFieldTranslation|null
  154. */
  155. public function getTranslation(string $locale, bool $create = false, bool $fallback = false)
  156. {
  157. foreach ($this->translations as $translation) {
  158. if ($translation->getLocale() == $locale) {
  159. return $translation;
  160. }
  161. }
  163. if ($create) {
  164. $translation = new FormFieldTranslation();
  165. $translation->setLocale($locale);
  166. $this->addTranslation($translation);
  167. $translation->setField($this);
  169. return $translation;
  170. }
  172. if ($fallback) {
  173. return $this->getTranslation($this->getDefaultLocale());
  174. }
  176. return null;
  177. }
  179. public function addTranslation(FormFieldTranslation $translation): self
  180. {
  181. $this->translations[] = $translation;
  183. return $this;
  184. }
  186. public function removeTranslation(FormFieldTranslation $translation): void
  187. {
  188. $this->translations->removeElement($translation);
  189. }
  191. /**
  192. * @return Collection<int, FormFieldTranslation>
  193. */
  194. public function getTranslations()
  195. {
  196. return $this->translations;
  197. }
  199. public function setForm(Form $form): self
  200. {
  201. $this->form = $form;
  203. return $this;
  204. }
  206. public function getForm(): Form
  207. {
  208. return $this->form;
  209. }
  210. }