Merge pull request #6611 from WoltLab/63-dbo-properties

Update / unify property documentation of database objects

Author: BurntimeX

composer.json

@@ -2,7 +2,7 @@
     "name": "woltlab/wcf",
     "type": "project",
     "require-dev": {
-        "phpstan/phpstan": "^2.1"
+        "phpstan/phpstan": "^2.1.40"
     },
     "require": {}
 }

composer.lock

@@ -1,4 +1,5 @@
 <?php // @codingStandardsIgnoreFile
+
 /**
  * This script tries to find the temp folder and unzip all setup files into.
  *
@@ -532,7 +533,6 @@ function printException($e)
 	throw new ErrorException($message, 0, $severity, $file, $line);
 }, E_ALL);
 
-/** @noinspection PhpMultipleClassesDeclarationsInOneFile */
 /**
  * A SystemException is thrown when an unexpected error occurs.
  *
@@ -573,9 +573,7 @@ public function getDescription()
 	 * Prints this exception.
 	 * This method is called by WCF::handleException().
 	 */
-	public function show()
-	{
-	}
+	public function show() {}
 }
 
 /**
@@ -633,7 +631,6 @@ function wcfDebug()
 	exit;
 }
 
-/** @noinspection PhpMultipleClassesDeclarationsInOneFile */
 /**
  * BasicFileUtil contains file-related functions.
  *
@@ -760,7 +757,6 @@ public static function makePath($path): bool
 	}
 }
 
-/** @noinspection PhpMultipleClassesDeclarationsInOneFile */
 /**
  * Opens tar or tar.gz archives.
  *
@@ -1124,7 +1120,6 @@ public function isZipped()
 	}
 }
 
-/** @noinspection PhpMultipleClassesDeclarationsInOneFile */
 /**
  * The File class handles all file operations.
  *
@@ -1185,15 +1180,13 @@ public function __call($function, $arguments)
 	}
 }
 
-/** @noinspection PhpMultipleClassesDeclarationsInOneFile */
 /**
  * The File class handles all file operations on a zipped file.
  *
  * @author	Marcel Werk
  */
 final class GZipFile extends File
 {
-	/** @noinspection PhpMissingParentConstructorInspection */
 	/**
 	 * Opens a gzip file.
 	 *

wcfsetup/install.php

@@ -9,11 +9,20 @@
  */
 
 use wcf\system\database\table\column\DefaultFalseBooleanDatabaseTableColumn;
+use wcf\system\database\table\column\NotNullVarchar255DatabaseTableColumn;
+use wcf\system\database\table\column\SmallintDatabaseTableColumn;
 use wcf\system\database\table\PartialDatabaseTable;
 
 return [
     PartialDatabaseTable::create('wcf1_label_group')
         ->columns([
             DefaultFalseBooleanDatabaseTableColumn::create('sortAlphabetically')
         ]),
+    PartialDatabaseTable::create('wcf1_trophy')
+        ->columns([
+            NotNullVarchar255DatabaseTableColumn::create('title'),
+            SmallintDatabaseTableColumn::create('type')
+                ->notNull()
+                ->defaultValue(1),
+        ]),
 ];

wcfsetup/install/files/acp/database/update_com.woltlab.wcf_6.3_step1.php

@@ -70,7 +70,6 @@ public function readData()
 
             $conditions = $this->assignment->getConditions();
             foreach ($conditions as $condition) {
-                /** @noinspection PhpUndefinedMethodInspection */
                 $this->conditions[$condition->getObjectType()->conditiongroup][$condition->objectTypeID]->getProcessor()->setData($condition);
             }
         }

wcfsetup/install/files/lib/acp/form/UserGroupAssignmentEditForm.class.php

@@ -143,7 +143,6 @@ protected function invoke()
 
         // validate accessibility
         $className = $this->className;
-        /** @noinspection PhpUndefinedFieldInspection */
         if (!\property_exists($className, 'allowInvoke') || !\in_array($this->actionName, $className::$allowInvoke)) {
             throw new PermissionDeniedException();
         }

wcfsetup/install/files/lib/action/AJAXInvokeAction.class.php

@@ -99,7 +99,6 @@ protected function sendResponse()
     {
         // add benchmark and debug data
         if (ENABLE_BENCHMARK) {
-            /** @noinspection PhpUndefinedMethodInspection */
             $this->response['benchmark'] = [
                 'executionTime' => WCF::getBenchmark()->getExecutionTime() . 's',
                 'memoryUsage' => WCF::getBenchmark()->getMemoryUsage(),
@@ -109,7 +108,6 @@ protected function sendResponse()
             ];
 
             if (ENABLE_DEBUG_MODE) {
-                /** @noinspection PhpUndefinedMethodInspection */
                 $this->response['benchmark']['items'] = WCF::getBenchmark()->getItems();
             }
         }

wcfsetup/install/files/lib/action/AJAXProxyAction.class.php

@@ -31,7 +31,6 @@ public function execute(): ResponseInterface
         $processor = null;
         try {
             // post back to paypal to validate
-            /** @noinspection PhpUnusedLocalVariableInspection */
             $content = '';
             try {
                 $url = 'https://www.paypal.com/cgi-bin/webscr';

wcfsetup/install/files/lib/action/PaypalCallbackAction.class.php

@@ -140,7 +140,6 @@ public function __construct(array $objects, $action, array $parameters = [])
                     throw new SystemException('invalid value of parameter objects given');
                 }
 
-                /** @noinspection PhpVariableVariableInspection */
                 $this->objectIDs[] = $object->{$indexName};
             } else {
                 $this->objectIDs[] = $object;

wcfsetup/install/files/lib/data/AbstractDatabaseObjectAction.class.php

@@ -229,7 +229,6 @@ public static function sort(&$objects, $sortBy, $sortOrder = 'ASC', $maintainInd
     {
         $sortArray = $objects2 = [];
         foreach ($objects as $idx => $obj) {
-            /** @noinspection PhpVariableVariableInspection */
             $sortArray[$idx] = $obj->{$sortBy};
 
             // array_multisort will drop index association if key is not a string