diff --git a/Readme.md b/Readme.md
index 2a5b960..99652ca 100644
--- a/Readme.md
+++ b/Readme.md
@@ -18,7 +18,7 @@ Install through [composer](https://getcomposer.org/doc/00-intro.md):
composer require picqer/php-barcode-generator
```
-If you want to generate PNG or JPG images, you need the GD library or Imagick installed on your system as well.
+If you want to generate PNG or JPG images, you need the GD library or Imagick installed on your system as well. For SVG or HTML renders, there are no dependencies.
## Usage
You want a barcode for a specific "type" (for example Code 128 or UPC) in a specific image format (for example PNG or SVG).
@@ -54,21 +54,28 @@ $barcode = (new Picqer\Barcode\Types\TypeCode128())->getBarcode('081231723897');
$renderer = new Picqer\Barcode\Renderers\PngRenderer();
$renderer->setForegroundColor($colorRed);
-// Save PNG to the filesystem, with widthFactor 3 and height of 50 pixels
-file_put_contents('barcode.png', $renderer->render($barcode, 3, 50));
+// Save PNG to the filesystem, with widthFactor 3 (width of the barcode x 3) and height of 50 pixels
+file_put_contents('barcode.png', $renderer->render($barcode, $barcode->getWidth() * 3, 50));
```
## Image renderers
Available image renderers: SVG, PNG, JPG and HTML.
-Each renderer has their own options. Only the barcode is required, the rest is optional. Here are all the options for each renderers:
+They all conform to the RendererInterface and have the same `render()` method. Some renderers have extra options as well, via set*() methods.
+
+### Widths
+The render() method needs the Barcode object, the width and height. **For JPG/PNG images**, you only get a valid barcode if you give a width that is a factor of the width of the Barcode object. That is why the examples show `$barcode->getWidth() * 2` to make the image 2 times wider in pixels then the width of the barcode data. You *can* give an arbitrary number as width and the image will be scaled as best as possible, but without anti-aliasing, it will not be perfectly valid.
+
+HTML and SVG renderers can handle any width and height, even floats.
+
+Here are all the options for each renderer:
### SVG
A vector based SVG image. Gives the best quality to print.
```php
$renderer = new Picqer\Barcode\Renderers\SvgRenderer();
-$renderer->setForegroundColor('red'); // Give a color for the bars, default is black
-$renderer->setBackgroundColor('blue'); // Give a color for the background, default is transparent
+$renderer->setForegroundColor([255, 0, 0]); // Give a color red for the bars, default is black. Give it as 3 times 0-255 values for red, green and blue.
+$renderer->setBackgroundColor([0, 0, 255]); // Give a color blue for the background, default is transparent. Give it as 3 times 0-255 values for red, green and blue.
$renderer->setSvgType($renderer::TYPE_SVG_INLINE); // Changes the output to be used inline inside HTML documents, instead of a standalone SVG image (default)
$renderer->setSvgType($renderer::TYPE_SVG_STANDALONE); // If you want to force the default, create a stand alone SVG image
@@ -91,8 +98,8 @@ $renderer->render($barcode, 5, 40); // Width factor (how many pixel wide every b
Gives HTML to use inline in a full HTML document.
```php
$renderer = new Picqer\Barcode\Renderers\HtmlRenderer();
-$renderer->setForegroundColor('red'); // Give a color for the bars, default is black
-$renderer->setBackgroundColor('blue'); // Give a color for the background, default is transparent
+$renderer->setForegroundColor([255, 0, 0]); // Give a color red for the bars, default is black. Give it as 3 times 0-255 values for red, green and blue.
+$renderer->setBackgroundColor([0, 0, 255]); // Give a color blue for the background, default is transparent. Give it as 3 times 0-255 values for red, green and blue.
$renderer->render($barcode, 450.20, 75); // Width and height support floats
````
@@ -101,8 +108,8 @@ $renderer->render($barcode, 450.20, 75); // Width and height support floats
Give HTML here the barcode is using the full width and height, to put inside a container/div that has a fixed size.
```php
$renderer = new Picqer\Barcode\Renderers\DynamicHtmlRenderer();
-$renderer->setForegroundColor('red'); // Give a color for the bars, default is black
-$renderer->setBackgroundColor('blue'); // Give a color for the background, default is transparent
+$renderer->setForegroundColor([255, 0, 0]); // Give a color red for the bars, default is black. Give it as 3 times 0-255 values for red, green and blue.
+$renderer->setBackgroundColor([0, 0, 255]); // Give a color blue for the background, default is transparent. Give it as 3 times 0-255 values for red, green and blue.
$renderer->render($barcode);
````
@@ -163,7 +170,7 @@ If you want to use PNG or JPG images, you need to install [Imagick](https://www.
```php
$barcode = (new Picqer\Barcode\Types\TypeCode128())->getBarcode('081231723897');
$renderer = new Picqer\Barcode\Renderers\PngRenderer();
-echo '';
+echo '';
```
### Save JPG barcode to disk
@@ -171,7 +178,7 @@ echo 'backgroundColor ? ';background-color:' . $this->backgroundColor : '') . '">' . PHP_EOL;
+ $html = '
' . PHP_EOL;
$positionHorizontal = 0;
/** @var BarcodeBar $bar */
@@ -26,7 +27,7 @@ public function render(Barcode $barcode): string
$positionVertical = round(($bar->getPositionVertical() / $barcode->getHeight() * 100), 3);
// draw a vertical bar
- $html .= '
' . PHP_EOL;
+ $html .= '
' . PHP_EOL;
}
$positionHorizontal += $barWidth;
@@ -37,15 +38,13 @@ public function render(Barcode $barcode): string
return $html;
}
- // Use HTML color definitions, like 'red' or '#ff0000'
- public function setForegroundColor(string $color): self
+ public function setForegroundColor(array $color): self
{
$this->foregroundColor = $color;
return $this;
}
- // Use HTML color definitions, like 'red' or '#ff0000'
- public function setBackgroundColor(?string $color): self
+ public function setBackgroundColor(?array $color): self
{
$this->backgroundColor = $color;
return $this;
diff --git a/src/Renderers/HtmlRenderer.php b/src/Renderers/HtmlRenderer.php
index fae8ffa..9b93651 100644
--- a/src/Renderers/HtmlRenderer.php
+++ b/src/Renderers/HtmlRenderer.php
@@ -5,16 +5,16 @@
use Picqer\Barcode\Barcode;
use Picqer\Barcode\BarcodeBar;
-class HtmlRenderer
+class HtmlRenderer implements RendererInterface
{
- protected string $foregroundColor = 'black';
- protected ?string $backgroundColor = null;
+ protected array $foregroundColor = [0, 0, 0];
+ protected ?array $backgroundColor = null;
public function render(Barcode $barcode, float $width = 200, float $height = 30): string
{
$widthFactor = $width / $barcode->getWidth();
- $html = '
) . ')
';
+echo ' * 2)) . ')
';
```
### Save JPG barcode to disk
@@ -171,7 +178,7 @@ echo ')->getBarcode('081231723897');
$renderer = new Picqer\Barcode\Renderers\JpgRenderer();
-file_put_contents('barcode.jpg', $renderer->render($barcode));
+file_put_contents('barcode.jpg', $renderer->render($barcode, $barcode->getWidth() * 2));
```
### Oneliner SVG output to disk
@@ -182,6 +189,8 @@ file_put_contents('barcode.svg', (new Picqer\Barcode\Renderers\SvgRenderer())->r
## Upgrading to v3
There is no need to change anything when upgrading from v2 to v3. Above you find the new preferred way of using this library since v3. But the old style still works.
+To give the renderers the same interface, setting colors is now always with an array of RGB colors. If you use the old BarcodeGenerator* classes and use colors with names ('red') or hex codes (#3399ef), these will be converted using the ColorHelper. All hexcodes are supported, but for names of colors only the basic colors are supported.
+
If you want to convert to the new style, here is an example:
```php
// Old style
@@ -194,7 +203,7 @@ $renderer = new Picqer\Barcode\Renderers\SvgRenderer();
echo $renderer->render($barcode);
```
-The width in the SVG and HTML renderer is now the width of the end result, instead of the widthFactor. If you want to keep dynamic widths, you can get the width of the encoded Barcode and multiply it by the widthFactor to get the same result as before. See here an example for a widthFactor of 2:
+The width in the renderer is now the width of the end result, instead of the widthFactor. If you want to keep dynamic widths, you can get the width of the encoded Barcode and multiply it by the widthFactor to get the same result as before. See here an example for a widthFactor of 2:
```php
// Old style
$generator = new Picqer\Barcode\BarcodeGeneratorSVG();
diff --git a/generate-verified-files.php b/generate-verified-files.php
index 3d02f76..d513546 100644
--- a/generate-verified-files.php
+++ b/generate-verified-files.php
@@ -15,13 +15,13 @@
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');
+$svgRendererRed->setBackgroundColor([255, 0, 0]);
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');
+$htmlRendererRed->setBackgroundColor([255, 0, 0]);
file_put_contents('tests/verified-files/081231723897-code128-red-background.html', $htmlRendererRed->render($barcode, $barcode->getWidth() * 2));
$barcode = $typeEncoderIMB->getBarcode('12345678903');
diff --git a/src/BarcodeGeneratorDynamicHTML.php b/src/BarcodeGeneratorDynamicHTML.php
index c08a4ed..5cebc2b 100644
--- a/src/BarcodeGeneratorDynamicHTML.php
+++ b/src/BarcodeGeneratorDynamicHTML.php
@@ -3,6 +3,7 @@
namespace Picqer\Barcode;
use Picqer\Barcode\Exceptions\UnknownTypeException;
+use Picqer\Barcode\Helpers\ColorHelper;
class BarcodeGeneratorDynamicHTML extends BarcodeGenerator
{
@@ -21,7 +22,7 @@ public function getBarcode(string $barcode, $type, string $foregroundColor = 'bl
$barcodeData = $this->getBarcodeData($barcode, $type);
$renderer = new \Picqer\Barcode\Renderers\DynamicHtmlRenderer();
- $renderer->setForegroundColor($foregroundColor);
+ $renderer->setForegroundColor(ColorHelper::getArrayFromColorString($foregroundColor));
return $renderer->render($barcodeData);
}
diff --git a/src/BarcodeGeneratorHTML.php b/src/BarcodeGeneratorHTML.php
index bc30f25..01b8b95 100644
--- a/src/BarcodeGeneratorHTML.php
+++ b/src/BarcodeGeneratorHTML.php
@@ -3,6 +3,7 @@
namespace Picqer\Barcode;
use Picqer\Barcode\Exceptions\UnknownTypeException;
+use Picqer\Barcode\Helpers\ColorHelper;
class BarcodeGeneratorHTML extends BarcodeGenerator
{
@@ -25,7 +26,7 @@ public function getBarcode(string $barcode, $type, int $widthFactor = 2, int $he
$width = round(($barcodeData->getWidth() * $widthFactor), 3);
$renderer = new \Picqer\Barcode\Renderers\HtmlRenderer();
- $renderer->setForegroundColor($foregroundColor);
+ $renderer->setForegroundColor(ColorHelper::getArrayFromColorString($foregroundColor));
return $renderer->render($barcodeData, $width, $height);
}
diff --git a/src/BarcodeGeneratorJPG.php b/src/BarcodeGeneratorJPG.php
index 2e27001..51eaf48 100644
--- a/src/BarcodeGeneratorJPG.php
+++ b/src/BarcodeGeneratorJPG.php
@@ -34,7 +34,7 @@ public function getBarcode(string $barcode, $type, int $widthFactor = 2, int $he
}
}
- return $renderer->render($barcodeData, $widthFactor, $height);
+ return $renderer->render($barcodeData, $barcodeData->getWidth() * $widthFactor, $height);
}
/**
diff --git a/src/BarcodeGeneratorPNG.php b/src/BarcodeGeneratorPNG.php
index 31edc56..f8f3d0c 100644
--- a/src/BarcodeGeneratorPNG.php
+++ b/src/BarcodeGeneratorPNG.php
@@ -34,7 +34,7 @@ public function getBarcode(string $barcode, $type, int $widthFactor = 2, int $he
}
}
- return $renderer->render($barcodeData, $widthFactor, $height);
+ return $renderer->render($barcodeData, $barcodeData->getWidth() * $widthFactor, $height);
}
/**
diff --git a/src/BarcodeGeneratorSVG.php b/src/BarcodeGeneratorSVG.php
index ef7d63f..64b725e 100644
--- a/src/BarcodeGeneratorSVG.php
+++ b/src/BarcodeGeneratorSVG.php
@@ -3,6 +3,7 @@
namespace Picqer\Barcode;
use Picqer\Barcode\Exceptions\UnknownTypeException;
+use Picqer\Barcode\Helpers\ColorHelper;
class BarcodeGeneratorSVG extends BarcodeGenerator
{
@@ -25,7 +26,7 @@ public function getBarcode(string $barcode, $type, float $widthFactor = 2, float
$width = round(($barcodeData->getWidth() * $widthFactor), 3);
$renderer = new \Picqer\Barcode\Renderers\SvgRenderer();
- $renderer->setForegroundColor($foregroundColor);
+ $renderer->setForegroundColor(ColorHelper::getArrayFromColorString($foregroundColor));
return $renderer->render($barcodeData, $width, $height);
}
diff --git a/src/Exceptions/UnknownColorException.php b/src/Exceptions/UnknownColorException.php
new file mode 100644
index 0000000..0401857
--- /dev/null
+++ b/src/Exceptions/UnknownColorException.php
@@ -0,0 +1,5 @@
+<?php
+
+namespace Picqer\Barcode\Exceptions;
+
+class UnknownColorException extends BarcodeException {}
diff --git a/src/Helpers/ColorHelper.php b/src/Helpers/ColorHelper.php
new file mode 100644
index 0000000..52d348d
--- /dev/null
+++ b/src/Helpers/ColorHelper.php
@@ -0,0 +1,46 @@
+<?php
+
+namespace Picqer\Barcode\Helpers;
+
+use Picqer\Barcode\Exceptions\UnknownColorException;
+
+class ColorHelper
+{
+ // Convert textual color values, to array of 3 colors 0-255
+ // Can be )
backgroundColor ? ';background-color:' . $this->backgroundColor : '') . '">' . PHP_EOL;
+ $html = '