Merge pull request #957 from GSadee/SYL-3888-deprecate-variant-exception

Deprecate VariantWithNoOptionsValuesException
Sylius · Oct 23, 2024 · d4457c6 · d4457c6
2 parents 44d53e9 + 6582fa5
commit d4457c6
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 1 deletion.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,3 +1,10 @@
+## UPGRADE FOR `1.13.x`
+
+### FROM `1.12.x` to `1.13.x`
+
+The `Sylius\Resource\Exception\VariantWithNoOptionsValuesException` and `Sylius\Component\Resource\Exception\VariantWithNoOptionsValuesException` 
+classes have been deprecated and will be removed in `2.0`.
+
 ## UPGRADE FOR `1.12.x`
 
 ### FROM `1.11.x` to `1.12.x`

diff --git a/psalm.xml b/psalm.xml
@@ -46,6 +46,8 @@
         <DeprecatedClass>
             <errorLevel type="info">
                 <referencedClass name="Doctrine\ORM\Event\LifecycleEventArgs" /> <!-- deprecated in doctrine/orm 2.14 -->
+                <referencedClass name="Sylius\Component\Resource\Exception\VariantWithNoOptionsValuesException" />
+                <referencedClass name="Sylius\Resource\Exception\VariantWithNoOptionsValuesException" />
             </errorLevel>
         </DeprecatedClass>
 
@@ -67,7 +69,7 @@
                 <file name="src/Bundle/Controller/Parameters.php" />
             </errorLevel>
         </DuplicateClass>
-        
+
         <InternalClass>
             <errorLevel type="suppress">
                 <file name="src/Bundle/DependencyInjection/PagerfantaExtension.php" />

diff --git a/src/Component/legacy/src/Exception/VariantWithNoOptionsValuesException.php b/src/Component/legacy/src/Exception/VariantWithNoOptionsValuesException.php
@@ -16,6 +16,14 @@
 class_exists(\Sylius\Resource\Exception\VariantWithNoOptionsValuesException::class);
 
 if (false) {
+    trigger_deprecation(
+        'sylius/resource-bundle',
+        '1.13',
+        'The "%s" class is deprecated and will be removed in 2.0.',
+        VariantWithNoOptionsValuesException::class,
+    );
+
+    /** @deprecated since SyliusResourceBundle 1.13 and will be removed in 2.0. */
     final class VariantWithNoOptionsValuesException extends \Sylius\Resource\Exception\VariantWithNoOptionsValuesException
     {
     }

diff --git a/src/Component/src/Exception/VariantWithNoOptionsValuesException.php b/src/Component/src/Exception/VariantWithNoOptionsValuesException.php
@@ -13,6 +13,14 @@
 
 namespace Sylius\Resource\Exception;
 
+trigger_deprecation(
+    'sylius/resource-bundle',
+    '1.13',
+    'The "%s" class is deprecated and will be removed in 2.0.',
+    VariantWithNoOptionsValuesException::class,
+);
+
+/** @deprecated since SyliusResourceBundle 1.13 and will be removed in 2.0. */
 final class VariantWithNoOptionsValuesException extends Exception
 {
     public function __construct()