ENH Add generic types

silverstripe · Jan 11, 2024 · f722f2b · f722f2b
1 parent d13eec6
commit f722f2b
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 9 deletions.
diff --git a/src/Extensions/ElementalAreaUsedOnTableExtension.php b/src/Extensions/ElementalAreaUsedOnTableExtension.php
@@ -8,10 +8,13 @@
 use SilverStripe\ORM\ValidationException;
 use DNADesign\Elemental\Models\ElementalArea;
 use DNADesign\Elemental\Models\BaseElement;
+use SilverStripe\Admin\Forms\UsedOnTable;
 
+/**
+ * @extends DataExtension<UsedOnTable>
+ */
 class ElementalAreaUsedOnTableExtension extends DataExtension
 {
-
     /**
      * Hides ElementalArea's from the "Used On" tab when viewing files
      *
@@ -56,7 +59,6 @@ public function updateUsageAncestorDataObjects(array &$ancestorDataObjects, Data
         try {
             // BaseElement::getPage() caches results so there's no performance decrease from
             // also calling it in updateUsageExcludeDataObject()
-            /** @var SiteTree $page */
             if ($page = $dataObject->getPage()) {
                 $ancestorDataObjects[] = $page;
             }

diff --git a/src/Extensions/ElementalAreasExtension.php b/src/Extensions/ElementalAreasExtension.php
@@ -42,7 +42,8 @@
  *     'ElementalArea2'
  * );
  *
- * @package elemental
+ * @template T of DataObject
+ * @extends DataExtension<T&static>
  */
 class ElementalAreasExtension extends DataExtension
 {

diff --git a/src/Extensions/ElementalCMSMainExtension.php b/src/Extensions/ElementalCMSMainExtension.php
@@ -2,10 +2,14 @@
 
 namespace DNADesign\Elemental\Extensions;
 
+use SilverStripe\CMS\Controllers\CMSMain;
 use SilverStripe\Core\Extension;
 use SilverStripe\Forms\DropdownField;
 use SilverStripe\Forms\Form;
 
+/**
+ * @extends Extension<CMSMain>
+ */
 class ElementalCMSMainExtension extends Extension
 {
     /**

diff --git a/src/Extensions/ElementalContentControllerExtension.php b/src/Extensions/ElementalContentControllerExtension.php
@@ -6,7 +6,11 @@
 use SilverStripe\ORM\DataObject;
 use DNADesign\Elemental\Models\ElementalArea;
 use DNADesign\Elemental\Extensions\ElementalAreasExtension;
+use SilverStripe\CMS\Controllers\ContentController;
 
+/**
+ * @extends Extension<ContentController>
+ */
 class ElementalContentControllerExtension extends Extension
 {
     /**
@@ -25,7 +29,6 @@ public function handleElement()
             return false;
         }
 
-        /** @var DataObject $elementOwner */
         $elementOwner = $this->owner->data();
 
         if (!$elementOwner->hasExtension(ElementalAreasExtension::class)) {

diff --git a/src/Extensions/ElementalLeftAndMainExtension.php b/src/Extensions/ElementalLeftAndMainExtension.php
@@ -2,12 +2,15 @@
 
 namespace DNADesign\Elemental\Extensions;
 
+use SilverStripe\Admin\LeftAndMain;
 use SilverStripe\Core\Extension;
 use SilverStripe\View\Requirements;
 
+/**
+ * @extends Extension<LeftAndMain>
+ */
 class ElementalLeftAndMainExtension extends Extension
 {
-
     public function init()
     {
         Requirements::add_i18n_javascript('dnadesign/silverstripe-elemental:client/lang');

diff --git a/src/Extensions/ElementalPageExtension.php b/src/Extensions/ElementalPageExtension.php
@@ -12,6 +12,8 @@
 /**
  * @property int ElementalAreaID
  * @method ElementalArea ElementalArea()
+ *
+ * @extends ElementalAreasExtension<SiteTree>
  */
 class ElementalPageExtension extends ElementalAreasExtension
 {

diff --git a/src/Extensions/GridFieldAddNewMultiClassHandlerExtension.php b/src/Extensions/GridFieldAddNewMultiClassHandlerExtension.php
@@ -5,10 +5,10 @@
 use SilverStripe\Core\Extension;
 use SilverStripe\Forms\Form;
 use DNADesign\Elemental\Models\BaseElement;
+use Symbiote\GridFieldExtensions\GridFieldAddNewMultiClassHandler;
 
 /**
- * Class GridFieldAddNewMultiClassHandlerExtension
- * @package DNADesign\Elemental\Extensions
+ * @extends Extension<GridFieldAddNewMultiClassHandler>
  */
 class GridFieldAddNewMultiClassHandlerExtension extends Extension
 {

diff --git a/src/Extensions/GridFieldDetailFormItemRequestExtension.php b/src/Extensions/GridFieldDetailFormItemRequestExtension.php
@@ -4,8 +4,12 @@
 
 use DNADesign\Elemental\Models\BaseElement;
 use SilverStripe\Core\Extension;
+use SilverStripe\Forms\GridField\GridFieldDetailForm_ItemRequest;
 use SilverStripe\ORM\FieldType\DBField;
 
+/**
+ * @extends Extension<GridFieldDetailForm_ItemRequest>
+ */
 class GridFieldDetailFormItemRequestExtension extends Extension
 {
     public function updateBreadcrumbs($crumbs)

diff --git a/src/Models/ElementalArea.php b/src/Models/ElementalArea.php
@@ -2,6 +2,7 @@
 
 namespace DNADesign\Elemental\Models;
 
+use DNADesign\Elemental\Controllers\ElementController;
 use DNADesign\Elemental\Extensions\ElementalAreasExtension;
 use DNADesign\Elemental\TopPage\DataExtension;
 use SilverStripe\Core\ClassInfo;
@@ -124,7 +125,7 @@ public function setOwnerPageCached(DataObject $page)
 
     /**
      * A cache-aware accessor for the elements
-     * @return ArrayList|HasManyList|BaseElement[]
+     * @return HasManyList<BaseElement>
      */
     public function Elements()
     {
@@ -160,7 +161,7 @@ public function Breadcrumbs()
      * its' controller, making it easier to access and process form logic and
      * actions stored in {@link ElementController}.
      *
-     * @return ArrayList
+     * @return ArrayList<ElementController>
      * @throws \Exception
      */
     public function ElementControllers()