Fix outdated code
authorMarcel Werk <burntime@woltlab.com>
Fri, 17 May 2024 10:14:51 +0000 (12:14 +0200)
committerMarcel Werk <burntime@woltlab.com>
Fri, 17 May 2024 10:14:51 +0000 (12:14 +0200)
Missing return type for `getTitle()` and `getLink()`

snippets/php/api/user_notifications/FooUserNotificationEvent.class.php
snippets/php/api/user_notifications/FooUserNotificationObject.class.php
snippets/tutorial/tutorial-series/part-1/files/lib/data/person/Person.class.php
snippets/tutorial/tutorial-series/part-3/files/lib/data/person/Person.class.php
snippets/tutorial/tutorial-series/part-4/files/lib/data/person/Person.class.php
snippets/tutorial/tutorial-series/part-5/files/lib/data/person/Person.class.php
snippets/tutorial/tutorial-series/part-6/files/lib/data/person/Person.class.php

index c8df90836ed5f352d6447203b75b4144f2f91235..f6fa76f79a15b9774932153c84145261c08aa320 100644 (file)
@@ -1,5 +1,7 @@
 <?php
+
 namespace example\system\user\notification\event;
+
 use example\system\cache\runtime\BazRuntimeCache;
 use example\system\user\notification\object\FooUserNotificationObject;
 use wcf\system\email\Email;
@@ -16,7 +18,8 @@ use wcf\system\user\notification\event\AbstractSharedUserNotificationEvent;
  *
  * @method     FooUserNotificationObject       getUserNotificationObject()
  */
-class FooUserNotificationEvent extends AbstractSharedUserNotificationEvent {
+class FooUserNotificationEvent extends AbstractSharedUserNotificationEvent
+{
     /**
      * @inheritDoc
      */
@@ -26,7 +29,8 @@ class FooUserNotificationEvent extends AbstractSharedUserNotificationEvent {
     /**
      * @inheritDoc
      */
-    public function checkAccess() {
+    public function checkAccess()
+    {
         $this->getUserNotificationObject()->setBaz(BazRuntimeCache::getInstance()->getObject($this->getUserNotificationObject()->bazID));
 
         if (!$this->getUserNotificationObject()->isAccessible()) {
@@ -42,15 +46,16 @@ class FooUserNotificationEvent extends AbstractSharedUserNotificationEvent {
     /**
      * @inheritDoc
      */
-    public function getEmailMessage($notificationType = 'instant') {
+    public function getEmailMessage($notificationType = 'instant')
+    {
         $this->getUserNotificationObject()->setBaz(BazRuntimeCache::getInstance()->getObject($this->getUserNotificationObject()->bazID));
 
-        $messageID = '<com.woltlab.example.baz/'.$this->getUserNotificationObject()->bazID.'@'.Email::getHost().'>';
+        $messageID = '<com.woltlab.example.baz/' . $this->getUserNotificationObject()->bazID . '@' . Email::getHost() . '>';
 
         return [
             'application' => 'example',
             'in-reply-to' => [$messageID],
-            'message-id' => 'com.woltlab.example.foo/'.$this->getUserNotificationObject()->fooID,
+            'message-id' => 'com.woltlab.example.foo/' . $this->getUserNotificationObject()->fooID,
             'references' => [$messageID],
             'template' => 'email_notification_foo'
         ];
@@ -60,7 +65,8 @@ class FooUserNotificationEvent extends AbstractSharedUserNotificationEvent {
      * @inheritDoc
      * @since  5.0
      */
-    public function getEmailTitle() {
+    public function getEmailTitle()
+    {
         $this->getUserNotificationObject()->setBaz(BazRuntimeCache::getInstance()->getObject($this->getUserNotificationObject()->bazID));
 
         return $this->getLanguage()->getDynamicVariable('example.foo.notification.mail.title', [
@@ -72,14 +78,16 @@ class FooUserNotificationEvent extends AbstractSharedUserNotificationEvent {
     /**
      * @inheritDoc
      */
-    public function getEventHash() {
+    public function getEventHash()
+    {
         return sha1($this->eventID . '-' . $this->getUserNotificationObject()->bazID);
     }
 
     /**
      * @inheritDoc
      */
-    public function getLink() {
+    public function getLink(): string
+    {
         return LinkHandler::getInstance()->getLink('Foo', [
             'application' => 'example',
             'object' => $this->getUserNotificationObject()->getDecoratedObject()
@@ -89,7 +97,8 @@ class FooUserNotificationEvent extends AbstractSharedUserNotificationEvent {
     /**
      * @inheritDoc
      */
-    public function getMessage() {
+    public function getMessage()
+    {
         $authors = $this->getAuthors();
         $count = count($authors);
 
@@ -118,7 +127,8 @@ class FooUserNotificationEvent extends AbstractSharedUserNotificationEvent {
     /**
      * @inheritDoc
      */
-    public function getTitle() {
+    public function getTitle(): string
+    {
         $count = count($this->getAuthors());
         if ($count > 1) {
             return $this->getLanguage()->getDynamicVariable('example.foo.notification.title.stacked', [
@@ -133,7 +143,8 @@ class FooUserNotificationEvent extends AbstractSharedUserNotificationEvent {
     /**
      * @inheritDoc
      */
-    protected function prepare() {
+    protected function prepare()
+    {
         BazRuntimeCache::getInstance()->cacheObjectID($this->getUserNotificationObject()->bazID);
     }
-}
\ No newline at end of file
+}
index 80bcbea0ff352554c63d752fa0db8d70e3d1b062..2fead83fe465f5ee973095f914f3889af558e137 100644 (file)
@@ -1,5 +1,7 @@
 <?php
+
 namespace example\system\user\notification\object;
+
 use example\data\foo\Foo;
 use wcf\data\DatabaseObjectDecorator;
 use wcf\system\user\notification\object\IUserNotificationObject;
@@ -15,7 +17,8 @@ use wcf\system\user\notification\object\IUserNotificationObject;
  * @method     Foo     getDecoratedObject()
  * @mixin      Foo
  */
-class FooUserNotificationObject extends DatabaseObjectDecorator implements IUserNotificationObject {
+class FooUserNotificationObject extends DatabaseObjectDecorator implements IUserNotificationObject
+{
     /**
      * @inheritDoc
      */
@@ -24,21 +27,24 @@ class FooUserNotificationObject extends DatabaseObjectDecorator implements IUser
     /**
      * @inheritDoc
      */
-    public function getTitle() {
+    public function getTitle(): string
+    {
         return $this->getDecoratedObject()->getTitle();
     }
 
     /**
      * @inheritDoc
      */
-    public function getURL() {
+    public function getURL()
+    {
         return $this->getDecoratedObject()->getLink();
     }
 
     /**
      * @inheritDoc
      */
-    public function getAuthorID() {
+    public function getAuthorID()
+    {
         return $this->getDecoratedObject()->userID;
     }
-}
\ No newline at end of file
+}
index c19e21a2fdfda9d255af76ace4e7d80b47284385..24a502859a8d85508e9ede9b4505903cb2640612 100644 (file)
@@ -32,7 +32,7 @@ class Person extends DatabaseObject implements IRouteController
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->firstName . ' ' . $this->lastName;
     }
index a6390e12a4abe48e544fc07f66ce108c460baa1f..c663871a8b08c1fa10a7025cb359e568fc644750 100644 (file)
@@ -35,7 +35,7 @@ class Person extends DatabaseObject implements ITitledLinkObject
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return LinkHandler::getInstance()->getControllerLink(PersonPage::class, [
             'object' => $this,
@@ -45,7 +45,7 @@ class Person extends DatabaseObject implements ITitledLinkObject
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->firstName . ' ' . $this->lastName;
     }
index a6390e12a4abe48e544fc07f66ce108c460baa1f..c663871a8b08c1fa10a7025cb359e568fc644750 100644 (file)
@@ -35,7 +35,7 @@ class Person extends DatabaseObject implements ITitledLinkObject
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return LinkHandler::getInstance()->getControllerLink(PersonPage::class, [
             'object' => $this,
@@ -45,7 +45,7 @@ class Person extends DatabaseObject implements ITitledLinkObject
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->firstName . ' ' . $this->lastName;
     }
index bb382bdd24c97ee0762d9e6cff43b085ea475962..d969f4bd0dafa109629d0ebe2b8a7461d7b50051 100644 (file)
@@ -44,7 +44,7 @@ class Person extends DatabaseObject implements ITitledLinkObject
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return LinkHandler::getInstance()->getControllerLink(PersonPage::class, [
             'object' => $this,
@@ -77,7 +77,7 @@ class Person extends DatabaseObject implements ITitledLinkObject
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->firstName . ' ' . $this->lastName;
     }
index bb382bdd24c97ee0762d9e6cff43b085ea475962..d969f4bd0dafa109629d0ebe2b8a7461d7b50051 100644 (file)
@@ -44,7 +44,7 @@ class Person extends DatabaseObject implements ITitledLinkObject
     /**
      * @inheritDoc
      */
-    public function getLink()
+    public function getLink(): string
     {
         return LinkHandler::getInstance()->getControllerLink(PersonPage::class, [
             'object' => $this,
@@ -77,7 +77,7 @@ class Person extends DatabaseObject implements ITitledLinkObject
     /**
      * @inheritDoc
      */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->firstName . ' ' . $this->lastName;
     }