From 7ad58bb9a0c9e3897bf3afa7abbd167f0a2f980c Mon Sep 17 00:00:00 2001 From: Steve Boyd Date: Tue, 20 Aug 2024 13:29:04 +1200 Subject: [PATCH] API Deprecate widget classes --- src/Model/BlogPostFeaturedExtension.php | 14 ++++++++++++++ src/Widgets/BlogArchiveWidget.php | 15 +++++++++++++++ src/Widgets/BlogArchiveWidgetController.php | 16 +++++++++++++++- src/Widgets/BlogCategoriesWidget.php | 15 +++++++++++++++ src/Widgets/BlogCategoriesWidgetController.php | 16 +++++++++++++++- src/Widgets/BlogFeaturedPostsWidget.php | 15 +++++++++++++++ src/Widgets/BlogRecentPostsWidget.php | 15 +++++++++++++++ src/Widgets/BlogRecentPostsWidgetController.php | 16 +++++++++++++++- src/Widgets/BlogTagsCloudWidget.php | 14 ++++++++++++++ src/Widgets/BlogTagsCloudWidgetController.php | 15 +++++++++++++++ src/Widgets/BlogTagsWidget.php | 15 +++++++++++++++ src/Widgets/BlogTagsWidgetController.php | 16 +++++++++++++++- 12 files changed, 178 insertions(+), 4 deletions(-) diff --git a/src/Model/BlogPostFeaturedExtension.php b/src/Model/BlogPostFeaturedExtension.php index e98dd0d..9d7ba44 100644 --- a/src/Model/BlogPostFeaturedExtension.php +++ b/src/Model/BlogPostFeaturedExtension.php @@ -5,14 +5,28 @@ namespace SilverStripe\Blog\Model; use SilverStripe\ORM\DataExtension; use SilverStripe\Forms\FieldList; use SilverStripe\Forms\CheckboxField; +use SilverStripe\Dev\Deprecation; /** * Adds a checkbox field for featured blog posts widget. * * @extends DataExtension + * @deprecated 4.3.0 Will be removed without equivalent functionality to replace it */ class BlogPostFeaturedExtension extends DataExtension { + public function __construct() + { + Deprecation::withNoReplacement(function () { + Deprecation::notice( + '4.3.0', + 'Will be removed without equivalent functionality to replace it', + Deprecation::SCOPE_CLASS + ); + }); + parent::__construct(); + } + /** * @var array */ diff --git a/src/Widgets/BlogArchiveWidget.php b/src/Widgets/BlogArchiveWidget.php index 30d00ac..f46a814 100644 --- a/src/Widgets/BlogArchiveWidget.php +++ b/src/Widgets/BlogArchiveWidget.php @@ -16,6 +16,8 @@ use SilverStripe\ORM\Queries\SQLSelect; use SilverStripe\Versioned\Versioned; use SilverStripe\View\ArrayData; use SilverStripe\Widgets\Model\Widget; +use SilverStripe\Dev\Deprecation; +use SilverStripe\ORM\DataObject; if (!class_exists(Widget::class)) { return; @@ -26,6 +28,7 @@ if (!class_exists(Widget::class)) { * * @property string $ArchiveType * @property int $NumberToDisplay + * @deprecated 4.3.0 Will be removed without equivalent functionality to replace it */ class BlogArchiveWidget extends Widget { @@ -71,6 +74,18 @@ class BlogArchiveWidget extends Widget */ private static $table_name = 'BlogArchiveWidget'; + public function __construct($record = [], $creationType = DataObject::CREATE_OBJECT, $queryParams = []) + { + Deprecation::withNoReplacement(function () { + Deprecation::notice( + '4.3.0', + 'Will be removed without equivalent functionality to replace it', + Deprecation::SCOPE_CLASS + ); + }); + parent::__construct($record, $creationType, $queryParams); + } + /** * {@inheritdoc} */ diff --git a/src/Widgets/BlogArchiveWidgetController.php b/src/Widgets/BlogArchiveWidgetController.php index cea77c6..aa00c5d 100644 --- a/src/Widgets/BlogArchiveWidgetController.php +++ b/src/Widgets/BlogArchiveWidgetController.php @@ -3,12 +3,26 @@ namespace SilverStripe\Blog\Widgets; use SilverStripe\Widgets\Model\WidgetController; +use SilverStripe\Dev\Deprecation; if (!class_exists(WidgetController::class)) { return; } +/** + * @deprecated 4.3.0 Will be removed without equivalent functionality to replace it + */ class BlogArchiveWidgetController extends WidgetController { - + public function __construct($widget = null) + { + Deprecation::withNoReplacement(function () { + Deprecation::notice( + '4.3.0', + 'Will be removed without equivalent functionality to replace it', + Deprecation::SCOPE_CLASS + ); + }); + parent::__construct($widget); + } } diff --git a/src/Widgets/BlogCategoriesWidget.php b/src/Widgets/BlogCategoriesWidget.php index 6736397..4d3d795 100644 --- a/src/Widgets/BlogCategoriesWidget.php +++ b/src/Widgets/BlogCategoriesWidget.php @@ -10,6 +10,8 @@ use SilverStripe\Forms\FieldList; use SilverStripe\Forms\NumericField; use SilverStripe\ORM\DataList; use SilverStripe\Widgets\Model\Widget; +use SilverStripe\Dev\Deprecation; +use SilverStripe\ORM\DataObject; if (!class_exists(Widget::class)) { return; @@ -17,6 +19,7 @@ if (!class_exists(Widget::class)) { /** * @method Blog Blog() + * @deprecated 4.3.0 Will be removed without equivalent functionality to replace it */ class BlogCategoriesWidget extends Widget { @@ -56,6 +59,18 @@ class BlogCategoriesWidget extends Widget */ private static $table_name = 'BlogCategoriesWidget'; + public function __construct($record = [], $creationType = DataObject::CREATE_OBJECT, $queryParams = []) + { + Deprecation::withNoReplacement(function () { + Deprecation::notice( + '4.3.0', + 'Will be removed without equivalent functionality to replace it', + Deprecation::SCOPE_CLASS + ); + }); + parent::__construct($record, $creationType, $queryParams); + } + /** * {@inheritdoc} */ diff --git a/src/Widgets/BlogCategoriesWidgetController.php b/src/Widgets/BlogCategoriesWidgetController.php index 2780e79..755e0b1 100644 --- a/src/Widgets/BlogCategoriesWidgetController.php +++ b/src/Widgets/BlogCategoriesWidgetController.php @@ -3,12 +3,26 @@ namespace SilverStripe\Blog\Widgets; use SilverStripe\Widgets\Model\WidgetController; +use SilverStripe\Dev\Deprecation; if (!class_exists(WidgetController::class)) { return; } +/** + * @deprecated 4.3.0 Will be removed without equivalent functionality to replace it + */ class BlogCategoriesWidgetController extends WidgetController { - + public function __construct($widget = null) + { + Deprecation::withNoReplacement(function () { + Deprecation::notice( + '4.3.0', + 'Will be removed without equivalent functionality to replace it', + Deprecation::SCOPE_CLASS + ); + }); + parent::__construct($widget); + } } diff --git a/src/Widgets/BlogFeaturedPostsWidget.php b/src/Widgets/BlogFeaturedPostsWidget.php index 93bee0b..4265813 100644 --- a/src/Widgets/BlogFeaturedPostsWidget.php +++ b/src/Widgets/BlogFeaturedPostsWidget.php @@ -9,6 +9,8 @@ use SilverStripe\Forms\FieldList; use SilverStripe\Forms\NumericField; use SilverStripe\ORM\DataList; use SilverStripe\Widgets\Model\Widget; +use SilverStripe\Dev\Deprecation; +use SilverStripe\ORM\DataObject; if (!class_exists(Widget::class)) { return; @@ -18,6 +20,7 @@ if (!class_exists(Widget::class)) { * @method Blog Blog() * * @property int $NumberOfPosts + * @deprecated 4.3.0 Will be removed without equivalent functionality to replace it */ class BlogFeaturedPostsWidget extends Widget { @@ -55,6 +58,18 @@ class BlogFeaturedPostsWidget extends Widget */ private static $table_name = 'BlogFeaturedPostsWidget'; + public function __construct($record = [], $creationType = DataObject::CREATE_OBJECT, $queryParams = []) + { + Deprecation::withNoReplacement(function () { + Deprecation::notice( + '4.3.0', + 'Will be removed without equivalent functionality to replace it', + Deprecation::SCOPE_CLASS + ); + }); + parent::__construct($record, $creationType, $queryParams); + } + /** * {@inheritdoc} */ diff --git a/src/Widgets/BlogRecentPostsWidget.php b/src/Widgets/BlogRecentPostsWidget.php index 2afc1d7..b5d3729 100644 --- a/src/Widgets/BlogRecentPostsWidget.php +++ b/src/Widgets/BlogRecentPostsWidget.php @@ -9,6 +9,8 @@ use SilverStripe\Forms\FieldList; use SilverStripe\Forms\NumericField; use SilverStripe\ORM\DataList; use SilverStripe\Widgets\Model\Widget; +use SilverStripe\ORM\DataObject; +use SilverStripe\Dev\Deprecation; if (!class_exists(Widget::class)) { return; @@ -18,6 +20,7 @@ if (!class_exists(Widget::class)) { * @method Blog Blog() * * @property int $NumberOfPosts + * @deprecated 4.3.0 Will be removed without equivalent functionality to replace it */ class BlogRecentPostsWidget extends Widget { @@ -55,6 +58,18 @@ class BlogRecentPostsWidget extends Widget */ private static $table_name = 'BlogRecentPostsWidget'; + public function __construct($record = [], $creationType = DataObject::CREATE_OBJECT, $queryParams = []) + { + Deprecation::withNoReplacement(function () { + Deprecation::notice( + '4.3.0', + 'Will be removed without equivalent functionality to replace it', + Deprecation::SCOPE_CLASS + ); + }); + parent::__construct($record, $creationType, $queryParams); + } + /** * {@inheritdoc} */ diff --git a/src/Widgets/BlogRecentPostsWidgetController.php b/src/Widgets/BlogRecentPostsWidgetController.php index a3399ad..86410d1 100644 --- a/src/Widgets/BlogRecentPostsWidgetController.php +++ b/src/Widgets/BlogRecentPostsWidgetController.php @@ -3,12 +3,26 @@ namespace SilverStripe\Blog\Widgets; use SilverStripe\Widgets\Model\WidgetController; +use SilverStripe\Dev\Deprecation; if (!class_exists(WidgetController::class)) { return; } +/** + * @deprecated 4.3.0 Will be removed without equivalent functionality to replace it + */ class BlogRecentPostsWidgetController extends WidgetController { - + public function __construct($widget = null) + { + Deprecation::withNoReplacement(function () { + Deprecation::notice( + '4.3.0', + 'Will be removed without equivalent functionality to replace it', + Deprecation::SCOPE_CLASS + ); + }); + parent::__construct($widget); + } } diff --git a/src/Widgets/BlogTagsCloudWidget.php b/src/Widgets/BlogTagsCloudWidget.php index 80424fd..c39a68c 100644 --- a/src/Widgets/BlogTagsCloudWidget.php +++ b/src/Widgets/BlogTagsCloudWidget.php @@ -10,6 +10,7 @@ use SilverStripe\ORM\DataObject; use SilverStripe\ORM\DB; use SilverStripe\Widgets\Model\Widget; use SilverStripe\Control\Controller; +use SilverStripe\Dev\Deprecation; if (!class_exists(Widget::class)) { return; @@ -17,6 +18,7 @@ if (!class_exists(Widget::class)) { /** * @method Blog Blog() + * @deprecated 4.3.0 Will be removed without equivalent functionality to replace it */ class BlogTagsCloudWidget extends Widget { @@ -52,6 +54,18 @@ class BlogTagsCloudWidget extends Widget */ private static $table_name = 'BlogTagsCloudWidget'; + public function __construct($record = [], $creationType = DataObject::CREATE_OBJECT, $queryParams = []) + { + Deprecation::withNoReplacement(function () { + Deprecation::notice( + '4.3.0', + 'Will be removed without equivalent functionality to replace it', + Deprecation::SCOPE_CLASS + ); + }); + parent::__construct($record, $creationType, $queryParams); + } + /** * {@inheritdoc} */ diff --git a/src/Widgets/BlogTagsCloudWidgetController.php b/src/Widgets/BlogTagsCloudWidgetController.php index 1f04d4e..3621a62 100644 --- a/src/Widgets/BlogTagsCloudWidgetController.php +++ b/src/Widgets/BlogTagsCloudWidgetController.php @@ -3,11 +3,26 @@ namespace SilverStripe\Blog\Widgets; use SilverStripe\Widgets\Model\WidgetController; +use SilverStripe\Dev\Deprecation; if (!class_exists(WidgetController::class)) { return; } +/** + * @deprecated 4.3.0 Will be removed without equivalent functionality to replace it + */ class BlogTagsCloudWidgetController extends WidgetController { + public function __construct($widget = null) + { + Deprecation::withNoReplacement(function () { + Deprecation::notice( + '4.3.0', + 'Will be removed without equivalent functionality to replace it', + Deprecation::SCOPE_CLASS + ); + }); + parent::__construct($widget); + } } diff --git a/src/Widgets/BlogTagsWidget.php b/src/Widgets/BlogTagsWidget.php index 15a329f..b07ef1a 100644 --- a/src/Widgets/BlogTagsWidget.php +++ b/src/Widgets/BlogTagsWidget.php @@ -10,6 +10,8 @@ use SilverStripe\Forms\FieldList; use SilverStripe\Forms\NumericField; use SilverStripe\ORM\DataList; use SilverStripe\Widgets\Model\Widget; +use SilverStripe\Dev\Deprecation; +use SilverStripe\ORM\DataObject; if (!class_exists(Widget::class)) { return; @@ -17,6 +19,7 @@ if (!class_exists(Widget::class)) { /** * @method Blog Blog() + * @deprecated 4.3.0 Will be removed without equivalent functionality to replace it */ class BlogTagsWidget extends Widget { @@ -56,6 +59,18 @@ class BlogTagsWidget extends Widget */ private static $table_name = 'BlogTagsWidget'; + public function __construct($record = [], $creationType = DataObject::CREATE_OBJECT, $queryParams = []) + { + Deprecation::withNoReplacement(function () { + Deprecation::notice( + '4.3.0', + 'Will be removed without equivalent functionality to replace it', + Deprecation::SCOPE_CLASS + ); + }); + parent::__construct($record, $creationType, $queryParams); + } + /** * {@inheritdoc} */ diff --git a/src/Widgets/BlogTagsWidgetController.php b/src/Widgets/BlogTagsWidgetController.php index bd99dfa..5a89bd1 100644 --- a/src/Widgets/BlogTagsWidgetController.php +++ b/src/Widgets/BlogTagsWidgetController.php @@ -3,12 +3,26 @@ namespace SilverStripe\Blog\Widgets; use SilverStripe\Widgets\Model\WidgetController; +use SilverStripe\Dev\Deprecation; if (!class_exists(WidgetController::class)) { return; } +/** + * @deprecated 4.3.0 Will be removed without equivalent functionality to replace it + */ class BlogTagsWidgetController extends WidgetController { - + public function __construct($widget = null) + { + Deprecation::withNoReplacement(function () { + Deprecation::notice( + '4.3.0', + 'Will be removed without equivalent functionality to replace it', + Deprecation::SCOPE_CLASS + ); + }); + parent::__construct($widget); + } }