ENH Add generic types

silverstripe · Jan 17, 2024 · 8ec5b93 · 8ec5b93
1 parent e8e40a8
commit 8ec5b93
Show file tree

Hide file tree

Showing 13 changed files with 28 additions and 13 deletions.
diff --git a/src/Model/Blog.php b/src/Model/Blog.php
@@ -533,7 +533,7 @@ public function canEditContributors($member = null)
      * @param null|int $month
      * @param null|int $day
      *
-     * @return DataList
+     * @return DataList<BlogPost>
      */
     public function getArchivedBlogPosts($year, $month = null, $day = null)
     {
@@ -574,7 +574,7 @@ public function getArchivedBlogPosts($year, $month = null, $day = null)
     /**
      * Return blog posts.
      *
-     * @return DataList of BlogPost objects
+     * @return DataList<BlogPost> of BlogPost objects
      */
     public function getBlogPosts()
     {

diff --git a/src/Model/BlogCommentExtension.php b/src/Model/BlogCommentExtension.php
@@ -2,10 +2,13 @@
 
 namespace SilverStripe\Blog\Model;
 
+use SilverStripe\Comments\Model\Comment;
 use SilverStripe\ORM\DataExtension;
 
 /**
  * Adds Blog specific behaviour to Comment.
+ *
+ * @extends DataExtension<Comment>
  */
 class BlogCommentExtension extends DataExtension
 {

diff --git a/src/Model/BlogController.php b/src/Model/BlogController.php
@@ -15,7 +15,11 @@
 use SilverStripe\Blog\Model\BlogCategory;
 use SilverStripe\View\Parsers\URLSegmentFilter;
 use SilverStripe\Control\HTTPRequest;
+use SilverStripe\ORM\SS_List;
 
+/**
+ * @extends PageController<Blog>
+ */
 class BlogController extends PageController
 {
     /**
@@ -58,7 +62,7 @@ class BlogController extends PageController
     /**
      * The current Blog Post DataList query.
      *
-     * @var DataList
+     * @var DataList<BlogPost>
      */
     protected $blogPosts;
 
@@ -67,9 +71,6 @@ class BlogController extends PageController
      */
     public function index(HTTPRequest $request)
     {
-        /**
-         * @var Blog $dataRecord
-         */
         $dataRecord = $this->dataRecord;
 
         $this->blogPosts = $dataRecord->getBlogPosts();
@@ -128,7 +129,7 @@ public function getCurrentProfile()
     /**
      * Get posts related to the current Member profile.
      *
-     * @return null|DataList
+     * @return null|DataList<BlogPost>
      */
     public function getCurrentProfilePosts()
     {
@@ -443,7 +444,7 @@ public function getFilterDescription()
     /**
      * Returns a list of paginated blog posts based on the BlogPost dataList.
      *
-     * @return PaginatedList
+     * @return PaginatedList<SS_List, BlogPost>
      */
     public function PaginatedList()
     {

diff --git a/src/Model/BlogFilter.php b/src/Model/BlogFilter.php
@@ -16,7 +16,6 @@
 /**
  * This class is responsible for filtering the SiteTree when necessary and also overlaps into
  * filtering only published posts.
- *
  */
 class BlogFilter extends Lumberjack
 {

diff --git a/src/Model/BlogMemberExtension.php b/src/Model/BlogMemberExtension.php
@@ -19,6 +19,8 @@
  *
  * @method SilverStripe\ORM\ManyManyList<BlogPost> BlogPosts()
  * @method Image BlogProfileImage()
+ *
+ * @extends DataExtension<Member>
  */
 class BlogMemberExtension extends DataExtension
 {

diff --git a/src/Model/BlogObject.php b/src/Model/BlogObject.php
@@ -21,7 +21,7 @@ trait BlogObject
 {
     /**
      * @param int|array|null $id Optional ID(s) for parent of this relation, if not the current record
-     * @return DataList
+     * @return DataList<BlogPost>
      */
     public function BlogPosts($id = null)
     {

diff --git a/src/Model/BlogPostController.php b/src/Model/BlogPostController.php
@@ -4,6 +4,9 @@
 
 use PageController;
 
+/**
+ * @extends PageController<BlogPost>
+ */
 class BlogPostController extends PageController
 {
 

diff --git a/src/Model/BlogPostFeaturedExtension.php b/src/Model/BlogPostFeaturedExtension.php
@@ -8,6 +8,8 @@
 
 /**
  * Adds a checkbox field for featured blog posts widget.
+ *
+ * @extends DataExtension<BlogPost>
  */
 class BlogPostFeaturedExtension extends DataExtension
 {

diff --git a/src/Model/BlogPostFilter.php b/src/Model/BlogPostFilter.php
@@ -17,6 +17,7 @@
  * This is responsible for filtering only published posts to users who do not have permission to
  * view non-published posts.
  *
+ * @extends DataExtension<BlogPost>
  */
 class BlogPostFilter extends DataExtension
 {

diff --git a/src/Model/BlogPostNotifications.php b/src/Model/BlogPostNotifications.php
@@ -12,6 +12,8 @@
  * Customise blog post to support comment notifications.
  *
  * Extends {@see BlogPost} with extensions to {@see CommentNotifiable}.
+ *
+ * @extends DataExtension<BlogPost>
  */
 class BlogPostNotifications extends DataExtension
 {

diff --git a/src/Widgets/BlogArchiveWidget.php b/src/Widgets/BlogArchiveWidget.php
@@ -108,7 +108,7 @@ public function getCMSFields()
     /**
      * Returns a list of months where blog posts are present.
      *
-     * @return ArrayList
+     * @return ArrayList<ArrayData>
      */
     public function getArchive()
     {

diff --git a/src/Widgets/BlogCategoriesWidget.php b/src/Widgets/BlogCategoriesWidget.php
@@ -3,6 +3,7 @@
 namespace SilverStripe\Blog\Widgets;
 
 use SilverStripe\Blog\Model\Blog;
+use SilverStripe\Blog\Model\BlogCategory;
 use SilverStripe\Core\Convert;
 use SilverStripe\Forms\DropdownField;
 use SilverStripe\Forms\FieldList;
@@ -106,7 +107,7 @@ public function getCMSFields()
     }
 
     /**
-     * @return DataList
+     * @return DataList<BlogCategory>
      */
     public function getCategories()
     {

diff --git a/src/Widgets/BlogTagsWidget.php b/src/Widgets/BlogTagsWidget.php
@@ -3,6 +3,7 @@
 namespace SilverStripe\Blog\Widgets;
 
 use SilverStripe\Blog\Model\Blog;
+use SilverStripe\Blog\Model\BlogTag;
 use SilverStripe\Core\Convert;
 use SilverStripe\Forms\DropdownField;
 use SilverStripe\Forms\FieldList;
@@ -106,7 +107,7 @@ public function getCMSFields()
     }
 
     /**
-     * @return DataList
+     * @return DataList<BlogTag>
      */
     public function getTags()
     {