mark nullable types explicitly (#276)

codemasher · codemasher · commit 1a8e1ffd2bd6 · 2024-07-17T10:19:31.000+02:00
diff --git a/composer.json b/composer.json
@@ -49,17 +49,17 @@
 	"require": {
 		"php": "^8.2",
 		"ext-mbstring": "*",
-		"chillerlan/php-settings-container": "^3.2"
+		"chillerlan/php-settings-container": "^3.2.1"
 	},
 	"require-dev": {
-		"chillerlan/php-authenticator": "^5.1",
+		"chillerlan/php-authenticator": "^5.2.1",
 		"intervention/image": "^3.7",
 		"phpbench/phpbench": "^1.2.15",
 		"phan/phan": "^5.4",
 		"phpunit/phpunit": "^11.2",
 		"phpmd/phpmd": "^2.15",
 		"setasign/fpdf": "^1.8.2",
-		"squizlabs/php_codesniffer": "^3.9"
+		"squizlabs/php_codesniffer": "^3.10"
 	},
 	"suggest": {
 		"chillerlan/php-authenticator": "Yet another Google authenticator! Also creates URIs for mobile apps.",
diff --git a/examples/custom_output.php b/examples/custom_output.php
@@ -48,7 +48,7 @@ protected function getDefaultModuleValue(bool $isDark):mixed{
 	/**
 	 * @inheritDoc
 	 */
-	public function dump(string $file = null):string{
+	public function dump(string|null $file = null):string{
 		$output = '';
 
 		for($y = 0; $y < $this->moduleCount; $y++){
diff --git a/examples/imageWithLogo.php b/examples/imageWithLogo.php
@@ -30,7 +30,7 @@ class QRImageWithLogo extends QRGdImagePNG{
 	 * @return string
 	 * @throws \chillerlan\QRCode\Output\QRCodeOutputException
 	 */
-	public function dump(string $file = null, string $logo = null):string{
+	public function dump(string|null $file = null, string|null $logo = null):string{
 		// set returnResource to true to skip further processing for now
 		$this->options->returnResource = true;
 
diff --git a/examples/imageWithText.php b/examples/imageWithText.php
@@ -26,7 +26,7 @@ class QRImageWithText extends QRGdImagePNG{
 	/**
 	 * @inheritDoc
 	 */
-	public function dump(string $file = null, string $text = null):string{
+	public function dump(string|null $file = null, string|null $text = null):string{
 		// set returnResource to true to skip further processing for now
 		$this->options->returnResource = true;
 
diff --git a/examples/imagickConvertSVGtoPNG.php b/examples/imagickConvertSVGtoPNG.php
@@ -47,7 +47,7 @@ protected function header():string{
 	}
 
 	/** @inheritDoc */
-	public function dump(string $file = null):string{
+	public function dump(string|null $file = null):string{
 		$base64 = $this->options->outputBase64;
 		// we don't want the SVG in base64
 		$this->options->outputBase64 = false;
diff --git a/examples/imagickWithLogo.php b/examples/imagickWithLogo.php
@@ -28,7 +28,7 @@ class QRImagickWithLogo extends QRImagick{
 	 * @inheritDoc
 	 * @throws \chillerlan\QRCode\Output\QRCodeOutputException
 	 */
-	public function dump(string $file = null):string{
+	public function dump(string|null $file = null):string{
 		// set returnResource to true to skip further processing for now
 		$this->options->returnResource = true;
 
diff --git a/src/Common/ECICharset.php b/src/Common/ECICharset.php
@@ -118,7 +118,7 @@ public function getID():int{
 	 * @see \mb_convert_encoding()
 	 * @see \iconv()
 	 */
-	public function getName():?string{
+	public function getName():string|null{
 		return (self::MB_ENCODINGS[$this->charsetID] ?? null);
 	}
 
diff --git a/src/Common/GenericGFPoly.php b/src/Common/GenericGFPoly.php
@@ -35,7 +35,7 @@ final class GenericGFPoly{
 	 * @throws \chillerlan\QRCode\QRCodeException if argument is null or empty, or if leading coefficient is 0 and this
 	 *                                            is not a constant polynomial (that is, it is not the monomial "0")
 	 */
-	public function __construct(array $coefficients, int $degree = null){
+	public function __construct(array $coefficients, int|null $degree = null){
 		$degree ??= 0;
 
 		if(empty($coefficients)){
diff --git a/src/Common/Version.php b/src/Common/Version.php
@@ -257,7 +257,7 @@ public function getDimension():int{
 	/**
 	 * the version pattern for the given version
 	 */
-	public function getVersionPattern():?int{
+	public function getVersionPattern():int|null{
 		return (self::VERSION_PATTERN[$this->version] ?? null);
 	}
 
diff --git a/src/Data/QRMatrix.php b/src/Data/QRMatrix.php
@@ -110,12 +110,12 @@ class QRMatrix{
 	/**
 	 * the matrix version - always set in QRMatrix, may be null in BitMatrix
 	 */
-	protected ?Version $version = null;
+	protected Version|null $version = null;
 
 	/**
 	 * the current ECC level - always set in QRMatrix, may be null in BitMatrix
 	 */
-	protected ?EccLevel $eccLevel = null;
+	protected EccLevel|null $eccLevel = null;
 
 	/**
 	 * the mask pattern that was used in the most recent operation, set via:
@@ -124,7 +124,7 @@ class QRMatrix{
 	 * - QRMatrix::mask()
 	 * - BitMatrix::readFormatInformation()
 	 */
-	protected ?MaskPattern $maskPattern = null;
+	protected MaskPattern|null $maskPattern = null;
 
 	/**
 	 * the size (side length) of the matrix, including quiet zone (if created)
@@ -175,7 +175,7 @@ public function initFunctionalPatterns():static{
 	 *
 	 * @return int[][]|bool[][]
 	 */
-	public function getMatrix(bool $boolean = null):array{
+	public function getMatrix(bool|null $boolean = null):array{
 
 		if($boolean !== true){
 			return $this->matrix;
@@ -193,21 +193,21 @@ public function getMatrix(bool $boolean = null):array{
 	/**
 	 * Returns the current version number
 	 */
-	public function getVersion():?Version{
+	public function getVersion():Version|null{
 		return $this->version;
 	}
 
 	/**
 	 * Returns the current ECC level
 	 */
-	public function getEccLevel():?EccLevel{
+	public function getEccLevel():EccLevel|null{
 		return $this->eccLevel;
 	}
 
 	/**
 	 * Returns the current mask pattern
 	 */
-	public function getMaskPattern():?MaskPattern{
+	public function getMaskPattern():MaskPattern|null{
 		return $this->maskPattern;
 	}
 
@@ -342,7 +342,7 @@ public function isDark(int $M_TYPE):bool{
 	 *   7 # 3
 	 *   6 5 4
 	 */
-	public function checkNeighbours(int $x, int $y, int $M_TYPE = null):int{
+	public function checkNeighbours(int $x, int $y, int|null $M_TYPE = null):int{
 		$bits = 0;
 
 		foreach($this::neighbours as $bit => [$ix, $iy]){
@@ -507,7 +507,7 @@ public function setVersionNumber():static{
 	 *
 	 * ISO/IEC 18004:2000 Section 8.9
 	 */
-	public function setFormatInfo(MaskPattern $maskPattern = null):static{
+	public function setFormatInfo(MaskPattern|null $maskPattern = null):static{
 		$this->maskPattern = $maskPattern;
 		$bits              = 0; // sets all format fields to false (test mode)
 
@@ -633,7 +633,7 @@ public function invert():static{
 	 *
 	 * @throws \chillerlan\QRCode\Data\QRCodeDataException
 	 */
-	public function setLogoSpace(int $width, int $height = null, int $startX = null, int $startY = null):static{
+	public function setLogoSpace(int $width, int|null $height = null, int|null $startX = null, int|null $startY = null):static{
 		$height ??= $width;
 
 		// if width and height happen to be negative or 0 (default value), just return - nothing to do
diff --git a/src/Decoder/BitMatrix.php b/src/Decoder/BitMatrix.php
@@ -251,7 +251,7 @@ private function copyVersionBit(int $i, int $j, int $versionBits):int{
 	/**
 	 * Returns information about the format it specifies, or null if it doesn't seem to match any known pattern
 	 */
-	private function doDecodeFormatInformation(int $maskedFormatInfo1, int $maskedFormatInfo2):?int{
+	private function doDecodeFormatInformation(int $maskedFormatInfo1, int $maskedFormatInfo2):int|null{
 		$bestDifference = PHP_INT_MAX;
 		$bestFormatInfo = 0;
 
@@ -347,7 +347,7 @@ private function readVersion():static{
 	/**
 	 * Decodes the version information from the given bit sequence, returns null if no valid match is found.
 	 */
-	private function decodeVersionInformation(int $versionBits):?Version{
+	private function decodeVersionInformation(int $versionBits):Version|null{
 		$bestDifference = PHP_INT_MAX;
 		$bestVersion    = 0;
 
@@ -414,15 +414,15 @@ private function numBitsDiffering(int $a, int $b):int{
 	 * @codeCoverageIgnore
 	 * @throws \chillerlan\QRCode\Data\QRCodeDataException
 	 */
-	public function setQuietZone(int $quietZoneSize = null):static{
+	public function setQuietZone(int|null $quietZoneSize = null):static{
 		throw new QRCodeDataException('not supported');
 	}
 
 	/**
 	 * @codeCoverageIgnore
 	 * @throws \chillerlan\QRCode\Data\QRCodeDataException
 	 */
-	public function setLogoSpace(int $width, int $height = null, int $startX = null, int $startY = null):static{
+	public function setLogoSpace(int $width, int|null $height = null, int|null $startX = null, int|null $startY = null):static{
 		throw new QRCodeDataException('not supported');
 	}
 
diff --git a/src/Decoder/Decoder.php b/src/Decoder/Decoder.php
@@ -31,9 +31,9 @@ final class Decoder{
 	 * @var \chillerlan\QRCode\QROptions|\chillerlan\Settings\SettingsContainerInterface
 	 */
 	private SettingsContainerInterface|QROptions   $options;
-	private ?Version                               $version     = null;
-	private ?EccLevel                              $eccLevel    = null;
-	private ?MaskPattern                           $maskPattern = null;
+	private Version|null                           $version     = null;
+	private EccLevel|null                          $eccLevel    = null;
+	private MaskPattern|null                       $maskPattern = null;
 	private BitBuffer                              $bitBuffer;
 
 	public function __construct(SettingsContainerInterface|QROptions $options = new QROptions){
diff --git a/src/Decoder/DecoderResult.php b/src/Decoder/DecoderResult.php
@@ -41,7 +41,7 @@ final class DecoderResult{
 	/**
 	 * DecoderResult constructor.
 	 */
-	public function __construct(iterable $properties = null){
+	public function __construct(iterable|null $properties = null){
 
 		if(!empty($properties)){
 
diff --git a/src/Detector/AlignmentPatternFinder.php b/src/Detector/AlignmentPatternFinder.php
@@ -58,7 +58,7 @@ public function __construct(BitMatrix $matrix, float $moduleSize){
 	 *
 	 * @return \chillerlan\QRCode\Detector\AlignmentPattern|null
 	 */
-	public function find(int $startX, int $startY, int $width, int $height):?AlignmentPattern{
+	public function find(int $startX, int $startY, int $width, int $height):AlignmentPattern|null{
 		$maxJ       = ($startX + $width);
 		$middleI    = ($startY + ($height / 2));
 		$stateCount = [];
@@ -173,7 +173,7 @@ private function foundPatternCross(array $stateCount):bool{
 	 *
 	 * @return \chillerlan\QRCode\Detector\AlignmentPattern|null if we have found the same pattern twice, or null if not
 	 */
-	private function handlePossibleCenter(array $stateCount, int $i, int $j):?AlignmentPattern{
+	private function handlePossibleCenter(array $stateCount, int $i, int $j):AlignmentPattern|null{
 		$stateCountTotal = ($stateCount[0] + $stateCount[1] + $stateCount[2]);
 		$centerJ         = $this->centerFromEnd($stateCount, $j);
 		$centerI         = $this->crossCheckVertical($i, (int)$centerJ, (2 * $stateCount[1]), $stateCountTotal);
@@ -222,7 +222,7 @@ private function centerFromEnd(array $stateCount, int $end):float{
 	 *
 	 * @return float|null vertical center of alignment pattern, or null if not found
 	 */
-	private function crossCheckVertical(int $startI, int $centerJ, int $maxCount, int $originalStateCountTotal):?float{
+	private function crossCheckVertical(int $startI, int $centerJ, int $maxCount, int $originalStateCountTotal):float|null{
 		$maxI          = $this->matrix->getSize();
 		$stateCount    = [];
 		$stateCount[0] = 0;
diff --git a/src/Detector/Detector.php b/src/Detector/Detector.php
@@ -275,7 +275,7 @@ private function findAlignmentInRegion(
 		int $estAlignmentX,
 		int $estAlignmentY,
 		float $allowanceFactor
-	):?AlignmentPattern{
+	):AlignmentPattern|null{
 		// Look for an alignment pattern (3 modules in size) around where it should be
 		$dimension           = $this->matrix->getSize();
 		$allowance           = (int)($allowanceFactor * $overallEstModuleSize);
@@ -305,11 +305,11 @@ private function findAlignmentInRegion(
 	 *
 	 */
 	private function createTransform(
-		FinderPattern    $nw,
-		FinderPattern    $ne,
-		FinderPattern    $sw,
-		int              $size,
-		AlignmentPattern $ap = null
+		FinderPattern         $nw,
+		FinderPattern         $ne,
+		FinderPattern         $sw,
+		int                   $size,
+		AlignmentPattern|null $ap = null
 	):PerspectiveTransform{
 		$dimMinusThree = ($size - 3.5);
 
diff --git a/src/Detector/FinderPattern.php b/src/Detector/FinderPattern.php
@@ -27,7 +27,7 @@ final class FinderPattern extends ResultPoint{
 	/**
 	 *
 	 */
-	public function __construct(float $posX, float $posY, float $estimatedModuleSize, int $count = null){
+	public function __construct(float $posX, float $posY, float $estimatedModuleSize, int|null $count = null){
 		parent::__construct($posX, $posY, $estimatedModuleSize);
 
 		$this->count = ($count ?? 1);
diff --git a/src/Detector/FinderPatternFinder.php b/src/Detector/FinderPatternFinder.php
@@ -330,7 +330,7 @@ private function crossCheckDiagonal(int $centerI, int $centerJ):bool{
 	 * @return float|null vertical center of finder pattern, or null if not found
 	 * @noinspection DuplicatedCode
 	 */
-	private function crossCheckVertical(int $startI, int $centerJ, int $maxCount, int $originalStateCountTotal):?float{
+	private function crossCheckVertical(int $startI, int $centerJ, int $maxCount, int $originalStateCountTotal):float|null{
 		$maxI       = $this->matrix->getSize();
 		$stateCount = $this->getCrossCheckStateCount();
 
@@ -414,7 +414,7 @@ private function crossCheckVertical(int $startI, int $centerJ, int $maxCount, in
 	 * check a vertical cross-check and locate the real center of the alignment pattern.
 	 * @noinspection DuplicatedCode
 	 */
-	private function crossCheckHorizontal(int $startJ, int $centerI, int $maxCount, int $originalStateCountTotal):?float{
+	private function crossCheckHorizontal(int $startJ, int $centerI, int $maxCount, int $originalStateCountTotal):float|null{
 		$maxJ       = $this->matrix->getSize();
 		$stateCount = $this->getCrossCheckStateCount();
 
diff --git a/src/Detector/PerspectiveTransform.php b/src/Detector/PerspectiveTransform.php
@@ -152,7 +152,7 @@ private function times(PerspectiveTransform $other):self{
 	/**
 	 * @return array[] [$xValues, $yValues]
 	 */
-	public function transformPoints(array $xValues, array $yValues = null):array{
+	public function transformPoints(array $xValues, array|null $yValues = null):array{
 		$max = count($xValues);
 
 		if($yValues !== null){ // unused
diff --git a/src/Output/QREps.php b/src/Output/QREps.php
@@ -101,7 +101,7 @@ protected function formatColor(array $values):string{
 	/**
 	 * @inheritDoc
 	 */
-	public function dump(string $file = null):string{
+	public function dump(string|null $file = null):string{
 		[$width, $height] = $this->getOutputDimensions();
 
 		$eps = [
diff --git a/src/Output/QRFpdf.php b/src/Output/QRFpdf.php
@@ -29,8 +29,8 @@ class QRFpdf extends QROutputAbstract{
 
 	final public const MIME_TYPE = 'application/pdf';
 
-	protected FPDF   $fpdf;
-	protected ?array $prevColor = null;
+	protected FPDF       $fpdf;
+	protected array|null $prevColor = null;
 
 	/**
 	 * QRFpdf constructor.
@@ -64,7 +64,7 @@ protected function initFPDF():FPDF{
 	/**
 	 * @inheritDoc
 	 */
-	public function dump(string $file = null, FPDF $fpdf = null):string|FPDF{
+	public function dump(string|null $file = null, FPDF|null $fpdf = null):string|FPDF{
 		$this->fpdf = ($fpdf ?? $this->initFPDF());
 
 		if($this::moduleValueIsValid($this->options->bgColor)){
diff --git a/src/Output/QRGdImage.php b/src/Output/QRGdImage.php
@@ -144,7 +144,7 @@ protected function getDefaultModuleValue(bool $isDark):int{
 	 *
 	 * @throws \ErrorException
 	 */
-	public function dump(string $file = null):string|GdImage{
+	public function dump(string|null $file = null):string|GdImage{
 
 		set_error_handler(function(int $errno, string $errstr):bool{
 			throw new ErrorException($errstr, $errno);
diff --git a/src/Output/QRImagick.php b/src/Output/QRImagick.php
@@ -111,7 +111,7 @@ protected function getDefaultModuleValue(bool $isDark):ImagickPixel{
 	/**
 	 * @inheritDoc
 	 */
-	public function dump(string $file = null):string|Imagick{
+	public function dump(string|null $file = null):string|Imagick{
 		$this->setBgColor();
 
 		$this->imagick = $this->createImage();
diff --git a/src/Output/QRInterventionImage.php b/src/Output/QRInterventionImage.php
@@ -85,7 +85,7 @@ public function setDriver(DriverInterface $driver):static{
 	/**
 	 * @inheritDoc
 	 */
-	public function dump(string $file = null):string|ImageInterface{
+	public function dump(string|null $file = null):string|ImageInterface{
 		[$width, $height] = $this->getOutputDimensions();
 
 		$this->image = $this->manager->create($width, $height);
diff --git a/src/Output/QRMarkup.php b/src/Output/QRMarkup.php
@@ -19,7 +19,7 @@ abstract class QRMarkup extends QROutputAbstract{
 	/**
 	 * @inheritDoc
 	 */
-	public function dump(string $file = null):string{
+	public function dump(string|null $file = null):string{
 		$saveToFile = $file !== null;
 		$data       = $this->createMarkup($saveToFile);
 
diff --git a/src/Output/QROutputAbstract.php b/src/Output/QROutputAbstract.php
diff --git a/src/Output/QROutputInterface.php b/src/Output/QROutputInterface.php
diff --git a/src/Output/QRStringJSON.php b/src/Output/QRStringJSON.php
diff --git a/src/Output/QRStringText.php b/src/Output/QRStringText.php
diff --git a/src/QRCode.php b/src/QRCode.php
diff --git a/src/QROptionsTrait.php b/src/QROptionsTrait.php
diff --git a/tests/Common/ECICharsetTest.php b/tests/Common/ECICharsetTest.php

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ protected function header():string{`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`/** @inheritDoc */`
`50`		`- public function dump(string $file = null):string{`
	`50`	`+ public function dump(string\|null $file = null):string{`
`51`	`51`	`$base64 = $this->options->outputBase64;`
`52`	`52`	`// we don't want the SVG in base64`
`53`	`53`	`$this->options->outputBase64 = false;`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ public function getID():int{`
`118`	`118`	`* @see \mb_convert_encoding()`
`119`	`119`	`* @see \iconv()`
`120`	`120`	`*/`
`121`		`- public function getName():?string{`
	`121`	`+ public function getName():string\|null{`
`122`	`122`	`return (self::MB_ENCODINGS[$this->charsetID] ?? null);`
`123`	`123`	`}`
`124`	`124`
Original file line number	Diff line number	Diff line change
`@@ -257,7 +257,7 @@ public function getDimension():int{`
`257`	`257`	`/**`
`258`	`258`	`* the version pattern for the given version`
`259`	`259`	`*/`
`260`		`- public function getVersionPattern():?int{`
	`260`	`+ public function getVersionPattern():int\|null{`
`261`	`261`	`return (self::VERSION_PATTERN[$this->version] ?? null);`
`262`	`262`	`}`
`263`	`263`