Standardize runtime deprecation handling to the `doctrine/deprecation…

…s` library (#2754) * Standardize runtime deprecation handling to the doctrine/deprecations library * Update src/Sortable/SortableListener.php --------- Co-authored-by: Fran Moreno <[email protected]>
doctrine-extensions · Feb 11, 2024 · 0632ab1 · 0632ab1
1 parent 8ac6b0b
commit 0632ab1
Show file tree

Hide file tree

Showing 34 changed files with 201 additions and 92 deletions.
diff --git a/composer.json b/composer.json
@@ -44,11 +44,11 @@
         "behat/transliterator": "^1.2",
         "doctrine/collections": "^1.2 || ^2.0",
         "doctrine/common": "^2.13 || ^3.0",
+        "doctrine/deprecations": "^1.0",
         "doctrine/event-manager": "^1.2 || ^2.0",
         "doctrine/persistence": "^2.2 || ^3.0",
         "psr/cache": "^1 || ^2 || ^3",
-        "symfony/cache": "^5.4 || ^6.0 || ^7.0",
-        "symfony/deprecation-contracts": "^2.1 || ^3.0"
+        "symfony/cache": "^5.4 || ^6.0 || ^7.0"
     },
     "require-dev": {
         "doctrine/annotations": "^1.13 || ^2.0",

diff --git a/src/DoctrineExtensions.php b/src/DoctrineExtensions.php
@@ -12,6 +12,7 @@
 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Common\Annotations\PsrCachedReader;
 use Doctrine\Common\Annotations\Reader;
+use Doctrine\Deprecations\Deprecation;
 use Doctrine\ODM\MongoDB\Mapping\Driver as DriverMongodbODM;
 use Doctrine\ORM\Mapping\Driver as DriverORM;
 use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
@@ -120,10 +121,12 @@ public static function registerAbstractMappingIntoDriverChainMongodbODM(MappingD
      */
     public static function registerAnnotations(): void
     {
-        @trigger_error(sprintf(
+        Deprecation::trigger(
+            'gedmo/doctrine-extensions',
+            'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2558',
             '"%s()" is deprecated since gedmo/doctrine-extensions 3.11 and will be removed in version 4.0.',
             __METHOD__
-        ), E_USER_DEPRECATED);
+        );
 
         // Purposefully no-op'd, all supported versions of `doctrine/annotations` support autoloading
     }

diff --git a/src/Mapping/Annotation/All.php b/src/Mapping/Annotation/All.php
@@ -7,10 +7,14 @@
  * file that was distributed with this source code.
  */
 
-@trigger_error(sprintf(
+use Doctrine\Deprecations\Deprecation;
+
+Deprecation::trigger(
+    'gedmo/doctrine-extensions',
+    'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2558',
     'Requiring the file at "%s" is deprecated since gedmo/doctrine-extensions 3.11, this file will be removed in version 4.0.',
     __FILE__
-), E_USER_DEPRECATED);
+);
 
 // Contains all annotations for extensions
 // NOTE: should be included with require_once

diff --git a/src/Mapping/Annotation/Blameable.php b/src/Mapping/Annotation/Blameable.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
@@ -42,10 +43,12 @@ final class Blameable implements GedmoAnnotation
     public function __construct(array $data = [], string $on = 'update', $field = null, $value = null)
     {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2375',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/IpTraceable.php b/src/Mapping/Annotation/IpTraceable.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
@@ -43,10 +44,12 @@ final class IpTraceable implements GedmoAnnotation
     public function __construct(array $data = [], string $on = 'update', $field = null, $value = null)
     {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2377',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/Loggable.php b/src/Mapping/Annotation/Loggable.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Loggable\LogEntryInterface;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
@@ -46,10 +47,12 @@ final class Loggable implements GedmoAnnotation
     public function __construct(array $data = [], ?string $logEntryClass = null)
     {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2357',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/Reference.php b/src/Mapping/Annotation/Reference.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
@@ -67,10 +68,12 @@ public function __construct(
         ?string $inversedBy = null
     ) {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2389',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/ReferenceIntegrity.php b/src/Mapping/Annotation/ReferenceIntegrity.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
@@ -39,10 +40,12 @@ public function __construct($data = [], ?string $value = null)
         if (is_string($data)) {
             $value = $data;
         } elseif ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2389',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/Slug.php b/src/Mapping/Annotation/Slug.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
@@ -65,10 +66,12 @@ public function __construct(
         string $dateFormat = 'Y-m-d-H:i'
     ) {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2379',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/SlugHandler.php b/src/Mapping/Annotation/SlugHandler.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 use Gedmo\Sluggable\Handler\SlugHandlerInterface;
 
@@ -49,10 +50,12 @@ public function __construct(
         array $options = []
     ) {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2379',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/SlugHandlerOption.php b/src/Mapping/Annotation/SlugHandlerOption.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
@@ -42,10 +43,12 @@ public function __construct(
         $value = null
     ) {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2379',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/SoftDeleteable.php b/src/Mapping/Annotation/SoftDeleteable.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
@@ -40,10 +41,12 @@ final class SoftDeleteable implements GedmoAnnotation
     public function __construct(array $data = [], string $fieldName = 'deletedAt', bool $timeAware = false, bool $hardDelete = true)
     {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2374',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/Timestampable.php b/src/Mapping/Annotation/Timestampable.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
@@ -42,10 +43,12 @@ final class Timestampable implements GedmoAnnotation
     public function __construct(array $data = [], string $on = 'update', $field = null, $value = null)
     {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2325',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/Translatable.php b/src/Mapping/Annotation/Translatable.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
@@ -37,10 +38,12 @@ final class Translatable implements GedmoAnnotation
     public function __construct(array $data = [], ?bool $fallback = null)
     {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2253',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/TranslationEntity.php b/src/Mapping/Annotation/TranslationEntity.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
@@ -37,10 +38,12 @@ final class TranslationEntity implements GedmoAnnotation
     public function __construct(array $data = [], string $class = '')
     {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2253',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/Tree.php b/src/Mapping/Annotation/Tree.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
@@ -60,10 +61,12 @@ public function __construct(
         ?string $identifierMethod = null
     ) {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2388',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/TreeClosure.php b/src/Mapping/Annotation/TreeClosure.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 use Gedmo\Tree\Entity\MappedSuperclass\AbstractClosure;
 
@@ -42,10 +43,12 @@ final class TreeClosure implements GedmoAnnotation
     public function __construct(array $data = [], string $class = '')
     {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2388',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();
 

diff --git a/src/Mapping/Annotation/TreeLevel.php b/src/Mapping/Annotation/TreeLevel.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Mapping\Annotation;
 
 use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Deprecations\Deprecation;
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
@@ -41,10 +42,12 @@ public function __construct(
         int $base = 0
     ) {
         if ([] !== $data) {
-            @trigger_error(sprintf(
+            Deprecation::trigger(
+                'gedmo/doctrine-extensions',
+                'https://github.com/doctrine-extensions/DoctrineExtensions/pull/2388',
                 'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
                 __METHOD__
-            ), E_USER_DEPRECATED);
+            );
 
             $args = func_get_args();