Update phpstan/phpstan requirement from ^0.12.88 || ^1.0.0 to ^0.12.88 || ^1.0.0 || ^2.0.0 (#2736)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Progi1984 <[email protected]>

Author: dependabot[bot]

composer.json

@@ -120,7 +120,7 @@
         "friendsofphp/php-cs-fixer": "^3.3",
         "mpdf/mpdf": "^7.0 || ^8.0",
         "phpmd/phpmd": "^2.13",
-        "phpstan/phpstan": "^0.12.88 || ^1.0.0",
+        "phpstan/phpstan": "^0.12.88 || ^1.0.0 || ^2.0.0",
         "phpstan/phpstan-phpunit": "^1.0 || ^2.0",
         "phpunit/phpunit": ">=7.0",
         "symfony/process": "^4.4 || ^5.0",

docs/changes/1.x/1.5.0.md

@@ -10,6 +10,8 @@
 
 ### Miscellaneous
 
+- Update phpstan/phpstan requirement from ^0.12.88 || ^1.0.0 to ^0.12.88 || ^1.0.0 || ^2.0.0 by [@dependabot](https://github.com/dependabot) & [@Progi1984](https://github.com/Progi1984) in [#2736](https://github.com/PHPOffice/PHPWord/pull/2736)
+
 ### Deprecations
 
 ### BC Breaks

phpstan-baseline.neon

@@ -1839,3 +1839,39 @@ parameters:
 			message: "#^Property PhpOffice\\\\PhpWordTests\\\\XmlDocument\\:\\:\\$xpath \\(DOMXPath\\) does not accept null\\.$#"
 			count: 1
 			path: tests/PhpWordTests/XmlDocument.php
+
+		# https://github.com/phpstan/phpstan/issues/8770
+		-
+			message: "#^PHPDoc tag @var with type PhpOffice\\\\PhpWord\\\\Writer\\\\HTML\\\\Part\\\\AbstractPart is not subtype of native type[\\sA-Za-z\\@\\\\\\/0-9\\.:|]+$#"
+			count: 1
+			path: src/PhpWord/Writer/HTML.php
+
+		# https://github.com/phpstan/phpstan/issues/8770
+		-
+			message: "#^PHPDoc tag @var with type PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement is not subtype of native type[\\sA-Za-z\\@\\\\\\/0-9\\.:]+$#"
+			count: 2
+			path: tests/PhpWordTests/Element/AbstractElementTest.php
+
+		# https://github.com/phpstan/phpstan/issues/8770
+		-
+			message: "#^PHPDoc tag @var with type PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle is not subtype of native type[\\sA-Za-z\\@\\\\\\/0-9\\.:]+$#"
+			count: 4
+			path: tests/PhpWordTests/Style/AbstractStyleTest.php
+
+		# https://github.com/phpstan/phpstan/issues/8770
+		-
+			message: "#^PHPDoc tag @var with type PhpOffice\\\\PhpWord\\\\Writer\\\\EPub3\\\\Style\\\\AbstractStyle is not subtype of native type[\\sA-Za-z\\@\\\\\\/0-9\\.:]+$#"
+			count: 2
+			path: tests/PhpWordTests/Writer/EPub3/Style/AbstractStyleTest.php
+
+		# https://github.com/phpstan/phpstan/issues/8770
+		-
+			message: "#^PHPDoc tag @var with type PhpOffice\\\\PhpWord\\\\Writer\\\\ODText\\\\Part\\\\AbstractPart is not subtype of native type[\\sA-Za-z\\@\\\\\\/0-9\\.:]+$#"
+			count: 2
+			path: tests/PhpWordTests/Writer/ODText/Part/AbstractPartTest.php
+
+		# https://github.com/phpstan/phpstan/issues/8770
+		-
+			message: "#^PHPDoc tag @var with type PhpOffice\\\\PhpWord\\\\Writer\\\\Word2007\\\\Part\\\\AbstractPart is not subtype of native type[\\sA-Za-z\\@\\\\\\/0-9\\.:]+$#"
+			count: 2
+			path: tests/PhpWordTests/Writer/Word2007/Part/AbstractPartTest.php

phpstan.neon.dist

@@ -16,6 +16,7 @@ parameters:
         - tests/bootstrap.php
     ## <=PHP7.4
     reportUnmatchedIgnoredErrors: false
+    treatPhpDocTypesAsCertain: false
     ignoreErrors:
         -
             identifier: missingType.iterableValue

src/PhpWord/Element/Field.php

@@ -108,7 +108,7 @@ class Field extends AbstractElement
     /**
      * Field text.
      *
-     * @var string|TextRun
+     * @var null|string|TextRun
      */
     protected $text;
 
@@ -217,22 +217,18 @@ public function getType()
     /**
      * Set Field properties.
      *
-     * @param array $properties
-     *
      * @return self
      */
-    public function setProperties($properties = [])
+    public function setProperties(array $properties = [])
     {
-        if (is_array($properties)) {
-            foreach (array_keys($properties) as $propkey) {
-                if (!(isset($this->fieldsArray[$this->type]['properties'][$propkey]))) {
-                    throw new InvalidArgumentException("Invalid property '$propkey'");
-                }
+        foreach (array_keys($properties) as $propkey) {
+            if (!(isset($this->fieldsArray[$this->type]['properties'][$propkey]))) {
+                throw new InvalidArgumentException("Invalid property '$propkey'");
             }
-            $this->properties = array_merge($this->properties, $properties);
         }
+        $this->properties = array_merge($this->properties, $properties);
 
-        return $this->properties;
+        return $this;
     }
 
     /**
@@ -248,22 +244,18 @@ public function getProperties()
     /**
      * Set Field options.
      *
-     * @param array $options
-     *
      * @return self
      */
-    public function setOptions($options = [])
+    public function setOptions(array $options = [])
     {
-        if (is_array($options)) {
-            foreach (array_keys($options) as $optionkey) {
-                if (!(isset($this->fieldsArray[$this->type]['options'][$optionkey])) && substr($optionkey, 0, 1) !== '\\') {
-                    throw new InvalidArgumentException("Invalid option '$optionkey', possible values are " . implode(', ', $this->fieldsArray[$this->type]['options']));
-                }
+        foreach (array_keys($options) as $optionkey) {
+            if (!(isset($this->fieldsArray[$this->type]['options'][$optionkey])) && substr($optionkey, 0, 1) !== '\\') {
+                throw new InvalidArgumentException("Invalid option '$optionkey', possible values are " . implode(', ', $this->fieldsArray[$this->type]['options']));
             }
-            $this->options = array_merge($this->options, $options);
         }
+        $this->options = array_merge($this->options, $options);
 
-        return $this->options;
+        return $this;
     }
 
     /**
@@ -279,13 +271,13 @@ public function getOptions()
     /**
      * Set Field text.
      *
-     * @param null|string|TextRun $text
+     * @param null|mixed|string|TextRun $text
      *
      * @return null|string|TextRun
      */
     public function setText($text = null)
     {
-        if (isset($text)) {
+        if (null !== $text) {
             if (is_string($text) || $text instanceof TextRun) {
                 $this->text = $text;
             } else {

src/PhpWord/Element/OLEObject.php

@@ -70,17 +70,16 @@ class OLEObject extends AbstractElement
     public function __construct($source, $style = null)
     {
         $supportedTypes = ['xls', 'doc', 'ppt', 'xlsx', 'docx', 'pptx'];
-        $pathInfo = pathinfo($source);
+        $pathInfoExtension = pathinfo($source, PATHINFO_EXTENSION);
 
-        if (file_exists($source) && in_array($pathInfo['extension'], $supportedTypes)) {
-            $ext = $pathInfo['extension'];
-            if (strlen($ext) == 4 && strtolower(substr($ext, -1)) == 'x') {
-                $ext = substr($ext, 0, -1);
+        if (file_exists($source) && in_array($pathInfoExtension, $supportedTypes)) {
+            if (strlen($pathInfoExtension) == 4 && strtolower(substr($pathInfoExtension, -1)) == 'x') {
+                $pathInfoExtension = substr($pathInfoExtension, 0, -1);
             }
 
             $this->source = $source;
             $this->style = $this->setNewStyle(new ImageStyle(), $style, true);
-            $this->icon = realpath(__DIR__ . "/../resources/{$ext}.png");
+            $this->icon = realpath(__DIR__ . "/../resources/{$pathInfoExtension}.png");
 
             return;
         }

src/PhpWord/Element/Section.php

@@ -75,12 +75,10 @@ public function __construct($sectionCount, $style = null)
 
     /**
      * Set section style.
-     *
-     * @param array $style
      */
-    public function setStyle($style = null): void
+    public function setStyle(?array $style = null): void
     {
-        if (null !== $style && is_array($style)) {
+        if (null !== $style) {
             $this->style->setStyleByArray($style);
         }
     }

src/PhpWord/Element/TOC.php

@@ -59,15 +59,14 @@ class TOC extends AbstractElement
      * Create a new Table-of-Contents Element.
      *
      * @param mixed $fontStyle
-     * @param array $tocStyle
      * @param int $minDepth
      * @param int $maxDepth
      */
-    public function __construct($fontStyle = null, $tocStyle = null, $minDepth = 1, $maxDepth = 9)
+    public function __construct($fontStyle = null, ?array $tocStyle = null, $minDepth = 1, $maxDepth = 9)
     {
         $this->tocStyle = new TOCStyle();
 
-        if (null !== $tocStyle && is_array($tocStyle)) {
+        if (null !== $tocStyle) {
             $this->tocStyle->setStyleByArray($tocStyle);
         }
 

src/PhpWord/Reader/ODText/Content.php

@@ -45,8 +45,6 @@ public function read(PhpWord $phpWord): void
         $xmlReader = new XMLReader();
         $xmlReader->getDomFromZip($this->docFile, $this->xmlFile);
 
-        $trackedChanges = [];
-
         $nodes = $xmlReader->getElements('office:body/office:text/*');
         $this->section = null;
         $this->processNodes($nodes, $xmlReader, $phpWord);
@@ -186,6 +184,7 @@ public function processNodes(DOMNodeList $nodes, XMLReader $xmlReader, PhpWord $
                     case 'text:section': // Section
                         // $sectionStyleName = $xmlReader->getAttribute('text:style-name', $listItem);
                         $this->section = $phpWord->addSection();
+                        /** @var DOMNodeList<DOMElement> $children */
                         $children = $node->childNodes;
                         $this->processNodes($children, $xmlReader, $phpWord);
 

src/PhpWord/Reader/RTF/Document.php

@@ -31,7 +31,7 @@
  *
  * @since 0.11.0
  *
- * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
+ * @SuppressWarnings("PHPMD.UnusedPrivateMethod")
  */
 class Document
 {