Upgrade Psalm to 5.22.x

Signed-off-by: George Steel <[email protected]>
laminas · Mar 4, 2024 · b05f727 · b05f727
1 parent 1e5ec63
commit b05f727
Show file tree

Hide file tree

Showing 24 changed files with 751 additions and 735 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
diff --git a/src/Boolean.php b/src/Boolean.php
@@ -198,7 +198,7 @@ public function setTranslations($translations)
      */
     public function getTranslations()
     {
-        return $this->options['translations'];
+        return $this->options['translations'] ?? [];
     }
 
     /**

diff --git a/src/Compress/Bz2.php b/src/Compress/Bz2.php
@@ -29,6 +29,8 @@
  */
 class Bz2 extends AbstractCompressionAlgorithm
 {
+    private const DEFAULT_BLOCK_SIZE = 4;
+
     /**
      * Compression Options
      * array(
@@ -39,7 +41,7 @@ class Bz2 extends AbstractCompressionAlgorithm
      * @var Options
      */
     protected $options = [
-        'blocksize' => 4,
+        'blocksize' => self::DEFAULT_BLOCK_SIZE,
         'archive'   => null,
     ];
 
@@ -62,7 +64,7 @@ public function __construct($options = null)
      */
     public function getBlocksize()
     {
-        return $this->options['blocksize'];
+        return $this->options['blocksize'] ?? self::DEFAULT_BLOCK_SIZE;
     }
 
     /**
@@ -114,7 +116,7 @@ public function setArchive($archive)
     public function compress($content)
     {
         $archive = $this->getArchive();
-        if (! empty($archive)) {
+        if ($archive !== null) {
             $file = bzopen($archive, 'w');
             if (! $file) {
                 throw new Exception\RuntimeException("Error opening the archive '" . $archive . "'");

diff --git a/src/Compress/Gz.php b/src/Compress/Gz.php
@@ -169,7 +169,7 @@ public function compress($content)
             $compressed = gzcompress($content, $this->getLevel());
         }
 
-        if (! $compressed) {
+        if ($compressed === false) {
             throw new Exception\RuntimeException('Error during compression');
         }
 

diff --git a/src/Compress/Tar.php b/src/Compress/Tar.php
@@ -216,10 +216,10 @@ public function compress($content)
      */
     public function decompress($content)
     {
-        $archive = $this->getArchive();
+        $archive = (string) $this->getArchive();
         if (file_exists($content)) {
             $archive = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, realpath($content));
-        } elseif (empty($archive) || ! file_exists($archive)) {
+        } elseif ($archive === '' || ! file_exists($archive)) {
             throw new Exception\RuntimeException('Tar Archive not found');
         }
 

diff --git a/src/Compress/Zip.php b/src/Compress/Zip.php
@@ -212,15 +212,15 @@ public function decompress($content)
         $res = $zip->open($archive);
 
         $target = $this->getTarget();
-        if (! empty($target) && ! is_dir($target)) {
+        if (is_string($target) && ! is_dir($target)) {
             $target = dirname($target);
         }
 
-        if (! empty($target)) {
+        if (is_string($target)) {
             $target = rtrim($target, '/\\') . DIRECTORY_SEPARATOR;
         }
 
-        if (empty($target) || ! is_dir($target)) {
+        if (! is_string($target) || ! is_dir($target)) {
             throw new Exception\RuntimeException('No target for ZIP decompression set');
         }
 

diff --git a/src/DataUnitFormatter.php b/src/DataUnitFormatter.php
@@ -32,6 +32,7 @@ final class DataUnitFormatter extends AbstractFilter
     public const BASE_BINARY  = 1024;
     public const BASE_DECIMAL = 1000;
 
+    private const DEFAULT_PRECISION = 2;
     /**
      * A list of all possible filter modes:
      *
@@ -64,7 +65,7 @@ final class DataUnitFormatter extends AbstractFilter
     protected $options = [
         'mode'      => self::MODE_DECIMAL,
         'unit'      => '',
-        'precision' => 2,
+        'precision' => self::DEFAULT_PRECISION,
         'prefixes'  => [],
     ];
 
@@ -106,7 +107,7 @@ protected function setMode($mode)
      */
     protected function getMode()
     {
-        return $this->options['mode'];
+        return $this->options['mode'] ?? self::MODE_DECIMAL;
     }
 
     /**
@@ -146,7 +147,7 @@ protected function setUnit($unit)
      */
     protected function getUnit()
     {
-        return $this->options['unit'];
+        return $this->options['unit'] ?? '';
     }
 
     /**
@@ -166,7 +167,7 @@ protected function setPrecision($precision)
      */
     protected function getPrecision()
     {
-        return $this->options['precision'];
+        return $this->options['precision'] ?? self::DEFAULT_PRECISION;
     }
 
     /**
@@ -186,8 +187,8 @@ protected function setPrefixes(array $prefixes)
      */
     protected function getPrefixes()
     {
-        $prefixes = $this->options['prefixes'];
-        if ($prefixes) {
+        $prefixes = $this->options['prefixes'] ?? null;
+        if ($prefixes !== null && $prefixes !== []) {
             return $prefixes;
         }
 

diff --git a/src/DateTimeFormatter.php b/src/DateTimeFormatter.php
@@ -35,7 +35,7 @@ class DateTimeFormatter extends AbstractFilter
      */
     public function __construct($options = null)
     {
-        if ($options) {
+        if ($options !== null) {
             $this->setOptions($options);
         }
     }

diff --git a/src/File/Decrypt.php b/src/File/Decrypt.php
@@ -92,14 +92,14 @@ public function filter($value)
         }
 
         $content = file_get_contents($value);
-        if (! $content) {
+        if ($content === false) {
             throw new Exception\RuntimeException("Problem while reading file '$value'");
         }
 
         $decrypted = parent::filter($content);
         $result    = file_put_contents($this->filename, $decrypted);
 
-        if (! $result) {
+        if ($result === false) {
             throw new Exception\RuntimeException("Problem while writing file '{$this->filename}'");
         }
 

diff --git a/src/File/Encrypt.php b/src/File/Encrypt.php
@@ -92,14 +92,14 @@ public function filter($value)
         }
 
         $content = file_get_contents($value);
-        if (! $content) {
+        if ($content === false) {
             throw new Exception\RuntimeException("Problem while reading file '$value'");
         }
 
         $encrypted = parent::filter($content);
         $result    = file_put_contents($this->filename, $encrypted);
 
-        if (! $result) {
+        if ($result === false) {
             throw new Exception\RuntimeException("Problem while writing file '{$this->filename}'");
         }
 

diff --git a/src/File/LowerCase.php b/src/File/LowerCase.php
@@ -58,14 +58,14 @@ public function filter($value)
         }
 
         $content = file_get_contents($value);
-        if (! $content) {
+        if ($content === false) {
             throw new Exception\RuntimeException("Problem while reading file '$value'");
         }
 
         $content = parent::filter($content);
         $result  = file_put_contents($value, $content);
 
-        if (! $result) {
+        if ($result === false) {
             throw new Exception\RuntimeException("Problem while writing file '$value'");
         }
 

diff --git a/src/File/Rename.php b/src/File/Rename.php
@@ -13,6 +13,7 @@
 use function count;
 use function file_exists;
 use function is_array;
+use function is_bool;
 use function is_dir;
 use function is_scalar;
 use function is_string;
@@ -232,7 +233,7 @@ public function filter($value)
      * Supports single and nested arrays
      *
      * @param  array $options
-     * @return array
+     * @return $this
      */
     // @codingStandardsIgnoreStart
     protected function _convertOptions($options)
@@ -267,23 +268,23 @@ protected function _convertOptions($options)
             }
         }
 
-        if (empty($files)) {
+        if ($files === []) {
             return $this;
         }
 
-        if (empty($files['source'])) {
+        if (! is_string($files['source'] ?? null)) {
             $files['source'] = '*';
         }
 
-        if (empty($files['target'])) {
+        if (! is_string($files['target'] ?? null)) {
             $files['target'] = '*';
         }
 
-        if (empty($files['overwrite'])) {
+        if (! is_bool($files['overwrite'] ?? null)) {
             $files['overwrite'] = false;
         }
 
-        if (empty($files['randomize'])) {
+        if (! is_bool($files['randomize'] ?? null)) {
             $files['randomize'] = false;
         }
 

diff --git a/src/File/RenameUpload.php b/src/File/RenameUpload.php
@@ -31,13 +31,13 @@
 
 /**
  * @psalm-type Options = array{
- *     target?: string|null,
- *     use_upload_name?: bool,
- *     use_upload_extension?: bool,
- *     overwrite?: bool,
- *     randomize?: bool,
- *     stream_factory?: StreamFactoryInterface|null,
- *     upload_file_factory?: UploadedFileFactoryInterface|null,
+ *     target: string|null,
+ *     use_upload_name: bool,
+ *     use_upload_extension: bool,
+ *     overwrite: bool,
+ *     randomize: bool,
+ *     stream_factory: StreamFactoryInterface|null,
+ *     upload_file_factory: UploadedFileFactoryInterface|null,
  *     ...
  * }
  * @template TOptions of Options

diff --git a/src/File/UpperCase.php b/src/File/UpperCase.php
@@ -55,14 +55,14 @@ public function filter($value)
         }
 
         $content = file_get_contents($value);
-        if (! $content) {
+        if ($content === false) {
             throw new Exception\RuntimeException("Problem while reading file '$value'");
         }
 
         $content = parent::filter($content);
         $result  = file_put_contents($value, $content);
 
-        if (! $result) {
+        if ($result === false) {
             throw new Exception\RuntimeException("Problem while writing file '$value'");
         }
 

diff --git a/src/FilterChain.php b/src/FilterChain.php
@@ -16,6 +16,7 @@
 use function get_debug_type;
 use function is_array;
 use function is_callable;
+use function is_string;
 use function sprintf;
 use function strtolower;
 
@@ -86,7 +87,7 @@ public function setOptions($options)
                     foreach ($value as $spec) {
                         $callback = $spec['callback'] ?? false;
                         $priority = $spec['priority'] ?? static::DEFAULT_PRIORITY;
-                        if ($callback) {
+                        if (is_callable($callback)) {
                             $this->attach($callback, $priority);
                         }
                     }
@@ -96,7 +97,7 @@ public function setOptions($options)
                         $name     = $spec['name'] ?? false;
                         $options  = $spec['options'] ?? [];
                         $priority = $spec['priority'] ?? static::DEFAULT_PRIORITY;
-                        if ($name) {
+                        if (is_string($name) && $name !== '') {
                             $this->attachByName($name, $options, $priority);
                         }
                     }

diff --git a/src/FilterPluginManagerFactory.php b/src/FilterPluginManagerFactory.php
@@ -7,10 +7,14 @@
 use Laminas\ServiceManager\Config;
 use Laminas\ServiceManager\FactoryInterface;
 use Laminas\ServiceManager\ServiceLocatorInterface;
+use Laminas\ServiceManager\ServiceManager;
 use Psr\Container\ContainerInterface;
 
 use function is_array;
 
+/**
+ * @psalm-import-type ServiceManagerConfiguration from ServiceManager
+ */
 class FilterPluginManagerFactory implements FactoryInterface
 {
     /**
@@ -23,11 +27,12 @@ class FilterPluginManagerFactory implements FactoryInterface
     /**
      * {@inheritDoc}
      *
+     * @param ServiceManagerConfiguration|null $options
      * @return FilterPluginManager
      */
     public function __invoke(ContainerInterface $container, $name, ?array $options = null)
     {
-        $pluginManager = new FilterPluginManager($container, $options ?: []);
+        $pluginManager = new FilterPluginManager($container, $options ?? []);
 
         // If this is in a laminas-mvc application, the ServiceListener will inject
         // merged configuration during bootstrap.

diff --git a/src/PregReplace.php b/src/PregReplace.php
@@ -19,8 +19,8 @@
 
 /**
  * @psalm-type Options = array{
- *     pattern?: string|list<string>|null,
- *     replacement?: string|list<string>,
+ *     pattern: string|list<string>|null,
+ *     replacement: string|list<string>,
  * }
  * @extends AbstractFilter<Options>
  * @final

diff --git a/src/RealPath.php b/src/RealPath.php
@@ -24,7 +24,7 @@
 
 /**
  * @psalm-type Options = array{
- *     exists?: bool,
+ *     exists: bool,
  *     ...
  * }
  * @template TOptions of Options
@@ -101,7 +101,7 @@ public function filter($value)
         ErrorHandler::start();
         $realpath = realpath($path);
         ErrorHandler::stop();
-        if ($realpath) {
+        if ($realpath !== false) {
             return $realpath;
         }
 

diff --git a/src/StringTrim.php b/src/StringTrim.php
@@ -84,11 +84,13 @@ public function filter($value)
         }
         $value = (string) $value;
 
-        if (null === $this->options['charlist']) {
+        $charlist = $this->options['charlist'];
+
+        if ($charlist === null) {
             return $this->unicodeTrim($value);
         }
 
-        return $this->unicodeTrim($value, $this->options['charlist']);
+        return $this->unicodeTrim($value, $charlist);
     }
 
     /**

diff --git a/src/ToNull.php b/src/ToNull.php
@@ -18,7 +18,7 @@
 
 /**
  * @psalm-type Options = array{
- *     type?: int-mask-of<self::TYPE_*>,
+ *     type: int-mask-of<self::TYPE_*>,
  * }
  * @extends AbstractFilter<Options>
  * @final
-Original file line number
+Diff line change
@@ Expand Up / @@ -198,7 +198,7 @@ public function setTranslations($translations) @@
          */
         public function getTranslations()
         {
-            return $this->options['translations'];
+            return $this->options['translations'] ?? [];
         }
         /**
@@ Expand Down @@