Skip to content

Commit 9c3420b

Browse files
mpdudempdude
authored
Fix that #[Polyglot\Translatable] may be used on unmapped fields (#68)
It may be useful to use the `#[Polyglot\Translatable]` attribute (or the corresponding annotation) on properties that are not configured as mapped Doctrine ORM fields. For example, the property value might be set by entity lifecycle callbacks or Doctrine listeners. It was possible to do so until #28 changed `\Webfactory\Bundle\PolyglotBundle\Doctrine\TranslatableClassMetadata::findTranslatedProperties` to work based on Doctrine ORM `ClassMetadata` information and fields. This was done to simplify detection of whether a particular property belongs to a given class or needs to be mapped through base class translations. Obviously, `ClassMetadata` does not know about unmapped properties. This PR changes the code to work on PHP reflection data instead, restoring functionality.
1 parent edb88a6 commit 9c3420b

File tree

2 files changed

+155
-9
lines changed

2 files changed

+155
-9
lines changed

‎src/Doctrine/TranslatableClassMetadata.php

+14-9
Original file line numberDiff line numberDiff line change
@@ -187,16 +187,23 @@ private function findTranslatedProperties(ClassMetadataInfo $cm, Reader $reader,
187187
return;
188188
}
189189

190+
$reflectionService = $classMetadataFactory->getReflectionService();
190191
$translationClassMetadata = $classMetadataFactory->getMetadataFor($this->translationClass->getName());
191192

192-
foreach ($cm->fieldMappings as $fieldName => $mapping) {
193-
if (isset($mapping['declared'])) {
194-
// The association is inherited from a parent class
193+
/* Iterate all properties of the class, not only those mapped by Doctrine */
194+
foreach ($cm->getReflectionClass()->getProperties() as $reflectionProperty) {
195+
$propertyName = $reflectionProperty->name;
196+
197+
/*
198+
If the property is inherited from a parent class, and our parent entity class
199+
already contains that declaration, we need not include it.
200+
*/
201+
$declaringClass = $reflectionProperty->getDeclaringClass()->name;
202+
if ($declaringClass !== $cm->name && $cm->parentClasses && is_a($cm->parentClasses[0], $declaringClass, true)) {
195203
continue;
196204
}
197205

198206
$foundAttributeOrAnnotation = null;
199-
$reflectionProperty = $cm->getReflectionProperty($fieldName);
200207
$attributes = $reflectionProperty->getAttributes(Attribute\Translatable::class);
201208

202209
if ($attributes) {
@@ -210,11 +217,9 @@ private function findTranslatedProperties(ClassMetadataInfo $cm, Reader $reader,
210217
}
211218

212219
if ($foundAttributeOrAnnotation) {
213-
$translationFieldname = $foundAttributeOrAnnotation->getTranslationFieldname() ?: $fieldName;
214-
$translationFieldReflectionProperty = $translationClassMetadata->getReflectionProperty($translationFieldname);
215-
216-
$this->translatedProperties[$fieldName] = $reflectionProperty;
217-
$this->translationFieldMapping[$fieldName] = $translationFieldReflectionProperty;
220+
$this->translatedProperties[$propertyName] = $reflectionService->getAccessibleProperty($cm->name, $propertyName);
221+
$translationFieldname = $foundAttributeOrAnnotation->getTranslationFieldname() ?: $propertyName;
222+
$this->translationFieldMapping[$propertyName] = $reflectionService->getAccessibleProperty($translationClassMetadata->name, $translationFieldname);
218223
}
219224
}
220225
}

‎tests/Functional/TranslatingUnmappedPropertiesTest.php

+141
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
<?php
2+
3+
namespace Webfactory\Bundle\PolyglotBundle\Tests\Functional;
4+
5+
use Doctrine\Common\Collections\ArrayCollection;
6+
use Doctrine\Common\Collections\Collection;
7+
use Doctrine\ORM\Mapping as ORM;
8+
use Webfactory\Bundle\PolyglotBundle\Attribute as Polyglot;
9+
use Webfactory\Bundle\PolyglotBundle\Translatable;
10+
11+
/**
12+
* This test covers that also properties which are not mapped Doctrine fields
13+
* can be marked as translatable and will be handled by the PolyglotListener.
14+
*
15+
* This is useful when these fields are managed or updated by e. g. lifecycle callbacks
16+
* or other Doctrine event listeners.
17+
*/
18+
class TranslatingUnmappedPropertiesTest extends FunctionalTestBase
19+
{
20+
protected function setUp(): void
21+
{
22+
parent::setUp();
23+
$this->setupOrmInfrastructure([
24+
TranslatingUnmappedPropertiesTest_Entity::class,
25+
TranslatingUnmappedPropertiesTest_Translation::class,
26+
]);
27+
}
28+
29+
public function testPersistAndReloadEntity(): void
30+
{
31+
$entity = new TranslatingUnmappedPropertiesTest_Entity();
32+
$entity->text = new Translatable('base text');
33+
$entity->text->setTranslation('Basistext', 'de_DE');
34+
35+
$this->infrastructure->import($entity);
36+
37+
$loaded = $this->infrastructure->getEntityManager()->find(TranslatingUnmappedPropertiesTest_Entity::class, $entity->id);
38+
39+
self::assertSame('Basistext', $loaded->text->translate('de_DE'));
40+
self::assertSame('base text', $loaded->text->translate('en_GB'));
41+
}
42+
}
43+
44+
/**
45+
* @ORM\Entity
46+
*
47+
* @ORM\HasLifecycleCallbacks
48+
*/
49+
#[Polyglot\Locale(primary: 'en_GB')]
50+
class TranslatingUnmappedPropertiesTest_Entity
51+
{
52+
/**
53+
* @ORM\Column(type="integer")
54+
*
55+
* @ORM\Id
56+
*
57+
* @ORM\GeneratedValue
58+
*/
59+
public ?int $id = null;
60+
61+
/**
62+
* @ORM\OneToMany(targetEntity="TranslatingUnmappedPropertiesTest_Translation", mappedBy="entity")
63+
*/
64+
#[Polyglot\TranslationCollection]
65+
protected Collection $translations;
66+
67+
/**
68+
* @ORM\Column(type="string")
69+
*/
70+
public $mappedText;
71+
72+
// (!) This field is unmapped from the ORM point of view
73+
#[Polyglot\Translatable]
74+
public $text;
75+
76+
public function __construct()
77+
{
78+
$this->translations = new ArrayCollection();
79+
$this->text = new Translatable();
80+
}
81+
82+
/** @ORM\PreFlush() */
83+
public function copyToMappedField(): void
84+
{
85+
$this->mappedText = $this->text;
86+
}
87+
88+
/** @ORM\PostLoad() */
89+
public function copyFromMappedField(): void
90+
{
91+
$this->text = $this->mappedText;
92+
}
93+
}
94+
95+
/**
96+
* @ORM\Entity
97+
*
98+
* @ORM\HasLifecycleCallbacks
99+
*/
100+
class TranslatingUnmappedPropertiesTest_Translation
101+
{
102+
/**
103+
* @ORM\Id
104+
*
105+
* @ORM\GeneratedValue
106+
*
107+
* @ORM\Column(type="integer")
108+
*/
109+
private ?int $id = null;
110+
111+
/**
112+
* @ORM\Column
113+
*/
114+
#[Polyglot\Locale]
115+
private string $locale;
116+
117+
/**
118+
* @ORM\ManyToOne(targetEntity="TranslatingUnmappedPropertiesTest_Entity", inversedBy="translations")
119+
*/
120+
private TranslatingUnmappedPropertiesTest_Entity $entity;
121+
122+
/**
123+
* @ORM\Column
124+
*/
125+
private $mappedText;
126+
127+
// (!) This field is unmapped from the ORM point of view
128+
private $text;
129+
130+
/** @ORM\PreFlush() */
131+
public function copyToMappedField(): void
132+
{
133+
$this->mappedText = $this->text;
134+
}
135+
136+
/** @ORM\PostLoad() */
137+
public function copyFromMappedField(): void
138+
{
139+
$this->text = $this->mappedText;
140+
}
141+
}

0 commit comments

Comments
 (0)