Merge pull request #1556 from endelwar/remove-annotation-namespace

garak · web-flow · commit 13a35b5db19c · 2025-10-25T09:30:21.000+02:00
Remove deprecated Annotation namespace
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -17,7 +17,7 @@ jobs:
               with:
                   php-version: 8.3
             - run: |
-                  composer require --no-update doctrine/annotations:"^2.0" liip/imagine-bundle:"^2.13" phpstan/phpstan:"^2" 
+                  composer require --no-update liip/imagine-bundle:"^2.13" phpstan/phpstan:"^2" 
                   composer install --ignore-platform-reqs
                   XDEBUG_MODE=off vendor/bin/phpstan
     cs-fixer:
@@ -110,7 +110,6 @@ jobs:
               with:
                   php-version: ${{ matrix.php }}
                   extensions: mongodb-stable, pdo_sqlite
-            - run: composer require --no-update doctrine/annotations:^1.14
             - run: |
                   composer global config --no-plugins allow-plugins.symfony/flex true
                   composer global require --no-interaction --no-progress symfony/flex:^2.8
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,21 @@
+# Upgrading from v2.9 to v3.0
+
+## Breaking Changes
+
+* The deprecated `Vich\UploaderBundle\Mapping\Annotation` namespace has been removed. Use `Vich\UploaderBundle\Mapping\Attribute` instead.
+* The deprecated `AnnotationInterface` has been removed. Use `AttributeInterface` instead.
+* `AttributeReader` deprecated methods have been removed: use `getClassAttribute()` instead of `getClassAnnotation()`, `getPropertyAttribute()` instead of `getPropertyAnnotation()`.
+
 # Upgrading from v2.8 to v2.9
 
+## Deprecations
+
+* The `Vich\UploaderBundle\Mapping\Annotation` namespace is deprecated. Replace it with `Vich\UploaderBundle\Mapping\Attribute`;
+  The old namespace will be removed in version 3.0.
+* `AttributeReader` methods: replace `*Annotation()` with `*Attribute()` (e.g., `getClassAnnotation()` → `getClassAttribute()`).
+
+## New Features
+
 * New `namer_keep_extension` configuration option to force namers to preserve original file extension.
 * Custom namers using `namer_keep_extension: true` must implement `ConfigurableInterface`.
 
diff --git a/config/mapping.php b/config/mapping.php
@@ -7,7 +7,7 @@
 use Metadata\Driver\FileLocator;
 use Metadata\MetadataFactory;
 use Vich\UploaderBundle\Metadata\CacheWarmer;
-use Vich\UploaderBundle\Metadata\Driver\AnnotationDriver;
+use Vich\UploaderBundle\Metadata\Driver\AttributeDriver;
 use Vich\UploaderBundle\Metadata\Driver\AttributeReader;
 use Vich\UploaderBundle\Metadata\Driver\XmlDriver;
 use Vich\UploaderBundle\Metadata\Driver\YamlDriver;
@@ -27,7 +27,7 @@
     $services->set('vich_uploader.metadata.attribute_reader', AttributeReader::class);
 
     // drivers
-    $services->set('vich_uploader.metadata_driver.annotation', AnnotationDriver::class)
+    $services->set('vich_uploader.metadata_driver.attribute', AttributeDriver::class)
         ->arg('$reader', service('vich_uploader.metadata.reader'))
         ->arg('$managerRegistryList', null); // replaced by compiler pass
 
diff --git a/docs/known_issues.md b/docs/known_issues.md
@@ -73,7 +73,7 @@ namespace App\Entity;
 
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\HttpFoundation\File\File;
-use Vich\UploaderBundle\Mapping\Annotation as Vich;
+use Vich\UploaderBundle\Mapping\Attribute as Vich;
 
 #[ORM\Entity]
 #[Vich\Uploadable]
diff --git a/docs/usage.md b/docs/usage.md
@@ -83,7 +83,7 @@ namespace App\Entity;
 
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\HttpFoundation\File\File;
-use Vich\UploaderBundle\Mapping\Annotation as Vich;
+use Vich\UploaderBundle\Mapping\Attribute as Vich;
 
 #[ORM\Entity]
 #[Vich\Uploadable]
@@ -168,7 +168,7 @@ namespace App\Entity;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\HttpFoundation\File\File;
 use Vich\UploaderBundle\Entity\File as EmbeddedFile;
-use Vich\UploaderBundle\Mapping\Annotation as Vich;
+use Vich\UploaderBundle\Mapping\Attribute as Vich;
 
 #[ORM\Entity]
 #[Vich\Uploadable]
diff --git a/docs/validators/file_required.md b/docs/validators/file_required.md
@@ -6,7 +6,7 @@ It validates that either an existing file is present or a new file has been uplo
 ## Basic Usage
 
 ```php
-use Vich\UploaderBundle\Mapping\Annotation as Vich;
+use Vich\UploaderBundle\Mapping\Attribute as Vich;
 use Vich\UploaderBundle\Validator\Constraints as VichAssert;
 
 #[Vich\Uploadable]
diff --git a/src/DependencyInjection/Compiler/RegisterMappingDriversPass.php b/src/DependencyInjection/Compiler/RegisterMappingDriversPass.php
@@ -30,7 +30,7 @@ public function process(ContainerBuilder $container): void
         }
 
         if (\count($managers) > 0) {
-            $drivers[] = $container->getDefinition('vich_uploader.metadata_driver.annotation')
+            $drivers[] = $container->getDefinition('vich_uploader.metadata_driver.attribute')
                 ->replaceArgument('$managerRegistryList', $managers);
         }
 
diff --git a/src/DependencyInjection/VichUploaderExtension.php b/src/DependencyInjection/VichUploaderExtension.php
@@ -53,7 +53,7 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $this->loadServicesFiles($container, $config);
         $this->registerMetadataDirectories($container, $config);
-        $this->registerAnnotationStrategy($container, $config);
+        $this->registerAttributeStrategy($container);
         $this->registerCacheStrategy($container, $config);
 
         $this->registerListeners($container, $config);
@@ -136,9 +136,9 @@ protected function registerMetadataDirectories(ContainerBuilder $container, arra
         ;
     }
 
-    protected function registerAnnotationStrategy(ContainerBuilder $container, array $config): void
+    protected function registerAttributeStrategy(ContainerBuilder $container): void
     {
-        if (!$container->has('vich_uploader.metadata_driver.annotation')) {
+        if (!$container->has('vich_uploader.metadata_driver.attribute')) {
             return;
         }
 
@@ -173,7 +173,7 @@ protected function registerCacheStrategy(ContainerBuilder $container, array $con
 
     protected function fixDbDriverConfig(array $config): array
     {
-        // mapping with no declared db_driver use the top-level one
+        // mapping with no declared db_driver, use the top-level one
         foreach ($config['mappings'] as &$mapping) {
             $mapping['db_driver'] = $mapping['db_driver'] ?: $config['db_driver'];
         }
diff --git a/src/Mapping/Annotation/Uploadable.php b/src/Mapping/Annotation/Uploadable.php
diff --git a/src/Mapping/Attribute/Uploadable.php b/src/Mapping/Attribute/Uploadable.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Vich\UploaderBundle\Mapping\Attribute;
+
+use Vich\UploaderBundle\Mapping\AttributeInterface;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class Uploadable implements AttributeInterface
+{
+}
diff --git a/src/Mapping/Attribute/UploadableField.php b/src/Mapping/Attribute/UploadableField.php
@@ -1,21 +1,11 @@
 <?php
 
-namespace Vich\UploaderBundle\Mapping\Annotation;
+namespace Vich\UploaderBundle\Mapping\Attribute;
 
-use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
-use Vich\UploaderBundle\Mapping\AnnotationInterface;
+use Vich\UploaderBundle\Mapping\AttributeInterface;
 
-/**
- * UploadableField.
- *
- * @Annotation
- * @Target({"PROPERTY"})
- * @NamedArgumentConstructor
- *
- * @author Dustin Dobervich <ddobervich@gmail.com>
- */
 #[\Attribute(\Attribute::TARGET_PROPERTY)]
-final class UploadableField implements AnnotationInterface
+final class UploadableField implements AttributeInterface
 {
     /**
      * Constructs a new instance of UploadableField.
diff --git a/src/Mapping/AttributeInterface.php b/src/Mapping/AttributeInterface.php
@@ -2,6 +2,6 @@
 
 namespace Vich\UploaderBundle\Mapping;
 
-interface AnnotationInterface
+interface AttributeInterface
 {
 }
diff --git a/src/Metadata/Driver/AttributeDriver.php b/src/Metadata/Driver/AttributeDriver.php
@@ -4,15 +4,15 @@
 
 use Metadata\ClassMetadata as JMSClassMetadata;
 use Metadata\Driver\AdvancedDriverInterface;
-use Vich\UploaderBundle\Mapping\Annotation\Uploadable;
-use Vich\UploaderBundle\Mapping\Annotation\UploadableField;
+use Vich\UploaderBundle\Mapping\Attribute\Uploadable;
+use Vich\UploaderBundle\Mapping\Attribute\UploadableField;
 use Vich\UploaderBundle\Metadata\ClassMetadata;
 
 /**
  * @author Kévin Gomez <contact@kevingomez.fr>
  * @author Konstantin Myakshin <koc-dp@yandex.ru>
  */
-class AnnotationDriver implements AdvancedDriverInterface
+class AttributeDriver implements AdvancedDriverInterface
 {
     /**
      * @param \Doctrine\Persistence\ManagerRegistry[] $managerRegistryList
@@ -44,7 +44,7 @@ public function loadMetadataForClass(\ReflectionClass $class): ?JMSClassMetadata
         }
 
         foreach ($properties as $property) {
-            $uploadableField = $this->reader->getPropertyAnnotation($property, UploadableField::class);
+            $uploadableField = $this->reader->getPropertyAttribute($property, UploadableField::class);
             if (!$uploadableField instanceof UploadableField) {
                 continue;
             }
@@ -93,6 +93,6 @@ public function getAllClassNames(): array
 
     protected function isUploadable(\ReflectionClass $class): bool
     {
-        return null !== $this->reader->getClassAnnotation($class, Uploadable::class);
+        return null !== $this->reader->getClassAttribute($class, Uploadable::class);
     }
 }
diff --git a/src/Metadata/Driver/AttributeReader.php b/src/Metadata/Driver/AttributeReader.php
@@ -2,50 +2,50 @@
 
 namespace Vich\UploaderBundle\Metadata\Driver;
 
-use Vich\UploaderBundle\Mapping\AnnotationInterface;
+use Vich\UploaderBundle\Mapping\AttributeInterface;
 
 /**
  * @internal
  */
 final class AttributeReader
 {
-    /** @return AnnotationInterface[] */
-    public function getClassAnnotations(\ReflectionClass $class): array
+    /** @return AttributeInterface[] */
+    public function getClassAttributes(\ReflectionClass $class): array
     {
         return $this->convertToAttributeInstances($class->getAttributes());
     }
 
-    public function getClassAnnotation(\ReflectionClass $class, string $annotationName): ?AnnotationInterface
+    public function getClassAttribute(\ReflectionClass $class, string $attributeName): ?AttributeInterface
     {
-        return $this->getClassAnnotations($class)[$annotationName] ?? null;
+        return $this->getClassAttributes($class)[$attributeName] ?? null;
     }
 
-    /** @return AnnotationInterface[] */
-    public function getMethodAnnotations(\ReflectionMethod $method): array
+    /** @return AttributeInterface[] */
+    public function getMethodAttributes(\ReflectionMethod $method): array
     {
         return $this->convertToAttributeInstances($method->getAttributes());
     }
 
-    public function getMethodAnnotation(\ReflectionMethod $method, string $annotationName): ?AnnotationInterface
+    public function getMethodAttribute(\ReflectionMethod $method, string $attributeName): ?AttributeInterface
     {
-        return $this->getMethodAnnotations($method)[$annotationName] ?? null;
+        return $this->getMethodAttributes($method)[$attributeName] ?? null;
     }
 
-    /** @return AnnotationInterface[] */
-    public function getPropertyAnnotations(\ReflectionProperty $property): array
+    /** @return AttributeInterface[] */
+    public function getPropertyAttributes(\ReflectionProperty $property): array
     {
         return $this->convertToAttributeInstances($property->getAttributes());
     }
 
-    public function getPropertyAnnotation(\ReflectionProperty $property, string $annotationName): ?AnnotationInterface
+    public function getPropertyAttribute(\ReflectionProperty $property, string $attributeName): ?AttributeInterface
     {
-        return $this->getPropertyAnnotations($property)[$annotationName] ?? null;
+        return $this->getPropertyAttributes($property)[$attributeName] ?? null;
     }
 
     /**
      * @param \ReflectionAttribute[] $attributes
      *
-     * @return AnnotationInterface[]
+     * @return AttributeInterface[]
      */
     private function convertToAttributeInstances(array $attributes): array
     {
@@ -55,7 +55,7 @@ private function convertToAttributeInstances(array $attributes): array
             $attributeName = $attribute->getName();
             $instance = $attribute->newInstance();
 
-            if (!$instance instanceof AnnotationInterface) {
+            if (!$instance instanceof AttributeInterface) {
                 continue;
             }
 
diff --git a/src/Validator/Constraints/FileRequired.php b/src/Validator/Constraints/FileRequired.php
@@ -4,10 +4,6 @@
 
 use Symfony\Component\Validator\Constraints\NotBlank;
 
-/**
- * @Annotation
- * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
- */
 #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
 class FileRequired extends NotBlank
 {
diff --git a/tests/DummyAttributeEntity.php b/tests/DummyAttributeEntity.php
@@ -2,7 +2,7 @@
 
 namespace Vich\UploaderBundle\Tests;
 
-use Vich\UploaderBundle\Mapping\Annotation as Vich;
+use Vich\UploaderBundle\Mapping\Attribute as Vich;
 
 /**
  * @author Mathieu Petrini
diff --git a/tests/DummyEntity.php b/tests/DummyEntity.php
@@ -2,7 +2,7 @@
 
 namespace Vich\UploaderBundle\Tests;
 
-use Vich\UploaderBundle\Mapping\Annotation as Vich;
+use Vich\UploaderBundle\Mapping\Attribute as Vich;
 
 /**
  * @author Dustin Dobervich <ddobervich@gmail.com>
diff --git a/tests/DummyFile.php b/tests/DummyFile.php
@@ -4,7 +4,7 @@
 
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\HttpFoundation\File\File as SymfonyFile;
-use Vich\UploaderBundle\Mapping\Annotation as Vich;
+use Vich\UploaderBundle\Mapping\Attribute as Vich;
 
 #[Vich\Uploadable]
 class DummyFile
diff --git a/tests/DummyImageFile.php b/tests/DummyImageFile.php
@@ -3,7 +3,7 @@
 namespace Vich\UploaderBundle\Tests;
 
 use Doctrine\ORM\Mapping as ORM;
-use Vich\UploaderBundle\Mapping\Annotation as Vich;
+use Vich\UploaderBundle\Mapping\Attribute as Vich;
 
 #[ORM\Entity]
 #[Vich\Uploadable]
diff --git a/tests/Fixtures/TestBundle/src/Entity/Article.php b/tests/Fixtures/TestBundle/src/Entity/Article.php
@@ -2,7 +2,7 @@
 
 namespace Vich\TestBundle\Entity;
 
-use Vich\UploaderBundle\Mapping\Annotation as Vich;
+use Vich\UploaderBundle\Mapping\Attribute as Vich;
 
 /**
  * @author Dustin Dobervich <ddobervich@gmail.com>
diff --git a/tests/Fixtures/TestBundle/src/Entity/Image.php b/tests/Fixtures/TestBundle/src/Entity/Image.php
@@ -3,7 +3,7 @@
 namespace Vich\TestBundle\Entity;
 
 use Symfony\Component\HttpFoundation\File\File;
-use Vich\UploaderBundle\Mapping\Annotation as Vich;
+use Vich\UploaderBundle\Mapping\Attribute as Vich;
 
 #[Vich\Uploadable]
 class Image
diff --git a/tests/Fixtures/TestBundle/src/Entity/ValidatedImage.php b/tests/Fixtures/TestBundle/src/Entity/ValidatedImage.php
@@ -4,7 +4,7 @@
 
 use Symfony\Component\HttpFoundation\File\File;
 use Vich\UploaderBundle\Entity\File as EmbeddedFile;
-use Vich\UploaderBundle\Mapping\Annotation as Vich;
+use Vich\UploaderBundle\Mapping\Attribute as Vich;
 use Vich\UploaderBundle\Validator\Constraints as VichAssert;
 
 #[Vich\Uploadable]
diff --git a/tests/Metadata/Driver/AttributeReaderTest.php b/tests/Metadata/Driver/AttributeReaderTest.php
diff --git a/tests/Validator/TestFileUploadEntity.php b/tests/Validator/TestFileUploadEntity.php

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public function process(ContainerBuilder $container): void`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`if (\count($managers) > 0) {`
`33`		`- $drivers[] = $container->getDefinition('vich_uploader.metadata_driver.annotation')`
	`33`	`+ $drivers[] = $container->getDefinition('vich_uploader.metadata_driver.attribute')`
`34`	`34`	`->replaceArgument('$managerRegistryList', $managers);`
`35`	`35`	`}`
`36`	`36`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public function load(array $configs, ContainerBuilder $container): void`
`53`	`53`
`54`	`54`	`$this->loadServicesFiles($container, $config);`
`55`	`55`	`$this->registerMetadataDirectories($container, $config);`
`56`		`- $this->registerAnnotationStrategy($container, $config);`
	`56`	`+ $this->registerAttributeStrategy($container);`
`57`	`57`	`$this->registerCacheStrategy($container, $config);`
`58`	`58`
`59`	`59`	`$this->registerListeners($container, $config);`
`@@ -136,9 +136,9 @@ protected function registerMetadataDirectories(ContainerBuilder $container, arra`
`136`	`136`	`;`
`137`	`137`	`}`
`138`	`138`
`139`		`- protected function registerAnnotationStrategy(ContainerBuilder $container, array $config): void`
	`139`	`+ protected function registerAttributeStrategy(ContainerBuilder $container): void`
`140`	`140`	`{`
`141`		`- if (!$container->has('vich_uploader.metadata_driver.annotation')) {`
	`141`	`+ if (!$container->has('vich_uploader.metadata_driver.attribute')) {`
`142`	`142`	`return;`
`143`	`143`	`}`
`144`	`144`
`@@ -173,7 +173,7 @@ protected function registerCacheStrategy(ContainerBuilder $container, array $con`
`173`	`173`
`174`	`174`	`protected function fixDbDriverConfig(array $config): array`
`175`	`175`	`{`
`176`		`- // mapping with no declared db_driver use the top-level one`
	`176`	`+ // mapping with no declared db_driver, use the top-level one`
`177`	`177`	`foreach ($config['mappings'] as &$mapping) {`
`178`	`178`	`$mapping['db_driver'] = $mapping['db_driver'] ?: $config['db_driver'];`
`179`	`179`	`}`