Fix errors reported by PHPStan

Author: dtdesign

phpstan-baseline.neon

@@ -24,12 +24,6 @@ parameters:
 			count: 1
 			path: wcfsetup/install/files/lib/acp/form/LanguageImportForm.class.php
 
-		-
-			message: '#^Parameter \#1 \$children of method wcf\\system\\form\\builder\\IFormParentNode\:\:appendChildren\(\) expects array\<wcf\\system\\form\\builder\\IFormChildNode\>, array\<int, wcf\\system\\form\\builder\\field\\PasswordFormField\|wcf\\system\\form\\builder\\field\\TextFormField\|wcf\\system\\form\\builder\\IObjectTypeFormNode\> given\.$#'
-			identifier: argument.type
-			count: 1
-			path: wcfsetup/install/files/lib/acp/form/LoginForm.class.php
-
 		-
 			message: '#^Property wcf\\acp\\page\\DevtoolsNotificationTestPage\:\:\$events \(array\<array\<wcf\\system\\user\\notification\\event\\ITestableUserNotificationEvent\>\>\) does not accept array\<array\<wcf\\system\\user\\notification\\event\\IUserNotificationEvent\>\>\.$#'
 			identifier: assign.propertyType
@@ -48,12 +42,6 @@ parameters:
 			count: 1
 			path: wcfsetup/install/files/lib/acp/page/TemplateDiffPage.class.php
 
-		-
-			message: '#^Parameter \#1 \$children of method wcf\\system\\form\\builder\\FormDocument\:\:appendChildren\(\) expects array\<wcf\\system\\form\\builder\\IFormChildNode\>, array\<int, wcf\\system\\form\\builder\\field\\user\\UsernameFormField\|wcf\\system\\form\\builder\\IObjectTypeFormNode\> given\.$#'
-			identifier: argument.type
-			count: 1
-			path: wcfsetup/install/files/lib/action/GuestTokenDialogAction.class.php
-
 		-
 			message: '#^Method wcf\\data\\article\\ArticleAction\:\:delete\(\) should return int but returns array\<string, array\<int\>\|string\>\.$#'
 			identifier: return.type
@@ -90,12 +78,6 @@ parameters:
 			count: 1
 			path: wcfsetup/install/files/lib/data/user/notification/event/UserNotificationEventAction.class.php
 
-		-
-			message: '#^Parameter \#1 \$children of method wcf\\system\\form\\builder\\container\\FormContainer\:\:appendChildren\(\) expects array\<wcf\\system\\form\\builder\\IFormChildNode\>, array\<int, wcf\\system\\form\\builder\\field\\TextFormField\|wcf\\system\\form\\builder\\IObjectTypeFormNode\> given\.$#'
-			identifier: argument.type
-			count: 1
-			path: wcfsetup/install/files/lib/form/LostPasswordForm.class.php
-
 		-
 			message: '#^Instanceof between wcf\\data\\search\\ISearchResultObject and wcf\\data\\search\\ISearchResultObject will always evaluate to true\.$#'
 			identifier: instanceof.alwaysTrue
@@ -786,120 +768,36 @@ parameters:
 			count: 2
 			path: wcfsetup/install/files/lib/system/form/builder/field/AbstractNumericFormField.class.php
 
-		-
-			message: '#^Call to function is_string\(\) with string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 2
-			path: wcfsetup/install/files/lib/system/form/builder/field/AbstractNumericFormField.class.php
-
-		-
-			message: '#^Call to function is_subclass_of\(\) with class\-string\<static\(wcf\\system\\form\\builder\\field\\AbstractNumericFormField\)\> and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/AbstractNumericFormField.class.php
-
-		-
-			message: '#^Call to function is_subclass_of\(\) with class\-string\<static\(wcf\\system\\form\\builder\\field\\BooleanFormField\)\> and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/BooleanFormField.class.php
-
-		-
-			message: '#^Call to function is_subclass_of\(\) with class\-string\<static\(wcf\\system\\form\\builder\\field\\ButtonFormField\)\> and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/ButtonFormField.class.php
-
-		-
-			message: '#^Call to function is_subclass_of\(\) with class\-string\<static\(wcf\\system\\form\\builder\\field\\DateFormField\)\> and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/DateFormField.class.php
-
-		-
-			message: '#^Call to function is_subclass_of\(\) with class\-string\<static\(wcf\\system\\form\\builder\\field\\DateRangeFormField\)\> and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/DateRangeFormField.class.php
-
 		-
 			message: '#^Call to function is_numeric\(\) with array\<string\> will always evaluate to false\.$#'
 			identifier: function.impossibleType
 			count: 2
 			path: wcfsetup/install/files/lib/system/form/builder/field/EmailFormField.class.php
 
-		-
-			message: '#^Call to function is_string\(\) with string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/EmailFormField.class.php
-
-		-
-			message: '#^Call to function is_subclass_of\(\) with class\-string\<static\(wcf\\system\\form\\builder\\field\\EmailFormField\)\> and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/EmailFormField.class.php
-
-		-
-			message: '#^Call to function is_subclass_of\(\) with class\-string\<static\(wcf\\system\\form\\builder\\field\\ItemListFormField\)\> and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/ItemListFormField.class.php
-
 		-
 			message: '#^Call to function is_callable\(\) with callable\(\)\: mixed will always evaluate to true\.$#'
 			identifier: function.alreadyNarrowedType
 			count: 2
 			path: wcfsetup/install/files/lib/system/form/builder/field/MultipleSelectionFormField.class.php
 
-		-
-			message: '#^Call to function is_subclass_of\(\) with class\-string\<static\(wcf\\system\\form\\builder\\field\\MultipleSelectionFormField\)\> and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/MultipleSelectionFormField.class.php
-
 		-
 			message: '#^Result of && is always false\.$#'
 			identifier: booleanAnd.alwaysFalse
 			count: 2
 			path: wcfsetup/install/files/lib/system/form/builder/field/MultipleSelectionFormField.class.php
 
-		-
-			message: '#^Call to function is_subclass_of\(\) with class\-string\<static\(wcf\\system\\form\\builder\\field\\NumericRangeFormField\)\> and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/NumericRangeFormField.class.php
-
 		-
 			message: '#^Call to function is_int\(\) with int will always evaluate to true\.$#'
 			identifier: function.alreadyNarrowedType
 			count: 2
 			path: wcfsetup/install/files/lib/system/form/builder/field/PasswordFormField.class.php
 
-		-
-			message: '#^Call to function is_string\(\) with string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/PasswordFormField.class.php
-
-		-
-			message: '#^Call to function is_subclass_of\(\) with class\-string\<static\(wcf\\system\\form\\builder\\field\\PasswordFormField\)\> and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/PasswordFormField.class.php
-
 		-
 			message: '#^Call to function is_callable\(\) with callable\(\)\: mixed will always evaluate to true\.$#'
 			identifier: function.alreadyNarrowedType
 			count: 2
 			path: wcfsetup/install/files/lib/system/form/builder/field/RadioButtonFormField.class.php
 
-		-
-			message: '#^Call to function is_subclass_of\(\) with class\-string\<static\(wcf\\system\\form\\builder\\field\\RadioButtonFormField\)\> and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/RadioButtonFormField.class.php
-
 		-
 			message: '#^Result of && is always false\.$#'
 			identifier: booleanAnd.alwaysFalse
@@ -942,12 +840,6 @@ parameters:
 			count: 2
 			path: wcfsetup/install/files/lib/system/form/builder/field/SourceCodeFormField.class.php
 
-		-
-			message: '#^Call to function is_subclass_of\(\) with ''wcf\\\\system\\\\form\\\\builder\\\\field\\\\SourceCodeFormField'' and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/SourceCodeFormField.class.php
-
 		-
 			message: '#^Call to function is_int\(\) with int will always evaluate to true\.$#'
 			identifier: function.alreadyNarrowedType
@@ -960,18 +852,6 @@ parameters:
 			count: 2
 			path: wcfsetup/install/files/lib/system/form/builder/field/TextFormField.class.php
 
-		-
-			message: '#^Call to function is_string\(\) with string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/TextFormField.class.php
-
-		-
-			message: '#^Call to function is_subclass_of\(\) with class\-string\<static\(wcf\\system\\form\\builder\\field\\TextFormField\)\> and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/TextFormField.class.php
-
 		-
 			message: '#^Call to function is_array\(\) with array\<wcf\\system\\file\\upload\\UploadFile\> will always evaluate to true\.$#'
 			identifier: function.alreadyNarrowedType
@@ -1020,42 +900,12 @@ parameters:
 			count: 1
 			path: wcfsetup/install/files/lib/system/form/builder/field/dependency/ValueFormFieldDependency.class.php
 
-		-
-			message: '#^Call to function is_subclass_of\(\) with ''wcf\\\\system\\\\form\\\\builder\\\\field\\\\tag\\\\TagFormField'' and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/tag/TagFormField.class.php
-
-		-
-			message: '#^Call to function is_string\(\) with string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/user/UserPasswordField.class.php
-
-		-
-			message: '#^Call to function is_subclass_of\(\) with ''wcf\\\\system\\\\form\\\\builder\\\\field\\\\user\\\\UserPasswordField'' and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/user/UserPasswordField.class.php
-
 		-
 			message: '#^Call to function is_int\(\) with int will always evaluate to true\.$#'
 			identifier: function.alreadyNarrowedType
 			count: 2
 			path: wcfsetup/install/files/lib/system/form/builder/field/user/UsernameFormField.class.php
 
-		-
-			message: '#^Call to function is_string\(\) with string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/user/UsernameFormField.class.php
-
-		-
-			message: '#^Call to function is_subclass_of\(\) with ''wcf\\\\system\\\\form\\\\builder\\\\field\\\\user\\\\UsernameFormField'' and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/user/UsernameFormField.class.php
-
 		-
 			message: '#^Call to function is_string\(\) with string will always evaluate to true\.$#'
 			identifier: function.alreadyNarrowedType
@@ -1068,12 +918,6 @@ parameters:
 			count: 2
 			path: wcfsetup/install/files/lib/system/form/builder/field/wysiwyg/WysiwygFormField.class.php
 
-		-
-			message: '#^Call to function is_subclass_of\(\) with ''wcf\\\\system\\\\form\\\\builder\\\\field\\\\wysiwyg\\\\WysiwygFormField'' and string will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: wcfsetup/install/files/lib/system/form/builder/field/wysiwyg/WysiwygFormField.class.php
-
 		-
 			message: '#^Call to function is_bool\(\) with string will always evaluate to false\.$#'
 			identifier: function.impossibleType

wcfsetup/install/files/acp/update_com.woltlab.wcf_6.2_contactOptions.php

@@ -23,12 +23,15 @@
         default => $contactOption->optionType,
     };
 
+    // @phpstan-ignore property.notFound
     if ($contactOption->required) {
         $configuration['required'] = 1;
     }
+    // @phpstan-ignore property.notFound
     if ($contactOption->defaultValue && $contactOption->optionType == 'text') {
         $configuration['defaultValue'] = $contactOption->defaultValue;
     }
+    // @phpstan-ignore property.notFound
     if ($contactOption->selectOptions) {
         $configuration['required'] = convertSelectOptions($contactOption->selectOptions);
     }

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

@@ -7,6 +7,7 @@
 use wcf\form\AbstractFormBuilderForm;
 use wcf\system\form\builder\data\processor\CustomFormDataProcessor;
 use wcf\system\form\builder\field\dependency\ValueFormFieldDependency;
+use wcf\system\form\builder\field\IFormField;
 use wcf\system\form\builder\field\SelectFormField;
 use wcf\system\form\builder\IFormDocument;
 use wcf\system\form\option\FormOptionHandler;
@@ -53,6 +54,7 @@ function (IFormDocument $document, array $parameters) {
                 function (IFormDocument $document, array $data, IStorableObject $object) {
                     \assert($object instanceof DatabaseObject);
 
+                    // @phpstan-ignore property.notFound
                     if ($object->configuration) {
                         $data = \array_merge($data, JSON::decode($object->configuration));
                     }
@@ -80,7 +82,7 @@ protected function getConfigurationFormFieldIds(): array
     }
 
     /**
-     * @return IFormField[]
+     * @return list<IFormField>
      */
     protected function getSharedConfigurationFormFields(): array
     {
@@ -101,6 +103,7 @@ protected function getSharedConfigurationFormFields(): array
 
         foreach ($matrix as $formFieldId => $dependencies) {
             $formField = $sharedConfigurationFormFields->getFormField($formFieldId);
+            \assert($formField !== null);
             $formField->addDependency(
                 ValueFormFieldDependency::create($formFieldId . 'OptionTypeDependency')
                     ->fieldId('optionType')

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

@@ -246,6 +246,7 @@ protected function createCollection(): void
 
         $collection = new ($firstObject->getCollectionClassName())($this->objects);
         foreach ($this->objects as $object) {
+            \assert($object instanceof CollectionDatabaseObject);
             $object->setCollection($collection);
         }
     }

wcfsetup/install/files/lib/data/article/content/ViewableArticleContent.class.php

@@ -132,7 +132,7 @@ public function setTeaserImage(ViewableMedia $image)
      * Returns a specific article content decorated as viewable article content.
      *
      * @param int $articleContentID
-     * @return  ViewableArticleContent
+     * @return ?ViewableArticleContent
      */
     public static function getArticleContent($articleContentID)
     {

wcfsetup/install/files/lib/data/article/content/ViewableArticleContentList.class.php

@@ -2,6 +2,7 @@
 
 namespace wcf\data\article\content;
 
+use wcf\data\article\ViewableArticle;
 use wcf\data\article\ViewableArticleList;
 use wcf\data\media\ViewableMediaList;
 use wcf\system\message\embedded\object\MessageEmbeddedObjectManager;
@@ -63,7 +64,7 @@ public function readObjects()
         }
 
         // cache images
-        if (!empty($imageIDs)) {
+        if ($imageIDs !== []) {
             $mediaList = new ViewableMediaList($contentLanguageID);
             $mediaList->setObjectIDs($imageIDs);
             $mediaList->readObjects();
@@ -79,12 +80,16 @@ public function readObjects()
             );
         }
 
-        if ($this->articleLoading && !empty($articleIDs)) {
+        /** @var array<int, ViewableArticle> */
+        $articles = [];
+        if ($this->articleLoading && $articleIDs !== []) {
             $articleList = new ViewableArticleList();
-            // to prevent an infinity loop, because the list loads otherwise the article content
+            // Prevents an infinite loop, because the list would load the
+            // content itself.
             $articleList->enableContentLoading(false);
             $articleList->setObjectIDs($articleIDs);
             $articleList->readObjects();
+            $articles = $articleList->getObjects();
         }
 
         foreach ($this->getObjects() as $articleContent) {
@@ -99,11 +104,12 @@ public function readObjects()
             }
 
             if ($this->articleLoading) {
-                if ($articleList->search($articleContent->articleID) !== null) {
-                    $articleContent->setArticle($articleList->search($articleContent->articleID));
-                } else {
+                $article = $articles[$articleContent->articleID] ?? null;
+                if ($article === null) {
                     throw new \LogicException('Unable to find article with id "' . $articleContent->articleID . '".');
                 }
+
+                $articleContent->setArticle($article);
             }
         }
     }

wcfsetup/install/files/lib/data/contact/option/ContactOptionAction.class.php

@@ -118,6 +118,9 @@ public function update()
         }
     }
 
+    /**
+     * @return array<string, string>
+     */
     #[\Override]
     public function getI18nSaveTypes(): array
     {

wcfsetup/install/files/lib/data/contact/recipient/ContactRecipientAction.class.php

@@ -108,6 +108,9 @@ public function update()
         }
     }
 
+    /**
+     * @return array<string, string>
+     */
     #[\Override]
     public function getI18nSaveTypes(): array
     {

wcfsetup/install/files/lib/data/custom/option/CustomOptionAction.class.php

@@ -14,12 +14,12 @@
  * @copyright   2001-2019 WoltLab GmbH
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since   3.1
+ * @deprecated 6.2 Use `IFormOption` instead
  *
  * @template TCustomOption of CustomOption = CustomOption
  * @template TCustomOptionEditor of CustomOptionEditor|DatabaseObjectDecorator<TCustomOption> = CustomOptionEditor
  * @extends AbstractDatabaseObjectAction<TCustomOption, TCustomOptionEditor>
  * @phpstan-ignore generics.notSubtype
- * @deprecated 6.2 Use `IFormOption` instead
  */
 abstract class CustomOptionAction extends AbstractDatabaseObjectAction implements IToggleAction
 {