Skip to content

Commit 212f4e5

Browse files
mpdudempdude
authored
Allow using PHP attributes for configuration (#40)
This PR introduces PHP attributes that can be used instead of the current annotations. At the same time, annotations are being deprecated. Annotations support will be removed in the next major version of this bundle.
1 parent 5d1fcc6 commit 212f4e5

17 files changed

+182
-107
lines changed

‎.github/workflows/lock-symfony-version.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/bin/sh
22

3-
sed --in-place --regexp-extended --expression='/symfony\/error-handler/b; /symfony\/phpunit-bridge/b; s/"(symfony\/.*)": ".*"/"\1": "'$VERSION'"/' composer.json
3+
sed --in-place --regexp-extended --expression='/symfony\/deprecation-contracts/b; /symfony\/error-handler/b; /symfony\/phpunit-bridge/b; s/"(symfony\/.*)": ".*"/"\1": "'$VERSION'"/' composer.json

‎CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
To get the diff for a specific change, go to https://github.com/webfactory/polyglot-bundle/commit/XXX where XXX is the change hash. To get the diff between two versions, go to https://github.com/webfactory/polyglot-bundle/compare/{oldversion}...{newversion}.
44

5+
## Version 3.1.0
6+
7+
* The annotations `\Webfactory\Bundle\PolyglotBundle\Annotation\Locale`, `\Webfactory\Bundle\PolyglotBundle\Annotation\Translatable` and `\Webfactory\Bundle\PolyglotBundle\Annotation\TranslationCollection` have been deprecated. Replace them with the corresponding PHP attributes from the `\Webfactory\Bundle\PolyglotBundle\Attribute` namespace.
8+
* Using annotations to configure entity classes for this bundle has been deprecated. Switch to PHP 8 attributes.
9+
* Attribute classes will be made `final` in the next major release.
10+
511
## Version 3.0.0
612

713
* Dropped support for PHP versions below 8.1, and for Symfony versions before 5.4.

‎composer.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,14 @@
2323
"php": "8.1.*|8.2.*|8.3.*",
2424
"doctrine/annotations": "^1.12",
2525
"doctrine/collections": "^1.0",
26-
"doctrine/event-manager": "^1.0",
2726
"doctrine/dbal": "^2.3|^3.0",
27+
"doctrine/event-manager": "^1.0",
2828
"doctrine/orm": "^2.10",
2929
"doctrine/persistence": "^1.3.8 | ^2.1",
3030
"psr/log": "^1.0",
3131
"symfony/config": "^5.4|^6.4|^7.0",
3232
"symfony/dependency-injection": "^5.4|^6.4|^7.0",
33+
"symfony/deprecation-contracts": "^2.0|^3.0",
3334
"symfony/event-dispatcher": "^5.4|^6.4|^7.0",
3435
"symfony/http-kernel": "^5.4|^6.4|^7.0"
3536
},

‎src/Annotation/Locale.php

+4-9
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,18 @@
1010
namespace Webfactory\Bundle\PolyglotBundle\Annotation;
1111

1212
use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
13+
use Webfactory\Bundle\PolyglotBundle\Attribute\Locale as Attribute;
1314

1415
/**
1516
* @Annotation
1617
* @NamedArgumentConstructor
1718
* @Target({"CLASS","PROPERTY"})
1819
*/
19-
final class Locale
20+
final class Locale extends Attribute
2021
{
21-
private ?string $primary;
22-
2322
public function __construct(string $primary = null)
2423
{
25-
$this->primary = $primary;
26-
}
27-
28-
public function getPrimary(): ?string
29-
{
30-
return $this->primary;
24+
trigger_deprecation('webfactory/polyglot-bundle', '3.1.0', 'The %s annotation has been deprecated and will be removed in the 4.0 release. Use the %s attribute instead.', self::class, parent::class);
25+
parent::__construct($primary);
3126
}
3227
}

‎src/Annotation/Translatable.php

+4-9
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,17 @@
1010
namespace Webfactory\Bundle\PolyglotBundle\Annotation;
1111

1212
use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
13+
use Webfactory\Bundle\PolyglotBundle\Attribute\Translatable as Attribute;
1314

1415
/**
1516
* @Annotation
1617
* @NamedArgumentConstructor
1718
*/
18-
final class Translatable
19+
final class Translatable extends Attribute
1920
{
20-
private ?string $translationFieldname;
21-
2221
public function __construct(string $translationFieldname = null)
2322
{
24-
$this->translationFieldname = $translationFieldname;
25-
}
26-
27-
public function getTranslationFieldname(): ?string
28-
{
29-
return $this->translationFieldname;
23+
trigger_deprecation('webfactory/polyglot-bundle', '3.1.0', 'The %s annotation has been deprecated and will be removed in the 4.0 release. Use the %s attribute instead.', self::class, parent::class);
24+
parent::__construct($translationFieldname);
3025
}
3126
}

‎src/Annotation/TranslationCollection.php

+7-1
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,15 @@
99

1010
namespace Webfactory\Bundle\PolyglotBundle\Annotation;
1111

12+
use Webfactory\Bundle\PolyglotBundle\Attribute\TranslationCollection as Attribute;
13+
1214
/**
1315
* @Annotation
1416
*/
15-
final class TranslationCollection
17+
final class TranslationCollection extends Attribute
1618
{
19+
public function __construct()
20+
{
21+
trigger_deprecation('webfactory/polyglot-bundle', '3.1.0', 'The %s annotation has been deprecated and will be removed in the 4.0 release. Use the %s attribute instead.', self::class, parent::class);
22+
}
1723
}

‎src/Attribute/Locale.php

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
/*
4+
* (c) webfactory GmbH <[email protected]>
5+
*
6+
* For the full copyright and license information, please view the LICENSE
7+
* file that was distributed with this source code.
8+
*/
9+
10+
namespace Webfactory\Bundle\PolyglotBundle\Attribute;
11+
12+
use Attribute;
13+
14+
/** @final */
15+
#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY)]
16+
class Locale
17+
{
18+
private ?string $primary;
19+
20+
public function __construct(string $primary = null)
21+
{
22+
$this->primary = $primary;
23+
}
24+
25+
public function getPrimary(): ?string
26+
{
27+
return $this->primary;
28+
}
29+
}

‎src/Attribute/Translatable.php

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
/*
4+
* (c) webfactory GmbH <[email protected]>
5+
*
6+
* For the full copyright and license information, please view the LICENSE
7+
* file that was distributed with this source code.
8+
*/
9+
10+
namespace Webfactory\Bundle\PolyglotBundle\Attribute;
11+
12+
use Attribute;
13+
14+
/** @final */
15+
#[Attribute]
16+
class Translatable
17+
{
18+
private ?string $translationFieldname;
19+
20+
public function __construct(string $translationFieldname = null)
21+
{
22+
$this->translationFieldname = $translationFieldname;
23+
}
24+
25+
public function getTranslationFieldname(): ?string
26+
{
27+
return $this->translationFieldname;
28+
}
29+
}

‎src/Attribute/TranslationCollection.php

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?php
2+
3+
/*
4+
* (c) webfactory GmbH <[email protected]>
5+
*
6+
* For the full copyright and license information, please view the LICENSE
7+
* file that was distributed with this source code.
8+
*/
9+
10+
namespace Webfactory\Bundle\PolyglotBundle\Attribute;
11+
12+
use Attribute;
13+
14+
/** @final */
15+
#[Attribute]
16+
class TranslationCollection
17+
{
18+
}

‎src/Doctrine/TranslatableClassMetadata.php

+42-18
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
use ReflectionProperty;
1919
use RuntimeException;
2020
use Webfactory\Bundle\PolyglotBundle\Annotation;
21+
use Webfactory\Bundle\PolyglotBundle\Attribute;
2122
use Webfactory\Bundle\PolyglotBundle\Locale\DefaultLocaleProvider;
2223
use Webfactory\Bundle\PolyglotBundle\Translatable;
2324

@@ -193,15 +194,22 @@ private function findTranslatedProperties(ClassMetadataInfo $cm, Reader $reader,
193194
continue;
194195
}
195196

197+
$foundAttributeOrAnnotation = null;
196198
$reflectionProperty = $cm->getReflectionClass()->getProperty($fieldName);
199+
$attributes = $reflectionProperty->getAttributes(Attribute\Translatable::class);
197200

198-
$annotation = $reader->getPropertyAnnotation(
199-
$reflectionProperty,
200-
Annotation\Translatable::class
201-
);
201+
if ($attributes) {
202+
$foundAttributeOrAnnotation = $attributes[0]->newInstance();
203+
} else {
204+
$foundAttributeOrAnnotation = $reader->getPropertyAnnotation($reflectionProperty, Annotation\Translatable::class);
205+
206+
if ($foundAttributeOrAnnotation) {
207+
trigger_deprecation('webfactory/polyglot-bundle', '3.1.0', 'Using the %s annotation on the %s::%s property is deprecated. Use the %s attribute instead.', Annotation\Translatable::class, $reflectionProperty->class, $reflectionProperty->name, Attribute\Translatable::class);
208+
}
209+
}
202210

203-
if ($annotation) {
204-
$translationFieldname = $annotation->getTranslationFieldname() ?: $fieldName;
211+
if ($foundAttributeOrAnnotation) {
212+
$translationFieldname = $foundAttributeOrAnnotation->getTranslationFieldname() ?: $fieldName;
205213
$translationFieldReflectionProperty = $translationClassMetadata->getReflectionProperty($translationFieldname);
206214

207215
$this->translatedProperties[$fieldName] = $reflectionProperty;
@@ -212,19 +220,24 @@ private function findTranslatedProperties(ClassMetadataInfo $cm, Reader $reader,
212220

213221
private function findTranslationsCollection(ClassMetadataInfo $cm, Reader $reader, ClassMetadataFactory $classMetadataFactory): void
214222
{
223+
$found = false;
215224
foreach ($cm->associationMappings as $fieldName => $mapping) {
216225
if (isset($mapping['declared'])) {
217226
// The association is inherited from a parent class
218227
continue;
219228
}
220229

221-
$annotation = $reader->getPropertyAnnotation(
222-
$cm->getReflectionProperty($fieldName),
223-
Annotation\TranslationCollection::class
224-
);
230+
$reflectionProperty = $cm->getReflectionProperty($fieldName);
225231

226-
if ($annotation) {
227-
$this->translationsCollectionProperty = $cm->getReflectionClass()->getProperty($fieldName);
232+
if ($reflectionProperty->getAttributes(Attribute\TranslationCollection::class)) {
233+
$found = true;
234+
} elseif ($reader->getPropertyAnnotation($reflectionProperty, Annotation\TranslationCollection::class)) {
235+
trigger_deprecation('webfactory/polyglot-bundle', '3.1.0', 'Using the %s annotation on the %s::%s property is deprecated. Use the %s attribute instead.', Annotation\TranslationCollection::class, $reflectionProperty->class, $reflectionProperty->name, Attribute\TranslationCollection::class);
236+
$found = true;
237+
}
238+
239+
if ($found) {
240+
$this->translationsCollectionProperty = $reflectionProperty;
228241

229242
$translationEntityMetadata = $classMetadataFactory->getMetadataFor($mapping['targetEntity']);
230243
$this->translationClass = $translationEntityMetadata->getReflectionClass();
@@ -239,8 +252,17 @@ private function findTranslationsCollection(ClassMetadataInfo $cm, Reader $reade
239252
private function findPrimaryLocale(ClassMetadataInfo $cm, Reader $reader): void
240253
{
241254
foreach (array_merge([$cm->name], $cm->parentClasses) as $class) {
242-
$annotation = $reader->getClassAnnotation(new ReflectionClass($class), Annotation\Locale::class);
255+
$reflectionClass = new ReflectionClass($class);
256+
257+
foreach ($reflectionClass->getAttributes(Attribute\Locale::class) as $attribute) {
258+
$this->primaryLocale = $attribute->newInstance()->getPrimary();
259+
260+
return;
261+
}
262+
263+
$annotation = $reader->getClassAnnotation($reflectionClass, Annotation\Locale::class);
243264
if (null !== $annotation) {
265+
trigger_deprecation('webfactory/polyglot-bundle', '3.1.0', 'Using the %s annotation on the %s class is deprecated. Use the %s attribute instead.', Annotation\Locale::class, $reflectionClass->name, Attribute\Locale::class);
244266
$this->primaryLocale = $annotation->getPrimary();
245267

246268
return;
@@ -253,13 +275,15 @@ private function parseTranslationsEntity(Reader $reader, ClassMetadataInfo $cm):
253275
foreach ($cm->fieldMappings as $fieldName => $mapping) {
254276
$reflectionProperty = $cm->getReflectionProperty($fieldName);
255277

256-
$annotation = $reader->getPropertyAnnotation(
257-
$reflectionProperty,
258-
Annotation\Locale::class
259-
);
278+
if ($reflectionProperty->getAttributes(Attribute\Locale::class)) {
279+
$this->translationLocaleProperty = $reflectionProperty;
280+
281+
return;
282+
}
260283

261-
if ($annotation) {
284+
if ($reader->getPropertyAnnotation($reflectionProperty, Annotation\Locale::class)) {
262285
$this->translationLocaleProperty = $reflectionProperty;
286+
trigger_deprecation('webfactory/polyglot-bundle', '3.1.0', 'Using the %s annotation on the %s::%s property is deprecated. Use the %s attribute instead.', Annotation\Locale::class, $reflectionProperty->class, $reflectionProperty->name, Attribute\Locale::class);
263287

264288
return;
265289
}

‎tests/Functional/CascadePersistTranslationsTest.php

+5-9
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
use Doctrine\Common\Collections\ArrayCollection;
66
use Doctrine\Common\Collections\Collection;
77
use Doctrine\ORM\Mapping as ORM;
8-
use Webfactory\Bundle\PolyglotBundle\Annotation as Polyglot;
8+
use Webfactory\Bundle\PolyglotBundle\Attribute as Polyglot;
99
use Webfactory\Bundle\PolyglotBundle\Translatable;
1010
use Webfactory\Bundle\PolyglotBundle\TranslatableInterface;
1111

@@ -46,9 +46,8 @@ public function adding_and_persisting_translations(): void
4646

4747
/**
4848
* @ORM\Entity
49-
*
50-
* @Polyglot\Locale(primary="en_GB")
5149
*/
50+
#[Polyglot\Locale(primary: 'en_GB')]
5251
class CascadePersistTranslationsTest_Entity
5352
{
5453
/**
@@ -64,16 +63,14 @@ class CascadePersistTranslationsTest_Entity
6463
* (!) There is *not* cascade="persist" configuration here.
6564
*
6665
* @ORM\OneToMany(targetEntity="CascadePersistTranslationsTest_Translation", mappedBy="entity")
67-
*
68-
* @Polyglot\TranslationCollection
6966
*/
67+
#[Polyglot\TranslationCollection]
7068
protected Collection $translations;
7169

7270
/**
7371
* @ORM\Column(type="string")
74-
*
75-
* @Polyglot\Translatable
7672
*/
73+
#[Polyglot\Translatable]
7774
protected string|TranslatableInterface $text;
7875

7976
public function __construct()
@@ -104,9 +101,8 @@ class CascadePersistTranslationsTest_Translation
104101

105102
/**
106103
* @ORM\Column
107-
*
108-
* @Polyglot\Locale
109104
*/
105+
#[Polyglot\Locale]
110106
private string $locale;
111107

112108
/**

0 commit comments

Comments
 (0)