allow returning the image resource

Author: codemasher

src/Output/QRFpdf.php

@@ -65,8 +65,10 @@ protected function setModuleValues():void{
 
 	/**
 	 * @inheritDoc
+	 *
+	 * @return string|\FPDF
 	 */
-	public function dump(string $file = null):string{
+	public function dump(string $file = null){
 		$file = $file ?? $this->options->cachefile;
 
 		$fpdf = new FPDF('P', $this->options->fpdfMeasureUnit, [$this->length, $this->length]);
@@ -90,6 +92,10 @@ public function dump(string $file = null):string{
 
 		}
 
+		if($this->options->returnResource){
+			return $fpdf;
+		}
+
 		$pdfData = $fpdf->Output('S');
 
 		if($file !== null){

src/Output/QRImage.php

@@ -65,8 +65,10 @@ protected function setModuleValues():void{
 
 	/**
 	 * @inheritDoc
+	 *
+	 * @return string|resource
 	 */
-	public function dump(string $file = null):string{
+	public function dump(string $file = null){
 		$this->image = imagecreatetruecolor($this->length, $this->length);
 
 		// avoid: Indirect modification of overloaded property $imageTransparencyBG has no effect
@@ -86,6 +88,10 @@ public function dump(string $file = null):string{
 			}
 		}
 
+		if($this->options->returnResource){
+			return $this->image;
+		}
+
 		$imageData = $this->dumpImage($file);
 
 		if((bool)$this->options->imageBase64){

src/Output/QRImagick.php

@@ -24,6 +24,11 @@
  */
 class QRImagick extends QROutputAbstract{
 
+	/**
+	 * @var \Imagick
+	 */
+	protected $imagick;
+
 	/**
 	 * @inheritDoc
 	 */
@@ -45,19 +50,27 @@ protected function setModuleValues():void{
 
 	/**
 	 * @inheritDoc
+	 *
+	 * @return string|\Imagick
 	 */
-	public function dump(string $file = null):string{
-		$file    = $file ?? $this->options->cachefile;
-		$imagick = new Imagick;
+	public function dump(string $file = null){
+		$file          = $file ?? $this->options->cachefile;
+		$this->imagick = new Imagick;
 
-		$imagick->newImage(
+		$this->imagick->newImage(
 			$this->length,
 			$this->length,
 			new ImagickPixel($this->options->imagickBG ?? 'transparent'),
 			$this->options->imagickFormat
 		);
 
-		$imageData = $this->drawImage($imagick);
+		$this->drawImage();
+
+		if($this->options->returnResource){
+			return $this->imagick;
+		}
+
+		$imageData = $this->imagick->getImageBlob();
 
 		if($file !== null){
 			$this->saveToFile($imageData, $file);
@@ -67,11 +80,9 @@ public function dump(string $file = null):string{
 	}
 
 	/**
-	 * @param \Imagick $imagick
-	 *
-	 * @return string
+	 * @return void
 	 */
-	protected function drawImage(Imagick $imagick):string{
+	protected function drawImage():void{
 		$draw = new ImagickDraw;
 
 		foreach($this->matrix->matrix() as $y => $row){
@@ -88,9 +99,7 @@ protected function drawImage(Imagick $imagick):string{
 			}
 		}
 
-		$imagick->drawImage($draw);
-
-		return (string)$imagick;
+		$this->imagick->drawImage($draw);
 	}
 
 }

src/QROptions.php

@@ -42,6 +42,7 @@
  * @property string $markupDark
  * @property string $markupLight
  *
+ * @property bool   $returnResource
  * @property bool   $imageBase64
  * @property bool   $imageTransparent
  * @property array  $imageTransparencyBG

src/QROptionsTrait.php

@@ -188,6 +188,22 @@ trait QROptionsTrait{
 	 */
 	protected $markupLight = '#fff';
 
+	/**
+	 * Return the image resource instead of a render if applicable.
+	 * This option overrides other output options, such as $cachefile and $imageBase64.
+	 *
+	 * Supported by the following modules:
+	 *
+	 * - QRImage:   resource
+	 * - QRImagick: Imagick
+	 * - QRFpdf:    FPDF
+	 *
+	 * @see \chillerlan\QRCode\Output\QROutputInterface::dump()
+	 *
+	 * @var bool
+	 */
+	protected $returnResource = false;
+
 	/**
 	 * toggle base64 or raw image data
 	 *

tests/Output/QRFpdfTest.php

@@ -71,4 +71,12 @@ public function testRenderImage():void{
 		$this::assertSame($expected, $actual);
 	}
 
+	public function testOutputGetResource():void{
+		$this->options->returnResource = true;
+
+		$this->setOutputInterface();
+
+		$this::assertInstanceOf(FPDF::class, $this->outputInterface->dump());
+	}
+
 }

tests/Output/QRImageTest.php

@@ -58,4 +58,12 @@ public function testSetModuleValues(){
 		$this->assertTrue(true); // tricking the code coverage
 	}
 
+	public function testOutputGetResource():void{
+		$this->options->returnResource = true;
+
+		$this->setOutputInterface();
+
+		$this::assertIsResource($this->outputInterface->dump());
+	}
+
 }

tests/Output/QRImagickTest.php

@@ -12,6 +12,7 @@
 
 namespace chillerlan\QRCodeTest\Output;
 
+use Imagick;
 use chillerlan\QRCode\{QRCode, Output\QRImagick};
 
 class QRImagickTest extends QROutputTestAbstract{
@@ -52,4 +53,12 @@ public function testSetModuleValues(){
 		$this->assertTrue(true); // tricking the code coverage
 	}
 
+	public function testOutputGetResource():void{
+		$this->options->returnResource = true;
+
+		$this->setOutputInterface();
+
+		$this::assertInstanceOf(Imagick::class, $this->outputInterface->dump());
+	}
+
 }