Add missing/Fix return tags
authorMatthias Schmidt <gravatronics@live.com>
Wed, 6 Apr 2016 14:19:09 +0000 (16:19 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Wed, 6 Apr 2016 14:19:09 +0000 (16:19 +0200)
15 files changed:
wcfsetup/install.php
wcfsetup/install/files/lib/system/Regex.class.php
wcfsetup/install/files/lib/system/WCF.class.php
wcfsetup/install/files/lib/system/bbcode/CodeBBCode.class.php
wcfsetup/install/files/lib/system/bulk/processing/user/AbstractUserBulkProcessingAction.class.php
wcfsetup/install/files/lib/system/category/CategoryPermissionHandler.class.php
wcfsetup/install/files/lib/system/clipboard/ClipboardHandler.class.php
wcfsetup/install/files/lib/system/database/editor/MySQLDatabaseEditor.class.php
wcfsetup/install/files/lib/system/database/editor/PostgreSQLDatabaseEditor.class.php
wcfsetup/install/files/lib/system/message/quote/MessageQuoteManager.class.php
wcfsetup/install/files/lib/system/package/PackageUpdateDispatcher.class.php
wcfsetup/install/files/lib/system/recaptcha/RecaptchaHandler.class.php
wcfsetup/install/files/lib/system/search/AbstractSearchEngine.class.php
wcfsetup/install/files/lib/system/template/TemplateScriptingCompiler.class.php
wcfsetup/install/files/lib/util/PasswordUtil.class.php

index c76427517e3b2f8af128e40537bffcd100837727..292fa30e3d3e57c5785c6a0bffa5a573850e8530 100644 (file)
@@ -711,6 +711,7 @@ class File {
         *
         * @param       string          $function
         * @param       array           $arguments
+        * @return      mixed
         */
        public function __call($function, $arguments) {
                if (function_exists('f' . $function)) {
@@ -766,6 +767,7 @@ class ZipFile extends File {
         *
         * @param       string          $function
         * @param       array           $arguments
+        * @return      mixed
         */
        public function __call($function, $arguments) {
                if (self::$gzopen64 && function_exists('gz' . $function . '64')) {
index 017960bf79991aedb5dfc1997a7b0da093f767c1..c85485891f55bae05559f42a1fbe24ec4d74bac5 100644 (file)
@@ -245,6 +245,7 @@ final class Regex {
         * 
         * @param       mixed           $result
         * @param       string          $method
+        * @return      mixed
         */
        private function checkResult($result, $method = '') {
                if ($result === false || $result === null) {
index c28cac1581ebe2f40b74f902fda316787e243513..ae49c3a64e8cd364b4863a8a5f7212ad88a65977 100644 (file)
@@ -696,6 +696,7 @@ class WCF {
         * 
         * @param       string          $name
         * @param       array           $arguments
+        * @return      object
         */
        public static final function __callStatic($name, array $arguments) {
                $className = preg_replace('~^get~', '', $name);
index ef5872823c52f9d705d24bf704841ba3c4daedc4..eee48377e49c0cd14da3918ef176d7db66b2e398 100644 (file)
@@ -249,7 +249,8 @@ class CodeBBCode extends AbstractBBCode {
        /**
         * Fixes markup that every line has proper number of opening and closing tags
         * 
-        * @param       array<string>   $lines
+        * @param       string[]        $lines
+        * @return      string[]
         */
        public static function fixMarkup(array $lines) {
                static $spanRegex = null;
index 5b0a73e720c706525562e7937ae73462157d6b35..2c0aa34c203a1168424dcf37e7f07747ad165e12 100644 (file)
@@ -1,6 +1,7 @@
 <?php
 namespace wcf\system\bulk\processing\user;
 use wcf\data\user\group\UserGroup;
+use wcf\data\user\User;
 use wcf\data\user\UserList;
 use wcf\system\bulk\processing\AbstractBulkProcessingAction;
 use wcf\system\database\util\PreparedStatementConditionBuilder;
@@ -10,7 +11,7 @@ use wcf\system\WCF;
  * Abstract implementation of a user bulk processing action.
  * 
  * @author     Matthias Schmidt
- * @copyright  2001-2015 WoltLab GmbH
+ * @copyright  2001-2016 WoltLab GmbH
  * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package    com.woltlab.wcf
  * @subpackage system.bulk.processing.user
@@ -19,7 +20,7 @@ use wcf\system\WCF;
  */
 abstract class AbstractUserBulkProcessingAction extends AbstractBulkProcessingAction {
        /**
-        * @see \wcf\system\bulk\processing\IBulkProcessingAction::getObjectList()
+        * @inheritDoc
         */
        public function getObjectList() {
                return new UserList();
@@ -29,7 +30,8 @@ abstract class AbstractUserBulkProcessingAction extends AbstractBulkProcessingAc
         * Returns all users who the active user can access due to their user group
         * assocition.
         * 
-        * @param       \wcf\data\user\UserList         $userList
+        * @param       UserList        $userList
+        * @return      User[]
         */
        protected function getAccessibleUsers(UserList $userList) {
                // fetch user group ids of all users
@@ -42,16 +44,16 @@ abstract class AbstractUserBulkProcessingAction extends AbstractBulkProcessingAc
                $statement = WCF::getDB()->prepareStatement($sql);
                $statement->execute($conditionBuilder->getParameters());
                
-               $groupIDs = [ ];
+               $groupIDs = [];
                while ($row = $statement->fetchArray()) {
                        if (!isset($groupIDs[$row['userID']])) {
-                               $groupIDs[$row['userID']] = [ ];
+                               $groupIDs[$row['userID']] = [];
                        }
                        
                        $groupIDs[$row['userID']][] = $row['groupID'];
                }
                
-               $users = [ ];
+               $users = [];
                foreach ($userList as $user) {
                        if (empty($groupIDs[$user->userID]) || UserGroup::isAccessibleGroup($groupIDs[$user->userID])) {
                                $users[$user->userID] = $user;
index 36ebfdf85b996240db4e2a0a02b0919fbcb757f2..c2c86ba658ffa5a8183e16e47e4d49ff75411332 100644 (file)
@@ -10,7 +10,7 @@ use wcf\system\WCF;
  * Handles the category permissions.
  * 
  * @author     Matthias Schmidt
- * @copyright  2001-2015 WoltLab GmbH
+ * @copyright  2001-2016 WoltLab GmbH
  * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package    com.woltlab.wcf
  * @subpackage system.category
@@ -21,21 +21,22 @@ class CategoryPermissionHandler extends SingletonFactory {
         * cached category acl options
         * @var array
         */
-       protected $categoryPermissions = array();
+       protected $categoryPermissions = [];
        
        /**
         * Returns the acl options for the given category and for the given user.
         * If no user is given, the active user is used.
         * 
-        * @param       \wcf\data\category\Category     $category
-        * @param       \wcf\data\user\User             $user
+        * @param       Category        $category
+        * @param       User            $user
+        * @return      integer[]
         */
        public function getPermissions(Category $category, User $user = null) {
                if ($user === null) {
                        $user = WCF::getUser();
                }
                
-               $permissions = array();
+               $permissions = [];
                if (isset($this->categoryPermissions[$category->categoryID])) {
                        if (isset($this->categoryPermissions[$category->categoryID]['group'])) {
                                foreach ($user->getGroupIDs() as $groupID) {
@@ -63,7 +64,7 @@ class CategoryPermissionHandler extends SingletonFactory {
        }
        
        /**
-        * @see \wcf\system\SingletonFactory::init()
+        * @inheritDoc
         */
        protected function init() {
                $this->categoryPermissions = CategoryACLOptionCacheBuilder::getInstance()->getData();
index 77f6bf9ccd117039264983d3791db993b5183309..1ee0b86303dc5e46db1ccc5cfa7fd2c763e68801 100644 (file)
@@ -265,6 +265,7 @@ class ClipboardHandler extends SingletonFactory {
         * Loads a list of marked items grouped by type name.
         * 
         * @param       integer         $objectTypeID
+        * @return      array
         */
        public function getMarkedItems($objectTypeID = null) {
                if ($this->markedItems === null) {
index 6086e25a1bb80ded7aac4935c2c44d2e1192f72c..abcd54378fc6259ab2f0a4e56299d24336f39909 100644 (file)
@@ -194,7 +194,7 @@ class MySQLDatabaseEditor extends DatabaseEditor {
         * 
         * @param       string          $columnName
         * @param       array           $columnData
-        * @param       string
+        * @return      string
         */
        protected function buildColumnDefinition($columnName, $columnData) {
                // column name
@@ -226,7 +226,7 @@ class MySQLDatabaseEditor extends DatabaseEditor {
         * 
         * @param       string          $indexName
         * @param       array           $indexData
-        * @param       string
+        * @return      string
         */
        protected function buildIndexDefinition($indexName, $indexData) {
                $definition = "";
index 9389b40eaf696e2f6433a1d26c3ef313e3f82c4d..487bba992cc6be5e5834c1bc46de3c3f8a1ec62b 100644 (file)
@@ -329,7 +329,7 @@ class PostgreSQLDatabaseEditor extends DatabaseEditor {
         * 
         * @param       string          $columnName
         * @param       array           $columnData
-        * @param       string
+        * @return      string
         */
        protected function buildColumnDefinition($columnName, $columnData) {
                // column name
@@ -363,7 +363,7 @@ class PostgreSQLDatabaseEditor extends DatabaseEditor {
         * Builds a column type for execution in a create table or alter table statement.
         * 
         * @param       array           $columnData
-        * @param       string
+        * @return      string
         */
        protected function buildColumnType($columnData) {
                $definition = strtoupper($columnData['type']);
@@ -385,7 +385,7 @@ class PostgreSQLDatabaseEditor extends DatabaseEditor {
         * Converts a MySQL column type to the matching PostgreSQL column type.
         * 
         * @param       string          $mySQLType
-        * @param       string
+        * @return      string
         */
        protected function getColumnType($mySQLType) {
                switch ($mySQLType) {
index 63ce3b0b7e29e2b3bbc93e8e03c824f8b61243ab..2b0260a592df9ad42c8e7e428dbc34f4d3c17df3 100644 (file)
@@ -167,9 +167,10 @@ class MessageQuoteManager extends SingletonFactory {
        }
        
        /**
-        * Removes a quote from storage.
+        * Removes a quote from storage and returns true if the quote has successfully been removed.
         * 
         * @param       string          $quoteID
+        * @return      boolean
         */
        public function removeQuote($quoteID) {
                if (!isset($this->quoteData[$quoteID])) {
@@ -265,6 +266,7 @@ class MessageQuoteManager extends SingletonFactory {
         * Returns a list of quotes.
         * 
         * @param       boolean         $supportPaste
+        * @return      string
         */
        public function getQuotes($supportPaste = false) {
                $template = '';
index 85078a2d5080c0baee1cc46cecf1961cc4da79d8..e7b7c94289f95c6f4ccdea045f5b740e23e68c51 100644 (file)
@@ -221,6 +221,7 @@ class PackageUpdateDispatcher extends SingletonFactory {
         * 
         * @param       \DOMXPath       $xpath
         * @param       \DOMNode        $package
+        * @return      array
         */
        protected function parsePackageUpdateXMLBlock(\DOMXPath $xpath, \DOMNode $package) {
                // define default values
index 99eeaa80726748850b194e40f718931e82d9311a..ca4bdf820909b3be5e15394c37033d13d4defdbf 100644 (file)
@@ -16,7 +16,7 @@ use wcf\util\UserUtil;
  * and released under the conditions of the GNU Lesser General Public License.
  * 
  * @author     Alexander Ebert
- * @copyright  2001-2015 WoltLab GmbH
+ * @copyright  2001-2016 WoltLab GmbH
  * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package    com.woltlab.wcf
  * @subpackage system.recaptcha
@@ -25,12 +25,10 @@ use wcf\util\UserUtil;
 class RecaptchaHandler extends SingletonFactory {
        /**
         * list of supported languages
-        * @var array<string>
+        * @var string[]
         * @see http://code.google.com/intl/de-DE/apis/recaptcha/docs/customization.html#i18n
         */
-       protected $supportedLanguages = array(
-               'de', 'en', 'es', 'fr', 'nl', 'pt', 'ru', 'tr'
-       );
+       protected $supportedLanguages = ['de', 'en', 'es', 'fr', 'nl', 'pt', 'ru', 'tr'];
        
        /**
         * language code
@@ -62,7 +60,7 @@ class RecaptchaHandler extends SingletonFactory {
        const ERROR_NOT_REACHABLE = 'recaptcha-not-reachable';
        
        /**
-        * @see \wcf\system\SingletonFactory::init()
+        * @inheritDoc
         */
        protected function init() {
                // set appropriate language code, fallback to EN if language code is not known to reCAPTCHA-API
@@ -122,14 +120,15 @@ class RecaptchaHandler extends SingletonFactory {
         * 
         * @param       string          $challenge
         * @param       string          $response
+        * @return      string
         */
        protected function verify($challenge, $response) {
-               $request = new HTTPRequest('http://www.google.com/recaptcha/api/verify', array('timeout' => 10), array(
+               $request = new HTTPRequest('http://www.google.com/recaptcha/api/verify', ['timeout' => 10], [
                        'privatekey' => $this->privateKey,
                        'remoteip' => UserUtil::getIpAddress(),
                        'challenge' => $challenge,
                        'response' => $response
-               ));
+               ]);
                
                try {
                        $request->execute();
@@ -152,11 +151,11 @@ class RecaptchaHandler extends SingletonFactory {
         * Assigns template variables for reCAPTCHA.
         */
        public function assignVariables() {
-               WCF::getTPL()->assign(array(
+               WCF::getTPL()->assign([
                        'recaptchaLanguageCode' => $this->languageCode,
                        'recaptchaPublicKey' => $this->publicKey,
                        'recaptchaUseSSL' => RouteHandler::secureConnection(), // @deprecated since 2.1
                        'recaptchaLegacyMode' => true
-               ));
+               ]);
        }
 }
index f5ee7d51a36cb08025091706d16908caf4376541..398b105040f7d1b47eb8d8c5724baadb312363dd 100644 (file)
@@ -1,5 +1,6 @@
 <?php
 namespace wcf\system\search;
+use wcf\system\database\util\PreparedStatementConditionBuilder;
 use wcf\system\SingletonFactory;
 use wcf\util\StringUtil;
 
@@ -8,7 +9,7 @@ use wcf\util\StringUtil;
  * all search engines to preserve compatibility in case of interface changes.
  * 
  * @author     Alexander Ebert
- * @copyright  2001-2015 WoltLab GmbH
+ * @copyright  2001-2016 WoltLab GmbH
  * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package    com.woltlab.wcf
  * @subpackage system.search
@@ -19,16 +20,16 @@ abstract class AbstractSearchEngine extends SingletonFactory implements ISearchE
         * class name for preferred condition builder
         * @var string
         */
-       protected $conditionBuilderClassName = 'wcf\system\database\util\PreparedStatementConditionBuilder';
+       protected $conditionBuilderClassName = PreparedStatementConditionBuilder::class;
        
        /**
         * list of engine-specific special characters
-        * @var array<string>
+        * @var string[]
         */
-       protected $specialCharacters = array();
+       protected $specialCharacters = [];
        
        /**
-        * @see \wcf\system\search\ISearchEngine::getConditionBuilderClassName()
+        * @inheritDoc
         */
        public function getConditionBuilderClassName() {
                return $this->conditionBuilderClassName;
@@ -44,6 +45,7 @@ abstract class AbstractSearchEngine extends SingletonFactory implements ISearchE
         * @see http://dev.mysql.com/doc/refman/5.5/en/fulltext-boolean.html
         * 
         * @param       string          $query
+        * @return      string
         */
        protected function parseSearchQuery($query) {
                $query = StringUtil::trim($query);
@@ -52,7 +54,7 @@ abstract class AbstractSearchEngine extends SingletonFactory implements ISearchE
                $inQuotes = false;
                $previousChar = $tmp = '';
                $controlCharacterOrSpace = false;
-               $chars = array('+', '-', '*');
+               $chars = ['+', '-', '*'];
                $ftMinWordLen = $this->getFulltextMinimumWordLength();
                for ($i = 0, $length = mb_strlen($query); $i < $length; $i++) {
                        $char = mb_substr($query, $i, 1);
@@ -131,7 +133,7 @@ abstract class AbstractSearchEngine extends SingletonFactory implements ISearchE
        abstract protected function getFulltextMinimumWordLength();
        
        /**
-        * @see \wcf\system\search\ISearchEngine::removeSpecialCharacters()
+        * @inheritDoc
         */
        public function removeSpecialCharacters($string) {
                if (!empty($this->specialCharacters)) {
index 731c24bda2edf9f118efc0fdd8bd892674669db3..7644add1e9a92e8c12354d73522ff09f406e76e1 100644 (file)
@@ -300,6 +300,7 @@ class TemplateScriptingCompiler {
         * @param       string          $tag
         * @param       string          $identifier
         * @param       array           $metaData
+        * @return      string
         */
        protected function compileTag($tag, $identifier, array &$metaData) {
                if (preg_match('~^'.$this->outputPattern.'~s', $tag)) {
index 2c06c22f96f1ecf8ce995fd34fd422aa7e36aa37..1eb596a98a2ff61c2b89707180b7ca80384c86b5 100644 (file)
@@ -522,6 +522,7 @@ final class PasswordUtil {
         * @param       string          $password
         * @param       string          $salt
         * @param       string          $dbHash
+        * @return      boolean
         */
        protected static function wcf1e($type, $password, $salt, $dbHash) {
                preg_match('~^wcf1e([cms])([01])([ab])([01])$~', $type, $matches);