Add `@method` comment for `DatabaseObjectList::getSingleObject()` in subclasses

[GitHub/WoltLab/com.woltlab.wcf.conversation.git] / files / lib / data / conversation / message / SearchResultConversationMessageList.class.php

diff --git a/files/lib/data/conversation/message/SearchResultConversationMessageList.class.php b/files/lib/data/conversation/message/SearchResultConversationMessageList.class.php
index 2214253acc1419aee76c7293a0ab30012b2c5faf..91ecda5309cde48163502bb180a2fcd4b9505ab1 100644 (file)
--- a/files/lib/data/conversation/message/SearchResultConversationMessageList.class.php
+++ b/files/lib/data/conversation/message/SearchResultConversationMessageList.class.php
@@ -1,33 +1,41 @@
 <?php
+
 namespace wcf\data\conversation\message;
 
 /**
  * Represents a list of search results.
- * 
- * @author     Marcel Werk
- * @copyright  2001-2017 WoltLab GmbH
- * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
- * @package    WoltLabSuite\Core\Data\Conversation\Message
  *
- * @method     SearchResultConversationMessage         current()
- * @method     SearchResultConversationMessage[]       getObjects()
- * @method     SearchResultConversationMessage|null    search($objectID)
- * @property   SearchResultConversationMessage[]       $objects
+ * @author  Marcel Werk
+ * @copyright   2001-2019 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package WoltLabSuite\Core\Data\Conversation\Message
+ *
+ * @method  SearchResultConversationMessage     current()
+ * @method  SearchResultConversationMessage[]   getObjects()
+ * @method  SearchResultConversationMessage|null    getSingleObject()
+ * @method  SearchResultConversationMessage|null    seach($objectID)
+ * @property    SearchResultConversationMessage[] $objects
  */
-class SearchResultConversationMessageList extends SimplifiedViewableConversationMessageList {
-       /**
-        * @inheritDoc
-        */
-       public $decoratorClassName = SearchResultConversationMessage::class;
-       
-       /**
-        * Creates a new SearchResultConversationMessageList object.
-        */
-       public function __construct() {
-               parent::__construct();
-               
-               if (!empty($this->sqlSelects)) $this->sqlSelects .= ',';
-               $this->sqlSelects .= 'conversation.subject';
-               $this->sqlJoins .= " LEFT JOIN wcf".WCF_N."_conversation conversation ON (conversation.conversationID = conversation_message.conversationID)";
-       }
+class SearchResultConversationMessageList extends SimplifiedViewableConversationMessageList
+{
+    /**
+     * @inheritDoc
+     */
+    public $decoratorClassName = SearchResultConversationMessage::class;
+
+    /**
+     * Creates a new SearchResultConversationMessageList object.
+     */
+    public function __construct()
+    {
+        parent::__construct();
+
+        if (!empty($this->sqlSelects)) {
+            $this->sqlSelects .= ',';
+        }
+        $this->sqlSelects .= 'conversation.subject';
+        $this->sqlJoins .= "
+            LEFT JOIN   wcf" . WCF_N . "_conversation conversation
+            ON          conversation.conversationID = conversation_message.conversationID";
+    }
 }