🛀 output (+test) simplification & cleanup

Author: codemasher

src/Output/QRImage.php renamed to src/Output/QRGdImage.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Class QRImage
+ * Class QRGdImage
  *
  * @created      05.12.2015
  * @author       Smiley <[email protected]>
@@ -15,31 +15,18 @@
 use chillerlan\QRCode\Data\QRMatrix;
 use chillerlan\QRCode\QRCode;
 use chillerlan\Settings\SettingsContainerInterface;
-use ErrorException, Exception;
-
+use ErrorException, Throwable;
 use function array_values, count, extension_loaded, imagecolorallocate, imagecolortransparent, imagecreatetruecolor,
-	 imagedestroy, imagefilledellipse, imagefilledrectangle, imagegif, imagejpeg, imagepng, imagescale, in_array,
-	is_array, ob_end_clean, ob_get_contents, ob_start, range, restore_error_handler, set_error_handler;
+	imagedestroy, imagefilledellipse, imagefilledrectangle, imagegif, imagejpeg, imagepng, imagescale, is_array,
+	max, min, ob_end_clean, ob_get_contents, ob_start, restore_error_handler, set_error_handler;
 use const IMG_BICUBIC;
 
 /**
  * Converts the matrix into GD images, raw or base64 output (requires ext-gd)
  *
  * @see http://php.net/manual/book.image.php
  */
-class QRImage extends QROutputAbstract{
-
-	/**
-	 * GD image types that support transparency
-	 *
-	 * @var string[]
-	 */
-	protected const TRANSPARENCY_TYPES = [
-		QRCode::OUTPUT_IMAGE_PNG,
-		QRCode::OUTPUT_IMAGE_GIF,
-	];
-
-	protected string $defaultMode = QRCode::OUTPUT_IMAGE_PNG;
+class QRGdImage extends QROutputAbstract{
 
 	/**
 	 * The GD image resource
@@ -115,7 +102,7 @@ public function dump(string $file = null){
 		/** @phan-suppress-next-line PhanParamTooFewInternalUnpack */
 		$background = imagecolorallocate($this->image, ...$tbg);
 
-		if($this->options->imageTransparent && in_array($this->options->outputType, $this::TRANSPARENCY_TYPES, true)){
+		if($this->options->imageTransparent && $this->options->outputType !== QRCode::OUTPUT_IMAGE_JPG){
 			imagecolortransparent($this->image, $background);
 		}
 
@@ -188,11 +175,24 @@ protected function dumpImage():string{
 		ob_start();
 
 		try{
-			$this->{$this->outputMode ?? $this->defaultMode}();
+
+			switch($this->options->outputType){
+				case QRCode::OUTPUT_IMAGE_GIF:
+					imagegif($this->image);
+					break;
+				case QRCode::OUTPUT_IMAGE_JPG:
+					imagejpeg($this->image, null, max(0, min(100, $this->options->jpegQuality)));
+					break;
+				// silently default to png output
+				case QRCode::OUTPUT_IMAGE_PNG:
+				default:
+					imagepng($this->image, null, max(-1, min(9, $this->options->pngCompression)));
+			}
+
 		}
 		// not going to cover edge cases
 		// @codeCoverageIgnoreStart
-		catch(Exception $e){
+		catch(Throwable $e){
 			throw new QRCodeOutputException($e->getMessage());
 		}
 		// @codeCoverageIgnoreEnd
@@ -205,43 +205,4 @@ protected function dumpImage():string{
 		return $imageData;
 	}
 
-	/**
-	 * PNG output
-	 *
-	 * @return void
-	 */
-	protected function png():void{
-		imagepng(
-			$this->image,
-			null,
-			in_array($this->options->pngCompression, range(-1, 9), true)
-				? $this->options->pngCompression
-				: -1
-		);
-	}
-
-	/**
-	 * Jiff - like... JitHub!
-	 *
-	 * @return void
-	 */
-	protected function gif():void{
-		imagegif($this->image);
-	}
-
-	/**
-	 * JPG output
-	 *
-	 * @return void
-	 */
-	protected function jpg():void{
-		imagejpeg(
-			$this->image,
-			null,
-			in_array($this->options->jpegQuality, range(0, 100), true)
-				? $this->options->jpegQuality
-				: 85
-		);
-	}
-
 }

src/Output/QRImagick.php

@@ -80,6 +80,8 @@ public function dump(string $file = null){
 			$this->options->imagickFormat
 		);
 
+		$this->imagick->setImageType(Imagick::IMGTYPE_TRUECOLOR);
+
 		$this->drawImage();
 
 		if($this->options->returnResource){

src/Output/QRMarkup.php

@@ -43,10 +43,33 @@ protected function getDefaultModuleValue(bool $isDark):string{
 		return $isDark ? $this->options->markupDark : $this->options->markupLight;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
+	public function dump(string $file = null){
+		$file       ??= $this->options->cachefile;
+		$saveToFile   = $file !== null;
+
+		switch($this->options->outputType){
+			case QRCode::OUTPUT_MARKUP_HTML:
+				$data = $this->html($saveToFile);
+				break;
+			case QRCode::OUTPUT_MARKUP_SVG:
+			default:
+				$data = $this->svg($saveToFile);
+		}
+
+		if($saveToFile){
+			$this->saveToFile($data, $file);
+		}
+
+		return $data;
+	}
+
 	/**
 	 * HTML output
 	 */
-	protected function html(string $file = null):string{
+	protected function html(bool $saveToFile):string{
 
 		$html = empty($this->options->cssClass)
 			? '<div>'
@@ -66,7 +89,7 @@ protected function html(string $file = null):string{
 
 		$html .= '</div>'.$this->options->eol;
 
-		if($file !== null){
+		if($saveToFile){
 			return sprintf(
 				'<!DOCTYPE html><head><meta charset="UTF-8"><title>QR Code</title></head><body>%s</body>',
 				$this->options->eol.$html
@@ -83,7 +106,7 @@ protected function html(string $file = null):string{
 	 * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg
 	 * @see https://www.sarasoueidan.com/demos/interactive-svg-coordinate-system/
 	 */
-	protected function svg(string $file = null):string{
+	protected function svg(bool $saveToFile):string{
 		$svg = $this->svgHeader();
 
 		if(!empty($this->options->svgDefs)){
@@ -96,7 +119,7 @@ protected function svg(string $file = null):string{
 		$svg .= sprintf('%1$s</svg>%1$s', $this->options->eol);
 
 		// transform to data URI only when not saving to file
-		if($file === null && $this->options->imageBase64){
+		if(!$saveToFile && $this->options->imageBase64){
 			$svg = $this->base64encode($svg, 'image/svg+xml');
 		}
 

src/Output/QROutputAbstract.php

@@ -10,9 +10,9 @@
 
 namespace chillerlan\QRCode\Output;
 
-use chillerlan\QRCode\{Data\QRMatrix, QRCode};
+use chillerlan\QRCode\Data\QRMatrix;
 use chillerlan\Settings\SettingsContainerInterface;
-use function base64_encode, dirname, file_put_contents, get_called_class, in_array, is_writable, sprintf;
+use function base64_encode, dirname, file_put_contents, is_writable, sprintf;
 
 /**
  * common output abstract
@@ -26,18 +26,6 @@ abstract class QROutputAbstract implements QROutputInterface{
 	 */
 	protected int $moduleCount;
 
-	/**
-	 * the current output mode
-	 *
-	 * @see \chillerlan\QRCode\QROptions::$outputType
-	 */
-	protected string $outputMode;
-
-	/**
-	 * the default output mode of the current output module
-	 */
-	protected string $defaultMode;
-
 	/**
 	 * the current scaling for a QR pixel
 	 *
@@ -74,11 +62,6 @@ public function __construct(SettingsContainerInterface $options, QRMatrix $matri
 		$this->moduleCount = $this->matrix->size();
 		$this->scale       = $this->options->scale;
 		$this->length      = $this->moduleCount * $this->scale;
-		$class             = get_called_class();
-
-		if(isset(QRCode::OUTPUT_MODES[$class]) && in_array($this->options->outputType, QRCode::OUTPUT_MODES[$class])){
-			$this->outputMode = $this->options->outputType;
-		}
 
 		$this->setModuleValues();
 	}
@@ -136,30 +119,15 @@ protected function base64encode(string $data, string $mime):string{
 	 *
 	 * @throws \chillerlan\QRCode\Output\QRCodeOutputException
 	 */
-	protected function saveToFile(string $data, string $file):bool{
+	protected function saveToFile(string $data, string $file):void{
 
 		if(!is_writable(dirname($file))){
 			throw new QRCodeOutputException(sprintf('Cannot write data to cache file: %s', $file));
 		}
 
-		return (bool)file_put_contents($file, $data);
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function dump(string $file = null){
-		$file ??= $this->options->cachefile;
-
-		// call the built-in output method with the optional file path as parameter
-		// to make the called method aware if a cache file was given
-		$data = $this->{$this->outputMode ?? $this->defaultMode}($file);
-
-		if($file !== null){
-			$this->saveToFile($data, $file);
+		if(file_put_contents($file, $data) === false){
+			throw new QRCodeOutputException(sprintf('Cannot write data to cache file: %s (file_put_contents error)', $file));
 		}
-
-		return $data;
 	}
 
 }

src/Output/QRString.php

@@ -45,10 +45,32 @@ protected function getDefaultModuleValue(bool $isDark):string{
 		return $isDark ? $this->options->textDark : $this->options->textLight;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
+	public function dump(string $file = null):string{
+		$file ??= $this->options->cachefile;
+
+		switch($this->options->outputType){
+			case QRCode::OUTPUT_STRING_TEXT:
+				$data = $this->text();
+				break;
+			case QRCode::OUTPUT_STRING_JSON:
+			default:
+				$data = $this->json();
+		}
+
+		if($file !== null){
+			$this->saveToFile($data, $file);
+		}
+
+		return $data;
+	}
+
 	/**
 	 * string output
 	 */
-	protected function text(string $file = null):string{
+	protected function text():string{
 		$str = [];
 
 		foreach($this->matrix->matrix() as $row){
@@ -67,7 +89,7 @@ protected function text(string $file = null):string{
 	/**
 	 * JSON output
 	 */
-	protected function json(string $file = null):string{
+	protected function json():string{
 		return json_encode($this->matrix->matrix());
 	}
 

src/QRCode.php

@@ -11,9 +11,9 @@
 namespace chillerlan\QRCode;
 
 use chillerlan\QRCode\Common\{EccLevel, ECICharset, MaskPattern, Mode};
-use chillerlan\QRCode\Data\{AlphaNum, Byte, ECI, Kanji, Number, QRData, QRCodeDataException, QRDataModeInterface, QRMatrix};
+use chillerlan\QRCode\Data\{AlphaNum, Byte, ECI, Kanji, Number, QRCodeDataException, QRData, QRDataModeInterface, QRMatrix};
 use chillerlan\QRCode\Decoder\{Decoder, DecoderResult, LuminanceSourceInterface};
-use chillerlan\QRCode\Output\{QRCodeOutputException, QRFpdf, QRImage, QRImagick, QRMarkup, QROutputInterface, QRString};
+use chillerlan\QRCode\Output\{QRCodeOutputException, QRFpdf, QRGdImage, QRImagick, QRMarkup, QROutputInterface, QRString};
 use chillerlan\Settings\SettingsContainerInterface;
 use function class_exists, class_implements, in_array, mb_convert_encoding, mb_detect_encoding;
 
@@ -68,30 +68,20 @@ class QRCode{
 	public const OUTPUT_CUSTOM      = 'custom';
 
 	/**
-	 * Map of built-in output modules => capabilities
+	 * Map of built-in output modes => modules
 	 *
-	 * @var string[][]
+	 * @var string[]
 	 */
 	public const OUTPUT_MODES = [
-		QRMarkup::class => [
-			self::OUTPUT_MARKUP_SVG,
-			self::OUTPUT_MARKUP_HTML,
-		],
-		QRImage::class => [
-			self::OUTPUT_IMAGE_PNG,
-			self::OUTPUT_IMAGE_GIF,
-			self::OUTPUT_IMAGE_JPG,
-		],
-		QRString::class => [
-			self::OUTPUT_STRING_JSON,
-			self::OUTPUT_STRING_TEXT,
-		],
-		QRImagick::class => [
-			self::OUTPUT_IMAGICK,
-		],
-		QRFpdf::class => [
-			self::OUTPUT_FPDF,
-		],
+		self::OUTPUT_MARKUP_SVG  => QRMarkup::class,
+		self::OUTPUT_MARKUP_HTML => QRMarkup::class,
+		self::OUTPUT_IMAGE_PNG   => QRGdImage::class,
+		self::OUTPUT_IMAGE_GIF   => QRGdImage::class,
+		self::OUTPUT_IMAGE_JPG   => QRGdImage::class,
+		self::OUTPUT_STRING_JSON => QRString::class,
+		self::OUTPUT_STRING_TEXT => QRString::class,
+		self::OUTPUT_IMAGICK     => QRImagick::class,
+		self::OUTPUT_FPDF        => QRFpdf::class,
 	];
 
 	/**
@@ -135,9 +125,7 @@ public function render(string $data = null, string $file = null){
 
 					break;
 				}
-
 			}
-
 		}
 
 		return $this->initOutputInterface()->dump($file);
@@ -189,12 +177,10 @@ protected function initOutputInterface():QROutputInterface{
 			return $this->initCustomOutputInterface();
 		}
 
-		foreach($this::OUTPUT_MODES as $outputInterface => $modes){
-
-			if(in_array($this->options->outputType, $modes)){
-				return new $outputInterface($this->options, $this->getMatrix());
-			}
+		$outputInterface = $this::OUTPUT_MODES[$this->options->outputType] ?? false;
 
+		if($outputInterface){
+			return new $outputInterface($this->options, $this->getMatrix());
 		}
 
 		throw new QRCodeOutputException('invalid output type');