ENH Add generic types (#182)

silverstripe · Jan 19, 2024 · 192ea76 · 192ea76
1 parent d7dcffe
commit 192ea76
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/src/Contract/StaticPublishingTrigger.php b/src/Contract/StaticPublishingTrigger.php
@@ -13,15 +13,15 @@ interface StaticPublishingTrigger
      * Provides an SS_List of StaticallyPublishable objects which need to be regenerated.
      *
      * @param array $context An associative array with extra engine-specific information.
-     * @return array|SS_List
+     * @return iterable
      */
     public function objectsToUpdate($context);
 
     /**
      * Provides a SS_list of objects that need to be deleted.
      *
      * @param array $context An associative array with extra engine-specific information.
-     * @return array|SS_List
+     * @return iterable
      */
     public function objectsToDelete($context);
 }
diff --git a/src/Extension/Engine/SiteTreePublishingEngine.php b/src/Extension/Engine/SiteTreePublishingEngine.php
@@ -25,6 +25,8 @@
  * * action - name of the executed action: publish or unpublish
  *
  * @see PublishableSiteTree
+ *
+ * @extends DataExtension<SiteTree>
  */
 class SiteTreePublishingEngine extends SiteTreeExtension implements Resettable
 {
@@ -300,7 +302,6 @@ public function flushChanges()
         $urlsToDelete = $this->getUrlsToDelete();
 
         if ($urlsToUpdate) {
-            /** @var UrlBundleInterface $urlService */
             $urlService = Injector::inst()->create(UrlBundleInterface::class);
             $urlService->addUrls($urlsToUpdate);
 
@@ -314,7 +315,6 @@ public function flushChanges()
         }
 
         if ($urlsToDelete) {
-            /** @var UrlBundleInterface $urlService */
             $urlService = Injector::inst()->create(UrlBundleInterface::class);
             $urlService->addUrls($urlsToDelete);
 

diff --git a/src/Extension/Publishable/PublishableSiteTree.php b/src/Extension/Publishable/PublishableSiteTree.php
@@ -19,6 +19,8 @@
  * an extension via the config system ordering (inject your extension "before" the PublishableSiteTree).
  *
  * @see SiteTreePublishingEngine
+ *
+ * @extends DataExtension<SiteTree>
  */
 class PublishableSiteTree extends DataExtension implements StaticallyPublishable, StaticPublishingTrigger
 {
@@ -36,7 +38,7 @@ public function getMyVirtualPages()
     }
 
     /**
-     * @return array|SS_List
+     * @return iterable<SiteTree>
      */
     public function objectsToUpdate($context)
     {
@@ -92,7 +94,7 @@ public function objectsToUpdate($context)
     /**
      * This method controls which caches will be purged
      *
-     * @return array|SS_List
+     * @return iterable<SiteTree>
      */
     public function objectsToDelete($context)
     {