Improve the typing of runtime caches and the clipboard

Author: dtdesign

wcfsetup/install/files/lib/system/cache/runtime/AbstractRuntimeCache.class.php

@@ -3,6 +3,7 @@
 namespace wcf\system\cache\runtime;
 
 use wcf\data\DatabaseObject;
+use wcf\data\DatabaseObjectDecorator;
 use wcf\data\DatabaseObjectList;
 use wcf\system\SingletonFactory;
 
@@ -13,6 +14,8 @@
  * @copyright   2001-2019 WoltLab GmbH
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since   3.0
+ * @template T of DatabaseObject|DatabaseObjectDecorator
+ * @implements IRuntimeCache<T>
  */
 abstract class AbstractRuntimeCache extends SingletonFactory implements IRuntimeCache
 {
@@ -30,21 +33,17 @@ abstract class AbstractRuntimeCache extends SingletonFactory implements IRuntime
 
     /**
      * cached DatabaseObject objects
-     * @var DatabaseObject[]
+     * @var T[]
      */
     protected $objects = [];
 
-    /**
-     * @inheritDoc
-     */
+    #[\Override]
     public function cacheObjectID($objectID)
     {
         $this->cacheObjectIDs([$objectID]);
     }
 
-    /**
-     * @inheritDoc
-     */
+    #[\Override]
     public function cacheObjectIDs(array $objectIDs)
     {
         foreach ($objectIDs as $objectID) {
@@ -74,17 +73,13 @@ protected function fetchObjects()
         $this->objectIDs = [];
     }
 
-    /**
-     * @inheritDoc
-     */
+    #[\Override]
     public function getCachedObjects()
     {
         return $this->objects;
     }
 
-    /**
-     * @inheritDoc
-     */
+    #[\Override]
     public function getObject($objectID)
     {
         if (\array_key_exists($objectID, $this->objects)) {
@@ -101,16 +96,14 @@ public function getObject($objectID)
     /**
      * Returns a database object list object to fetch cached objects.
      *
-     * @return  DatabaseObjectList
+     * @return DatabaseObjectList
      */
     protected function getObjectList()
     {
         return new $this->listClassName();
     }
 
-    /**
-     * @inheritDoc
-     */
+    #[\Override]
     public function getObjects(array $objectIDs)
     {
         $objects = [];
@@ -137,17 +130,13 @@ public function getObjects(array $objectIDs)
         return $objects;
     }
 
-    /**
-     * @inheritDoc
-     */
+    #[\Override]
     public function removeObject($objectID)
     {
         $this->removeObjects([$objectID]);
     }
 
-    /**
-     * @inheritDoc
-     */
+    #[\Override]
     public function removeObjects(array $objectIDs)
     {
         foreach ($objectIDs as $objectID) {

wcfsetup/install/files/lib/system/cache/runtime/AttachmentRuntimeCache.class.php

@@ -13,9 +13,7 @@
  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since       6.1
  *
- * @method  Attachment[]         getCachedObjects()
- * @method  Attachment|null      getObject($objectID)
- * @method  Attachment[]         getObjects(array $objectIDs)
+ * @extends AbstractRuntimeCache<Attachment>
  */
 final class AttachmentRuntimeCache extends AbstractRuntimeCache
 {

wcfsetup/install/files/lib/system/cache/runtime/CommentResponseRuntimeCache.class.php

@@ -13,9 +13,7 @@
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since   3.0
  *
- * @method  (CommentResponse|null)[]    getCachedObjects()
- * @method  ?CommentResponse getObject($objectID)
- * @method  (CommentResponse|null)[]    getObjects(array $objectIDs)
+ * @extends AbstractRuntimeCache<CommentResponse>
  */
 class CommentResponseRuntimeCache extends AbstractRuntimeCache
 {

wcfsetup/install/files/lib/system/cache/runtime/CommentRuntimeCache.class.php

@@ -13,9 +13,7 @@
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since   3.0
  *
- * @method  (Comment|null)[]    getCachedObjects()
- * @method  ?Comment getObject($objectID)
- * @method  (Comment|null)[]    getObjects(array $objectIDs)
+ * @extends AbstractRuntimeCache<Comment>
  */
 class CommentRuntimeCache extends AbstractRuntimeCache
 {

wcfsetup/install/files/lib/system/cache/runtime/FileRuntimeCache.class.php

@@ -13,9 +13,7 @@
  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since       6.2
  *
- * @method  File[]      getCachedObjects()
- * @method  File|null   getObject($objectID)
- * @method  File[]      getObjects(array $objectIDs)
+ * @extends AbstractRuntimeCache<File>
  */
 class FileRuntimeCache extends AbstractRuntimeCache
 {

wcfsetup/install/files/lib/system/cache/runtime/IRuntimeCache.class.php

@@ -11,6 +11,7 @@
  * @copyright   2001-2019 WoltLab GmbH
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since   3.0
+ * @template T of DatabaseObject|DatabaseObjectDecorator
  */
 interface IRuntimeCache
 {
@@ -19,6 +20,7 @@ interface IRuntimeCache
      * this id will also be fetched.
      *
      * @param int $objectID
+     * @return void
      */
     public function cacheObjectID($objectID);
 
@@ -27,13 +29,14 @@ public function cacheObjectID($objectID);
      * these ids will also be fetched.
      *
      * @param int[] $objectIDs
+     * @return void
      */
     public function cacheObjectIDs(array $objectIDs);
 
     /**
      * Returns all currently cached objects.
      *
-     * @return  DatabaseObject[]
+     * @return array<int, ?T>
      */
     public function getCachedObjects();
 
@@ -43,7 +46,7 @@ public function getCachedObjects();
      * during this method call and the object, if existing, will be returned.
      *
      * @param int $objectID
-     * @return  DatabaseObject|null
+     * @return ?T
      */
     public function getObject($objectID);
 
@@ -54,21 +57,23 @@ public function getObject($objectID);
      * during this method call and the objects, if existing, will be returned.
      *
      * @param int[] $objectIDs
-     * @return  DatabaseObject[]
+     * @return array<int, ?T>
      */
     public function getObjects(array $objectIDs);
 
     /**
      * Removes the object with the given id from the runtime cache if it has already been loaded.
      *
      * @param int $objectID
+     * @return void
      */
     public function removeObject($objectID);
 
     /**
      * Removes the objects with the given ids from the runtime cache if they have already been loaded.
      *
      * @param int[] $objectIDs
+     * @return void
      */
     public function removeObjects(array $objectIDs);
 }

wcfsetup/install/files/lib/system/cache/runtime/MediaRuntimeCache.class.php

@@ -13,9 +13,7 @@
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since   3.0
  *
- * @method  Media[]         getCachedObjects()
- * @method  Media|null      getObject($objectID)
- * @method  Media[]         getObjects(array $objectIDs)
+ * @extends AbstractRuntimeCache<Media>
  */
 class MediaRuntimeCache extends AbstractRuntimeCache
 {

wcfsetup/install/files/lib/system/cache/runtime/UserProfileRuntimeCache.class.php

@@ -13,9 +13,7 @@
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since   3.0
  *
- * @method  (UserProfile|null)[]    getCachedObjects()
- * @method  UserProfile|null getObject($objectID)
- * @method  (UserProfile|null)[]    getObjects(array $objectIDs)
+ * @extends AbstractRuntimeCache<UserProfile>
  */
 class UserProfileRuntimeCache extends AbstractRuntimeCache
 {
@@ -28,8 +26,8 @@ class UserProfileRuntimeCache extends AbstractRuntimeCache
      * Adds a user profile to the cache. This is an internal method that should
      * not be used on a regular basis.
      *
-     * @param UserProfile $profile
-     * @since       3.1
+     * @return void
+     * @since 3.1
      */
     public function addUserProfile(UserProfile $profile)
     {

wcfsetup/install/files/lib/system/cache/runtime/UserRuntimeCache.class.php

@@ -13,9 +13,7 @@
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since   3.0
  *
- * @method  (User|null)[]      getCachedObjects()
- * @method  ?User   getObject($objectID)
- * @method  (User|null)[]      getObjects(array $objectIDs)
+ * @extends AbstractRuntimeCache<User>
  */
 class UserRuntimeCache extends AbstractRuntimeCache
 {

wcfsetup/install/files/lib/system/cache/runtime/ViewableArticleContentRuntimeCache.class.php

@@ -13,9 +13,7 @@
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since   5.2
  *
- * @method  ViewableArticleContent[]        getCachedObjects()
- * @method  ViewableArticleContent|null     getObject($objectID)
- * @method  ViewableArticleContent[]        getObjects(array $objectIDs)
+ * @extends AbstractRuntimeCache<ViewableArticleContent>
  */
 class ViewableArticleContentRuntimeCache extends AbstractRuntimeCache
 {