🛀 clean-up (again)

chillerlan · Nov 27, 2023 · 00800ef · 00800ef
1 parent 2d2a00f
commit 00800ef
Show file tree

Hide file tree

Showing 44 changed files with 93 additions and 114 deletions.
diff --git a/examples/authenticator.php b/examples/authenticator.php
@@ -10,9 +10,10 @@
 
 use chillerlan\Authenticator\{Authenticator, AuthenticatorOptionsTrait};
 use chillerlan\Authenticator\Authenticators\AuthenticatorInterface;
-use chillerlan\Settings\SettingsContainerAbstract;
 use chillerlan\QRCode\{QRCode, QROptionsTrait};
 use chillerlan\QRCode\Data\QRMatrix;
+use chillerlan\QRCode\Output\QRMarkupSVG;
+use chillerlan\Settings\SettingsContainerAbstract;
 
 require_once __DIR__.'/../vendor/autoload.php';
 
@@ -35,6 +36,7 @@
  */
 $options->version              = 7;
 $options->addQuietzone         = false;
+$options->outputInterface      = QRMarkupSVG::class;
 $options->outputBase64         = false;
 $options->svgAddXmlHeader      = false;
 $options->cssClass             = 'my-qrcode';

diff --git a/examples/custom_output.php b/examples/custom_output.php
@@ -40,7 +40,7 @@ protected function prepareModuleValue(mixed $value):mixed{
 	/**
 	 * @inheritDoc
 	 */
-	protected function getDefaultModuleValue(bool $isDark){
+	protected function getDefaultModuleValue(bool $isDark):mixed{
 		// TODO: Implement getDefaultModuleValue() method. (abstract)
 		return null;
 	}

diff --git a/examples/imageWithRoundedShapes.php b/examples/imageWithRoundedShapes.php
@@ -13,11 +13,10 @@
  * @noinspection PhpComposerExtensionStubsInspection
  */
 
+use chillerlan\QRCode\{QRCode, QROptions};
 use chillerlan\QRCode\Common\EccLevel;
 use chillerlan\QRCode\Data\QRMatrix;
 use chillerlan\QRCode\Output\QRGdImagePNG;
-use chillerlan\QRCode\QRCode;
-use chillerlan\QRCode\QROptions;
 use chillerlan\Settings\SettingsContainerInterface;
 
 require_once __DIR__ . '/../vendor/autoload.php';

diff --git a/examples/imagickConvertSVGtoPNG.php b/examples/imagickConvertSVGtoPNG.php
@@ -16,10 +16,9 @@
  * @license      MIT
  */
 
+use chillerlan\QRCode\{QRCode, QROptions};
 use chillerlan\QRCode\Data\QRMatrix;
 use chillerlan\QRCode\Output\QRMarkupSVG;
-use chillerlan\QRCode\QRCode;
-use chillerlan\QRCode\QROptions;
 
 require_once __DIR__.'/../vendor/autoload.php';
 

diff --git a/examples/imagickImageAsBackground.php b/examples/imagickImageAsBackground.php
@@ -8,11 +8,9 @@
  * @license      MIT
  */
 
+use chillerlan\QRCode\{QRCode, QRCodeException, QROptions};
 use chillerlan\QRCode\Common\EccLevel;
 use chillerlan\QRCode\Output\QRImagick;
-use chillerlan\QRCode\QRCode;
-use chillerlan\QRCode\QRCodeException;
-use chillerlan\QRCode\QROptions;
 
 require_once __DIR__.'/../vendor/autoload.php';
 

diff --git a/examples/multimode.php b/examples/multimode.php
@@ -8,8 +8,7 @@
  * @license      MIT
  */
 
-use chillerlan\QRCode\QRCode;
-use chillerlan\QRCode\QROptions;
+use chillerlan\QRCode\{QRCode, QROptions};
 
 require_once __DIR__.'/../vendor/autoload.php';
 

diff --git a/examples/qrcode-interactive.php b/examples/qrcode-interactive.php
@@ -8,9 +8,8 @@
  * @noinspection PhpComposerExtensionStubsInspection
  */
 
+use chillerlan\QRCode\{QRCode, QROptions};
 use chillerlan\QRCode\Data\QRMatrix;
-use chillerlan\QRCode\QRCode;
-use chillerlan\QRCode\QROptions;
 
 require_once '../vendor/autoload.php';
 

diff --git a/examples/reflectance.php b/examples/reflectance.php
@@ -8,11 +8,10 @@
  * @license      MIT
  */
 
+use chillerlan\QRCode\{QRCode, QROptions};
 use chillerlan\QRCode\Common\EccLevel;
 use chillerlan\QRCode\Data\QRMatrix;
 use chillerlan\QRCode\Output\QRMarkupSVG;
-use chillerlan\QRCode\QRCode;
-use chillerlan\QRCode\QROptions;
 
 require_once __DIR__.'/../vendor/autoload.php';
 

diff --git a/examples/svgConvertViaCanvas.php b/examples/svgConvertViaCanvas.php
@@ -8,11 +8,9 @@
  * @license      MIT
  */
 
-
+use chillerlan\QRCode\{QRCode, QROptions};
 use chillerlan\QRCode\Data\QRMatrix;
 use chillerlan\QRCode\Output\QRMarkupSVG;
-use chillerlan\QRCode\QRCode;
-use chillerlan\QRCode\QROptions;
 
 require_once __DIR__.'/../vendor/autoload.php';
 

diff --git a/examples/svgRoundQuietzone.php b/examples/svgRoundQuietzone.php
@@ -12,10 +12,10 @@
  * @noinspection PhpIllegalPsrClassPathInspection
  */
 
+use chillerlan\QRCode\{QRCode, QRCodeException, QROptions};
 use chillerlan\QRCode\Common\EccLevel;
 use chillerlan\QRCode\Data\QRMatrix;
 use chillerlan\QRCode\Output\QRMarkupSVG;
-use chillerlan\QRCode\{QRCode, QRCodeException, QROptions};
 
 require_once __DIR__.'/../vendor/autoload.php';
 

diff --git a/src/Common/BitBuffer.php b/src/Common/BitBuffer.php
@@ -42,11 +42,9 @@ final class BitBuffer{
 
 	/**
 	 * BitBuffer constructor.
-	 *
-	 * @param int[]|null $bytes
 	 */
-	public function __construct(array $bytes = null){
-		$this->buffer = ($bytes ?? []);
+	public function __construct(array $bytes = []){
+		$this->buffer = $bytes;
 		$this->length = count($this->buffer);
 	}
 

diff --git a/src/Common/EccLevel.php b/src/Common/EccLevel.php
@@ -11,7 +11,6 @@
 namespace chillerlan\QRCode\Common;
 
 use chillerlan\QRCode\QRCodeException;
-
 use function array_column;
 
 /**

diff --git a/src/Common/GDLuminanceSource.php b/src/Common/GDLuminanceSource.php
@@ -33,7 +33,7 @@ final class GDLuminanceSource extends LuminanceSourceAbstract{
 	 *
 	 * @throws \chillerlan\QRCode\Decoder\QRCodeDecoderException
 	 */
-	public function __construct(GdImage $gdImage, SettingsContainerInterface|QROptions $options = null){
+	public function __construct(GdImage $gdImage, SettingsContainerInterface|QROptions $options = new QROptions){
 		parent::__construct(imagesx($gdImage), imagesy($gdImage), $options);
 
 		$this->gdImage = $gdImage;
@@ -71,12 +71,12 @@ private function setLuminancePixels():void{
 	}
 
 	/** @inheritDoc */
-	public static function fromFile(string $path, SettingsContainerInterface $options = null):static{
+	public static function fromFile(string $path, SettingsContainerInterface|QROptions $options = new QROptions):static{
 		return new self(imagecreatefromstring(file_get_contents(self::checkFile($path))), $options);
 	}
 
 	/** @inheritDoc */
-	public static function fromBlob(string $blob, SettingsContainerInterface $options = null):static{
+	public static function fromBlob(string $blob, SettingsContainerInterface|QROptions $options = new QROptions):static{
 		return new self(imagecreatefromstring($blob), $options);
 	}
 

diff --git a/src/Common/GenericGFPoly.php b/src/Common/GenericGFPoly.php
@@ -12,7 +12,6 @@
 namespace chillerlan\QRCode\Common;
 
 use chillerlan\QRCode\QRCodeException;
-
 use function array_fill, array_slice, array_splice, count;
 
 /**

diff --git a/src/Common/IMagickLuminanceSource.php b/src/Common/IMagickLuminanceSource.php
@@ -29,7 +29,7 @@ final class IMagickLuminanceSource extends LuminanceSourceAbstract{
 	/**
 	 * IMagickLuminanceSource constructor.
 	 */
-	public function __construct(Imagick $imagick, SettingsContainerInterface|QROptions $options = null){
+	public function __construct(Imagick $imagick, SettingsContainerInterface|QROptions $options = new QROptions){
 		parent::__construct($imagick->getImageWidth(), $imagick->getImageHeight(), $options);
 
 		$this->imagick = $imagick;
@@ -64,12 +64,12 @@ private function setLuminancePixels():void{
 	}
 
 	/** @inheritDoc */
-	public static function fromFile(string $path, SettingsContainerInterface $options = null):static{
+	public static function fromFile(string $path, SettingsContainerInterface|QROptions $options = new QROptions):static{
 		return new self(new Imagick(self::checkFile($path)), $options);
 	}
 
 	/** @inheritDoc */
-	public static function fromBlob(string $blob, SettingsContainerInterface $options = null):static{
+	public static function fromBlob(string $blob, SettingsContainerInterface|QROptions $options = new QROptions):static{
 		$im = new Imagick;
 		$im->readImageBlob($blob);
 

diff --git a/src/Common/LuminanceSourceAbstract.php b/src/Common/LuminanceSourceAbstract.php
@@ -12,8 +12,8 @@
 
 namespace chillerlan\QRCode\Common;
 
-use chillerlan\QRCode\Decoder\QRCodeDecoderException;
 use chillerlan\QRCode\QROptions;
+use chillerlan\QRCode\Decoder\QRCodeDecoderException;
 use chillerlan\Settings\SettingsContainerInterface;
 use function array_slice, array_splice, file_exists, is_file, is_readable, realpath;
 
@@ -33,10 +33,10 @@ abstract class LuminanceSourceAbstract implements LuminanceSourceInterface{
 	/**
 	 *
 	 */
-	public function __construct(int $width, int $height, SettingsContainerInterface|QROptions $options = null){
+	public function __construct(int $width, int $height, SettingsContainerInterface|QROptions $options = new QROptions){
 		$this->width   = $width;
 		$this->height  = $height;
-		$this->options = ($options ?? new QROptions);
+		$this->options = $options;
 
 		$this->luminances = [];
 	}

diff --git a/src/Common/LuminanceSourceInterface.php b/src/Common/LuminanceSourceInterface.php
@@ -10,6 +10,9 @@
 
 namespace chillerlan\QRCode\Common;
 
+use chillerlan\QRCode\QROptions;
+use chillerlan\Settings\SettingsContainerInterface;
+
 /**
  */
 interface LuminanceSourceInterface{
@@ -51,11 +54,11 @@ public function getRow(int $y):array;
 	/**
 	 * Creates a LuminanceSource instance from the given file
 	 */
-	public static function fromFile(string $path):static;
+	public static function fromFile(string $path, SettingsContainerInterface|QROptions $options = new QROptions):static;
 
 	/**
 	 * Creates a LuminanceSource instance from the given data blob
 	 */
-	public static function fromBlob(string $blob):static;
+	public static function fromBlob(string $blob, SettingsContainerInterface|QROptions $options = new QROptions):static;
 
 }
diff --git a/src/Common/MaskPattern.php b/src/Common/MaskPattern.php
@@ -11,8 +11,8 @@
 
 namespace chillerlan\QRCode\Common;
 
-use chillerlan\QRCode\Data\QRMatrix;
 use chillerlan\QRCode\QRCodeException;
+use chillerlan\QRCode\Data\QRMatrix;
 use Closure;
 use function abs, array_column, array_search, intdiv, min;
 

diff --git a/src/Data/AlphaNum.php b/src/Data/AlphaNum.php
@@ -11,7 +11,6 @@
 namespace chillerlan\QRCode\Data;
 
 use chillerlan\QRCode\Common\{BitBuffer, Mode};
-
 use function array_flip, ceil, intdiv, str_split;
 
 /**

diff --git a/src/Data/Byte.php b/src/Data/Byte.php
@@ -11,7 +11,6 @@
 namespace chillerlan\QRCode\Data;
 
 use chillerlan\QRCode\Common\{BitBuffer, Mode};
-
 use function chr, ord;
 
 /**

diff --git a/src/Data/Hanzi.php b/src/Data/Hanzi.php
@@ -11,7 +11,6 @@
 namespace chillerlan\QRCode\Data;
 
 use chillerlan\QRCode\Common\{BitBuffer, Mode};
-
 use Throwable;
 use function chr, implode, intdiv, is_string, mb_convert_encoding, mb_detect_encoding,
 	mb_detect_order, mb_internal_encoding, mb_strlen, ord, sprintf, strlen;
@@ -96,7 +95,7 @@ public static function validateString(string $string):bool{
 		try{
 			$string = self::convertEncoding($string);
 		}
-		catch(Throwable $e){
+		catch(Throwable){
 			return false;
 		}
 

diff --git a/src/Data/Kanji.php b/src/Data/Kanji.php
@@ -11,7 +11,6 @@
 namespace chillerlan\QRCode\Data;
 
 use chillerlan\QRCode\Common\{BitBuffer, Mode};
-
 use Throwable;
 use function chr, implode, intdiv, is_string, mb_convert_encoding, mb_detect_encoding,
 	mb_detect_order, mb_internal_encoding, mb_strlen, ord, sprintf, strlen;
@@ -89,7 +88,7 @@ public static function validateString(string $string):bool{
 		try{
 			$string = self::convertEncoding($string);
 		}
-		catch(Throwable $e){
+		catch(Throwable){
 			return false;
 		}
 

diff --git a/src/Data/Number.php b/src/Data/Number.php
@@ -11,7 +11,6 @@
 namespace chillerlan\QRCode\Data;
 
 use chillerlan\QRCode\Common\{BitBuffer, Mode};
-
 use function array_flip, ceil, intdiv, str_split, substr, unpack;
 
 /**

diff --git a/src/Data/QRData.php b/src/Data/QRData.php
@@ -10,12 +10,10 @@
 
 namespace chillerlan\QRCode\Data;
 
-use chillerlan\QRCode\Common\{BitBuffer, EccLevel, Mode, Version};
 use chillerlan\QRCode\QROptions;
+use chillerlan\QRCode\Common\{BitBuffer, EccLevel, Mode, Version};
 use chillerlan\Settings\SettingsContainerInterface;
-
-use function count;
-use function sprintf;
+use function count, sprintf;
 
 /**
  * Processes the binary data and maps it on a QRMatrix which is then being returned

diff --git a/src/Data/QRDataModeInterface.php b/src/Data/QRDataModeInterface.php
@@ -20,14 +20,10 @@ interface QRDataModeInterface{
 	/**
 	 * the current data mode: Number, Alphanum, Kanji, Hanzi, Byte, ECI
 	 *
-	 * tbh I hate this constant here, but it's part of the interface, so I can't just declare it in the abstract class.
-	 * (phan will complain about a PhanAccessOverridesFinalConstant)
-	 *
-	 * @see https://wiki.php.net/rfc/final_class_const
+	 * Note: do not call this constant from the interface, but rather from one of the child classes
 	 *
 	 * @var int
 	 * @see \chillerlan\QRCode\Common\Mode
-	 * @internal do not call this constant from the interface, but rather from one of the child classes
 	 */
 	public const DATAMODE = -1;
 

diff --git a/src/Data/ReedSolomonEncoder.php b/src/Data/ReedSolomonEncoder.php
@@ -23,8 +23,8 @@ final class ReedSolomonEncoder{
 	private Version  $version;
 	private EccLevel $eccLevel;
 
-	private array $interleavedData;
-	private int   $interleavedDataIndex;
+	private array    $interleavedData;
+	private int      $interleavedDataIndex;
 
 	/**
 	 * ReedSolomonDecoder constructor
@@ -35,7 +35,7 @@ public function __construct(Version $version, EccLevel $eccLevel){
 	}
 
 	/**
-	 * ECC interleaving
+	 * ECC encoding and interleaving
 	 *
 	 * @throws \chillerlan\QRCode\QRCodeException
 	 */

diff --git a/src/Decoder/BitMatrix.php b/src/Decoder/BitMatrix.php
@@ -97,7 +97,6 @@ public function mirrorDiagonal():static{
 		// mirror vertically
 		$this->matrix = array_reverse($this->matrix);
 		// rotate by 90 degrees clockwise
-		/** @phan-suppress-next-line PhanTypeMismatchReturnSuperType */
 		return $this->rotate90();
 	}
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,7 +11,6 @@ @@
     namespace chillerlan\QRCode\Common;
     use chillerlan\QRCode\QRCodeException;
     use function array_column;
     /**
@@ Expand Down @@