vendor/lexik/translation-bundle/Model/TransUnit.php line 15

Open in your IDE?
  1. <?php
  3. namespace Lexik\Bundle\TranslationBundle\Model;
  5. use Doctrine\Common\Collections\Collection;
  6. use Doctrine\Common\Collections\ArrayCollection;
  7. use Lexik\Bundle\TranslationBundle\Manager\TranslationInterface;
  8. use Symfony\Component\Validator\Constraints as Assert;
  10. /**
  11. * This class represent a trans unit which contain translations for a given domain and key.
  12. *
  13. * @author Cédric Girard <c.girard@lexik.fr>
  14. */
  15. abstract class TransUnit
  16. {
  17. /**
  18. * @var int
  19. */
  20. protected $id;
  22. /**
  23. * @var string
  24. *
  25. * @Assert\NotBlank()
  26. */
  27. protected $key;
  29. /**
  30. * @var string
  31. *
  32. * @Assert\NotBlank()
  33. */
  34. protected $domain;
  36. /**
  37. * @var \Doctrine\Common\Collections\Collection
  38. */
  39. protected $translations;
  41. /**
  42. * @var \DateTime
  43. */
  44. protected $createdAt;
  46. /**
  47. * @var \DateTime
  48. */
  49. protected $updatedAt;
  51. /**
  52. * Construct.
  53. */
  54. public function __construct()
  55. {
  56. $this->domain = 'messages';
  57. $this->translations = new ArrayCollection();
  58. }
  60. /**
  61. * Get id
  62. *
  63. * @return integer
  64. */
  65. public function getId()
  66. {
  67. return $this->id;
  68. }
  70. /**
  71. * Set key name
  72. *
  73. * @param string $key
  74. */
  75. public function setKey($key)
  76. {
  77. $this->key = $key;
  78. }
  80. /**
  81. * Get key name
  82. *
  83. * @return string
  84. */
  85. public function getKey()
  86. {
  87. return $this->key;
  88. }
  90. /**
  91. * Set domain
  92. *
  93. * @param string $domain
  94. */
  95. public function setDomain($domain)
  96. {
  97. $this->domain = $domain;
  98. }
  100. /**
  101. * Get domain
  102. *
  103. * @return string
  104. */
  105. public function getDomain()
  106. {
  107. return $this->domain;
  108. }
  110. /**
  111. * Add translations
  112. *
  113. * @param \Lexik\Bundle\TranslationBundle\Model\Translation $translations
  114. */
  115. public function addTranslation(\Lexik\Bundle\TranslationBundle\Model\Translation $translation)
  116. {
  117. $this->translations[] = $translation;
  118. }
  120. /**
  121. * Remove translations
  122. *
  123. * @param \Lexik\Bundle\TranslationBundle\Model\Translation $translations
  124. */
  125. public function removeTranslation(\Lexik\Bundle\TranslationBundle\Model\Translation $translation)
  126. {
  127. $this->translations->removeElement($translation);
  128. }
  130. /**
  131. * Get translations
  132. *
  133. * @return \Doctrine\Common\Collections\Collection
  134. */
  135. public function getTranslations()
  136. {
  137. return $this->translations;
  138. }
  140. /**
  141. * Return true if this object has a translation for the given locale.
  142. *
  143. * @param string $locale
  144. * @return boolean
  145. */
  146. public function hasTranslation($locale)
  147. {
  148. return null !== $this->getTranslation($locale);
  149. }
  151. /**
  152. * Return the content of translation for the given locale.
  153. *
  154. * @param string $locale
  155. * @return \Lexik\Bundle\TranslationBundle\Model\Translation
  156. */
  157. public function getTranslation($locale)
  158. {
  159. foreach ($this->getTranslations() as $translation) {
  160. if ($translation->getLocale() == $locale) {
  161. return $translation;
  162. }
  163. }
  165. return null;
  166. }
  168. /**
  169. * Set translations collection
  170. *
  171. * @param Collection $collection
  172. */
  173. public function setTranslations(Collection $collection)
  174. {
  175. $this->translations = new ArrayCollection();
  177. foreach ($collection as $translation) {
  178. $this->addTranslation($translation);
  179. }
  180. }
  182. /**
  183. * Return transaltions with not blank content.
  184. *
  185. * @return \Doctrine\Common\Collections\Collection
  186. */
  187. public function filterNotBlankTranslations()
  188. {
  189. return $this->getTranslations()->filter(function (TranslationInterface $translation) {
  190. $content = $translation->getContent();
  191. return !empty($content);
  192. });
  193. }
  195. /**
  196. * Get createdAt
  197. *
  198. * @return datetime $createdAt
  199. */
  200. public function getCreatedAt()
  201. {
  202. return $this->createdAt;
  203. }
  205. /**
  206. * Get updatedAt
  207. *
  208. * @return datetime $updatedAt
  209. */
  210. public function getUpdatedAt()
  211. {
  212. return $this->updatedAt;
  213. }
  214. }