Merge pull request #1251 from creative-commoners/pulls/5/deprecate-to…

…p-page-classes API Deprecate TopPage classes which are being renamed
silverstripe · Sep 9, 2024 · b923eae · b923eae
2 parents 13f6a3f + 2410220
commit b923eae
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 0 deletions.
diff --git a/src/TopPage/DataExtension.php b/src/TopPage/DataExtension.php
@@ -12,6 +12,7 @@
 use SilverStripe\ORM\ValidationException;
 use SilverStripe\View\ViewableData;
 use SilverStripe\Forms\FieldList;
+use SilverStripe\Dev\Deprecation;
 
 /**
  * Class DataExtension
@@ -23,6 +24,8 @@
  * @method SiteTree TopPage()
  *
  * @extends BaseDataExtension<BaseElement|ElementalArea|static>
+ *
+ * @deprecated 5.4.0 Will be replaced with DNADesign\Elemental\Extensions\TopPageElementExtension
  */
 class DataExtension extends BaseDataExtension
 {
@@ -51,6 +54,17 @@ class DataExtension extends BaseDataExtension
      */
     private $fixedTopPageID = 0;
 
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice(
+                '5.4.0',
+                'Will be replaced with DNADesign\Elemental\Extensions\TopPageElementExtension',
+                Deprecation::SCOPE_CLASS
+            );
+        });
+    }
+
     /**
      * Extension point in @see DataObject::onAfterWrite()
      *

diff --git a/src/TopPage/FluentExtension.php b/src/TopPage/FluentExtension.php
@@ -9,6 +9,7 @@
 use SilverStripe\ORM\Queries\SQLUpdate;
 use TractorCow\Fluent\State\FluentState;
 use SilverStripe\Forms\FieldList;
+use SilverStripe\Dev\Deprecation;
 
 /**
  * Class FluentExtension
@@ -19,6 +20,8 @@
  * @property string $TopPageLocale
  *
  * @extends DataExtension<DataObject&static>
+ *
+ * @deprecated 5.4.0 Will be replaced with DNADesign\Elemental\Extensions\TopPageFluentElementExtension
  */
 class FluentExtension extends DataExtension
 {
@@ -29,6 +32,17 @@ class FluentExtension extends DataExtension
         'TopPageLocale' => 'Varchar',
     ];
 
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice(
+                '5.4.0',
+                'Will be replaced with DNADesign\Elemental\Extensions\TopPageFluentElementExtension',
+                Deprecation::SCOPE_CLASS
+            );
+        });
+    }
+
     public function updateCMSFields(FieldList $fields)
     {
         $fields->removeByName('TopPageID');

diff --git a/src/TopPage/SiteTreeExtension.php b/src/TopPage/SiteTreeExtension.php
@@ -7,6 +7,7 @@
 use SilverStripe\CMS\Model\SiteTreeExtension as BaseSiteTreeExtension;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\ValidationException;
+use SilverStripe\Dev\Deprecation;
 
 /**
  * Class SiteTreeExtension
@@ -15,6 +16,8 @@
  * It can be applied directly to Page, as it only takes effect in the presence of a ElementalArea.
  *
  * @extends BaseSiteTreeExtension<SiteTree&ElementalPageExtension&static>
+ *
+ * @deprecated 5.4.0 Will be replaced with DNADesign\Elemental\Extensions\TopPageSiteTreeExtension
  */
 class SiteTreeExtension extends BaseSiteTreeExtension
 {
@@ -32,6 +35,17 @@ class SiteTreeExtension extends BaseSiteTreeExtension
      */
     protected $duplicatedObjects = [];
 
+    public function __construct()
+    {
+        Deprecation::withNoReplacement(function () {
+            Deprecation::notice(
+                '5.4.0',
+                'Will be replaced with DNADesign\Elemental\Extensions\TopPageSiteTreeExtension',
+                Deprecation::SCOPE_CLASS
+            );
+        });
+    }
+
     /**
      * Extension point in @see DataObject::onAfterWrite()
      *