🚿

codemasher · codemasher · commit 83d5ce91df4d · 2024-01-07T00:59:42.000+01:00
diff --git a/.phan/config.php b/.phan/config.php
@@ -14,8 +14,8 @@
 	// Note that the **only** effect of choosing `'5.6'` is to infer
 	// that functions removed in php 7.0 exist.
 	// (See `backward_compatibility_checks` for additional options)
-	'target_php_version' => null,
-	'minimum_target_php_version' => '7.4',
+	'target_php_version'              => null,
+	'minimum_target_php_version'      => '7.4',
 
 	// A list of directories that should be parsed for class and
 	// method information. After excluding the directories
@@ -24,19 +24,19 @@
 	//
 	// Thus, both first-party and third-party code being used by
 	// your application should be included in this list.
-	'directory_list' => [
+	'directory_list'                  => [
 		'examples',
 		'src',
 		'tests',
 		'vendor',
-		'.phan/stubs'
+		'.phan/stubs',
 	],
 
 	// A regex used to match every file name that you want to
 	// exclude from parsing. Actual value will exclude every
 	// "test", "tests", "Test" and "Tests" folders found in
 	// "vendor/" directory.
-	'exclude_file_regex' => '@^vendor/.*/(tests?|Tests?)/@',
+	'exclude_file_regex'              => '@^vendor/.*/(tests?|Tests?)/@',
 
 	// A directory list that defines files that will be excluded
 	// from static analysis, but whose class and method
@@ -51,9 +51,9 @@
 	//       and `exclude_analysis_directory_list` arrays.
 	'exclude_analysis_directory_list' => [
 		'vendor/',
-		'.phan/stubs'
+		'.phan/stubs',
 	],
-	'suppress_issue_types' => [
+	'suppress_issue_types'            => [
 		'PhanAccessMethodInternal',
 		'PhanAccessOverridesFinalConstant',
 		'PhanDeprecatedClass',
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/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/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;
 
@@ -94,11 +94,6 @@ public function getPattern():int{
 	/**
 	 * Returns a closure that applies the mask for the chosen mask pattern.
 	 *
-	 * Encapsulates data masks for the data bits in a QR code, per ISO 18004:2006 6.8. Implementations
-	 * of this class can un-mask a raw BitMatrix. For simplicity, they will unmask the entire BitMatrix,
-	 * including areas used for finder patterns, timing patterns, etc. These areas should be unused
-	 * after the point they are unmasked anyway.
-	 *
 	 * Note that the diagram in section 6.8.1 is misleading since it indicates that $i is column position
 	 * and $j is row position. In fact, as the text says, $i is row position and $j is column position.
 	 *
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;
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;
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
@@ -12,9 +12,7 @@
 
 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/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/DecoderResult.php b/src/Decoder/DecoderResult.php
@@ -11,8 +11,8 @@
 
 namespace chillerlan\QRCode\Decoder;
 
-use chillerlan\QRCode\Data\QRMatrix;
 use chillerlan\QRCode\Common\{BitBuffer, EccLevel, MaskPattern, Version};
+use chillerlan\QRCode\Data\QRMatrix;
 use function property_exists;
 
 /**
@@ -85,7 +85,7 @@ public function hasStructuredAppend():bool{
 	}
 
 	/**
-	 * Returns a QRMatrix instance with thesettings and data of the reader result
+	 * Returns a QRMatrix instance with the settings and data of the reader result
 	 */
 	public function getQRMatrix():QRMatrix{
 		return (new QRMatrix($this->version, $this->eccLevel))
diff --git a/src/Decoder/ReedSolomonDecoder.php b/src/Decoder/ReedSolomonDecoder.php
@@ -12,7 +12,6 @@
 namespace chillerlan\QRCode\Decoder;
 
 use chillerlan\QRCode\Common\{BitBuffer, EccLevel, GenericGFPoly, GF256, Version};
-use chillerlan\QRCode\QRCodeException;
 use function array_fill, array_reverse, count;
 
 /**
@@ -167,7 +166,7 @@ private function correctErrors(array $codewordBytes, int $numDataCodewords):arra
 	 * @param int   $numEccCodewords number of error-correction codewords available
 	 *
 	 * @return int[]
-	 * @throws \chillerlan\QRCode\QRCodeException if decoding fails for any reason
+	 * @throws \chillerlan\QRCode\Decoder\QRCodeDecoderException if decoding fails for any reason
 	 */
 	private function decodeWords(array $received, int $numEccCodewords):array{
 		$poly                 = new GenericGFPoly($received);
@@ -201,7 +200,7 @@ private function decodeWords(array $received, int $numEccCodewords):array{
 			$position = ($receivedCount - 1 - GF256::log($errorLocations[$i]));
 
 			if($position < 0){
-				throw new QRCodeException('Bad error location');
+				throw new QRCodeDecoderException('Bad error location');
 			}
 
 			$received[$position] ^= $errorMagnitudes[$i];
@@ -212,7 +211,7 @@ private function decodeWords(array $received, int $numEccCodewords):array{
 
 	/**
 	 * @return \chillerlan\QRCode\Common\GenericGFPoly[] [sigma, omega]
-	 * @throws \chillerlan\QRCode\QRCodeException
+	 * @throws \chillerlan\QRCode\Decoder\QRCodeDecoderException
 	 */
 	private function runEuclideanAlgorithm(GenericGFPoly $a, GenericGFPoly $b, int $z):array{
 		// Assume a's degree is >= b's
@@ -240,14 +239,14 @@ private function runEuclideanAlgorithm(GenericGFPoly $a, GenericGFPoly $b, int $
 			$t = $q->multiply($tLast)->addOrSubtract($tLastLast);
 
 			if($r->getDegree() >= $rLast->getDegree()){
-				throw new QRCodeException('Division algorithm failed to reduce polynomial?');
+				throw new QRCodeDecoderException('Division algorithm failed to reduce polynomial?');
 			}
 		}
 
 		$sigmaTildeAtZero = $t->getCoefficient(0);
 
 		if($sigmaTildeAtZero === 0){
-			throw new QRCodeException('sigmaTilde(0) was zero');
+			throw new QRCodeDecoderException('sigmaTilde(0) was zero');
 		}
 
 		$inverse = GF256::inverse($sigmaTildeAtZero);
@@ -256,7 +255,7 @@ private function runEuclideanAlgorithm(GenericGFPoly $a, GenericGFPoly $b, int $
 	}
 
 	/**
-	 * @throws \chillerlan\QRCode\QRCodeException
+	 * @throws \chillerlan\QRCode\Decoder\QRCodeDecoderException
 	 */
 	private function findErrorLocations(GenericGFPoly $errorLocator):array{
 		// This is a direct application of Chien's search
@@ -277,7 +276,7 @@ private function findErrorLocations(GenericGFPoly $errorLocator):array{
 		}
 
 		if($e !== $numErrors){
-			throw new QRCodeException('Error locator degree does not match number of roots');
+			throw new QRCodeDecoderException('Error locator degree does not match number of roots');
 		}
 
 		return $result;
diff --git a/src/Detector/Detector.php b/src/Detector/Detector.php
@@ -11,9 +11,8 @@
 
 namespace chillerlan\QRCode\Detector;
 
-use chillerlan\QRCode\Decoder\Binarizer;
 use chillerlan\QRCode\Common\{LuminanceSourceInterface, Version};
-use chillerlan\QRCode\Decoder\BitMatrix;
+use chillerlan\QRCode\Decoder\{Binarizer, BitMatrix};
 use function abs, intdiv, is_nan, max, min, round;
 use const NAN;
 
diff --git a/src/Output/QRGdImageJPEG.php b/src/Output/QRGdImageJPEG.php
@@ -12,9 +12,7 @@
 
 namespace chillerlan\QRCode\Output;
 
-use function imagejpeg;
-use function max;
-use function min;
+use function imagejpeg, max, min;
 
 /**
  * GdImage jpeg output
diff --git a/src/Output/QRGdImagePNG.php b/src/Output/QRGdImagePNG.php
@@ -12,9 +12,7 @@
 
 namespace chillerlan\QRCode\Output;
 
-use function imagepng;
-use function max;
-use function min;
+use function imagepng, max, min;
 
 /**
  * GdImage png output
diff --git a/src/Output/QRGdImageWEBP.php b/src/Output/QRGdImageWEBP.php
@@ -12,9 +12,7 @@
 
 namespace chillerlan\QRCode\Output;
 
-use function imagewebp;
-use function max;
-use function min;
+use function imagewebp, max, min;
 
 /**
  * GdImage webp output
diff --git a/src/Output/QRMarkupSVG.php b/src/Output/QRMarkupSVG.php
@@ -18,7 +18,10 @@
  * @see https://github.com/codemasher/php-qrcode/pull/5
  * @see https://developer.mozilla.org/en-US/docs/Web/SVG
  * @see https://www.sarasoueidan.com/demos/interactive-svg-coordinate-system/
- * @see http://apex.infogridpacific.com/SVG/svg-tutorial-contents.html
+ * @see https://lea.verou.me/blog/2019/05/utility-convert-svg-path-to-all-relative-or-all-absolute-commands/
+ * @see https://codepen.io/leaverou/full/RmwzKv
+ * @see https://jakearchibald.github.io/svgomg/
+ * @see https://web.archive.org/web/20200220211445/http://apex.infogridpacific.com/SVG/svg-tutorial-contents.html
  */
 class QRMarkupSVG extends QRMarkup{
 
@@ -54,6 +57,17 @@ protected function getOutputDimensions():array{
 		return [$this->moduleCount, $this->moduleCount];
 	}
 
+	/**
+	 * @inheritDoc
+	 */
+	protected function getCssClass(int $M_TYPE = 0):string{
+		return implode(' ', [
+			'qr-'.($this::LAYERNAMES[$M_TYPE] ?? $M_TYPE),
+			$this->matrix->isDark($M_TYPE) ? 'dark' : 'light',
+			$this->options->cssClass,
+		]);
+	}
+
 	/**
 	 * @inheritDoc
 	 */
@@ -159,17 +173,6 @@ protected function path(string $path, int $M_TYPE):string{
 		return sprintf('<path class="%s" d="%s"/>', $this->getCssClass($M_TYPE), $path);
 	}
 
-	/**
-	 * @inheritDoc
-	 */
-	protected function getCssClass(int $M_TYPE = 0):string{
-		return implode(' ', [
-			'qr-'.($this::LAYERNAMES[$M_TYPE] ?? $M_TYPE),
-			$this->matrix->isDark($M_TYPE) ? 'dark' : 'light',
-			$this->options->cssClass,
-		]);
-	}
-
 	/**
 	 * returns a path segment for a single module
 	 *
diff --git a/src/Output/QROutputAbstract.php b/src/Output/QROutputAbstract.php
@@ -145,6 +145,22 @@ protected function setModuleValues():void{
 
 	}
 
+	/**
+	 * Prepares the value for the given input ()
+	 *
+	 * @param mixed $value
+	 *
+	 * @return mixed|null return value depends on the output class
+	 */
+	abstract protected function prepareModuleValue($value);
+
+	/**
+	 * Returns a default value for either dark or light modules
+	 *
+	 * @return mixed|null return value depends on the output class
+	 */
+	abstract protected function getDefaultModuleValue(bool $isDark);
+
 	/**
 	 * Returns the prepared value for the given $M_TYPE
 	 *
@@ -169,22 +185,6 @@ protected function getModuleValueAt(int $x, int $y){
 		return $this->getModuleValue($this->matrix->get($x, $y));
 	}
 
-	/**
-	 * Prepares the value for the given input ()
-	 *
-	 * @param mixed $value
-	 *
-	 * @return mixed|null return value depends on the output class
-	 */
-	abstract protected function prepareModuleValue($value);
-
-	/**
-	 * Returns a default value for either dark or light modules
-	 *
-	 * @return mixed|null return value depends on the output class
-	 */
-	abstract protected function getDefaultModuleValue(bool $isDark);
-
 	/**
 	 * Returns a base64 data URI for the given string and mime type
 	 */
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/QROptionsTrait.php b/src/QROptionsTrait.php
diff --git a/tests/Common/ECICharsetTest.php b/tests/Common/ECICharsetTest.php
diff --git a/tests/Common/EccLevelTest.php b/tests/Common/EccLevelTest.php
diff --git a/tests/Common/MaskPatternTest.php b/tests/Common/MaskPatternTest.php
diff --git a/tests/Common/ModeTest.php b/tests/Common/ModeTest.php
diff --git a/tests/Common/VersionTest.php b/tests/Common/VersionTest.php
