mark nullable types explicitly (#276)

codemasher · codemasher · commit beecbe7ba5f4 · 2024-07-17T11:05:32.000+02:00
diff --git a/composer.json b/composer.json
@@ -42,15 +42,15 @@
 	"require": {
 		"php": "^7.4 || ^8.0",
 		"ext-mbstring": "*",
-		"chillerlan/php-settings-container": "^2.1.4 || ^3.2"
+		"chillerlan/php-settings-container": "^2.1.6 || ^3.2.1"
 	},
 	"require-dev": {
-		"chillerlan/php-authenticator": "^4.1 || ^5.1",
+		"chillerlan/php-authenticator": "^4.3.1 || ^5.2.1",
 		"phan/phan": "^5.4",
 		"phpunit/phpunit": "^9.6",
 		"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
@@ -49,7 +49,7 @@ protected function getDefaultModuleValue(bool $isDark){
 	/**
 	 * @inheritDoc
 	 */
-	public function dump(string $file = null):string{
+	public function dump(?string $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 $file = null, ?string $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 $file = null, ?string $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
@@ -49,7 +49,7 @@ protected function header():string{
 	}
 
 	/** @inheritDoc */
-	public function dump(string $file = null):string{
+	public function dump(?string $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 $file = null):string{
 		// set returnResource to true to skip further processing for now
 		$this->options->returnResource = true;
 
diff --git a/src/Common/GDLuminanceSource.php b/src/Common/GDLuminanceSource.php
@@ -38,7 +38,7 @@ class GDLuminanceSource extends LuminanceSourceAbstract{
 	 *
 	 * @throws \chillerlan\QRCode\Decoder\QRCodeDecoderException
 	 */
-	public function __construct($gdImage, SettingsContainerInterface $options = null){
+	public function __construct($gdImage, ?SettingsContainerInterface $options = null){
 
 		/** @noinspection PhpFullyQualifiedNameUsageInspection */
 		if(
@@ -85,12 +85,12 @@ protected function setLuminancePixels():void{
 	}
 
 	/** @inheritDoc */
-	public static function fromFile(string $path, SettingsContainerInterface $options = null):self{
+	public static function fromFile(string $path, ?SettingsContainerInterface $options = null):self{
 		return new self(imagecreatefromstring(file_get_contents(self::checkFile($path))), $options);
 	}
 
 	/** @inheritDoc */
-	public static function fromBlob(string $blob, SettingsContainerInterface $options = null):self{
+	public static function fromBlob(string $blob, ?SettingsContainerInterface $options = null):self{
 		return new self(imagecreatefromstring($blob), $options);
 	}
 
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 $degree = null){
 		$degree ??= 0;
 
 		if(empty($coefficients)){
diff --git a/src/Common/IMagickLuminanceSource.php b/src/Common/IMagickLuminanceSource.php
@@ -28,7 +28,7 @@ class IMagickLuminanceSource extends LuminanceSourceAbstract{
 	/**
 	 * IMagickLuminanceSource constructor.
 	 */
-	public function __construct(Imagick $imagick, SettingsContainerInterface $options = null){
+	public function __construct(Imagick $imagick, ?SettingsContainerInterface $options = null){
 		parent::__construct($imagick->getImageWidth(), $imagick->getImageHeight(), $options);
 
 		$this->imagick = $imagick;
@@ -63,12 +63,12 @@ protected function setLuminancePixels():void{
 	}
 
 	/** @inheritDoc */
-	public static function fromFile(string $path, SettingsContainerInterface $options = null):self{
+	public static function fromFile(string $path, ?SettingsContainerInterface $options = null):self{
 		return new self(new Imagick(self::checkFile($path)), $options);
 	}
 
 	/** @inheritDoc */
-	public static function fromBlob(string $blob, SettingsContainerInterface $options = null):self{
+	public static function fromBlob(string $blob, ?SettingsContainerInterface $options = null):self{
 		$im = new Imagick;
 		$im->readImageBlob($blob);
 
diff --git a/src/Common/LuminanceSourceAbstract.php b/src/Common/LuminanceSourceAbstract.php
@@ -34,7 +34,7 @@ abstract class LuminanceSourceAbstract implements LuminanceSourceInterface{
 	/**
 	 *
 	 */
-	public function __construct(int $width, int $height, SettingsContainerInterface $options = null){
+	public function __construct(int $width, int $height, ?SettingsContainerInterface $options = null){
 		$this->width   = $width;
 		$this->height  = $height;
 		$this->options = ($options ?? new QROptions);
diff --git a/src/Data/QRMatrix.php b/src/Data/QRMatrix.php
@@ -175,7 +175,7 @@ public function initFunctionalPatterns():self{
 	 *
 	 * @return int[][]|bool[][]
 	 */
-	public function getMatrix(bool $boolean = null):array{
+	public function getMatrix(?bool $boolean = null):array{
 
 		if($boolean !== true){
 			return $this->matrix;
@@ -195,7 +195,7 @@ public function getMatrix(bool $boolean = null):array{
 	 * @see \chillerlan\QRCode\Data\QRMatrix::getMatrix()
 	 * @codeCoverageIgnore
 	 */
-	public function matrix(bool $boolean = null):array{
+	public function matrix(?bool $boolean = null):array{
 		return $this->getMatrix($boolean);
 	}
 
@@ -387,7 +387,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 $M_TYPE = null):int{
 		$bits = 0;
 
 		foreach($this::neighbours as $bit => [$ix, $iy]){
@@ -552,7 +552,7 @@ public function setVersionNumber():self{
 	 *
 	 * ISO/IEC 18004:2000 Section 8.9
 	 */
-	public function setFormatInfo(MaskPattern $maskPattern = null):self{
+	public function setFormatInfo(?MaskPattern $maskPattern = null):self{
 		$this->maskPattern = $maskPattern;
 		$bits              = 0; // sets all format fields to false (test mode)
 
@@ -678,7 +678,7 @@ public function invert():self{
 	 *
 	 * @throws \chillerlan\QRCode\Data\QRCodeDataException
 	 */
-	public function setLogoSpace(int $width, int $height = null, int $startX = null, int $startY = null):self{
+	public function setLogoSpace(int $width, ?int $height = null, ?int $startX = null, ?int $startY = null):self{
 		$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
@@ -415,15 +415,15 @@ private function numBitsDiffering(int $a, int $b):int{
 	 * @codeCoverageIgnore
 	 * @throws \chillerlan\QRCode\Data\QRCodeDataException
 	 */
-	public function setQuietZone(int $quietZoneSize = null):self{
+	public function setQuietZone(?int $quietZoneSize = null):self{
 		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):self{
+	public function setLogoSpace(int $width, ?int $height = null, ?int $startX = null, ?int $startY = null):self{
 		throw new QRCodeDataException('not supported');
 	}
 
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 $properties = null){
 
 		if(!empty($properties)){
 
diff --git a/src/Detector/Detector.php b/src/Detector/Detector.php
@@ -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 $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 $count = null){
 		parent::__construct($posX, $posY, $estimatedModuleSize);
 
 		$this->count = ($count ?? 1);
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 $yValues = null):array{
 		$max = count($xValues);
 
 		if($yValues !== null){ // unused
diff --git a/src/Output/QREps.php b/src/Output/QREps.php
@@ -103,7 +103,7 @@ protected function formatColor(array $values):string{
 	/**
 	 * @inheritDoc
 	 */
-	public function dump(string $file = null):string{
+	public function dump(?string $file = null):string{
 		[$width, $height] = $this->getOutputDimensions();
 
 		$eps = [
diff --git a/src/Output/QRFpdf.php b/src/Output/QRFpdf.php
@@ -121,7 +121,7 @@ protected function initFPDF():FPDF{
 	 *
 	 * @return string|\FPDF
 	 */
-	public function dump(string $file = null, FPDF $fpdf = null){
+	public function dump(?string $file = null, ?FPDF $fpdf = null){
 		$this->fpdf = ($fpdf ?? $this->initFPDF());
 
 		if($this::moduleValueIsValid($this->options->bgColor)){
diff --git a/src/Output/QRGdImage.php b/src/Output/QRGdImage.php
@@ -179,7 +179,7 @@ protected function getDefaultModuleValue(bool $isDark):int{
 	 * @phan-suppress PhanUndeclaredTypeReturnType, PhanTypeMismatchReturn
 	 * @throws \ErrorException
 	 */
-	public function dump(string $file = null){
+	public function dump(?string $file = null){
 
 		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
@@ -112,7 +112,7 @@ protected function getDefaultModuleValue(bool $isDark):ImagickPixel{
 	 *
 	 * @return string|\Imagick
 	 */
-	public function dump(string $file = null){
+	public function dump(?string $file = null){
 		$this->setBgColor();
 
 		$this->imagick = $this->createImage();
diff --git a/src/Output/QRMarkup.php b/src/Output/QRMarkup.php
@@ -71,7 +71,7 @@ protected function getDefaultModuleValue(bool $isDark):string{
 	/**
 	 * @inheritDoc
 	 */
-	public function dump(string $file = null):string{
+	public function dump(?string $file = null):string{
 		$data = $this->createMarkup($file !== null);
 
 		$this->saveToFile($data, $file);
diff --git a/src/Output/QROutputAbstract.php b/src/Output/QROutputAbstract.php
@@ -188,7 +188,7 @@ protected function getModuleValueAt(int $x, int $y){
 	/**
 	 * Returns a base64 data URI for the given string and mime type
 	 */
-	protected function toBase64DataURI(string $data, string $mime = null):string{
+	protected function toBase64DataURI(string $data, ?string $mime = null):string{
 		return sprintf('data:%s;base64,%s', ($mime ?? $this::MIME_TYPE), base64_encode($data));
 	}
 
@@ -200,7 +200,7 @@ protected function toBase64DataURI(string $data, string $mime = null):string{
 	 *
 	 * @throws \chillerlan\QRCode\Output\QRCodeOutputException
 	 */
-	protected function saveToFile(string $data, string $file = null):void{
+	protected function saveToFile(string $data, ?string $file = null):void{
 
 		if($file === null){
 			return;
diff --git a/src/Output/QROutputInterface.php b/src/Output/QROutputInterface.php
@@ -221,6 +221,6 @@ public static function moduleValueIsValid($value):bool;
 	 *
 	 * @return mixed
 	 */
-	public function dump(string $file = null);
+	public function dump(?string $file = null);
 
 }
diff --git a/src/Output/QRString.php b/src/Output/QRString.php
@@ -46,7 +46,7 @@ protected function getDefaultModuleValue(bool $isDark):string{
 	/**
 	 * @inheritDoc
 	 */
-	public function dump(string $file = null):string{
+	public function dump(?string $file = null):string{
 
 		switch($this->options->outputType){
 			case QROutputInterface::STRING_TEXT:
@@ -101,7 +101,7 @@ protected function json():string{
 	 *
 	 * @codeCoverageIgnore
 	 */
-	public static function ansi8(string $str, int $color, bool $background = null):string{
+	public static function ansi8(string $str, int $color, ?bool $background = null):string{
 		$color      = max(0, min($color, 255));
 		$background = ($background === true) ? 48 : 38;
 
diff --git a/src/Output/QRStringJSON.php b/src/Output/QRStringJSON.php
@@ -25,7 +25,7 @@ class QRStringJSON extends QROutputAbstract{
 	 * @inheritDoc
 	 * @throws \JsonException
 	 */
-	public function dump(string $file = null):string{
+	public function dump(?string $file = null):string{
 		$matrix = $this->matrix->getMatrix($this->options->jsonAsBooleans);
 		$data   = json_encode($matrix, $this->options->jsonFlags);;
 
diff --git a/src/Output/QRStringText.php b/src/Output/QRStringText.php
@@ -43,7 +43,7 @@ protected function getDefaultModuleValue(bool $isDark):string{
 	/**
 	 * @inheritDoc
 	 */
-	public function dump(string $file = null):string{
+	public function dump(?string $file = null):string{
 		$lines     = [];
 		$linestart = $this->options->textLineStart;
 
@@ -66,7 +66,7 @@ public function dump(string $file = null):string{
 	 *
 	 * @codeCoverageIgnore
 	 */
-	public static function ansi8(string $str, int $color, bool $background = null):string{
+	public static function ansi8(string $str, int $color, ?bool $background = null):string{
 		$color      = max(0, min($color, 255));
 		$background = ($background === true) ? 48 : 38;
 
diff --git a/src/QRCode.php b/src/QRCode.php
@@ -182,7 +182,7 @@ class QRCode{
 	 *
 	 * PHP8: accept iterable
 	 */
-	public function __construct(SettingsContainerInterface $options = null){
+	public function __construct(?SettingsContainerInterface $options = null){
 		$this->setOptions(($options ?? new QROptions));
 	}
 
@@ -209,7 +209,7 @@ public function setOptions(SettingsContainerInterface $options):self{
 	 *
 	 * @return mixed
 	 */
-	public function render(string $data = null, string $file = null){
+	public function render(?string $data = null, ?string $file = null){
 
 		if($data !== null){
 			/** @var \chillerlan\QRCode\Data\QRDataModeInterface $dataInterface */
@@ -231,7 +231,7 @@ public function render(string $data = null, string $file = null){
 	 *
 	 * @return mixed
 	 */
-	public function renderMatrix(QRMatrix $matrix, string $file = null){
+	public function renderMatrix(QRMatrix $matrix, ?string $file = null){
 		return $this->initOutputInterface($matrix)->dump($file ?? $this->options->cachefile);
 	}
 
diff --git a/tests/Common/ECICharsetTest.php b/tests/Common/ECICharsetTest.php
@@ -43,7 +43,7 @@ public function encodingProvider():array{
 	/**
 	 * @dataProvider encodingProvider
 	 */
-	public function testGetName(int $id, string $name = null):void{
+	public function testGetName(int $id, ?string $name = null):void{
 		$eciCharset = new ECICharset($id);
 
 		$this::assertSame($id, $eciCharset->getID());

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ protected function header():string{`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`/** @inheritDoc */`
`52`		`- public function dump(string $file = null):string{`
	`52`	`+ public function dump(?string $file = null):string{`
`53`	`53`	`$base64 = $this->options->outputBase64;`
`54`	`54`	`// we don't want the SVG in base64`
`55`	`55`	`$this->options->outputBase64 = false;`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ class GDLuminanceSource extends LuminanceSourceAbstract{`
`38`	`38`	`*`
`39`	`39`	`* @throws \chillerlan\QRCode\Decoder\QRCodeDecoderException`
`40`	`40`	`*/`
`41`		`- public function __construct($gdImage, SettingsContainerInterface $options = null){`
	`41`	`+ public function __construct($gdImage, ?SettingsContainerInterface $options = null){`
`42`	`42`
`43`	`43`	`/** @noinspection PhpFullyQualifiedNameUsageInspection */`
`44`	`44`	`if(`
`@@ -85,12 +85,12 @@ protected function setLuminancePixels():void{`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`/** @inheritDoc */`
`88`		`- public static function fromFile(string $path, SettingsContainerInterface $options = null):self{`
	`88`	`+ public static function fromFile(string $path, ?SettingsContainerInterface $options = null):self{`
`89`	`89`	`return new self(imagecreatefromstring(file_get_contents(self::checkFile($path))), $options);`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`/** @inheritDoc */`
`93`		`- public static function fromBlob(string $blob, SettingsContainerInterface $options = null):self{`
	`93`	`+ public static function fromBlob(string $blob, ?SettingsContainerInterface $options = null):self{`
`94`	`94`	`return new self(imagecreatefromstring($blob), $options);`
`95`	`95`	`}`
`96`	`96`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ abstract class LuminanceSourceAbstract implements LuminanceSourceInterface{`
`34`	`34`	`/**`
`35`	`35`	`*`
`36`	`36`	`*/`
`37`		`- public function __construct(int $width, int $height, SettingsContainerInterface $options = null){`
	`37`	`+ public function __construct(int $width, int $height, ?SettingsContainerInterface $options = null){`
`38`	`38`	`$this->width = $width;`
`39`	`39`	`$this->height = $height;`
`40`	`40`	`$this->options = ($options ?? new QROptions);`