ENH Add generic types (#319)

silverstripe · Jan 18, 2024 · ad08d76 · ad08d76
1 parent 64fa5f1
commit ad08d76
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 11 deletions.
diff --git a/src/ArchiveAdmin.php b/src/ArchiveAdmin.php
@@ -293,9 +293,6 @@ public function getOtherModelSelectorField($currentModel = '')
 
     /**
      * Use 'Archive' as the top title rather than the model title
-     *
-     * @param bool $unlinked
-     * @return ArrayList
      */
     public function Breadcrumbs($unlinked = false)
     {
@@ -327,7 +324,7 @@ public function getManagedModels()
     /**
      * Add the special 'Others' tab
      *
-     * @return ArrayList An ArrayList of all managed models to build the tabs for this ModelAdmin
+     * @return ArrayList<ArrayData> An ArrayList of all managed models to build the tabs for this ModelAdmin
      */
     public function getManagedModelTabs()
     {

diff --git a/src/Controllers/CMSPageHistoryViewerController.php b/src/Controllers/CMSPageHistoryViewerController.php
@@ -4,9 +4,7 @@
 
 use SilverStripe\CMS\Controllers\CMSMain;
 use SilverStripe\Forms\FieldList;
-use SilverStripe\Forms\Form;
 use SilverStripe\Forms\HiddenField;
-use SilverStripe\ORM\DataObject;
 use SilverStripe\VersionedAdmin\Forms\HistoryViewerField;
 
 if (!class_exists(CMSMain::class)) {
@@ -30,10 +28,8 @@ class CMSPageHistoryViewerController extends CMSMain
 
     public function getEditForm($id = null, $fields = null)
     {
-        /** @var DataObject $record */
         $record = $this->getRecord($id ?: $this->currentPageID());
 
-        /** @var Form $form */
         $form = parent::getEditForm($id);
         $form->addExtraClass('history-viewer__form');
         // Disable default CMS preview

diff --git a/src/Controllers/HistoryViewerController.php b/src/Controllers/HistoryViewerController.php
@@ -9,7 +9,6 @@
 use SilverStripe\Control\HTTPResponse;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Forms\Form;
-use SilverStripe\Forms\FormFactory;
 use SilverStripe\ORM\DataList;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\FieldType\DBDatetime;
@@ -332,7 +331,6 @@ protected function validateInput(array $context, array $requiredFields = [])
      */
     protected function scaffoldForm($formName, array $context = [], array $extra = [])
     {
-        /** @var FormFactory $scaffolder */
         $scaffolder = Injector::inst()->get(DataObjectVersionFormFactory::class);
         $form = $scaffolder->getForm($this, $formName, $context);
 

diff --git a/src/Extensions/ArchiveRestoreAction.php b/src/Extensions/ArchiveRestoreAction.php
@@ -12,10 +12,13 @@
 use SilverStripe\ORM\ValidationResult;
 use SilverStripe\Versioned\RestoreAction;
 use SilverStripe\Versioned\Versioned;
+use SilverStripe\Versioned\VersionedGridFieldItemRequest;
 use SilverStripe\VersionedAdmin\ArchiveAdmin;
 
 /**
  * Adds a restore action to the item edit form of ArchiveAdmin
+ *
+ * @extends DataExtension<VersionedGridFieldItemRequest>
  */
 class ArchiveRestoreAction extends DataExtension
 {

diff --git a/src/Extensions/BlockArchiveExtension.php b/src/Extensions/BlockArchiveExtension.php
@@ -12,6 +12,8 @@
 
 /**
  * Adds a archive view for Elemental blocks
+ *
+ * @extends DataExtension<BaseElement>
  */
 class BlockArchiveExtension extends DataExtension implements ArchiveViewProvider
 {

diff --git a/src/Extensions/FileArchiveExtension.php b/src/Extensions/FileArchiveExtension.php
@@ -15,6 +15,8 @@
 
 /**
  * Adds a archive view for Files
+ *
+ * @extends DataExtension<File>
  */
 class FileArchiveExtension extends DataExtension implements ArchiveViewProvider
 {

diff --git a/src/Extensions/SiteTreeArchiveExtension.php b/src/Extensions/SiteTreeArchiveExtension.php
@@ -12,6 +12,8 @@
 
 /**
  * Adds a archive view for Pages
+ *
+ * @extends DataExtension<SiteTree>
  */
 class SiteTreeArchiveExtension extends DataExtension implements ArchiveViewProvider
 {

diff --git a/src/Extensions/UsedOnTableExtension.php b/src/Extensions/UsedOnTableExtension.php
@@ -2,12 +2,15 @@
 
 namespace SilverStripe\VersionedAdmin\Extensions;
 
+use SilverStripe\Admin\Forms\UsedOnTable;
 use SilverStripe\Core\Extension;
 use SilverStripe\Versioned\ChangeSetItem;
 
+/**
+ * @extends Extension<UsedOnTable>
+ */
 class UsedOnTableExtension extends Extension
 {
-
     /**
      * @var array $excludedClasses
      */