Merge branch 'master' into bullet_list_render

Author: jgiacomello

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,4 +9,4 @@ Fixes # (issue)
 - [ ] My CI is :green_circle:
 - [ ] I have covered by unit tests my new code (check build/coverage for coverage report)
 - [ ] I have updated the [documentation](https://github.com/PHPOffice/PHPWord/tree/master/docs) to describe the changes
-- [ ] I have updated the [changelog](https://github.com/PHPOffice/PHPWord/blob/master/docs/changes/1.x/1.4.0.md)
+- [ ] I have updated the [changelog](https://github.com/PHPOffice/PHPWord/blob/master/docs/changes/1.x/1.5.0.md)

composer.json

@@ -112,15 +112,15 @@
         "ext-zip": "*",
         "ext-json": "*",
         "ext-xml": "*",
-        "phpoffice/math": "^0.2"
+        "phpoffice/math": "^0.3"
     },
     "require-dev": {
         "ext-libxml": "*",
         "dompdf/dompdf": "^2.0 || ^3.0",
         "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.4.0.md

@@ -1,4 +1,4 @@
-# [1.4.0](https://github.com/PHPOffice/PHPWord/tree/1.4.0) (WIP)
+# [1.4.0](https://github.com/PHPOffice/PHPWord/tree/1.4.0)
 
 [Full Changelog](https://github.com/PHPOffice/PHPWord/compare/1.3.0...1.4.0)
 
@@ -31,13 +31,16 @@
 - Writer HTML: Fixed null string for Text Elements by [@armagedon007](https://github.com/armagedon007) and [@Progi1984](https://github.com/Progi1984) in [#2738](https://github.com/PHPOffice/PHPWord/pull/2738)
 - Template Processor: Fix 0 considered as empty string by [@cavasinf](https://github.com/cavasinf), [@SnipsMine](https://github.com/SnipsMine) and [@Progi1984](https://github.com/Progi1984) fixing [#2572](https://github.com/PHPOffice/PHPWord/issues/2572), [#2703](https://github.com/PHPOffice/PHPWord/issues/2703) in [#2748](https://github.com/PHPOffice/PHPWord/pull/2748)
 - Word2007 Writer : Corrected generating TOC to fix page number missing issues [@jgiacomello](https://github.com/jgiacomello) in [#2556](https://github.com/PHPOffice/PHPWord/pull/2556)
+- Enhanced error handling in encoding functions [@michalschroeder](https://github.com/michalschroeder) in [#2784](https://github.com/PHPOffice/PHPWord/pull/2784)
 
 ### Miscellaneous
 
 - Bump dompdf/dompdf from 2.0.4 to 3.0.0 by [@dependabot](https://github.com/dependabot) fixing [#2621](https://github.com/PHPOffice/PHPWord/issues/2621) in [#2666](https://github.com/PHPOffice/PHPWord/pull/2666)
 - Add test case to make sure vMerge defaults to 'continue' by [@SpraxDev](https://github.com/SpraxDev) in [#2677](https://github.com/PHPOffice/PHPWord/pull/2677)
 - Adding the possibility to use iterate search and replace with setValues by [@moghwan](https://github.com/moghwan) in [#2632](https://github.com/PHPOffice/PHPWord/pull/2640)
 - Add test cases that test the ODTText and Word2007 reader using the corresponding writer, increasing test coverage by [@MichaelPFrey](https://github.com/MichaelPFrey) in [#2745](https://github.com/PHPOffice/PHPWord/pull/2745)
+- Updated TOCTest to use static HTML content instead of external resource [@michalschroeder](https://github.com/michalschroeder) in [#2784](https://github.com/PHPOffice/PHPWord/pull/2784)
+- Bump PHPOffice/math from 0.2.0 to 0.3.0 by [@eileenmcnaughton](https://github.com/eileenmcnaughton) in [#2785](https://github.com/PHPOffice/PHPWord/pull/2785)
 
 ### Deprecations
 - Deprecate `PhpOffice\PhpWord\Style\Paragraph::getIndent()` : Use `PhpOffice\PhpWord\Style\Paragraph::getIndentLeft()`

docs/changes/1.x/1.5.0.md

@@ -0,0 +1,19 @@
+# [1.5.0](https://github.com/PHPOffice/PHPWord/tree/1.5.0) (WIP)
+
+[Full Changelog](https://github.com/PHPOffice/PHPWord/compare/1.4.0...1.5.0)
+
+## Enhancements
+
+### Bug fixes
+
+- Set writeAttribute return type by [@radarhere](https://github.com/radarhere) fixing [#2204](https://github.com/PHPOffice/PHPWord/issues/2204) in [#2776](https://github.com/PHPOffice/PHPWord/pull/2776)
+
+### 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
+
+### Notes

mkdocs.yml

@@ -88,7 +88,8 @@ nav:
   - Credits: 'credits.md'
   - Releases:
     - '1.x':
-      - '1.4.0 (WIP)': 'changes/1.x/1.4.0.md'
+      - '1.5.0 (WIP)': 'changes/1.x/1.5.0.md'
+      - '1.4.0': 'changes/1.x/1.4.0.md'
       - '1.3.0': 'changes/1.x/1.3.0.md'
       - '1.2.0': 'changes/1.x/1.2.0.md'
       - '1.1.0': 'changes/1.x/1.1.0.md'

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);
         }
     }