Add phpstan

.travis.yml

@@ -7,14 +7,14 @@ matrix:
   include:
     - php: 7.2
       env: WITH_PHPUNIT=true
+    - php: 7.2
+      env: WITH_PHPSTAN=true
     - php: 7.3
       env: WITH_PHPUNIT=true
     - php: 7.3
       env: WITH_PHPUNIT=true WITH_COVERAGE=true
     - php: 7.4
       env: WITH_PHPUNIT=true
-    - php: 8.0
-      env: WITH_PHPUNIT=true
 
 
 cache:
@@ -30,6 +30,9 @@ before_install:
     if [[ "$WITH_CS" != "true" ]]; then
         composer remove friendsofphp/php-cs-fixer --dev --no-update
     fi
+    if [[ "$WITH_PHPSTAN" != "true" ]]; then
+        composer remove phpstan/phpstan --dev --no-update
+    fi
   - composer validate
 
 install:
@@ -44,6 +47,10 @@ script:
     if [[ "$WITH_CS" == "true" ]]; then
         vendor/bin/php-cs-fixer fix --config=.php_cs.dist --verbose --diff --dry-run --diff-format=udiff
     fi
+  - |
+    if [[ "$WITH_PHPSTAN" == "true" ]]; then
+        vendor/bin/phpstan
+    fi
   - |
     if [[ "$WITH_PHPUNIT" == "true" ]]; then
         if [[ "$WITH_COVERAGE" == "true" ]]; then

CONTRIBUTING.md

@@ -82,7 +82,28 @@ This will print a diff of proposed code style changes. To apply these suggestion
 vendor/bin/php-cs-fixer fix --config=.php_cs.dist
 ```
 
-### Step 9: Send the pull request
+You can also use
+
+```
+composer phpcs
+```
+
+### Step 9: Fix phpstan
+
+Run the following command to analyse source code.
+Make sure to fix all errors before submitting a pull request.
+
+```
+vendor/bin/phpstan analyse
+```
+
+You can also use
+
+```
+composer phpstan
+```
+
+### Step 10: Send the pull request
 
 Send the pull request from your feature branch to us. Be sure to include a description that lets us know what work you did.
 

composer.json

@@ -19,7 +19,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^8",
-        "friendsofphp/php-cs-fixer": "^2"
+        "friendsofphp/php-cs-fixer": "^2",
+        "phpstan/phpstan": "^0.12.98"
     },
     "suggest": {
         "ext-iconv": "To handle non UTF-8 CSV files (if \"php-intl\" is not already installed or is too limited)",
@@ -30,6 +31,11 @@
             "Box\\Spout\\": "src/Spout"
         }
     },
+    "scripts": {
+        "phpunit": "vendor/bin/phpunit",
+        "phpstan": "vendor/bin/phpstan analyse",
+        "phpcs": "vendor/bin/php-cs-fixer fix --config=.php_cs.dist"
+    },
     "extra": {
         "branch-alias": {
             "dev-master": "3.1.x-dev"

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+    level: 7
+    paths:
+        - src
+        - tests

src/Spout/Autoloader/Psr4Autoloader.php

@@ -12,7 +12,7 @@ class Psr4Autoloader
      * An associative array where the key is a namespace prefix and the value
      * is an array of base directories for classes in that namespace.
      *
-     * @var array
+     * @var array<string, array>
      */
     protected $prefixes = [];
 

src/Spout/Common/Entity/Cell.php

@@ -77,7 +77,7 @@ public function __construct($value, Style $style = null)
     /**
      * @param mixed|null $value
      */
-    public function setValue($value)
+    public function setValue($value) : void
     {
         $this->value = $value;
         $this->type = $this->detectType($value);
@@ -102,7 +102,7 @@ public function getValueEvenIfError()
     /**
      * @param Style|null $style
      */
-    public function setStyle($style)
+    public function setStyle($style) : void
     {
         $this->style = $style ?: new Style();
     }
@@ -126,7 +126,7 @@ public function getType()
     /**
      * @param int $type
      */
-    public function setType($type)
+    public function setType($type) : void
     {
         $this->type = $type;
     }

src/Spout/Common/Entity/Row.php

@@ -95,7 +95,10 @@ public function getNumCells()
             return 0;
         }
 
-        return \max(\array_keys($this->cells)) + 1;
+        /** @var int $highest */
+        $highest = \max(\array_keys($this->cells));
+
+        return $highest + 1;
     }
 
     /**
@@ -118,7 +121,7 @@ public function setStyle($style)
     }
 
     /**
-     * @return array The row values, as array
+     * @return array<mixed> The row values, as array
      */
     public function toArray()
     {

src/Spout/Common/Entity/Style/Border.php

@@ -22,11 +22,11 @@ class Border
     const WIDTH_MEDIUM = 'medium';
     const WIDTH_THICK = 'thick';
 
-    /** @var array A list of BorderPart objects for this border. */
+    /** @var array<BorderPart> A list of BorderPart objects for this border. */
     private $parts = [];
 
     /**
-     * @param array $borderParts
+     * @param array<BorderPart> $borderParts
      */
     public function __construct(array $borderParts = [])
     {
@@ -52,7 +52,7 @@ public function hasPart($name)
     }
 
     /**
-     * @return array
+     * @return array<BorderPart>
      */
     public function getParts()
     {
@@ -61,7 +61,7 @@ public function getParts()
 
     /**
      * Set BorderParts
-     * @param array $parts
+     * @param array<BorderPart> $parts
      * @return void
      */
     public function setParts($parts)

src/Spout/Common/Entity/Style/BorderPart.php

@@ -32,7 +32,7 @@ class BorderPart
     protected $width;
 
     /**
-     * @var array Allowed style constants for parts.
+     * @var array<string> Allowed style constants for parts.
      */
     protected static $allowedStyles = [
         'none',
@@ -43,7 +43,7 @@ class BorderPart
     ];
 
     /**
-     * @var array Allowed names constants for border parts.
+     * @var array<string> Allowed names constants for border parts.
      */
     protected static $allowedNames = [
         'left',
@@ -53,7 +53,7 @@ class BorderPart
     ];
 
     /**
-     * @var array Allowed width constants for border parts.
+     * @var array<string> Allowed width constants for border parts.
      */
     protected static $allowedWidths = [
         'thin',
@@ -159,23 +159,23 @@ public function setWidth($width)
     }
 
     /**
-     * @return array
+     * @return array<string>
      */
     public static function getAllowedStyles()
     {
         return self::$allowedStyles;
     }
 
     /**
-     * @return array
+     * @return array<string>
      */
     public static function getAllowedNames()
     {
         return self::$allowedNames;
     }
 
     /**
-     * @return array
+     * @return array<string>
      */
     public static function getAllowedWidths()
     {

src/Spout/Common/Entity/Style/CellAlignment.php

@@ -13,6 +13,9 @@ abstract class CellAlignment
     const CENTER = 'center';
     const JUSTIFY = 'justify';
 
+    /**
+     * @var array<string, int>
+     */
     private static $VALID_ALIGNMENTS = [
         self::LEFT => 1,
         self::RIGHT => 1,

src/Spout/Common/Entity/Style/Style.php

@@ -66,7 +66,7 @@ class Style
     /** @var bool Whether the wrap text property was set */
     private $hasSetWrapText = false;
 
-    /** @var Border */
+    /** @var Border|null */
     private $border;
 
     /** @var bool Whether border properties should be applied */
@@ -110,7 +110,7 @@ public function setId($id)
     }
 
     /**
-     * @return Border
+     * @return Border|null
      */
     public function getBorder()
     {

src/Spout/Common/Helper/CellTypeHelper.php

@@ -9,7 +9,7 @@
 class CellTypeHelper
 {
     /**
-     * @param $value
+     * @param mixed $value
      * @return bool Whether the given value is considered "empty"
      */
     public static function isEmpty($value)
@@ -18,7 +18,7 @@ public static function isEmpty($value)
     }
 
     /**
-     * @param $value
+     * @param mixed $value
      * @return bool Whether the given value is a non empty string
      */
     public static function isNonEmptyString($value)
@@ -30,7 +30,7 @@ public static function isNonEmptyString($value)
      * Returns whether the given value is numeric.
      * A numeric value is from type "integer" or "double" ("float" is not returned by gettype).
      *
-     * @param $value
+     * @param mixed $value
      * @return bool Whether the given value is numeric
      */
     public static function isNumeric($value)
@@ -44,7 +44,7 @@ public static function isNumeric($value)
      * Returns whether the given value is boolean.
      * "true"/"false" and 0/1 are not booleans.
      *
-     * @param $value
+     * @param mixed $value
      * @return bool Whether the given value is boolean
      */
     public static function isBoolean($value)
@@ -55,7 +55,7 @@ public static function isBoolean($value)
     /**
      * Returns whether the given value is a DateTime or DateInterval object.
      *
-     * @param $value
+     * @param mixed $value
      * @return bool Whether the given value is a DateTime or DateInterval object
      */
     public static function isDateTimeOrDateInterval($value)

src/Spout/Common/Helper/EncodingHelper.php

@@ -27,7 +27,7 @@ class EncodingHelper
     /** @var \Box\Spout\Common\Helper\GlobalFunctionsHelper Helper to work with global functions */
     protected $globalFunctionsHelper;
 
-    /** @var array Map representing the encodings supporting BOMs (key) and their associated BOM (value) */
+    /** @var array<string, string> Map representing the encodings supporting BOMs (key) and their associated BOM (value) */
     protected $supportedEncodingsWithBom;
 
     /**
@@ -143,7 +143,7 @@ protected function attemptConversion($string, $sourceEncoding, $targetEncoding)
             throw new EncodingConversionException("The conversion from $sourceEncoding to $targetEncoding is not supported. Please install \"iconv\" or \"PHP Intl\".");
         }
 
-        if ($convertedString === false) {
+        if (!is_string($convertedString)) {
             throw new EncodingConversionException("The conversion from $sourceEncoding to $targetEncoding failed.");
         }
 

src/Spout/Common/Helper/Escaper/XLSX.php

@@ -22,6 +22,7 @@ class XLSX implements EscaperInterface
 
     /**
      * Initializes the control characters if not already done
+     * @return void
      */
     protected function initIfNeeded()
     {

src/Spout/Common/Helper/FileSystemHelper.php

@@ -19,7 +19,10 @@ class FileSystemHelper implements FileSystemHelperInterface
      */
     public function __construct(string $baseFolderPath)
     {
-        $this->baseFolderRealPath = \realpath($baseFolderPath);
+        /** @var string $realPath */
+        $realPath = \realpath($baseFolderPath);
+
+        $this->baseFolderRealPath = $realPath;
     }
 
     /**
@@ -127,6 +130,7 @@ protected function throwIfOperationNotInBaseFolder(string $operationFolderPath)
         if (!$this->baseFolderRealPath) {
             throw new IOException("The base folder path is invalid: {$this->baseFolderRealPath}");
         }
+        /** @var string $operationFolderRealPath */
         $isInBaseFolder = (\strpos($operationFolderRealPath, $this->baseFolderRealPath) === 0);
         if (!$isInBaseFolder) {
             throw new IOException("Cannot perform I/O operation outside of the base folder: {$this->baseFolderRealPath}");