Fix typo in method documentation

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / data / attachment / AdministrativeAttachmentList.class.php

diff --git a/wcfsetup/install/files/lib/data/attachment/AdministrativeAttachmentList.class.php b/wcfsetup/install/files/lib/data/attachment/AdministrativeAttachmentList.class.php
index 9a62e71a27336757141cd4e1ceeb2a65d32ed122..38085da9388a259f44f5ece289dda5625e42501a 100644 (file)
--- a/wcfsetup/install/files/lib/data/attachment/AdministrativeAttachmentList.class.php
+++ b/wcfsetup/install/files/lib/data/attachment/AdministrativeAttachmentList.class.php
@@ -1,93 +1,105 @@
 <?php
+
 namespace wcf\data\attachment;
+
 use wcf\data\object\type\ObjectTypeCache;
 use wcf\system\WCF;
 
 /**
  * Represents a list of attachments.
- * 
- * @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\Attachment
  *
- * @method     AdministrativeAttachment        current()
- * @method     AdministrativeAttachment[]      getObjects()
- * @method     AdministrativeAttachment|null   search($objectID)
- * @property   AdministrativeAttachment[]      $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\Attachment
+ *
+ * @method  AdministrativeAttachment    current()
+ * @method  AdministrativeAttachment[]  getObjects()
+ * @method  AdministrativeAttachment|null   getSingleObject()
+ * @method  AdministrativeAttachment|null   search($objectID)
+ * @property    AdministrativeAttachment[] $objects
  */
-class AdministrativeAttachmentList extends AttachmentList {
-       /**
-        * @inheritDoc
-        */
-       public $decoratorClassName = AdministrativeAttachment::class;
-       
-       /**
-        * Creates a new AdministrativeAttachmentList object.
-        */
-       public function __construct() {
-               parent::__construct();
-               
-               $this->sqlSelects = 'user_table.username';
-               $this->sqlJoins = " LEFT JOIN wcf".WCF_N."_user user_table ON (user_table.userID = attachment.userID)";
-       }
-       
-       /**
-        * @inheritDoc
-        */
-       public function readObjects() {
-               parent::readObjects();
-               
-               // cache objects
-               $groupedObjectIDs = [];
-               foreach ($this->objects as $attachment) {
-                       if (!isset($groupedObjectIDs[$attachment->objectTypeID])) $groupedObjectIDs[$attachment->objectTypeID] = [];
-                       $groupedObjectIDs[$attachment->objectTypeID][] = $attachment->objectID;
-               }
-               
-               foreach ($groupedObjectIDs as $objectTypeID => $objectIDs) {
-                       $objectType = ObjectTypeCache::getInstance()->getObjectType($objectTypeID);
-                       $objectType->getProcessor()->cacheObjects($objectIDs);
-               }
-       }
-       
-       /**
-        * Returns a list of available mime types.
-        * 
-        * @return      string[]
-        */
-       public function getAvailableFileTypes() {
-               $fileTypes = [];
-               $sql = "SELECT  DISTINCT attachment.fileType
-                       FROM    wcf".WCF_N."_attachment attachment
-                       ".$this->getConditionBuilder();
-               $statement = WCF::getDB()->prepareStatement($sql);
-               $statement->execute($this->getConditionBuilder()->getParameters());
-               while ($row = $statement->fetchArray()) {
-                       if ($row['fileType']) {
-                               $fileTypes[$row['fileType']] = $row['fileType'];
-                       }
-               }
-               
-               ksort($fileTypes);
-               
-               return $fileTypes;
-       }
-       
-       /**
-        * Returns attachment statistics.
-        * 
-        * @return      integer[]
-        */
-       public function getStats() {
-               $sql = "SELECT  COUNT(*) AS count,
-                               COALESCE(SUM(attachment.filesize), 0) AS size,
-                               COALESCE(SUM(downloads), 0) AS downloads
-                       FROM    wcf".WCF_N."_attachment attachment
-                       ".$this->getConditionBuilder();
-               $statement = WCF::getDB()->prepareStatement($sql);
-               $statement->execute($this->getConditionBuilder()->getParameters());
-               
-               return $statement->fetchArray();
-       }
+class AdministrativeAttachmentList extends AttachmentList
+{
+    /**
+     * @inheritDoc
+     */
+    public $decoratorClassName = AdministrativeAttachment::class;
+
+    /**
+     * Creates a new AdministrativeAttachmentList object.
+     */
+    public function __construct()
+    {
+        parent::__construct();
+
+        $this->sqlSelects = 'user_table.username';
+        $this->sqlJoins = "
+            LEFT JOIN   wcf" . WCF_N . "_user user_table
+            ON          user_table.userID = attachment.userID";
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function readObjects()
+    {
+        parent::readObjects();
+
+        // cache objects
+        $groupedObjectIDs = [];
+        foreach ($this->objects as $attachment) {
+            if (!isset($groupedObjectIDs[$attachment->objectTypeID])) {
+                $groupedObjectIDs[$attachment->objectTypeID] = [];
+            }
+            $groupedObjectIDs[$attachment->objectTypeID][] = $attachment->objectID;
+        }
+
+        foreach ($groupedObjectIDs as $objectTypeID => $objectIDs) {
+            $objectType = ObjectTypeCache::getInstance()->getObjectType($objectTypeID);
+            $objectType->getProcessor()->cacheObjects($objectIDs);
+        }
+    }
+
+    /**
+     * Returns a list of available mime types.
+     *
+     * @return  string[]
+     */
+    public function getAvailableFileTypes()
+    {
+        $fileTypes = [];
+        $sql = "SELECT  DISTINCT attachment.fileType
+                FROM    wcf" . WCF_N . "_attachment attachment
+                " . $this->getConditionBuilder();
+        $statement = WCF::getDB()->prepareStatement($sql);
+        $statement->execute($this->getConditionBuilder()->getParameters());
+        while ($row = $statement->fetchArray()) {
+            if ($row['fileType']) {
+                $fileTypes[$row['fileType']] = $row['fileType'];
+            }
+        }
+
+        \ksort($fileTypes);
+
+        return $fileTypes;
+    }
+
+    /**
+     * Returns attachment statistics.
+     *
+     * @return  int[]
+     */
+    public function getStats()
+    {
+        $sql = "SELECT  COUNT(*) AS count,
+                        COALESCE(SUM(attachment.filesize), 0) AS size,
+                        COALESCE(SUM(downloads), 0) AS downloads
+                FROM    wcf" . WCF_N . "_attachment attachment
+                " . $this->getConditionBuilder();
+        $statement = WCF::getDB()->prepareStatement($sql);
+        $statement->execute($this->getConditionBuilder()->getParameters());
+
+        return $statement->fetchArray();
+    }
 }