diff --git a/generate-verified-files.php b/generate-verified-files.php index 386da50..3d02f76 100644 --- a/generate-verified-files.php +++ b/generate-verified-files.php @@ -14,8 +14,15 @@ file_put_contents('tests/verified-files/081231723897-ean13.svg', $svgRenderer->render($barcode, $barcode->getWidth() * 2)); file_put_contents('tests/verified-files/081231723897-ean13-fractional-width.svg', $svgRenderer->render($barcode, $barcode->getWidth() * 0.25, 25.75)); +$svgRendererRed = new Picqer\Barcode\Renderers\SvgRenderer(); +$svgRendererRed->setBackgroundColor('red'); +file_put_contents('tests/verified-files/081231723897-ean13-red-background.svg', $svgRendererRed->render($barcode, $barcode->getWidth() * 2)); + $barcode = $typeEncoderCode128->getBarcode('081231723897'); file_put_contents('tests/verified-files/081231723897-code128.html', $htmlRenderer->render($barcode, $barcode->getWidth() * 2)); +$htmlRendererRed = new Picqer\Barcode\Renderers\HtmlRenderer(); +$htmlRendererRed->setBackgroundColor('red'); +file_put_contents('tests/verified-files/081231723897-code128-red-background.html', $htmlRendererRed->render($barcode, $barcode->getWidth() * 2)); $barcode = $typeEncoderIMB->getBarcode('12345678903'); file_put_contents('tests/verified-files/12345678903-imb.html', $htmlRenderer->render($barcode, $barcode->getWidth() * 2)); diff --git a/src/Renderers/DynamicHtmlRenderer.php b/src/Renderers/DynamicHtmlRenderer.php index 66a3e52..45500e5 100644 --- a/src/Renderers/DynamicHtmlRenderer.php +++ b/src/Renderers/DynamicHtmlRenderer.php @@ -10,10 +10,11 @@ class DynamicHtmlRenderer protected const WIDTH_PRECISION = 6; protected string $foregroundColor = 'black'; + protected ?string $backgroundColor = null; public function render(Barcode $barcode): string { - $html = '
' . PHP_EOL; + $html = '
' . PHP_EOL; $positionHorizontal = 0; /** @var BarcodeBar $bar */ @@ -36,10 +37,17 @@ public function render(Barcode $barcode): string return $html; } + // Use HTML color definitions, like 'red' or '#ff0000' public function setForegroundColor(string $color): self { $this->foregroundColor = $color; + return $this; + } + // Use HTML color definitions, like 'red' or '#ff0000' + public function setBackgroundColor(?string $color): self + { + $this->backgroundColor = $color; return $this; } } diff --git a/src/Renderers/HtmlRenderer.php b/src/Renderers/HtmlRenderer.php index 77ba389..fae8ffa 100644 --- a/src/Renderers/HtmlRenderer.php +++ b/src/Renderers/HtmlRenderer.php @@ -8,12 +8,13 @@ class HtmlRenderer { protected string $foregroundColor = 'black'; + protected ?string $backgroundColor = null; public function render(Barcode $barcode, float $width = 200, float $height = 30): string { $widthFactor = $width / $barcode->getWidth(); - $html = '
' . PHP_EOL; + $html = '
' . PHP_EOL; $positionHorizontal = 0; /** @var BarcodeBar $bar */ @@ -36,10 +37,17 @@ public function render(Barcode $barcode, float $width = 200, float $height = 30) return $html; } + // Use HTML color definitions, like 'red' or '#ff0000' public function setForegroundColor(string $color): self { $this->foregroundColor = $color; - + return $this; + } + + // Use HTML color definitions, like 'red' or '#ff0000' + public function setBackgroundColor(?string $color): self + { + $this->backgroundColor = $color; return $this; } } diff --git a/src/Renderers/JpgRenderer.php b/src/Renderers/JpgRenderer.php index 132ec10..1c835f7 100644 --- a/src/Renderers/JpgRenderer.php +++ b/src/Renderers/JpgRenderer.php @@ -9,7 +9,14 @@ class JpgRenderer extends PngRenderer protected function createImagickImageObject(int $width, int $height): Imagick { $image = new Imagick(); - $image->newImage($width, $height, 'none', 'JPG'); + if ($this->backgroundColor !== null) { + // Colored background + $backgroundColor = new ImagickPixel('rgb(' . implode(',', $this->backgroundColor) . ')'); + } else { + // Use transparent background + $backgroundColor = new ImagickPixel('none'); + } + $image->newImage($width, $height, $backgroundColor, 'JPG'); return $image; } diff --git a/src/Renderers/PngRenderer.php b/src/Renderers/PngRenderer.php index 8297d88..226a7b7 100644 --- a/src/Renderers/PngRenderer.php +++ b/src/Renderers/PngRenderer.php @@ -12,6 +12,8 @@ class PngRenderer { protected array $foregroundColor = [0, 0, 0]; + protected ?array $backgroundColor = null; + protected bool $useImagick; /** @@ -52,6 +54,7 @@ public function render(Barcode $barcode, int $widthFactor = 2, int $height = 30) $width = (int)round($barcode->getWidth() * $widthFactor); if ($this->useImagick) { + $image = $this->createImagickImageObject($width, $height); $imagickBarsShape = new ImagickDraw(); $imagickBarsShape->setFillColor(new ImagickPixel('rgb(' . implode(',', $this->foregroundColor) .')')); } else { @@ -80,7 +83,6 @@ public function render(Barcode $barcode, int $widthFactor = 2, int $height = 30) } if ($this->useImagick) { - $image = $this->createImagickImageObject($width, $height); $image->drawImage($imagickBarsShape); return $image->getImageBlob(); } else { @@ -90,18 +92,34 @@ public function render(Barcode $barcode, int $widthFactor = 2, int $height = 30) } } + // Use RGB color definitions, like [0, 0, 0] or [255, 255, 255] public function setForegroundColor(array $color): self { $this->foregroundColor = $color; - + return $this; + } + + // Use RGB color definitions, like [0, 0, 0] or [255, 255, 255] + // If no color is set, the background will be transparent + public function setBackgroundColor(?array $color): self + { + $this->backgroundColor = $color; return $this; } protected function createGdImageObject(int $width, int $height) { $image = \imagecreate($width, $height); - $colorBackground = \imagecolorallocate($image, 255, 255, 255); - \imagecolortransparent($image, $colorBackground); + + if ($this->backgroundColor !== null) { + // Colored background + $backgroundColor = \imagecolorallocate($image, $this->backgroundColor[0], $this->backgroundColor[1], $this->backgroundColor[2]); + \imagefill($image, 0, 0, $backgroundColor); + } else { + // Use transparent background + $backgroundColor = \imagecolorallocate($image, 255, 255, 255); + \imagecolortransparent($image, $backgroundColor); + } return $image; } @@ -109,7 +127,14 @@ protected function createGdImageObject(int $width, int $height) protected function createImagickImageObject(int $width, int $height): Imagick { $image = new Imagick(); - $image->newImage($width, $height, 'none', 'PNG'); + if ($this->backgroundColor !== null) { + // Colored background + $backgroundColor = new ImagickPixel('rgb(' . implode(',', $this->backgroundColor) . ')'); + } else { + // Use transparent background + $backgroundColor = new ImagickPixel('none'); + } + $image->newImage($width, $height, $backgroundColor, 'PNG'); return $image; } diff --git a/src/Renderers/SvgRenderer.php b/src/Renderers/SvgRenderer.php index 6af44b3..418333a 100644 --- a/src/Renderers/SvgRenderer.php +++ b/src/Renderers/SvgRenderer.php @@ -9,6 +9,7 @@ class SvgRenderer { protected string $foregroundColor = 'black'; + protected ?string $backgroundColor = null; protected string $svgType = self::TYPE_SVG_STANDALONE; public const TYPE_SVG_STANDALONE = 'standalone'; @@ -25,6 +26,12 @@ public function render(Barcode $barcode, float $width = 200, float $height = 30) } $svg .= '' . PHP_EOL; $svg .= "\t" . '' . htmlspecialchars($barcode->getBarcode()) . '' . PHP_EOL; + + // Add background rectangle if backgroundColor is set + if ($this->backgroundColor !== null) { + $svg .= "\t" . '' . PHP_EOL; + } + $svg .= "\t" . '' . PHP_EOL; // print bars @@ -55,6 +62,12 @@ public function setForegroundColor(string $color): self return $this; } + public function setBackgroundColor(?string $color): self + { + $this->backgroundColor = $color; + return $this; + } + public function setSvgType(string $svgType): self { if (! in_array($svgType, [self::TYPE_SVG_INLINE, self::TYPE_SVG_STANDALONE])) { diff --git a/tests/HtmlRendererTest.php b/tests/HtmlRendererTest.php index 803d2c0..387a43e 100644 --- a/tests/HtmlRendererTest.php +++ b/tests/HtmlRendererTest.php @@ -23,4 +23,15 @@ public function test_html_barcode_generator_can_generate_imb_barcode_to_test_hei $this->assertStringEqualsFile('tests/verified-files/12345678903-imb.html', $generated); } + + public function test_html_barcode_generator_with_background() + { + $barcode = (new Picqer\Barcode\Types\TypeCode128())->getBarcode('081231723897'); + + $renderer = new Picqer\Barcode\Renderers\HtmlRenderer(); + $renderer->setBackgroundColor('red'); + $generated = $renderer->render($barcode, $barcode->getWidth() * 2); + + $this->assertStringEqualsFile('tests/verified-files/081231723897-code128-red-background.html', $generated); + } } diff --git a/tests/SvgRendererTest.php b/tests/SvgRendererTest.php index aa1e97f..a8d73e6 100644 --- a/tests/SvgRendererTest.php +++ b/tests/SvgRendererTest.php @@ -56,4 +56,15 @@ public function test_svg_renderer_throws_exception_wrong_type() $renderer = new Picqer\Barcode\Renderers\SvgRenderer(); $renderer->setSvgType('other'); } + + public function test_svg_barcode_generator_can_use_background_color() + { + $barcode = (new Picqer\Barcode\Types\TypeEan13())->getBarcode('081231723897'); + + $renderer = new Picqer\Barcode\Renderers\SvgRenderer(); + $renderer->setBackgroundColor('red'); + $generated = $renderer->render($barcode, 190); + + $this->assertStringEqualsFile('tests/verified-files/081231723897-ean13-red-background.svg', $generated); + } } diff --git a/tests/verified-files/081231723897-code128-red-background.html b/tests/verified-files/081231723897-code128-red-background.html new file mode 100644 index 0000000..6023c22 --- /dev/null +++ b/tests/verified-files/081231723897-code128-red-background.html @@ -0,0 +1,30 @@ +
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
diff --git a/tests/verified-files/081231723897-ean13-red-background.svg b/tests/verified-files/081231723897-ean13-red-background.svg new file mode 100644 index 0000000..406af57 --- /dev/null +++ b/tests/verified-files/081231723897-ean13-red-background.svg @@ -0,0 +1,38 @@ + + + + 0812317238973 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +