ENH Add generic types (#220)

silverstripe · Jan 18, 2024 · f04e9fa · f04e9fa
1 parent 21ed224
commit f04e9fa
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 7 deletions.
diff --git a/src/Extensions/ContentReviewCMSExtension.php b/src/Extensions/ContentReviewCMSExtension.php
@@ -4,6 +4,7 @@
 
 use SilverStripe\Admin\LeftAndMain;
 use SilverStripe\Admin\LeftAndMainExtension;
+use SilverStripe\CMS\Controllers\CMSMain;
 use SilverStripe\CMS\Model\SiteTree;
 use SilverStripe\ContentReview\Forms\ReviewContentHandler;
 use SilverStripe\ContentReview\Traits\PermissionChecker;
@@ -17,6 +18,8 @@
 /**
  * CMSPageEditController extension to receive the additional action button from
  * SiteTreeContentReview::updateCMSActions()
+ *
+ * @extends LeftAndMainExtension<CMSMain>
  */
 class ContentReviewCMSExtension extends LeftAndMainExtension
 {

diff --git a/src/Extensions/ContentReviewDefaultSettings.php b/src/Extensions/ContentReviewDefaultSettings.php
@@ -14,6 +14,7 @@
 use SilverStripe\Security\Group;
 use SilverStripe\Security\Member;
 use SilverStripe\Security\Permission;
+use SilverStripe\SiteConfig\SiteConfig;
 
 /**
  * This extensions add a default schema for new pages and pages without a content
@@ -22,6 +23,8 @@
  * @property int $ReviewPeriodDays
  * @method SilverStripe\ORM\ManyManyList<Group> ContentReviewGroups()
  * @method SilverStripe\ORM\ManyManyList<Member> ContentReviewUsers()
+ *
+ * @extends DataExtension<SiteConfig>
  */
 class ContentReviewDefaultSettings extends DataExtension
 {
@@ -88,15 +91,15 @@ public function getOwnerNames()
     }
 
     /**
-     * @return ManyManyList
+     * @return ManyManyList<Group>
      */
     public function OwnerGroups()
     {
         return $this->owner->getManyManyComponents('ContentReviewGroups');
     }
 
     /**
-     * @return ManyManyList
+     * @return ManyManyList<Member>
      */
     public function OwnerUsers()
     {
@@ -180,7 +183,7 @@ public function updateCMSFields(FieldList $fields)
      * Get all Members that are default Content Owners. This includes checking group hierarchy
      * and adding any direct users.
      *
-     * @return ArrayList
+     * @return ArrayList<Group|Member>
      */
     public function ContentReviewOwners()
     {

diff --git a/src/Extensions/ContentReviewLeftAndMainExtension.php b/src/Extensions/ContentReviewLeftAndMainExtension.php
@@ -2,8 +2,12 @@
 
 namespace SilverStripe\ContentReview\Extensions;
 
+use SilverStripe\Admin\LeftAndMain;
 use SilverStripe\Admin\LeftAndMainExtension;
 
+/**
+ * @extends LeftAndMainExtension<LeftAndMain>
+ */
 class ContentReviewLeftAndMainExtension extends LeftAndMainExtension
 {
     /**

diff --git a/src/Extensions/ContentReviewOwner.php b/src/Extensions/ContentReviewOwner.php
@@ -5,9 +5,13 @@
 use SilverStripe\CMS\Model\SiteTree;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\ORM\DataExtension;
+use SilverStripe\Security\Group;
+use SilverStripe\Security\Member;
 
 /**
  * @method SilverStripe\ORM\ManyManyList<SiteTree> SiteTreeContentReview()
+ *
+ * @extends DataExtension<Group|Member>
  */
 class ContentReviewOwner extends DataExtension
 {

diff --git a/src/Extensions/SiteTreeContentReview.php b/src/Extensions/SiteTreeContentReview.php
@@ -53,6 +53,8 @@
  * @method SilverStripe\ORM\ManyManyList<Group> ContentReviewGroups()
  * @method SilverStripe\ORM\ManyManyList<Member> ContentReviewUsers()
  * @method SilverStripe\ORM\HasManyList<ContentReviewLog> ReviewLogs()
+ *
+ * @extends DataExtension<SiteTree>
  */
 class SiteTreeContentReview extends DataExtension implements PermissionProvider
 {
@@ -119,7 +121,7 @@ public static function get_schedule()
      * @param SS_List $groups
      * @param SS_List $members
      *
-     * @return ArrayList
+     * @return ArrayList<Group|Member>
      */
     public static function merge_owners(SS_List $groups, SS_List $members)
     {
@@ -293,7 +295,7 @@ public function getEditorName()
      * Get all Members that are Content Owners to this page. This includes checking group
      * hierarchy and adding any direct users.
      *
-     * @return ArrayList
+     * @return ArrayList<Group|Member>
      */
     public function ContentReviewOwners()
     {
@@ -304,15 +306,15 @@ public function ContentReviewOwners()
     }
 
     /**
-     * @return ManyManyList
+     * @return ManyManyList<Group>
      */
     public function OwnerGroups()
     {
         return $this->owner->getManyManyComponents("ContentReviewGroups");
     }
 
     /**
-     * @return ManyManyList
+     * @return ManyManyList<Member>
      */
     public function OwnerUsers()
     {