Merge pull request #269 from creative-commoners/pulls/3/deprecate

API Add deprecations

_config.php

@@ -5,5 +5,4 @@
 
 // Avoid creating global variables
 call_user_func(function () {
-
 });

src/Extensions/AjaxField.php

@@ -4,16 +4,27 @@
 
 use SilverStripe\Core\Extension;
 use SilverStripe\Forms\FormField;
+use SilverStripe\Dev\Deprecation;
 
 /**
  * Tweak fields that need to be served through the DynamicLink form schema and need to be able to receive AJAX calls.
  *
  * For example the TreeDropdownField need to be able to receive AJAX request to fetch the list of available SiteTrees.
  *
  * This is a bit hackish. There's probably a less dumb way of doing this.
+ *
+ * @deprecated 3.0.0 Will be removed without equivalent functionality to replace it
  */
 class AjaxField extends Extension
 {
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('3.0.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+        parent::__construct();
+    }
+
     public function updateLink(&$link, $action)
     {
         /** @var FormField $owner */

src/Extensions/FormFactoryExtension.php

@@ -8,14 +8,24 @@
 use SilverStripe\Forms\FormAction;
 use SilverStripe\LinkField\Form\FormFactory;
 use SilverStripe\LinkField\Models\Link;
+use SilverStripe\Dev\Deprecation;
 
 /**
  * Enhance the insert / edit link button label to match the model data state
  *
  * @method FormFactory getOwner()
+ * @deprecated 3.0.0 Will be removed without equivalent functionality to replace it
  */
 class FormFactoryExtension extends Extension
 {
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('3.0.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+        parent::__construct();
+    }
+
     /**
      * Extension point in @see FormFactory::getFormActions()
      *

src/Extensions/LeftAndMain.php

@@ -4,12 +4,23 @@
 
 use SilverStripe\Core\Extension;
 use SilverStripe\LinkField\Type\Registry;
+use SilverStripe\Dev\Deprecation;
 
 /**
  * Register a new Form Schema in LeftAndMain.
+ *
+ * @deprecated 3.0.0 Will be removed without equivalent functionality to replace it
  */
 class LeftAndMain extends Extension
 {
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('3.0.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+        parent::__construct();
+    }
+
     public function init()
     {
         // Get the Link Registry to load all the JS requirements for managing Links.

src/Extensions/ModalController.php

@@ -12,12 +12,15 @@
 use SilverStripe\LinkField\Models\Link;
 use SilverStripe\LinkField\Type\Registry;
 use SilverStripe\ORM\DataObject;
+use SilverStripe\Dev\Deprecation;
 
 /**
  * Extensions to apply to ModalController so it knows how to handle the DynamicLink action.
  *
  * This action receive a link type key and some link data as a JSON string and retrieve a Form Schema for a
  * specific Link Type.
+ *
+ * @deprecated 3.0.0 Will be removed without equivalent functionality to replace it
  */
 class ModalController extends Extension
 {
@@ -29,6 +32,14 @@ class ModalController extends Extension
         'DynamicLink',
     ];
 
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('3.0.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+        parent::__construct();
+    }
+
     /**
      * Builds and returns the external link form
      *

src/Form/FormFactory.php

@@ -7,12 +7,22 @@
 use SilverStripe\Forms\HiddenField;
 use SilverStripe\LinkField\Type\Type;
 use SilverStripe\ORM\DataObject;
+use SilverStripe\Dev\Deprecation;
 
 /**
  * Create Form schema for the LinkField based on a key provided by the request.
+ *
+ * @deprecated 3.0.0 Will be removed without equivalent functionality to replace it
  */
 class FormFactory extends LinkFormFactory
 {
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('3.0.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+    }
+
     protected function getFormFields($controller, $name, $context)
     {
         /** @var Type $type */

src/Form/JsonField.php

@@ -7,17 +7,28 @@
 use SilverStripe\LinkField\JsonData;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\DataObjectInterface;
+use SilverStripe\Dev\Deprecation;
 
 /**
  * Field designed to edit complex data passed as a JSON string. Other FormFields can be built on top of this one.
  *
  * It will output a hidden input with serialize JSON Data.
+ *
+ * @deprecated 3.0.0 Will be removed without equivalent functionality to replace it
  */
 abstract class JsonField extends FormField
 {
     protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_CUSTOM;
     protected $inputType = 'hidden';
 
+    public function __construct($name, $title = null, $value = null)
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('3.0.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+        parent::__construct($name, $title, $value);
+    }
+
     public function setValue($value, $data = null)
     {
         if ($value && $value instanceof JsonData) {

src/GraphQL/LinkDescriptionResolver.php

@@ -6,9 +6,20 @@
 use InvalidArgumentException;
 use SilverStripe\GraphQL\Schema\DataObject\Resolver;
 use SilverStripe\LinkField\Type\Registry;
+use SilverStripe\Dev\Deprecation;
 
+/**
+ * @deprecated 3.0.0 Will be removed without equivalent functionality to replace it
+ */
 class LinkDescriptionResolver extends Resolver
 {
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('3.0.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+    }
+
     public static function resolve($obj, $args = [], $context = [], ?ResolveInfo $info = null)
     {
         $data = json_decode($args['dataStr'], true);

src/GraphQL/LinkTypeResolver.php

@@ -7,9 +7,20 @@
 use SilverStripe\GraphQL\Schema\DataObject\Resolver;
 use SilverStripe\LinkField\Type\Registry;
 use SilverStripe\LinkField\Type\Type;
+use SilverStripe\Dev\Deprecation;
 
+/**
+ * @deprecated 3.0.0 Will be removed without equivalent functionality to replace it
+ */
 class LinkTypeResolver extends Resolver
 {
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('3.0.0', 'Will be removed without equivalent functionality to replace it', Deprecation::SCOPE_CLASS);
+        });
+    }
+
     public static function resolve($obj, $args = [], $context = [], ?ResolveInfo $info = null)
     {
         if (isset($args['keys']) && !is_array($args['keys'])) {

src/JsonData.php

@@ -6,6 +6,8 @@
 
 /**
  * An object that can be serialized and deserialized to JSON.
+ *
+ * @deprecated 3.0.0 Will be removed without equivalent functionality to replace it
  */
 interface JsonData extends JsonSerializable
 {

src/Models/EmailLink.php

@@ -4,6 +4,7 @@
 
 use SilverStripe\Forms\EmailField;
 use SilverStripe\Forms\FieldList;
+use SilverStripe\Dev\Deprecation;
 
 /**
  * A link to an Email address.
@@ -18,8 +19,14 @@ class EmailLink extends Link
         'Email' => 'Varchar(255)',
     ];
 
+    /**
+     * @deprecated 3.0.0 Will be removed in linkfield v4 which will use getDescription() instead
+     */
     public function generateLinkDescription(array $data): string
     {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('3.0.0', 'Will be removed in linkfield v4 which will use getDescription() instead.');
+        });
         return isset($data['Email']) ? $data['Email'] : '';
     }
 

src/Models/ExternalLink.php

@@ -2,6 +2,8 @@
 
 namespace SilverStripe\LinkField\Models;
 
+use SilverStripe\Dev\Deprecation;
+
 /**
  * A link to an external URL.
  *
@@ -15,8 +17,14 @@ class ExternalLink extends Link
         'ExternalUrl' => 'Varchar',
     ];
 
+    /**
+     * @deprecated 3.0.0 Will be removed in linkfield v4 which will use getDescription() instead
+     */
     public function generateLinkDescription(array $data): string
     {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('3.0.0', 'Will be removed in linkfield v4 which will use getDescription() instead.');
+        });
         return isset($data['ExternalUrl']) ? $data['ExternalUrl'] : '';
     }
 

src/Models/FileLink.php

@@ -3,6 +3,7 @@
 namespace SilverStripe\LinkField\Models;
 
 use SilverStripe\Assets\File;
+use SilverStripe\Dev\Deprecation;
 
 /**
  * A link to a File track in asset-admin
@@ -18,8 +19,14 @@ class FileLink extends Link
         'File' => File::class,
     ];
 
+    /**
+     * @deprecated 3.0.0 Will be removed in linkfield v4 which will use getDescription() instead
+     */
     public function generateLinkDescription(array $data): string
     {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('3.0.0', 'Will be removed in linkfield v4 which will use getDescription() instead.');
+        });
         $fileId = $data['FileID'] ?? null;
 
         if (!$fileId) {
@@ -31,8 +38,14 @@ public function generateLinkDescription(array $data): string
         return $file?->getFilename() ?? '';
     }
 
+    /**
+     * @deprecated 3.0.0 Will be removed in linkfield v4 which will use getLinkTypeHandlerName() instead
+     */
     public function LinkTypeHandlerName(): string
     {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice('3.0.0', 'Will be removed in linkfield v4 which will use getLinkTypeHandlerName() instead.');
+        });
         return 'InsertMediaModal';
     }