TranslationRepository.php 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  1. <?php
  2. namespace Gedmo\Translatable\Entity\Repository;
  3. use Gedmo\Translatable\TranslatableListener;
  4. use Doctrine\ORM\EntityRepository;
  5. use Doctrine\ORM\Query;
  6. use Doctrine\ORM\EntityManager;
  7. use Doctrine\ORM\Mapping\ClassMetadata;
  8. use Gedmo\Tool\Wrapper\EntityWrapper;
  9. use Gedmo\Translatable\Mapping\Event\Adapter\ORM as TranslatableAdapterORM;
  10. use Doctrine\DBAL\Types\Type;
  11. /**
  12. * The TranslationRepository has some useful functions
  13. * to interact with translations.
  14. *
  15. * @author Gediminas Morkevicius <gediminas.morkevicius@gmail.com>
  16. * @package Gedmo.Translatable.Entity.Repository
  17. * @subpackage TranslationRepository
  18. * @link http://www.gediminasm.org
  19. * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  20. */
  21. class TranslationRepository extends EntityRepository
  22. {
  23. /**
  24. * Current TranslatableListener instance used
  25. * in EntityManager
  26. *
  27. * @var TranslatableListener
  28. */
  29. private $listener;
  30. /**
  31. * {@inheritdoc}
  32. */
  33. public function __construct(EntityManager $em, ClassMetadata $class)
  34. {
  35. if ($class->getReflectionClass()->isSubclassOf('Gedmo\Translatable\Entity\MappedSuperclass\AbstractPersonalTranslation')) {
  36. throw new \Gedmo\Exception\UnexpectedValueException('This repository is useless for personal translations');
  37. }
  38. parent::__construct($em, $class);
  39. }
  40. /**
  41. * Makes additional translation of $entity $field into $locale
  42. * using $value
  43. *
  44. * @param object $entity
  45. * @param string $field
  46. * @param string $locale
  47. * @param mixed $value
  48. * @return TranslationRepository
  49. */
  50. public function translate($entity, $field, $locale, $value)
  51. {
  52. $meta = $this->_em->getClassMetadata(get_class($entity));
  53. if($meta->inheritanceType == ClassMetadataInfo::INHERITANCE_TYPE_SINGLE_TABLE){
  54. $metaname = $meta->rootEntityName;
  55. }else{
  56. $metaname = $meta->name;
  57. }
  58. $listener = $this->getTranslatableListener();
  59. $config = $listener->getConfiguration($this->_em, $meta->name);
  60. if (!isset($config['fields']) || !in_array($field, $config['fields'])) {
  61. throw new \Gedmo\Exception\InvalidArgumentException("Entity: {$meta->name} does not translate field - {$field}");
  62. }
  63. if (in_array($locale, array($listener->getDefaultLocale(), $listener->getTranslatableLocale($entity, $meta)))) {
  64. $meta->getReflectionProperty($field)->setValue($entity, $value);
  65. $this->_em->persist($entity);
  66. } else {
  67. $ea = new TranslatableAdapterORM();
  68. $foreignKey = $meta->getReflectionProperty($meta->getSingleIdentifierFieldName())->getValue($entity);
  69. $objectClass = $metaname;
  70. $class = $listener->getTranslationClass($ea, $metaname);
  71. $transMeta = $this->_em->getClassMetadata($class);
  72. $trans = $this->findOneBy(compact('locale', 'field', 'objectClass', 'foreignKey'));
  73. if (!$trans) {
  74. $trans = $transMeta->newInstance();
  75. $transMeta->getReflectionProperty('foreignKey')->setValue($trans, $foreignKey);
  76. $transMeta->getReflectionProperty('objectClass')->setValue($trans, $objectClass);
  77. $transMeta->getReflectionProperty('field')->setValue($trans, $field);
  78. $transMeta->getReflectionProperty('locale')->setValue($trans, $locale);
  79. }
  80. $type = Type::getType($meta->getTypeOfField($field));
  81. $transformed = $type->convertToDatabaseValue($value, $this->_em->getConnection()->getDatabasePlatform());
  82. $transMeta->getReflectionProperty('content')->setValue($trans, $transformed);
  83. if ($this->_em->getUnitOfWork()->isInIdentityMap($entity)) {
  84. $this->_em->persist($trans);
  85. } else {
  86. $oid = spl_object_hash($entity);
  87. $listener->addPendingTranslationInsert($oid, $trans);
  88. }
  89. }
  90. return $this;
  91. }
  92. /**
  93. * Loads all translations with all translatable
  94. * fields from the given entity
  95. *
  96. * @param object $entity Must implement Translatable
  97. * @return array list of translations in locale groups
  98. */
  99. public function findTranslations($entity)
  100. {
  101. $result = array();
  102. $wrapped = new EntityWrapper($entity, $this->_em);
  103. if ($wrapped->hasValidIdentifier()) {
  104. $entityId = $wrapped->getIdentifier();
  105. $entityClass = $wrapped->getMetadata()->name;
  106. $translationMeta = $this->getClassMetadata(); // table inheritance support
  107. $qb = $this->_em->createQueryBuilder();
  108. $qb->select('trans.content, trans.field, trans.locale')
  109. ->from($translationMeta->rootEntityName, 'trans')
  110. ->where('trans.foreignKey = :entityId', 'trans.objectClass = :entityClass')
  111. ->orderBy('trans.locale');
  112. $q = $qb->getQuery();
  113. $data = $q->execute(
  114. compact('entityId', 'entityClass'),
  115. Query::HYDRATE_ARRAY
  116. );
  117. if ($data && is_array($data) && count($data)) {
  118. foreach ($data as $row) {
  119. $result[$row['locale']][$row['field']] = $row['content'];
  120. }
  121. }
  122. }
  123. return $result;
  124. }
  125. /**
  126. * Find the entity $class by the translated field.
  127. * Result is the first occurence of translated field.
  128. * Query can be slow, since there are no indexes on such
  129. * columns
  130. *
  131. * @param string $field
  132. * @param string $value
  133. * @param string $class
  134. * @return object - instance of $class or null if not found
  135. */
  136. public function findObjectByTranslatedField($field, $value, $class)
  137. {
  138. $entity = null;
  139. $meta = $this->_em->getClassMetadata($class);
  140. $translationMeta = $this->getClassMetadata(); // table inheritance support
  141. if ($meta->hasField($field)) {
  142. $dql = "SELECT trans.foreignKey FROM {$translationMeta->rootEntityName} trans";
  143. $dql .= ' WHERE trans.objectClass = :class';
  144. $dql .= ' AND trans.field = :field';
  145. $dql .= ' AND trans.content = :value';
  146. $q = $this->_em->createQuery($dql);
  147. $q->setParameters(compact('class', 'field', 'value'));
  148. $q->setMaxResults(1);
  149. $result = $q->getArrayResult();
  150. $id = count($result) ? $result[0]['foreignKey'] : null;
  151. if ($id) {
  152. $entity = $this->_em->find($class, $id);
  153. }
  154. }
  155. return $entity;
  156. }
  157. /**
  158. * Loads all translations with all translatable
  159. * fields by a given entity primary key
  160. *
  161. * @param mixed $id - primary key value of an entity
  162. * @return array
  163. */
  164. public function findTranslationsByObjectId($id)
  165. {
  166. $result = array();
  167. if ($id) {
  168. $translationMeta = $this->getClassMetadata(); // table inheritance support
  169. $qb = $this->_em->createQueryBuilder();
  170. $qb->select('trans.content, trans.field, trans.locale')
  171. ->from($translationMeta->rootEntityName, 'trans')
  172. ->where('trans.foreignKey = :entityId')
  173. ->orderBy('trans.locale');
  174. $q = $qb->getQuery();
  175. $data = $q->execute(
  176. array('entityId' => $id),
  177. Query::HYDRATE_ARRAY
  178. );
  179. if ($data && is_array($data) && count($data)) {
  180. foreach ($data as $row) {
  181. $result[$row['locale']][$row['field']] = $row['content'];
  182. }
  183. }
  184. }
  185. return $result;
  186. }
  187. /**
  188. * Get the currently used TranslatableListener
  189. *
  190. * @throws \Gedmo\Exception\RuntimeException - if listener is not found
  191. * @return TranslatableListener
  192. */
  193. private function getTranslatableListener()
  194. {
  195. if (!$this->listener) {
  196. foreach ($this->_em->getEventManager()->getListeners() as $event => $listeners) {
  197. foreach ($listeners as $hash => $listener) {
  198. if ($listener instanceof TranslatableListener) {
  199. $this->listener = $listener;
  200. break;
  201. }
  202. }
  203. if ($this->listener) {
  204. break;
  205. }
  206. }
  207. if (is_null($this->listener)) {
  208. throw new \Gedmo\Exception\RuntimeException('The translation listener could not be found');
  209. }
  210. }
  211. return $this->listener;
  212. }
  213. }