API Deprecate GraphQL

silverstripe · Aug 15, 2024 · 33cc4b0 · 33cc4b0
1 parent 4bc9abd
commit 33cc4b0
Show file tree

Hide file tree

Showing 10 changed files with 96 additions and 1 deletion.
diff --git a/src/GraphQL/Operations/AbstractPublishOperationCreator.php b/src/GraphQL/Operations/AbstractPublishOperationCreator.php
@@ -23,6 +23,7 @@
 use SilverStripe\Versioned\GraphQL\Resolvers\VersionedResolver;
 use SilverStripe\Versioned\Versioned;
 use SilverStripe\View\ViewableData;
+use SilverStripe\Dev\Deprecation;
 
 // GraphQL dependency is optional in versioned,
 // and the following implementation relies on existence of this class (in GraphQL v4)
@@ -32,6 +33,7 @@
 
 /**
  * Scaffolds a generic update operation for DataObjects.
+ * @deprecated 5.3.0 Will be removed without equivalent functionality to replace it
  */
 abstract class AbstractPublishOperationCreator implements OperationCreator
 {
@@ -41,6 +43,13 @@ abstract class AbstractPublishOperationCreator implements OperationCreator
     const ACTION_PUBLISH = 'publish';
     const ACTION_UNPUBLISH = 'unpublish';
 
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('5.3.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+    }
+
     /**
      * @param SchemaModelInterface $model
      * @param string $typeName

diff --git a/src/GraphQL/Operations/CopyToStageCreator.php b/src/GraphQL/Operations/CopyToStageCreator.php
@@ -13,6 +13,7 @@
 use SilverStripe\Versioned\GraphQL\Resolvers\VersionedResolver;
 use SilverStripe\Versioned\Versioned;
 use SilverStripe\View\ViewableData;
+use SilverStripe\Dev\Deprecation;
 
 // GraphQL dependency is optional in versioned,
 // and the following implementation relies on existence of this class (in GraphQL v4)
@@ -25,12 +26,20 @@
  *
  * copy[TypeName]ToStage(ID!, FromVersion!, FromStage!, ToStage!)
  *
+ * @deprecated 5.3.0 Will be removed without equivalent functionality to replace it
  */
 class CopyToStageCreator implements OperationCreator
 {
     use Configurable;
     use Injectable;
 
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('5.3.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+    }
+
     /**
      * @var array
      * @config

diff --git a/src/GraphQL/Operations/PublishCreator.php b/src/GraphQL/Operations/PublishCreator.php
@@ -3,6 +3,7 @@
 namespace SilverStripe\Versioned\GraphQL\Operations;
 
 use SilverStripe\GraphQL\Schema\Interfaces\OperationCreator;
+use SilverStripe\Dev\Deprecation;
 
 // GraphQL dependency is optional in versioned,
 // and the following implementation relies on existence of this class (in GraphQL v4)
@@ -12,10 +13,11 @@
 
 /**
  * Scaffolds a generic update operation for DataObjects.
+ *
+ * @deprecated 5.3.0 Will be removed without equivalent functionality to replace it
  */
 class PublishCreator extends AbstractPublishOperationCreator
 {
-
     /**
      * @param string $typeName
      * @return string

diff --git a/src/GraphQL/Operations/RollbackCreator.php b/src/GraphQL/Operations/RollbackCreator.php
@@ -12,6 +12,7 @@
 use SilverStripe\Versioned\GraphQL\Resolvers\VersionedResolver;
 use SilverStripe\Versioned\Versioned;
 use SilverStripe\View\ViewableData;
+use SilverStripe\Dev\Deprecation;
 
 // GraphQL dependency is optional in versioned,
 // and the following implementation relies on existence of this class (in GraphQL v4)
@@ -23,12 +24,21 @@
  * Scaffolds a "rollback recursive" operation for DataObjects.
  *
  * rollback[TypeName](ID!, ToVersion!)
+ *
+ * @deprecated 5.3.0 Will be removed without equivalent functionality to replace it
  */
 class RollbackCreator implements OperationCreator
 {
     use Injectable;
     use Configurable;
 
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('5.3.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+    }
+
     /**
      * @var array
      * @config

diff --git a/src/GraphQL/Operations/UnpublishCreator.php b/src/GraphQL/Operations/UnpublishCreator.php
@@ -3,6 +3,7 @@
 namespace SilverStripe\Versioned\GraphQL\Operations;
 
 use SilverStripe\GraphQL\Schema\Interfaces\OperationCreator;
+use SilverStripe\Dev\Deprecation;
 
 // GraphQL dependency is optional in versioned,
 // and the following implementation relies on existence of this class (in GraphQL v4)
@@ -12,9 +13,18 @@
 
 /**
  * Scaffolds a generic update operation for DataObjects.
+ *
+ * @deprecated 5.3.0 Will be removed without equivalent functionality to replace it
  */
 class UnpublishCreator extends AbstractPublishOperationCreator
 {
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('5.3.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+    }
+
     /**
      * @param string $typeName
      * @return string

diff --git a/src/GraphQL/Plugins/UnpublishOnDelete.php b/src/GraphQL/Plugins/UnpublishOnDelete.php
@@ -15,17 +15,28 @@
 use Exception;
 use Closure;
 use SilverStripe\View\ViewableData;
+use SilverStripe\Dev\Deprecation;
 
 // GraphQL dependency is optional in versioned,
 // and the following implementation relies on existence of this class (in GraphQL v4)
 if (!interface_exists(ModelMutationPlugin::class)) {
     return;
 }
 
+/**
+ * @deprecated 5.3.0 Will be removed without equivalent functionality to replace it
+ */
 class UnpublishOnDelete implements ModelMutationPlugin
 {
     const IDENTIFIER = 'unpublishOnDelete';
 
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('5.3.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+    }
+
     /**
      * @return string
      */

diff --git a/src/GraphQL/Plugins/VersionedDataObject.php b/src/GraphQL/Plugins/VersionedDataObject.php
@@ -23,17 +23,28 @@
 use SilverStripe\Versioned\Versioned;
 use Closure;
 use SilverStripe\View\ViewableData;
+use SilverStripe\Dev\Deprecation;
 
 // GraphQL dependency is optional in versioned,
 // and the following implementation relies on existence of this class (in GraphQL v4)
 if (!interface_exists(ModelTypePlugin::class)) {
     return;
 }
 
+/**
+ * @deprecated 5.3.0 Will be removed without equivalent functionality to replace it
+ */
 class VersionedDataObject implements ModelTypePlugin, SchemaUpdater
 {
     const IDENTIFIER = 'versioning';
 
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('5.3.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+    }
+
     /**
      * @return string
      */

diff --git a/src/GraphQL/Plugins/VersionedRead.php b/src/GraphQL/Plugins/VersionedRead.php
@@ -9,17 +9,28 @@
 use SilverStripe\Versioned\GraphQL\Resolvers\VersionedResolver;
 use SilverStripe\Versioned\Versioned;
 use SilverStripe\View\ViewableData;
+use SilverStripe\Dev\Deprecation;
 
 // GraphQL dependency is optional in versioned,
 // and the following implementation relies on existence of this class (in GraphQL v4)
 if (!interface_exists(ModelQueryPlugin::class)) {
     return;
 }
 
+/**
+ * @deprecated 5.3.0 Will be removed without equivalent functionality to replace it
+ */
 class VersionedRead implements ModelQueryPlugin
 {
     const IDENTIFIER = 'readVersion';
 
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('5.3.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+    }
+
     /**
      * @return string
      */

diff --git a/src/GraphQL/Resolvers/VersionFilters.php b/src/GraphQL/Resolvers/VersionFilters.php
@@ -8,9 +8,20 @@
 use SilverStripe\Versioned\Versioned;
 use InvalidArgumentException;
 use DateTime;
+use SilverStripe\Dev\Deprecation;
 
+/**
+ * @deprecated 5.3.0 Will be removed without equivalent functionality to replace it
+ */
 class VersionFilters
 {
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('5.3.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+    }
+
     /**
      * Use this as a fallback where resolver results aren't queried as a DataList,
      * but rather use DataObject::get_one(). Example: SiteTree::get_by_link().

diff --git a/src/GraphQL/Resolvers/VersionedResolver.php b/src/GraphQL/Resolvers/VersionedResolver.php
@@ -21,11 +21,22 @@
 use Exception;
 use Closure;
 use InvalidArgumentException;
+use SilverStripe\Dev\Deprecation;
 
+/**
+ * @deprecated 5.3.0 Will be removed without equivalent functionality to replace it
+ */
 class VersionedResolver
 {
     private static $priority = 1;
 
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('5.3.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+    }
+
     /**
      * @param DataObject $obj
      * @param array $args