API Update deprecations (#375)

* ENH Update deprecation messages * API Update deprecations * API Update deprecation message
silverstripe · Oct 25, 2022 · ece9003 · ece9003
1 parent 6ebbc7d
commit ece9003
Show file tree

Hide file tree

Showing 20 changed files with 155 additions and 35 deletions.
diff --git a/_legacy/GraphQL/Extensions/DataObjectScaffolderExtension.php b/_legacy/GraphQL/Extensions/DataObjectScaffolderExtension.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Versioned\GraphQL\Extensions;
 
+use SilverStripe\Dev\Deprecation;
 use GraphQL\Type\Definition\ObjectType;
 use GraphQL\Type\Definition\Type;
 use SilverStripe\Core\Extension;
@@ -19,14 +20,19 @@
 }
 
 /**
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class DataObjectScaffolderExtension extends Extension
 {
     /**
      * Adds the "Version" and "Versions" fields to any dataobject that has the Versioned extension.
      * @param Manager $manager
      */
+    public function __construct()
+    {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
+    }
+
     public function onBeforeAddToManager(Manager $manager)
     {
         /* @var DataObjectScaffolder $owner */

diff --git a/_legacy/GraphQL/Extensions/DeleteExtension.php b/_legacy/GraphQL/Extensions/DeleteExtension.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Versioned\GraphQL\Extensions;
 
+use SilverStripe\Dev\Deprecation;
 use Exception;
 use SilverStripe\Core\Extension;
 use SilverStripe\GraphQL\Scaffolding\Scaffolders\CRUD\Delete;
@@ -18,7 +19,7 @@
 /**
  * Extends the @see Delete CRUD scaffolder to unpublish any items first
  *
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class DeleteExtension extends Extension
 {
@@ -30,6 +31,11 @@ class DeleteExtension extends Extension
      * @param array $context
      * @throws Exception
      */
+    public function __construct()
+    {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
+    }
+
     public function augmentMutation(DataList $objects, $args, $context)
     {
         foreach ($objects as $object) {

diff --git a/_legacy/GraphQL/Extensions/ManagerExtension.php b/_legacy/GraphQL/Extensions/ManagerExtension.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Versioned\GraphQL\Extensions;
 
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\Core\Extension;
 use SilverStripe\Versioned\GraphQL\Types\CopyToStageInputType;
 use SilverStripe\Versioned\GraphQL\Types\VersionedInputType;
@@ -17,7 +18,7 @@
 }
 
 /**
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class ManagerExtension extends Extension
 {
@@ -26,6 +27,11 @@ class ManagerExtension extends Extension
      *
      * @param $config
      */
+    public function __construct()
+    {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
+    }
+
     public function updateConfig(&$config)
     {
         if (!isset($config['types'])) {

diff --git a/_legacy/GraphQL/Extensions/ReadExtension.php b/_legacy/GraphQL/Extensions/ReadExtension.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Versioned\GraphQL\Extensions;
 
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\Core\Extension;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\GraphQL\Resolvers\ApplyVersionFilters;
@@ -21,10 +22,15 @@
  * Decorator for either a Read or ReadOne query scaffolder
  *
  * @property Read|ReadOne $owner
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class ReadExtension extends Extension
 {
+    public function __construct()
+    {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
+    }
+
     public function updateList(DataList &$list, $args)
     {
         if (!isset($args[$this->argName()])) {

diff --git a/_legacy/GraphQL/Extensions/SchemaScaffolderExtension.php b/_legacy/GraphQL/Extensions/SchemaScaffolderExtension.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Versioned\GraphQL\Extensions;
 
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\Core\Extension;
 use SilverStripe\GraphQL\Manager;
 use SilverStripe\GraphQL\Scaffolding\Scaffolders\SchemaScaffolder;
@@ -16,7 +17,7 @@
 }
 
 /**
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class SchemaScaffolderExtension extends Extension
 {
@@ -26,6 +27,11 @@ class SchemaScaffolderExtension extends Extension
      *
      * @param Manager $manager
      */
+    public function __construct()
+    {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
+    }
+
     public function onBeforeAddToManager(Manager $manager)
     {
         $memberType = StaticSchema::inst()->typeNameForDataObject(Member::class);

diff --git a/_legacy/GraphQL/Operations/CopyToStage.php b/_legacy/GraphQL/Operations/CopyToStage.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Versioned\GraphQL\Operations;
 
+use SilverStripe\Dev\Deprecation;
 use GraphQL\Type\Definition\ResolveInfo;
 use GraphQL\Type\Definition\Type;
 use InvalidArgumentException;
@@ -24,7 +25,7 @@
  * copy[TypeName]ToStage(ID!, FromVersion!, FromStage!, ToStage!)
  *
  * @internal This is a low level API that might be removed in the future. Consider using the "rollback" mutation instead
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class CopyToStage extends MutationScaffolder implements OperationResolver
 {
@@ -35,6 +36,7 @@ class CopyToStage extends MutationScaffolder implements OperationResolver
      */
     public function __construct($dataObjectClass)
     {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
         parent::__construct(null, null, $this, $dataObjectClass);
     }
 

diff --git a/_legacy/GraphQL/Operations/Publish.php b/_legacy/GraphQL/Operations/Publish.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Versioned\GraphQL\Operations;
 
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\ORM\DataObjectInterface;
 use SilverStripe\Security\Member;
 use SilverStripe\Versioned\RecursivePublishable;
@@ -16,13 +17,21 @@
 /**
  * Scaffolds a generic update operation for DataObjects.
  *
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class Publish extends PublishOperation
 {
     /**
+     * @param string $dataObjectClass
+     *
      * @return string
      */
+    public function __construct($dataObjectClass)
+    {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
+        parent::__construct($dataObjectClass);
+    }
+
     protected function createOperationName()
     {
         return 'publish' . ucfirst($this->getTypeName());

diff --git a/_legacy/GraphQL/Operations/PublishOperation.php b/_legacy/GraphQL/Operations/PublishOperation.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Versioned\GraphQL\Operations;
 
+use SilverStripe\Dev\Deprecation;
 use Exception;
 use GraphQL\Type\Definition\ResolveInfo;
 use GraphQL\Type\Definition\Type;
@@ -24,7 +25,7 @@
 /**
  * Scaffolds a generic update operation for DataObjects.
  *
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 abstract class PublishOperation extends MutationScaffolder implements OperationResolver
 {
@@ -33,6 +34,7 @@ abstract class PublishOperation extends MutationScaffolder implements OperationR
      */
     public function __construct($dataObjectClass)
     {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
         parent::__construct(null, null, $this, $dataObjectClass);
     }
 

diff --git a/_legacy/GraphQL/Operations/ReadVersions.php b/_legacy/GraphQL/Operations/ReadVersions.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Versioned\GraphQL\Operations;
 
+use SilverStripe\Dev\Deprecation;
 use Exception;
 use SilverStripe\Core\Injector\Injectable;
 use GraphQL\Type\Definition\ResolveInfo;
@@ -19,7 +20,7 @@
 /**
  * Scaffolds a generic read operation for DataObjects.
  *
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class ReadVersions extends ListQueryScaffolder implements OperationResolver
 {
@@ -32,6 +33,7 @@ class ReadVersions extends ListQueryScaffolder implements OperationResolver
      */
     public function __construct($dataObjectClass, $versionTypeName)
     {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
         $this->setDataObjectClass($dataObjectClass);
         $operationName = 'read' . ucfirst($versionTypeName);
 

diff --git a/_legacy/GraphQL/Operations/Rollback.php b/_legacy/GraphQL/Operations/Rollback.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Versioned\GraphQL\Operations;
 
+use SilverStripe\Dev\Deprecation;
 use GraphQL\Type\Definition\ResolveInfo;
 use GraphQL\Type\Definition\Type;
 use InvalidArgumentException;
@@ -23,7 +24,7 @@
  *
  * rollback[TypeName](ID!, ToVersion!)
  *
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class Rollback extends MutationScaffolder implements OperationResolver
 {
@@ -34,6 +35,7 @@ class Rollback extends MutationScaffolder implements OperationResolver
      */
     public function __construct($dataObjectClass)
     {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
         parent::__construct(null, null, $this, $dataObjectClass);
     }
 

diff --git a/_legacy/GraphQL/Operations/Unpublish.php b/_legacy/GraphQL/Operations/Unpublish.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Versioned\GraphQL\Operations;
 
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\DataObjectInterface;
 use SilverStripe\Security\Member;
@@ -16,13 +17,21 @@
 /**
  * Scaffolds a generic update operation for DataObjects.
  *
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class Unpublish extends PublishOperation
 {
     /**
+     * @param string $dataObjectClass
+     *
      * @return string
      */
+    public function __construct($dataObjectClass)
+    {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
+        parent::__construct($dataObjectClass);
+    }
+
     protected function createOperationName()
     {
         return 'unpublish'.ucfirst($this->getTypeName());

diff --git a/_legacy/GraphQL/Resolvers/ApplyVersionFilters.php b/_legacy/GraphQL/Resolvers/ApplyVersionFilters.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\GraphQL\Resolvers;
 
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\GraphQL\Scaffolding\StaticSchema;
 use SilverStripe\ORM\DataList;
 use SilverStripe\Versioned\Versioned;
@@ -15,7 +16,7 @@
 }
 
 /**
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class ApplyVersionFilters
 {
@@ -27,6 +28,11 @@ class ApplyVersionFilters
      *
      * @param $versioningArgs
      */
+    public function __construct()
+    {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
+    }
+
     public function applyToReadingState($versioningArgs)
     {
         list ($mode, $archiveDate) = StaticSchema::inst()->extractKeys(

diff --git a/_legacy/GraphQL/Types/CopyToStageInputType.php b/_legacy/GraphQL/Types/CopyToStageInputType.php
@@ -2,8 +2,10 @@
 
 namespace SilverStripe\Versioned\GraphQL\Types;
 
+use SilverStripe\Dev\Deprecation;
 use GraphQL\Type\Definition\Type;
 use SilverStripe\GraphQL\Scaffolding\StaticSchema;
+use SilverStripe\GraphQL\Manager;
 use SilverStripe\GraphQL\TypeCreator;
 
 // GraphQL dependency is optional in versioned,
@@ -13,7 +15,7 @@
 }
 
 /**
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class CopyToStageInputType extends TypeCreator
 {
@@ -25,6 +27,12 @@ class CopyToStageInputType extends TypeCreator
     /**
      * @return array
      */
+    public function __construct(Manager $manager = null)
+    {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
+        parent::__construct($manager);
+    }
+
     public function attributes()
     {
         return [

diff --git a/_legacy/GraphQL/Types/VersionSortType.php b/_legacy/GraphQL/Types/VersionSortType.php
@@ -3,8 +3,10 @@
 
 namespace SilverStripe\Versioned\GraphQL\Types;
 
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\GraphQL\Pagination\SortDirectionTypeCreator;
+use SilverStripe\GraphQL\Manager;
 use SilverStripe\GraphQL\TypeCreator;
 
 // GraphQL dependency is optional in versioned,
@@ -14,7 +16,7 @@
 }
 
 /**
- * @deprecated 4.8..5.0 Use silverstripe/graphql:^4 functionality.
+ * @deprecated 1.8.0 Use the latest version of graphql instead
  */
 class VersionSortType extends TypeCreator
 {
@@ -31,6 +33,12 @@ class VersionSortType extends TypeCreator
     /**
      * @return array
      */
+    public function __construct(Manager $manager = null)
+    {
+        Deprecation::notice('1.8.0', 'Use the latest version of graphql instead', Deprecation::SCOPE_CLASS);
+        parent::__construct($manager);
+    }
+
     public function attributes()
     {
         return [