Use psalm to check and add more return types

Author: GenieTim

composer.json

@@ -26,7 +26,8 @@
   "require-dev": {
     "phpunit/phpunit": "^5.7 | ^7.5 | ^8.0 | ^9.0",
     "rector/rector": "^0.13.6",
-    "symplify/easy-coding-standard": "^11.0"
+    "symplify/easy-coding-standard": "^11.0",
+    "vimeo/psalm": "^4.24"
   },
   "autoload": {
     "psr-4": {
@@ -39,7 +40,8 @@
   "scripts": {
     "check-cs": "./vendor/bin/ecs check",
     "fix-cs": "./vendor/bin/ecs check --fix",
-    "tests": "./vendor/bin/phpunit"
+    "tests": "./vendor/bin/phpunit",
+    "static-tests": "./vendor/bin/psalm --php-version=8.1"
   },
   "autoload-dev": {
     "psr-4": {

lib/Binarizer.php

@@ -50,14 +50,14 @@ final public function getLuminanceSource()
 	 * and passed in with each call for performance. However it is legal to keep more than one row
 	 * at a time if needed.
 	 *
-	 * @param $y   The row to fetch, which must be in [0, bitmap height)
-	 * @param An $row optional preallocated array. If null or too small, it will be ignored.
+	 * @param int $y   The row to fetch, which must be in [0, bitmap height)
+	 * @param BitArray|null $row An optional preallocated array. If null or too small, it will be ignored.
 	 *            If used, the Binarizer will call BitArray.clear(). Always use the returned object.
 	 *
-	 * @return array The array of bits for this row (true means black).
+	 * @return BitArray The array of bits for this row (true means black).
 	 * @throws NotFoundException if row can't be binarized
 	 */
-	abstract public function getBlackRow($y, $row);
+	abstract public function getBlackRow(int $y, ?BitArray $row = null): BitArray;
 
 	/**
 	 * Converts a 2D array of luminance data to 1 bit data. As above, assume this method is expensive

lib/BinaryBitmap.php

@@ -60,13 +60,14 @@ public function getHeight()
 	 * This method is intended for decoding 1D barcodes and may choose to apply sharpening.
 	 *
 	 * @param $y   The row to fetch, which must be in [0, bitmap height)
-	 * @param An $row optional preallocated array. If null or too small, it will be ignored.
+	 * @param array|null $row An optional preallocated array. If null or too small, it will be ignored.
 	 *            If used, the Binarizer will call BitArray.clear(). Always use the returned object.
 	 *
-	 * @return array The array of bits for this row (true means black).
+	 * @return Common\BitArray The array of bits for this row (true means black).
+	 *
 	 * @throws NotFoundException if row can't be binarized
 	 */
-	public function getBlackRow($y, $row)
+	public function getBlackRow($y, $row): Common\BitArray
 	{
 		return $this->binarizer->getBlackRow($y, $row);
 	}
@@ -98,7 +99,7 @@ public function crop($left, $top, $width, $height): \Zxing\BinaryBitmap
 	}
 
 	/**
-	 * @return Whether this bitmap supports counter-clockwise rotation.
+	 * @return bool this Whether bitmap supports counter-clockwise rotation.
 	 */
 	public function isRotateSupported()
 	{
@@ -131,7 +132,7 @@ public function rotateCounterClockwise45(): \Zxing\BinaryBitmap
 		return new BinaryBitmap($this->binarizer->createBinarizer($newSource));
 	}
 
-	public function toString()
+	public function toString(): string
 	{
 		try {
 			return $this->getBlackMatrix()->toString();

lib/ChecksumException.php

@@ -27,7 +27,7 @@ final class ChecksumException extends ReaderException
 {
 	private static ?\Zxing\ChecksumException $instance = null;
 
-	public static function getChecksumInstance($cause = null)
+	public static function getChecksumInstance($cause = null): self
 	{
 		if (self::$isStackTrace) {
 			return new ChecksumException($cause);

lib/Common/BitArray.php

@@ -33,7 +33,7 @@
 final class BitArray
 {
 	/**
-  * @var mixed[]|mixed|int[]|null
+  * @var mixed[]|int[]|null
   */
 	private $bits;
 	/**
@@ -56,7 +56,10 @@ public function __construct($bits = [], $size = 0)
 		}
 	}
 
-	private static function makeArray($size)
+	/**
+	 * @psalm-return array<empty, empty>
+	 */
+	private static function makeArray($size): array
 	{
 		return [];
 	}
@@ -74,7 +77,7 @@ public function getSizeInBytes()
 	/**
 	 * Sets bit i.
 	 *
-	 * @param bit $i to set
+	 * @param int $i bit to set
 	 */
 	public function set($i): void
 	{
@@ -85,7 +88,7 @@ public function set($i): void
 	/**
 	 * Flips bit i.
 	 *
-	 * @param bit $i to set
+	 * @param int $i bit to set
 	 */
 	public function flip($i): void
 	{
@@ -94,9 +97,9 @@ public function flip($i): void
 	}
 
 	/**
-	 * @param first $from bit to check
+	 * @param int $from first bit to check
 	 *
-	 * @return index of first bit that is set, starting from the given index, or size if none are set
+	 * @return int index of first bit that is set, starting from the given index, or size if none are set
 	 *  at or beyond this given index
 	 * @see #getNextUnset(int)
 	 */
@@ -121,9 +124,9 @@ public function getNextSet($from)
 	}
 
 	/**
-	 * @param index $from to start looking for unset bit
+	 * @param int $from index to start looking for unset bit
 	 *
-	 * @return index of next unset bit, or {@code size} if none are unset until the end
+	 * @return int index of next unset bit, or {@code size} if none are unset until the end
 	 * @see #getNextSet(int)
 	 */
 	public function getNextUnset($from)
@@ -149,8 +152,8 @@ public function getNextUnset($from)
 	/**
 	 * Sets a block of 32 bits, starting at bit i.
 	 *
-	 * @param first       $i bit to set
-	 * @param the $newBits new value of the next 32 bits. Note again that the least-significant bit
+	 * @param int $i first  bit to set
+	 * @param int $newBits the new value of the next 32 bits. Note again that the least-significant bit
 	 *                corresponds to bit i, the next-least-significant to i+1, and so on.
 	 */
 	public function setBulk($i, $newBits): void
@@ -161,8 +164,10 @@ public function setBulk($i, $newBits): void
 	/**
 	 * Sets a range of bits.
 	 *
-	 * @param start $start of range, inclusive.
-	 * @param end   $end of range, exclusive
+	 * @param int $start start of range, inclusive.
+	 * @param int $end end   of range, exclusive
+	 *
+	 * @return void
 	 */
 	public function setRange($start, $end)
 	{
@@ -205,12 +210,13 @@ public function clear(): void
 	/**
 	 * Efficient method to check if a range of bits is set, or not set.
 	 *
-	 * @param start $start of range, inclusive.
-	 * @param end   $end of range, exclusive
-	 * @param if $value true, checks that bits in range are set, otherwise checks that they are not set
+	 * @param int $start start of range, inclusive.
+	 * @param int $end end   of range, exclusive
+	 * @param bool $value if true, checks that bits in range are set, otherwise checks that they are not set
 	 *
-	 * @return true iff all bits are set or not set in range, according to value argument
-	 * @throws InvalidArgumentException if end is less than or equal to start
+	 * @return bool iff all bits are set or not set in range, according to value argument
+	 *
+	 * @throws \InvalidArgumentException if end is less than or equal to start
 	 */
 	public function isRange($start, $end, $value): bool
 	{
@@ -251,10 +257,10 @@ public function isRange($start, $end, $value): bool
 	 * least-significant. For example, appending 6 bits from 0x000001E will append the bits
 	 * 0, 1, 1, 1, 1, 0 in that order.
 	 *
-	 * @param $value   {@code int} containing bits to append
-	 * @param bits $numBits from value to append
+	 * @param int $value   {@code int} containing bits to append
+	 * @param int $numBits bits from value to append
 	 */
-	public function appendBits($value, $numBits)
+	public function appendBits($value, $numBits): void
 	{
 		if ($numBits < 0 || $numBits > 32) {
 			throw new \InvalidArgumentException("Num bits must be between 0 and 32");
@@ -274,7 +280,7 @@ private function ensureCapacity($size): void
 		}
 	}
 
-	public function appendBit($bit): void
+	public function appendBit(bool $bit): void
 	{
 		$this->ensureCapacity($this->size + 1);
 		if ($bit) {
@@ -292,7 +298,7 @@ public function appendBitArray($other): void
 		}
 	}
 
-	public function _xor($other)
+	public function _xor($other): void
 	{
 		if ((is_countable($this->bits) ? count($this->bits) : 0) !== (is_countable($other->bits) ? count($other->bits) : 0)) {
 			throw new \InvalidArgumentException("Sizes don't match");
@@ -307,11 +313,11 @@ public function _xor($other)
 
 	/**
 	 *
-	 * @param first $bitOffset bit to start writing
+	 * @param int $bitOffset first bit to start writing
 	 * @param array     $array to write into. Bytes are written most-significant byte first. This is the opposite
 	 *                  of the internal representation, which is exposed by {@link #getBitArray()}
-	 * @param position    $offset in array to start writing
-	 * @param how  $numBytes many bytes to write
+	 * @param int $offset position    in array to start writing
+	 * @param int $numBytes how  many bytes to write
 	 */
 	public function toBytes($bitOffset, array &$array, $offset, $numBytes): void
 	{
@@ -329,21 +335,23 @@ public function toBytes($bitOffset, array &$array, $offset, $numBytes): void
 
 	/**
 	 * @param $i ; bit to get
+	 * @param float|int first $i
 	 *
-	 * @return true iff bit i is set
+	 * @return bool iff bit i is set
 	 */
-	public function get($i): bool
+	public function get(int|float $i): bool
 	{
 		$key = (int)($i / 32);
 
 		return ($this->bits[$key] & (1 << ($i & 0x1F))) != 0;
 	}
 
 	/**
-	 * @return array underlying array of ints. The first element holds the first 32 bits, and the least
-	 *         significant bit is bit 0.
+	 * @return (int|mixed)[]|null underlying array of ints. The first element holds the first 32 bits, and the least significant bit is bit 0.
+	 *
+	 * @psalm-return array<int|mixed>|null
 	 */
-	public function getBitArray()
+	public function getBitArray(): array|null
 	{
 		return $this->bits;
 	}
@@ -405,7 +413,7 @@ public function hashCode()
 		return 31 * $this->size + hashCode($this->bits);
 	}
 
-	public function toString()
+	public function toString(): string
 	{
 		$result = '';
 		for ($i = 0; $i < $this->size; $i++) {