Merge pull request #5157 from MysteryCode/tltype

Return Types for `ITitledObject::getLink()` and `ILinkableObject::getLink()`
WoltLab · Feb 1, 2023 · a87fd58 · a87fd58
2 parents 2c4095c + 6972b3d
commit a87fd58
Show file tree

Hide file tree

Showing 62 changed files with 90 additions and 96 deletions.
diff --git a/wcfsetup/install/files/lib/data/ILinkableObject.class.php b/wcfsetup/install/files/lib/data/ILinkableObject.class.php
@@ -13,8 +13,6 @@ interface ILinkableObject
 {
     /**
      * Returns the link to the object.
-     *
-     * @return  string
      */
-    public function getLink();
+    public function getLink(): string;
 }
diff --git a/wcfsetup/install/files/lib/data/ITitledObject.class.php b/wcfsetup/install/files/lib/data/ITitledObject.class.php
@@ -13,8 +13,6 @@ interface ITitledObject
 {
     /**
      * Returns the title of the object.
-     *
-     * @return  string
      */
-    public function getTitle();
+    public function getTitle(): string;
 }
diff --git a/wcfsetup/install/files/lib/data/ad/Ad.class.php b/wcfsetup/install/files/lib/data/ad/Ad.class.php
@@ -59,7 +59,7 @@ public function getLocation()
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->adName;
     }

diff --git a/wcfsetup/install/files/lib/data/article/Article.class.php b/wcfsetup/install/files/lib/data/article/Article.class.php
@@ -176,7 +176,7 @@ public function canPublish()
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         if ($this->getArticleContent() !== null) {
             return $this->getArticleContent()->getLink();
@@ -186,11 +186,9 @@ public function getLink()
     }
 
     /**
-     * Returns the article's title.
-     *
-     * @return      string
+     * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         if ($this->getArticleContent() !== null) {
             return $this->getArticleContent()->getTitle();

diff --git a/wcfsetup/install/files/lib/data/article/ArticleVersionTracker.class.php b/wcfsetup/install/files/lib/data/article/ArticleVersionTracker.class.php
@@ -72,7 +72,7 @@ public function getContent()
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return $this->getDecoratedObject()->getLink();
     }
@@ -104,7 +104,7 @@ public function getTime()
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->getDecoratedObject()->getTitle();
     }

diff --git a/wcfsetup/install/files/lib/data/article/FeedArticle.class.php b/wcfsetup/install/files/lib/data/article/FeedArticle.class.php
@@ -27,15 +27,15 @@ class FeedArticle extends ViewableArticle implements IFeedEntryWithEnclosure
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return $this->getDecoratedObject()->getLink();
     }
 
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->getDecoratedObject()->getTitle();
     }

diff --git a/wcfsetup/install/files/lib/data/article/LikeableArticle.class.php b/wcfsetup/install/files/lib/data/article/LikeableArticle.class.php
@@ -30,7 +30,7 @@ class LikeableArticle extends AbstractLikeObject implements IReactionObject
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->getDecoratedObject()->getTitle();
     }

diff --git a/wcfsetup/install/files/lib/data/article/category/ArticleCategory.class.php b/wcfsetup/install/files/lib/data/article/category/ArticleCategory.class.php
@@ -107,7 +107,7 @@ public function getPermission($permission, ?User $user = null)
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return LinkHandler::getInstance()->getLink('CategoryArticleList', [
             'forceFrontend' => true,
@@ -118,7 +118,7 @@ public function getLink()
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return WCF::getLanguage()->get($this->title);
     }

diff --git a/wcfsetup/install/files/lib/data/article/content/ArticleContent.class.php b/wcfsetup/install/files/lib/data/article/content/ArticleContent.class.php
@@ -52,7 +52,7 @@ class ArticleContent extends DatabaseObject implements ILinkableObject, IRouteCo
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return LinkHandler::getInstance()->getLink('Article', [
             'object' => $this,
@@ -63,7 +63,7 @@ public function getLink()
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->title;
     }

diff --git a/wcfsetup/install/files/lib/data/article/content/SearchResultArticleContent.class.php b/wcfsetup/install/files/lib/data/article/content/SearchResultArticleContent.class.php
@@ -44,7 +44,7 @@ public function getTime()
     /**
      * @inheritDoc
      */
-    public function getLink($query = '')
+    public function getLink($query = ''): string
     {
         $parameters = [
             'object' => $this->getDecoratedObject(),

diff --git a/wcfsetup/install/files/lib/data/attachment/Attachment.class.php b/wcfsetup/install/files/lib/data/attachment/Attachment.class.php
@@ -60,7 +60,7 @@ class Attachment extends DatabaseObject implements ILinkableObject, IRouteContro
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         // Do not use `LinkHandler::getControllerLink()` or `forceFrontend` as attachment
         // links can be opened in the frontend and in the ACP.
@@ -246,7 +246,7 @@ public function getThumbnailLink($size = '')
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->filename;
     }

diff --git a/wcfsetup/install/files/lib/data/bbcode/BBCode.class.php b/wcfsetup/install/files/lib/data/bbcode/BBCode.class.php
@@ -78,7 +78,7 @@ public function setAttributes(array $attributes)
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->bbcodeTag;
     }

diff --git a/wcfsetup/install/files/lib/data/bbcode/media/provider/BBCodeMediaProvider.class.php b/wcfsetup/install/files/lib/data/bbcode/media/provider/BBCodeMediaProvider.class.php
@@ -127,7 +127,7 @@ public function getOutput($url)
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->title;
     }

diff --git a/wcfsetup/install/files/lib/data/box/BoxVersionTracker.class.php b/wcfsetup/install/files/lib/data/box/BoxVersionTracker.class.php
@@ -72,7 +72,7 @@ public function getContent()
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return $this->getDecoratedObject()->getLink();
     }
@@ -104,7 +104,7 @@ public function getTime()
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->getDecoratedObject()->getTitle();
     }

diff --git a/wcfsetup/install/files/lib/data/category/Category.class.php b/wcfsetup/install/files/lib/data/category/Category.class.php
@@ -230,7 +230,7 @@ public function getPermission($permission, ?User $user = null)
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return WCF::getLanguage()->get($this->title);
     }

diff --git a/wcfsetup/install/files/lib/data/comment/Comment.class.php b/wcfsetup/install/files/lib/data/comment/Comment.class.php
@@ -140,7 +140,7 @@ public function getMessage()
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         /** @var ICommentManager $processor */
         $processor = CommentHandler::getInstance()->getObjectType($this->objectTypeID)->getProcessor();
@@ -151,7 +151,7 @@ public function getLink()
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return CommentHandler::getInstance()->getObjectType($this->objectTypeID)->getProcessor()->getTitle(
             $this->objectTypeID,

diff --git a/wcfsetup/install/files/lib/data/comment/LikeableComment.class.php b/wcfsetup/install/files/lib/data/comment/LikeableComment.class.php
@@ -30,7 +30,7 @@ class LikeableComment extends AbstractLikeObject implements IReactionObject
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->message;
     }

diff --git a/wcfsetup/install/files/lib/data/comment/response/CommentResponse.class.php b/wcfsetup/install/files/lib/data/comment/response/CommentResponse.class.php
@@ -130,7 +130,7 @@ public function setComment(Comment $comment)
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         /** @var ICommentManager $processor */
         $processor = CommentHandler::getInstance()->getObjectType($this->getComment()->objectTypeID)->getProcessor();
@@ -141,7 +141,7 @@ public function getLink()
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return CommentHandler::getInstance()->getObjectType($this->getComment()->objectTypeID)->getProcessor()->getTitle(
             $this->getComment()->objectTypeID,

diff --git a/wcfsetup/install/files/lib/data/comment/response/LikeableCommentResponse.class.php b/wcfsetup/install/files/lib/data/comment/response/LikeableCommentResponse.class.php
@@ -31,7 +31,7 @@ class LikeableCommentResponse extends AbstractLikeObject implements IReactionObj
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->message;
     }

diff --git a/wcfsetup/install/files/lib/data/contact/attachment/ContactAttachment.class.php b/wcfsetup/install/files/lib/data/contact/attachment/ContactAttachment.class.php
@@ -59,15 +59,15 @@ public static function generateKey()
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->getAttachment()->getTitle();
     }
 
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return LinkHandler::getInstance()->getLink('ContactAttachment', [
             'object' => $this->getAttachment(),

diff --git a/wcfsetup/install/files/lib/data/custom/option/CustomOption.class.php b/wcfsetup/install/files/lib/data/custom/option/CustomOption.class.php
@@ -59,7 +59,7 @@ public function __get($name)
      * @inheritDoc
      * @since   5.2
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return WCF::getLanguage()->get($this->optionTitle);
     }

diff --git a/wcfsetup/install/files/lib/data/label/Label.class.php b/wcfsetup/install/files/lib/data/label/Label.class.php
@@ -36,7 +36,7 @@ public function __toString()
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return WCF::getLanguage()->get($this->label);
     }

diff --git a/wcfsetup/install/files/lib/data/label/group/LabelGroup.class.php b/wcfsetup/install/files/lib/data/label/group/LabelGroup.class.php
@@ -24,7 +24,7 @@ class LabelGroup extends DatabaseObject implements IRouteController
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return WCF::getLanguage()->get($this->groupName);
     }

diff --git a/wcfsetup/install/files/lib/data/language/category/LanguageCategory.class.php b/wcfsetup/install/files/lib/data/language/category/LanguageCategory.class.php
@@ -25,7 +25,7 @@ class LanguageCategory extends DatabaseObject implements ITitledObject
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->languageCategory;
     }

diff --git a/wcfsetup/install/files/lib/data/media/Media.class.php b/wcfsetup/install/files/lib/data/media/Media.class.php
@@ -91,7 +91,7 @@ class Media extends DatabaseObject implements ILinkableObject, IRouteController,
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return LinkHandler::getInstance()->getLink('Media', ['object' => $this]);
     }
@@ -182,7 +182,7 @@ public function getThumbnailLocation($size)
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->filename;
     }

diff --git a/wcfsetup/install/files/lib/data/menu/Menu.class.php b/wcfsetup/install/files/lib/data/menu/Menu.class.php
@@ -74,7 +74,7 @@ public function hasContent()
      * @inheritDoc
      * @since   5.2
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return WCF::getLanguage()->get($this->title);
     }

diff --git a/wcfsetup/install/files/lib/data/menu/item/MenuItem.class.php b/wcfsetup/install/files/lib/data/menu/item/MenuItem.class.php
@@ -50,7 +50,7 @@ class MenuItem extends DatabaseObject implements ITitledObject
      * @inheritDoc
      * @since   5.2
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return WCF::getLanguage()->get($this->title);
     }

diff --git a/wcfsetup/install/files/lib/data/moderation/queue/ViewableModerationQueue.class.php b/wcfsetup/install/files/lib/data/moderation/queue/ViewableModerationQueue.class.php
@@ -66,15 +66,15 @@ public function setAffectedObject(IUserContent $object)
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return ModerationQueueManager::getInstance()->getLink($this->objectTypeID, $this->queueID);
     }
 
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->affectedObject === null ? '' : $this->affectedObject->getTitle();
     }

diff --git a/wcfsetup/install/files/lib/data/notice/Notice.class.php b/wcfsetup/install/files/lib/data/notice/Notice.class.php
@@ -69,7 +69,7 @@ public function getConditions()
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->noticeName;
     }

diff --git a/wcfsetup/install/files/lib/data/package/Package.class.php b/wcfsetup/install/files/lib/data/package/Package.class.php
@@ -80,7 +80,7 @@ class Package extends DatabaseObject implements ILinkableObject, IRouteControlle
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return LinkHandler::getInstance()->getControllerLink(PackagePage::class, [
             'object' => $this,
@@ -90,7 +90,7 @@ public function getLink()
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->getName();
     }