vendor/gedmo/doctrine-extensions/src/Translatable/Mapping/Driver/Attribute.php line 58

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Doctrine Behavioral Extensions package.
  5. * (c) Gediminas Morkevicius <gediminas.morkevicius@gmail.com> http://www.gediminasm.org
  6. * For the full copyright and license information, please view the LICENSE
  7. * file that was distributed with this source code.
  8. */
  10. namespace Gedmo\Translatable\Mapping\Driver;
  12. use Doctrine\ORM\Mapping\EmbeddedClassMapping;
  13. use Gedmo\Exception\InvalidMappingException;
  14. use Gedmo\Mapping\Annotation\Language;
  15. use Gedmo\Mapping\Annotation\Locale;
  16. use Gedmo\Mapping\Annotation\Translatable;
  17. use Gedmo\Mapping\Annotation\TranslationEntity;
  18. use Gedmo\Mapping\Driver\AbstractAnnotationDriver;
  20. /**
  21. * Mapping driver for the translatable extension which reads extended metadata from annotations on a translatable class.
  22. *
  23. * @author Gediminas Morkevicius <gediminas.morkevicius@gmail.com>
  24. *
  25. * @internal
  26. */
  27. class Attribute extends AbstractAnnotationDriver
  28. {
  29. /**
  30. * Mapping object to configure the translation model for a translatable class.
  31. */
  32. public const ENTITY_CLASS = TranslationEntity::class;
  34. /**
  35. * Mapping object to identify a field as translatable in a translatable class.
  36. */
  37. public const TRANSLATABLE = Translatable::class;
  39. /**
  40. * Mapping object to identify the field which stores the locale or language for the translation.
  41. *
  42. * This object is an alias of {@see self::LANGUAGE}
  43. */
  44. public const LOCALE = Locale::class;
  46. /**
  47. * Mapping object to identify the field which stores the locale or language for the translation.
  48. *
  49. * This object is an alias of {@see self::LOCALE}
  50. */
  51. public const LANGUAGE = Language::class;
  53. public function readExtendedMetadata($meta, array &$config)
  54. {
  55. $class = $this->getMetaReflectionClass($meta);
  57. // class annotations
  58. if ($annot = $this->reader->getClassAnnotation($class, self::ENTITY_CLASS)) {
  59. \assert($annot instanceof TranslationEntity);
  61. if (!$cl = $this->getRelatedClassName($meta, $annot->class)) {
  62. throw new InvalidMappingException("Translation class: {$annot->class} does not exist.");
  63. }
  65. $config['translationClass'] = $cl;
  66. }
  68. // property annotations
  69. foreach ($class->getProperties() as $property) {
  70. if ($meta->isMappedSuperclass && !$property->isPrivate()
  71. || $meta->isInheritedField($property->name)
  72. || isset($meta->associationMappings[$property->name]['inherited'])
  73. ) {
  74. continue;
  75. }
  77. // translatable property
  78. if ($translatable = $this->reader->getPropertyAnnotation($property, self::TRANSLATABLE)) {
  79. \assert($translatable instanceof Translatable);
  81. $field = $property->getName();
  83. if (!$meta->hasField($field)) {
  84. throw new InvalidMappingException("Unable to find translatable [{$field}] as mapped property in entity - {$meta->getName()}");
  85. }
  87. // fields cannot be overrided and throws mapping exception
  88. $config['fields'][] = $field;
  90. if (isset($translatable->fallback)) {
  91. $config['fallback'][$field] = $translatable->fallback;
  92. }
  93. }
  95. // locale property
  96. if ($this->reader->getPropertyAnnotation($property, self::LOCALE)) {
  97. $field = $property->getName();
  99. if ($meta->hasField($field)) {
  100. throw new InvalidMappingException("Locale field [{$field}] should not be mapped as column property in entity - {$meta->getName()}, since it makes no sense");
  101. }
  103. $config['locale'] = $field;
  104. } elseif ($this->reader->getPropertyAnnotation($property, self::LANGUAGE)) {
  105. $field = $property->getName();
  107. if ($meta->hasField($field)) {
  108. throw new InvalidMappingException("Language field [{$field}] should not be mapped as column property in entity - {$meta->getName()}, since it makes no sense");
  109. }
  111. $config['locale'] = $field;
  112. }
  113. }
  115. // Embedded entity
  116. if (property_exists($meta, 'embeddedClasses') && $meta->embeddedClasses) {
  117. foreach ($meta->embeddedClasses as $propertyName => $embeddedClassInfo) {
  118. if ($meta->isInheritedEmbeddedClass($propertyName)) {
  119. continue;
  120. }
  122. /** Remove conditional when ORM 2.x is no longer supported. */
  123. $className = ($embeddedClassInfo instanceof EmbeddedClassMapping) ? $embeddedClassInfo->class : $embeddedClassInfo['class'];
  124. $embeddedClass = new \ReflectionClass($className);
  126. foreach ($embeddedClass->getProperties() as $embeddedProperty) {
  127. if ($translatable = $this->reader->getPropertyAnnotation($embeddedProperty, self::TRANSLATABLE)) {
  128. \assert($translatable instanceof Translatable);
  130. $field = $propertyName.'.'.$embeddedProperty->getName();
  132. $config['fields'][] = $field;
  134. if (isset($translatable->fallback)) {
  135. $config['fallback'][$field] = $translatable->fallback;
  136. }
  137. }
  138. }
  139. }
  140. }
  142. if (!$meta->isMappedSuperclass && $config) {
  143. if (is_array($meta->getIdentifier()) && count($meta->getIdentifier()) > 1) {
  144. throw new InvalidMappingException("Translatable does not support composite identifiers in class - {$meta->getName()}");
  145. }
  146. }
  148. return $config;
  149. }
  150. }