ENH Add generic types

Author: GuySartorelli

src/Dev/VersionedTestSessionExtension.php

@@ -10,7 +10,7 @@
 /**
  * Decorates TestSession object to update get / post requests with versioned querystring arguments.
  *
- * @property TestSession $owner
+ * @extends VersionedStateExtension<TestSession>
  */
 class VersionedTestSessionExtension extends VersionedStateExtension
 {

src/RecursivePublishable.php

@@ -17,7 +17,7 @@
  * Provides owns / owned_by and recursive publishing API for all objects.
  * This extension is added to DataObject by default
  *
- * @property DataObject|RecursivePublishable $owner
+ * @extends DataExtension<DataObject&static>
  */
 class RecursivePublishable extends DataExtension
 {
@@ -155,7 +155,7 @@ public function deleteFromChangeSets()
      *
      * @param bool $recursive True if recursive
      * @param ArrayList $list Optional list to add items to
-     * @return ArrayList list of objects
+     * @return ArrayList<DataObject&static> list of objects
      */
     public function findOwned($recursive = true, $list = null)
     {
@@ -191,7 +191,7 @@ public function hasOwned()
      *
      * @param bool $recursive True if recursive
      * @param ArrayList $list Optional list to add items to
-     * @return ArrayList list of objects
+     * @return ArrayList<DataObject> list of objects
      */
     public function findOwners($recursive = true, $list = null)
     {
@@ -213,7 +213,7 @@ public function findOwners($recursive = true, $list = null)
      * @param bool $recursive True if recursive
      * @param ArrayList $list List to add items to
      * @param array $lookup List of reverse lookup rules for owned objects
-     * @return ArrayList list of objects
+     * @return ArrayList<DataObject> list of objects
      */
     public function findOwnersRecursive($recursive, $list, $lookup)
     {

src/RecursivePublishableHandler.php

@@ -2,11 +2,14 @@
 
 namespace SilverStripe\Versioned;
 
+use SilverStripe\Admin\LeftAndMain;
 use SilverStripe\Core\Extension;
 use SilverStripe\ORM\DataObject;
 
 /**
  * Provides recursive publishable behaviour for LeftAndMain and GridFieldDetailForm_ItemRequest
+ *
+ * @extends Extension<LeftAndMain>
  */
 class RecursivePublishableHandler extends Extension
 {

src/Versioned.php

@@ -36,8 +36,9 @@
  * Note: This extension relies on the object also having the {@see Ownership} extension applied.
  *
  * @property int $Version
- * @property DataObject|RecursivePublishable|Versioned $owner
  * @mixin RecursivePublishable
+ *
+ * @extends DataExtension<DataObject&RecursivePublishable&Versioned>
  */
 class Versioned extends DataExtension implements TemplateGlobalProvider, Resettable
 {
@@ -2018,7 +2019,7 @@ public function stagesDifferRecursive(): bool
      * @param string $join Deprecated, use leftJoin($table, $joinClause) instead
      * @param string $having @deprecated 2.2.0 The $having parameter does nothing and will be removed without
      *               equivalent functionality to replace it
-     * @return ArrayList
+     * @return ArrayList<Versioned_Version>
      */
     public function Versions($filter = "", $sort = "", $limit = "", $join = "", $having = "")
     {
@@ -2363,13 +2364,13 @@ public static function reading_archived_date($date, $stage = self::DRAFT)
     /**
      * Get a singleton instance of a class in the given stage.
      *
-     * @param string $class The name of the class.
+     * @template T of DataObject
+     * @param class-string<T> $class The name of the class.
      * @param string $stage The name of the stage.
      * @param string $filter A filter to be inserted into the WHERE clause.
      * @param boolean $cache Use caching.
      * @param string $sort A sort expression to be inserted into the ORDER BY clause.
-     *
-     * @return DataObject
+     * @return T&Versioned
      */
     public static function get_one_by_stage($class, $stage, $filter = '', $cache = true, $sort = '')
     {
@@ -2519,15 +2520,16 @@ public static function prepopulate_versionnumber_cache($class, $stage, $idList =
     /**
      * Get a set of class instances by the given stage.
      *
-     * @param string $class The name of the class.
+     * @template T of DataObject
+     * @param class-string<T> $class The name of the class.
      * @param string $stage The name of the stage.
      * @param string $filter A filter to be inserted into the WHERE clause.
      * @param string $sort A sort expression to be inserted into the ORDER BY clause.
      * @param string $join Deprecated, use leftJoin($table, $joinClause) instead
      * @param int $limit A limit on the number of records returned from the database.
      * @param string $containerClass The container class for the result set (default is DataList)
      *
-     * @return DataList A modified DataList designated to the specified stage
+     * @return DataList<T> A modified DataList designated to the specified stage
      */
     public static function get_by_stage(
         $class,
@@ -2657,9 +2659,10 @@ public function rollbackSingle($version)
     /**
      * Return the latest version of the given record.
      *
-     * @param string $class
+     * @template T of DataObject
+     * @param class-string<T> $class
      * @param int $id
-     * @return DataObject
+     * @return T&Versioned
      */
     public static function get_latest_version($class, $id)
     {
@@ -2687,7 +2690,6 @@ public function isLatestVersion()
             return false;
         }
 
-        /** @var Versioned|DataObject $version */
         $version = static::get_latest_version($this->owner->baseClass(), $owner->ID);
         return ($version->Version == $owner->Version);
     }
@@ -2826,10 +2828,11 @@ public function isModifiedOnDraft()
      *
      * In particular, this will query deleted records as well as active ones.
      *
-     * @param string $class
+     * @template T of DataObject
+     * @param class-string<T> $class
      * @param string $filter
      * @param string $sort
-     * @return DataList
+     * @return DataList<T>
      */
     public static function get_including_deleted($class, $filter = "", $sort = "")
     {
@@ -2851,11 +2854,11 @@ public static function get_including_deleted($class, $filter = "", $sort = "")
      * modifications via write() will create a new version, rather than
      * modifying the existing one.
      *
-     * @param string $class
+     * @template T of DataObject
+     * @param class-string<T> $class
      * @param int $id
      * @param int $version
-     *
-     * @return DataObject
+     * @return T&Versioned
      */
     public static function get_version($class, $id, $version)
     {
@@ -2872,10 +2875,11 @@ public static function get_version($class, $id, $version)
     /**
      * Return a list of all versions for a given id.
      *
-     * @param string $class
+     * @template T
+     * @param class-string<T> $class
      * @param int $id
      *
-     * @return DataList
+     * @return DataList<T>
      */
     public static function get_all_versions($class, $id)
     {

src/VersionedGridFieldArchiveExtension.php

@@ -8,14 +8,14 @@
 
 /**
  * Decorates a GridFieldConfig with a archive action
+ *
+ * @extends Extension<GridFieldConfig>
  */
 class VersionedGridFieldArchiveExtension extends Extension
 {
     public function updateConfig()
     {
-        /** @var GridFieldConfig $owner */
         $owner = $this->getOwner();
-
         $owner->addComponent(new GridFieldArchiveAction(), GridFieldDeleteAction::class);
     }
 }

src/VersionedGridFieldDetailForm.php

@@ -5,10 +5,11 @@
 use SilverStripe\Control\RequestHandler;
 use SilverStripe\Core\Extension;
 use SilverStripe\Forms\GridField\GridField;
+use SilverStripe\Forms\GridField\GridFieldDetailForm;
 use SilverStripe\ORM\DataObject;
 
 /**
- * Extends {@see GridFieldDetailForm}
+ * @extends Extension<GridFieldDetailForm>
  */
 class VersionedGridFieldDetailForm extends Extension
 {

src/VersionedGridFieldStateExtension.php

@@ -8,12 +8,13 @@
 
 /**
  * Decorates a GridFieldConfig with gridfield publishing state
+ *
+ * @extends Extension<GridFieldConfig>
  */
 class VersionedGridFieldStateExtension extends Extension
 {
     public function updateConfig()
     {
-        /** @var GridFieldConfig $owner */
         $owner = $this->getOwner();
         if (!$owner->getComponentByType(VersionedGridFieldState::class)) {
             $owner->addComponent(new VersionedGridFieldState());

src/VersionedStateExtension.php

@@ -11,7 +11,8 @@
 /**
  * Persists versioned state between requests via querystring arguments
  *
- * @property RequestHandler|DataObject $owner
+ * @template T of RequestHandler|DataObject
+ * @extends Extension<T>
  */
 class VersionedStateExtension extends Extension
 {

src/VersionedTableDataQueryExtension.php

@@ -10,7 +10,7 @@
 /**
  * Applies correct stage to tables
  *
- * @property DataQuery $owner
+ * @extends Extension<DataQuery>
  */
 class VersionedTableDataQueryExtension extends Extension
 {