-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
diff --git a/API-QRCode.html b/API-QRCode.html
index d09a6bad2..11a66a3fa 100644
--- a/API-QRCode.html
+++ b/API-QRCode.html
@@ -99,6 +99,8 @@
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
diff --git a/API-QRMatrix.html b/API-QRMatrix.html
index f828521d0..0ffd8b7a4 100644
--- a/API-QRMatrix.html
+++ b/API-QRMatrix.html
@@ -99,6 +99,8 @@
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
diff --git a/API-QROptions.html b/API-QROptions.html
index 7319509fb..6139945d2 100644
--- a/API-QROptions.html
+++ b/API-QROptions.html
@@ -99,6 +99,8 @@
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
@@ -520,127 +535,121 @@
a valid GD or Imagick color value
Sets a transparency color for when
QROptions::$imageTransparentis set to true. Defaults toQROptions::$bgColor.$pngCompression$qualityint-1-1...9imagepng()compression level, -1 = auto*
compression quality setting for
imagejpeg(),imagepng(),imagewebp(),Imagick::setImageCompressionQuality()$jpegQualityint850...100imagejpeg()quality$imagickFormat$imagickFormatstring'png'*
ImageMagick output type, see
Imagick::setType()$cssClass$cssClassstring'qrcode'*
A common css class
$markupDark$markupDarkstring'#000'*
Markup substitute for dark (CSS value)
$markupLight$markupLightstring'#fff'*
Markup substitute for light (CSS value)
$svgAddXmlHeader$svgAddXmlHeaderbooltrue*
Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML
$svgOpacity$svgOpacityfloat1.00...1SVG opacity
$svgDefs$svgDefsstring''*
Anything in the
<defs>tag$svgViewBoxSize$svgViewBoxSizeint|nullnull*
SVG viewBox size. A single integer number which defines width/height of the viewBox attribute
viewBox="0 0 x x".$svgPreserveAspectRatio$svgPreserveAspectRatiostring'xMidYMid'*
$svgWidth$svgWidthstring|nullnull*
Optional “width” attribute with the specified value (note that the value is not checked!)
$svgHeight$svgHeightstring|nullnull*
Optional “height” attribute with the specified value (note that the value is not checked!)
$textDark$textDarkstring'██'*
String substitute for dark
$textLight$textLightstring'░░'*
String substitute for light
$textLineStart$textLineStartstring''*
An optional line prefix, e.g. empty space to align the QR Code in a console
$jsonAsBooleans$jsonAsBooleansboolfalse*
Whether to return matrix values in JSON as booleans or $M_TYPE integers
$fpdfMeasureUnit$fpdfMeasureUnitstring'pt'*
Measurement unit for FPDF output: pt, mm, cm, in
$readerUseImagickIfAvailable$readerUseImagickIfAvailableboolfalse*
Use Imagick (if available) when reading QR Codes
$readerGrayscale$readerGrayscaleboolfalse*
Grayscale the image before reading
$readerIncreaseContrast$readerIncreaseContrastboolfalse*
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
diff --git a/Appendix-License.html b/Appendix-License.html
index 6fc0e8713..dc9b844bd 100644
--- a/Appendix-License.html
+++ b/Appendix-License.html
@@ -98,6 +98,8 @@
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -105,6 +107,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -112,6 +116,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -119,6 +125,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -126,6 +134,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -133,6 +143,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -140,6 +152,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
diff --git a/Appendix-Terminology.html b/Appendix-Terminology.html
index 84b310eb4..79fc0f87b 100644
--- a/Appendix-Terminology.html
+++ b/Appendix-Terminology.html
@@ -99,6 +99,8 @@
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
diff --git a/Appendix-URI-Content.html b/Appendix-URI-Content.html
index bf757e0d7..d3207b8aa 100644
--- a/Appendix-URI-Content.html
+++ b/Appendix-URI-Content.html
@@ -99,6 +99,8 @@
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
diff --git a/Built-In-Output-QREps.html b/Built-In-Output-QREps.html
index 04610fd02..7e4b9280a 100644
--- a/Built-In-Output-QREps.html
+++ b/Built-In-Output-QREps.html
@@ -99,6 +99,8 @@
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
@@ -269,7 +284,67 @@
QREps
-Class
+QREps: Encapsulated Postscript (EPS) outputClass
+QREps: Encapsulated Postscript (EPS) output.+ +Example
+See: EPS example
+Set the options:
+++$options = new QROptions; + +$options->outputType = QROutputInterface::EPS; +$options->scale = 5; +$options->drawLightModules = false; +// colors can be specified either as [R, G, B] or [C, M, Y, K] (0-255) +$options->bgColor = [222, 222, 222]; +$options->moduleValues = [ + QRMatrix::M_FINDER_DARK => [0, 63, 255], // dark (true) + QRMatrix::M_FINDER_DOT => [0, 63, 255], // finder dot, dark (true) + QRMatrix::M_FINDER => [233, 233, 233], // light (false) + QRMatrix::M_ALIGNMENT_DARK => [255, 0, 255], + QRMatrix::M_ALIGNMENT => [233, 233, 233], + QRMatrix::M_DATA_DARK => [0, 0, 0], + QRMatrix::M_DATA => [233, 233, 233], +]; +
Render and save to file:
+++$data = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'; +$file = __DIR__.'/qrcode.eps'; + +(new QRCode($options))->render($data, $file); +
Push as file download in a browser:
+++header('Content-type: application/postscript'); +header('Content-Disposition: filename="qrcode.eps"'); + +echo (new QRCode($options))->render($data); + +exit; +
+ Additional methods
++ +
+method
return
description
(protected)
formatColor(array $values)stringSet the color format string
(protected)
module(int $x, int $y, int $M_TYPE)stringReturns a path segment for a single module
Options that affect this module
@@ -279,16 +354,19 @@ -
$drawLightModulesbool$bgColorarray$connectPathsbool$excludeFromConnect$drawLightModulesbool$excludeFromConnectarray$scale$scaleint$returnResourceN/A
$imageBase64N/A
$bgColor$circleRadiusnot implemented
$drawCircularModulesnot implemented
$circleRadius$outputBase64N/A
$imageTransparentN/A
$keepAsSquarenot implemented
$keepAsSquarenot implemented
$imageTransparent$returnResourceN/A
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
@@ -270,6 +285,71 @@
QRFpdf
Class
+QRFpdf: Portable Document Format (PDF) output via FPDF+ +Example
+See: FPDF example
+Set the options:
+++$options = new QROptions; + +$options->outputType = QROutputInterface::FPDF; +$options->scale = 5; +$options->fpdfMeasureUnit = 'mm'; // pt, mm, cm, in +$options->bgColor = [222, 222, 222]; // [R, G, B] +$options->drawLightModules = false; +$options->moduleValues = [ + QRMatrix::M_FINDER_DARK => [0, 63, 255], // dark (true) + QRMatrix::M_FINDER_DOT => [0, 63, 255], // finder dot, dark (true) + QRMatrix::M_FINDER => [255, 255, 255], // light (false) + QRMatrix::M_ALIGNMENT_DARK => [255, 0, 255], + QRMatrix::M_ALIGNMENT => [255, 255, 255], + QRMatrix::M_DATA_DARK => [0, 0, 0], + QRMatrix::M_DATA => [255, 255, 255], +]; +
Render the output:
+++$data = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'; +$out = (new QRCode($options))->render($data); // -> data:application/pdf;base64,... + +echo $out; +
Return the
+FPDFinstance (will ignore other output options):++$options->returnResource = true; + +/** @var \FPDF $fpdf */ +$fpdf = (new QRCode($options))->render($data); + +// do stuff with the FPDF instance... + +// ...dump output +header('application/pdf'); + +echo $fpdf->Output('S'); +
+ Additional methods
++ +
+method
return
description
(protected)
initFPDF()FPDFInitializes an FPDF instance
(protected)
module(int $x, int $y, int $M_TYPE)voidRenders a single module
Options that affect this module
@@ -279,14 +359,8 @@ -
$returnResourcebool$imageBase64bool$bgColormixedarray$drawLightModulesbool$fpdfMeasureUnitstring$outputBase64bool$returnResourcebool$scaleìnt@@ -305,27 +388,24 @@ - $drawCircularModulesN/A
$circleRadiusN/A
$keepAsSquare$circleRadiusN/A
$connectPathsN/A
$excludeFromConnect$drawCircularModulesN/A
$scalenot implemented
$excludeFromConnectN/A
$imageTransparentN/A
$keepAsSquareN/A
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
@@ -270,6 +285,99 @@
QRGdImage
Class
+QRGdImage: GdImage raster graphic output (GIF, JPG, PNG)+ +Example
+See: GdImage example
+Set the options:
+++$options = new QROptions; + +// $outputType can be one of: GDIMAGE_BMP, GDIMAGE_GIF, GDIMAGE_JPG, GDIMAGE_PNG, GDIMAGE_WEBP +$options->outputType = QROutputInterface::GDIMAGE_WEBP; +$options->quality = 90; +// the size of one qr module in pixels +$options->scale = 20; +$options->bgColor = [200, 150, 200]; +$options->imageTransparent = true; +// the color that will be set transparent +// @see https://www.php.net/manual/en/function.imagecolortransparent +$options->transparencyColor = [200, 150, 200]; +$options->drawCircularModules = true; +$options->drawLightModules = true; +$options->circleRadius = 0.4; +$options->keepAsSquare = [ + QRMatrix::M_FINDER_DARK, + QRMatrix::M_FINDER_DOT, + QRMatrix::M_ALIGNMENT_DARK, +]; +$options->moduleValues = [ + QRMatrix::M_FINDER_DARK => [0, 63, 255], // dark (true) + QRMatrix::M_FINDER_DOT => [0, 63, 255], // finder dot, dark (true) + QRMatrix::M_FINDER => [233, 233, 233], // light (false) + QRMatrix::M_ALIGNMENT_DARK => [255, 0, 255], + QRMatrix::M_ALIGNMENT => [233, 233, 233], + QRMatrix::M_DATA_DARK => [0, 0, 0], + QRMatrix::M_DATA => [233, 233, 233], +]; +
Render the output:
+++$data = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'; +$out = (new QRCode($options))->render($data); // -> data:image/webp;base64,... + +printf('<img alt="%s" src="%s" />', $alt, $out); +
Return the
+GdImageinstance/resource (will ignore other output options):++$options->returnResource = true; + +/** @var \GdImage|resource $gdImage */ +$gdImage = (new QRCode($options))->render($data); + +// do stuff with the GdImage instance... +$size = imagesx($gdImage); +// ... + +// ...dump output +header('Content-type: image/jpeg'); + +imagejpeg($gdImage); +imagedestroy($gdImage); +
+ Additional methods
++ +
+method
return
description
(protected)
drawImage()voidDraws the QR image
(protected)
dumpImage()stringCreates the final image by calling the desired GD output function
(protected)
module(int $x, int $y, int $M_TYPE)voidRenders a single module
(protected)
setBgColor()voidSets the background color
(protected)
setTransparencyColor()voidSets the transparency color
Options that affect this module
@@ -279,42 +387,39 @@ -
$returnResourcebool$imageBase64bool$bgColormixed$drawLightModulesbool$drawCircularModulesbool$circleRadiusfloat$keepAsSquarearray$drawCircularModulesbool$scaleint$drawLightModulesbool$imageTransparentbool$transparencyColor$qualityint$keepAsSquarearray$outputBase64bool$returnResourcebool$scaleint$transparencyColormixed$pngCompressionint$jpegQualityintdiff --git a/Built-In-Output-QRImagick.html b/Built-In-Output-QRImagick.html index ec25c175a..e0fc61071 100644 --- a/Built-In-Output-QRImagick.html +++ b/Built-In-Output-QRImagick.html @@ -99,6 +99,8 @@ Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module @@ -276,6 +291,93 @@
PHP
ext-imagick: github.com/Imagick/imagick (Windows downloads)
+ +Example
+See: ImageMagick example
+Set the options:
+++$options = new QROptions; + +$options->outputType = QROutputInterface::IMAGICK; +$options->imagickFormat = 'webp'; // e.g. png32, jpeg, webp +$options->quality = 90; +$options->scale = 20; +$options->bgColor = '#ccccaa'; +$options->imageTransparent = true; +$options->transparencyColor = '#ccccaa'; +$options->drawLightModules = true; +$options->drawCircularModules = true; +$options->circleRadius = 0.4; +$options->keepAsSquare = [ + QRMatrix::M_FINDER_DARK, + QRMatrix::M_FINDER_DOT, + QRMatrix::M_ALIGNMENT_DARK, +]; +$options->moduleValues = [ + QRMatrix::M_FINDER_DARK => '#A71111', // dark (true) + QRMatrix::M_FINDER_DOT => '#A71111', // finder dot, dark (true) + QRMatrix::M_FINDER => '#FFBFBF', // light (false) + QRMatrix::M_ALIGNMENT_DARK => '#A70364', + QRMatrix::M_ALIGNMENT => '#FFC9C9', + QRMatrix::M_VERSION_DARK => '#650098', + QRMatrix::M_VERSION => '#E0B8FF', +]; +
Render the output:
+++$data = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'; +$out = (new QRCode($options))->render($data); // -> data:image/webp;base64,... + +printf('<img alt="%s" src="%s" />', $alt, $out); +
Return the
+Imagickinstance (will ignore other output options):++$options->returnResource = true; + +/** @var \Imagick $imagick */ +$imagick = (new QRCode($options))->render($data); + +// do stuff with the Imagick instance... +$imagick->scaleImage(150, 150, true); +// ... + +// ...dump output +$imagick->setImageFormat('png32'); + +header('Content-type: image/png'); + +echo $imagick->getImageBlob(); +
+ Additional methods
++ +
+method
return
description
(protected)
drawImage()voidCreates the QR image via ImagickDraw
(protected)
module()voidDraws a single pixel at the given position
(protected)
setBgColor()voidSets the background color
(protected)
setTransparencyColor()voidSets the transparency color
Options that affect this module
@@ -285,39 +387,42 @@ -
$returnResourcebool$imageBase64bool$bgColormixed$drawLightModulesbool$drawCircularModulesbool$circleRadiusfloat$keepAsSquarearray$drawCircularModulesbool$scaleint$drawLightModulesbool$imageTransparentbool$imagickFormatstring$keepAsSquarearray$outputBase64bool$qualityint$returnResourcebool$scaleint$transparencyColormixed$imagickFormatstring@@ -335,12 +440,6 @@ diff --git a/Built-In-Output-QRMarkupHTML.html b/Built-In-Output-QRMarkupHTML.html index a14602ef6..786b5d324 100644 --- a/Built-In-Output-QRMarkupHTML.html +++ b/Built-In-Output-QRMarkupHTML.html @@ -99,6 +99,8 @@$excludeFromConnectN/A
$pngCompressionGdImage exclusive
$jpegQualityGdImage exclusive
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
@@ -269,7 +284,93 @@
QRMarkupHTML
-Class
+QRMarkupHTML: HTML output (a cheap markup substitute when SVG is not available or not an option)Class
+QRMarkupHTML: HTML outputThis class is a cheap markup substitute for when SVG is not available or not an option (which was an issue before ca 2012). +As a general rule: if you plan to display the QR Code in a web browser, you should be using the SVG output.
++ +Example
+See: HTML example
+Set the options:
+++$options = new QROptions; + +$options->outputType = QROutputInterface::MARKUP_HTML; +$options->cssClass = 'qrcode'; +// default values for unassigned module types +$options->markupDark = '#555'; +$options->markupLight = '#CCC'; +$options->moduleValues = [ + // finder + QRMatrix::M_FINDER_DARK => '#A71111', // dark (true) + QRMatrix::M_FINDER_DOT => '#A71111', // finder dot, dark (true) + QRMatrix::M_FINDER => '#FFBFBF', // light (false) + // alignment + QRMatrix::M_ALIGNMENT_DARK => '#A70364', + QRMatrix::M_ALIGNMENT => '#FFC9C9', +]; +
Output in a HTML document (via PHP):
+++<?php + +$data = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'; +$out = (new QRCode($options))->render($data); + +header('Content-type: text/html'); + +?> +<!DOCTYPE html> +<html lang="none"> +<head> + <meta charset="UTF-8"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <title>QRCode HTML Example</title> + <style> + div.qrcode{ + margin: 1em; + } + + /* rows */ + div.qrcode > div { + height: 10px; + } + + /* modules */ + div.qrcode > div > span { + display: inline-block; + width: 10px; + height: 10px; + } + </style> +</head> +<body> +<!-- php poutput --> +<?php echo $out; ?> +</body> +</html> +
+ Additional methods
++ +
+method
return
description
(protected)
createMarkup(bool $saveToFile)stringReturns the fully parsed and rendered markup string for the given input
(protected)
getCssClass(int $M_TYPE = 0)stringReturns a string with all css classes for the current element
Options that affect this module
@@ -279,10 +380,10 @@ -
$eol$cssClassstring$cssClass$eolstring$markupDark$returnResourceN/A
$imageBase64N/A
$bgColorvia CSS
$drawLightModulesN/A
$drawCircularModulesN/A
$circleRadiusN/A
$keepAsSquare$connectPathsN/A
$connectPaths$drawCircularModulesN/A
$excludeFromConnect$drawLightModulesN/A
$scalevia CSS
$excludeFromConnectN/A
$imageTransparentN/A
$keepAsSquareN/A
$outputBase64N/A
$returnResourceN/A
$scalevia CSS
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
@@ -270,6 +285,90 @@
QRMarkupSVG
Class
+QRMarkupSVG: Scalable Vector Graphics (SVG) output+ +Example
+See: ImageMagick example
+Set the options:
+++$options = new QROptions; + +$options->version = 7; +$options->outputType = QROutputInterface::MARKUP_SVG; +// if set to false, the light modules won't be rendered +$options->drawLightModules = true; +// empty the default value to remove the fill* and opacity* attributes from the <path> elements +$options->markupDark = ''; +$options->markupLight = ''; +// draw the modules as circles isntead of squares +$options->drawCircularModules = true; +$options->circleRadius = 0.4; +// connect paths to avoid render glitches +// @see https://github.com/chillerlan/php-qrcode/issues/57 +$options->connectPaths = true; +// keep modules of these types as square +$options->keepAsSquare = [ + QRMatrix::M_FINDER_DARK, + QRMatrix::M_FINDER_DOT, + QRMatrix::M_ALIGNMENT_DARK, +]; +// add a gradient via the <defs> element +// @see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs +// @see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/linearGradient +$options->svgDefs = ' + <linearGradient id="rainbow" x1="1" y2="1"> + <stop stop-color="#e2453c" offset="0"/> + <stop stop-color="#e07e39" offset="0.2"/> + <stop stop-color="#e5d667" offset="0.4"/> + <stop stop-color="#51b95b" offset="0.6"/> + <stop stop-color="#1e72b7" offset="0.8"/> + <stop stop-color="#6f5ba7" offset="1"/> + </linearGradient> + <style><![CDATA[ + .dark{fill: url(#rainbow);} + .light{fill: #eee;} + ]]></style>'; +
Render the output:
+++$data = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'; +$out = (new QRCode($options))->render($data); // -> data:image/svg+xml;base64,PD94bWwgdmVyc2... + +printf('<img alt="%s" src="%s" />', $alt, $out); +
+ Additional methods
++ +
+method
return
description
(protected)
getCssClass(int $M_TYPE = 0)stringreturns a string with all css classes for the current element
(protected)
header()stringreturns the
<svg>header with the given options parsed(protected)
module(int $x, int $y, int $M_TYPE)stringreturns a path segment for a single module
(protected)
path(string $path, int $M_TYPE)stringrenders and returns a single
<path>element(protected)
paths()stringreturns one or more SVG
<path>elementsOptions that affect this module
@@ -279,58 +378,58 @@ -
diff --git a/Built-In-Output-QRString.html b/Built-In-Output-QRString.html index cf871837b..6b5c5a8a1 100644 --- a/Built-In-Output-QRString.html +++ b/Built-In-Output-QRString.html @@ -99,6 +99,8 @@$imageBase64$circleRadiusfloat$connectPathsbool$cssClassstring$drawCircularModulesbool$drawLightModulesbool$eolstring$drawLightModulesbool$drawCircularModulesbool$circleRadiusfloat$excludeFromConnectarray$keepAsSquarearray$connectPaths$markupDarkstring$markupLightstring$outputBase64bool$excludeFromConnectarray$cssClassstring$markupDarkstring$markupLightstring$svgAddXmlHeaderbool$svgDefsstring$svgHeightstring|null$svgOpacityfloat$svgDefs$svgPreserveAspectRatiostring$svgViewBoxSizeint|null$svgPreserveAspectRatiostring$svgWidthstring|null$svgHeight$svgWidthstring|null$bgColorbackground color can be achieved via CSS, attributes or the
<defs>element, see also php-qrcode/discussions/199 (comment)$imageTransparentSVG is - similar to a HTML element - transparent by default
$returnResourceN/A
$bgColorbackground color can be achieved via CSS,
<defs>or attributes, see also php-qrcode/discussions/199 (comment)$scale$scaleis intended for raster image types, use$svgViewBoxSizeinstead$imageTransparentSVG is transparent by default
$scale$scale(pixel size of a qr module) is intended for raster image types, use$svgViewBoxSizeinsteadBuilt-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
@@ -270,6 +285,84 @@
QRString
Class
+QRString: String output: plain text, JSON+ +Plain text
+Render in a CLI console, using ANSI colors and block elements:
+++// a little helper to a create proper ANSI 8-bit color escape sequence +function ansi8(string $str, int $color, bool $background = false):string{ + $color = max(0, min($color, 255)); + $background = ($background ? 48 : 38); + + return sprintf("\x1b[%s;5;%sm%s\x1b[0m", $background, $color, $str); +} + +$options = new QROptions; + +$options->outputType = QROutputInterface::STRING_TEXT; +$options->eol = "\n"; +// add some space on the line start +$options->textLineStart = str_repeat(' ', 6); +// default values for unassigned module types +$options->textDark = QRString::ansi8('██', 253); +$options->textLight = QRString::ansi8('░░', 253); +$options->moduleValues = [ + QRMatrix::M_FINDER_DARK => QRString::ansi8('██', 124), + QRMatrix::M_FINDER => QRString::ansi8('░░', 124), + QRMatrix::M_FINDER_DOT => QRString::ansi8('██', 124), + QRMatrix::M_ALIGNMENT_DARK => QRString::ansi8('██', 2), + QRMatrix::M_ALIGNMENT => QRString::ansi8('░░', 2), + QRMatrix::M_VERSION_DARK => QRString::ansi8('██', 21), + QRMatrix::M_VERSION => QRString::ansi8('░░', 21), +]; +
Output:
+++$data = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'; +$qrcode = (new QRCode($options))->render($data); + +echo "\n\n$qrcode\n\n"; +
+ +JSON
+++$options = new QROptions; + +$options->outputType = QROutputInterface::STRING_JSON; +// output the integer values ($M_TYPE) held in the matrix object +$options->jsonAsBooleans = false; + +header('Content-type: application/json'); + +echo (new QRCode($options))->render($data); +
+ Additional methods
++ +
+method
return
description
(protected)
text()stringstring output
(protected)
json()stringJSON output
ansi8(string $str, int $color, bool $background = null)stringa little helper to create a proper ANSI 8-bit color escape sequence
Options that affect this module
@@ -282,10 +375,16 @@
$eolstring$textDark$jsonAsBooleansbool$textDarkstring$textLight$textLightstring$textLineStartstring$returnResourceN/A
$imageBase64N/A
$bgColorN/A
$drawLightModulesnot implemented
$drawCircularModulesN/A
$circleRadiusN/A
$keepAsSquare$connectPathsN/A
$connectPaths$drawCircularModulesN/A
$excludeFromConnectN/A
$drawLightModulesnot implemented
$scale$excludeFromConnectN/A
$imageTransparentN/A
$keepAsSquareN/A
$outputBase64N/A
$returnResourceN/A
$scaleN/A
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
diff --git a/Usage-Installation.html b/Usage-Installation.html
index e35de2859..eb4ee9294 100644
--- a/Usage-Installation.html
+++ b/Usage-Installation.html
@@ -99,6 +99,8 @@
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
diff --git a/Usage-Overview.html b/Usage-Overview.html
index e05379dc6..f6854d670 100644
--- a/Usage-Overview.html
+++ b/Usage-Overview.html
@@ -99,6 +99,8 @@
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
diff --git a/Usage-Quickstart.html b/Usage-Quickstart.html
index 49e1f7eef..41fa36637 100644
--- a/Usage-Quickstart.html
+++ b/Usage-Quickstart.html
@@ -99,6 +99,8 @@
Built-In Output Modules
- QREps
-
+
- Example +
- Additional methods
- Options that affect this module @@ -106,6 +108,8 @@
- QRFpdf
-
+
- Example +
- Additional methods
- Options that affect this module @@ -113,6 +117,8 @@
- QRGdImage
-
+
- Example +
- Additional methods
- Options that affect this module @@ -120,6 +126,8 @@
- QRImagick
-
+
- Example +
- Additional methods
- Options that affect this module @@ -127,6 +135,8 @@
- QRMarkupHTML
-
+
- Example +
- Additional methods
- Options that affect this module @@ -134,6 +144,8 @@
- QRMarkupSVG
-
+
- Example +
- Additional methods
- Options that affect this module @@ -141,6 +153,9 @@
- QRString
-
+
- Plain text +
- JSON +
- Additional methods
- Options that affect this module
diff --git a/_sources/API-QROptions.md.txt b/_sources/API-QROptions.md.txt
index 5efa1494c..911a1fc98 100644
--- a/_sources/API-QROptions.md.txt
+++ b/_sources/API-QROptions.md.txt
@@ -57,8 +57,7 @@ Inherited from [`SettingsContainerAbstract`](https://github.com/chillerlan/php-s
| `$scale` | `int` | `5` | * | Pixel size of a QR code module |
| `$imageTransparent` | `bool` | `true` | * | Toggle transparency (no jpeg support), QRGdImage and QRImagick only. The given `QROptions::$transparencyColor` is set as transparent |
| `$transparencyColor` | `mixed` | `null` | a valid GD or Imagick color value | Sets a transparency color for when `QROptions::$imageTransparent` is set to true. Defaults to `QROptions::$bgColor`. |
-| `$pngCompression` | `int` | `-1` | `-1...9` | `imagepng()` compression level, -1 = auto |
-| `$jpegQuality` | `int` | `85` | `0...100` | `imagejpeg()` quality |
+| `$quality` | `int` | `-1` | * | compression quality setting for `imagejpeg()`, `imagepng()`, `imagewebp()`, `Imagick::setImageCompressionQuality()` |
| `$imagickFormat` | `string` | `'png'` | * | ImageMagick output type, see `Imagick::setType()` |
| `$cssClass` | `string` | `'qrcode'` | * | A common css class |
| `$markupDark` | `string` | `'#000'` | * | Markup substitute for dark (CSS value) |
diff --git a/_sources/Built-In-Output-QREps.md.txt b/_sources/Built-In-Output-QREps.md.txt
index 60485b4b7..9cef1814f 100644
--- a/_sources/Built-In-Output-QREps.md.txt
+++ b/_sources/Built-In-Output-QREps.md.txt
@@ -1,26 +1,81 @@
# QREps
-[Class `QREps`](https://github.com/chillerlan/php-qrcode/blob/main/src/Output/QREps.php): [Encapsulated Postscript](https://en.wikipedia.org/wiki/Encapsulated_PostScript) (EPS) output
+[Class `QREps`](https://github.com/chillerlan/php-qrcode/blob/main/src/Output/QREps.php): [Encapsulated Postscript](https://en.wikipedia.org/wiki/Encapsulated_PostScript) (EPS) output.
+
+
+## Example
+
+See: [EPS example](https://github.com/chillerlan/php-qrcode/blob/main/examples/eps.php)
+
+Set the options:
+
+```php
+$options = new QROptions;
+
+$options->outputType = QROutputInterface::EPS;
+$options->scale = 5;
+$options->drawLightModules = false;
+// colors can be specified either as [R, G, B] or [C, M, Y, K] (0-255)
+$options->bgColor = [222, 222, 222];
+$options->moduleValues = [
+ QRMatrix::M_FINDER_DARK => [0, 63, 255], // dark (true)
+ QRMatrix::M_FINDER_DOT => [0, 63, 255], // finder dot, dark (true)
+ QRMatrix::M_FINDER => [233, 233, 233], // light (false)
+ QRMatrix::M_ALIGNMENT_DARK => [255, 0, 255],
+ QRMatrix::M_ALIGNMENT => [233, 233, 233],
+ QRMatrix::M_DATA_DARK => [0, 0, 0],
+ QRMatrix::M_DATA => [233, 233, 233],
+];
+```
+
+
+Render and save to file:
+
+```php
+$data = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ';
+$file = __DIR__.'/qrcode.eps';
+
+(new QRCode($options))->render($data, $file);
+```
+
+
+Push as file download in a browser:
+
+```php
+header('Content-type: application/postscript');
+header('Content-Disposition: filename="qrcode.eps"');
+
+echo (new QRCode($options))->render($data);
+
+exit;
+```
+
+## Additional methods
+
+| method | return | description |
+|---------------------------------------------------|----------|--------------------------------------------|
+| (protected) `formatColor(array $values)` | `string` | Set the color format string |
+| (protected) `module(int $x, int $y, int $M_TYPE)` | `string` | Returns a path segment for a single module |
## Options that affect this module
-| property | type |
-|--------------------------------|----------------|
-| `$drawLightModules` | `bool` |
-| `$connectPaths` | `bool` |
-| `$excludeFromConnect` | `array` |
-| `$scale` | `int` |
+| property | type |
+|-----------------------|---------|
+| `$bgColor` | `array` |
+| `$connectPaths` | `bool` |
+| `$drawLightModules` | `bool` |
+| `$excludeFromConnect` | `array` |
+| `$scale` | `int` |
### Options that have no effect
| property | reason |
|------------------------|-----------------|
-| `$returnResource` | N/A |
-| `$imageBase64` | N/A |
-| `$bgColor` | not implemented |
-| `$drawCircularModules` | not implemented |
| `$circleRadius` | not implemented |
-| `$keepAsSquare` | not implemented |
+| `$drawCircularModules` | not implemented |
+| `$outputBase64` | N/A |
| `$imageTransparent` | N/A |
+| `$keepAsSquare` | not implemented |
+| `$returnResource` | N/A |
diff --git a/_sources/Built-In-Output-QRFpdf.md.txt b/_sources/Built-In-Output-QRFpdf.md.txt
index 62115287c..db35e9ec1 100644
--- a/_sources/Built-In-Output-QRFpdf.md.txt
+++ b/_sources/Built-In-Output-QRFpdf.md.txt
@@ -3,27 +3,86 @@
[Class `QRFpdf`](https://github.com/chillerlan/php-qrcode/blob/main/src/Output/QRFpdf.php): [Portable Document Format](https://en.wikipedia.org/wiki/PDF) (PDF) output via [FPDF](https://github.com/setasign/fpdf)
+## Example
+
+See: [FPDF example](https://github.com/chillerlan/php-qrcode/blob/main/examples/fpdf.php)
+
+Set the options:
+
+```php
+$options = new QROptions;
+
+$options->outputType = QROutputInterface::FPDF;
+$options->scale = 5;
+$options->fpdfMeasureUnit = 'mm'; // pt, mm, cm, in
+$options->bgColor = [222, 222, 222]; // [R, G, B]
+$options->drawLightModules = false;
+$options->moduleValues = [
+ QRMatrix::M_FINDER_DARK => [0, 63, 255], // dark (true)
+ QRMatrix::M_FINDER_DOT => [0, 63, 255], // finder dot, dark (true)
+ QRMatrix::M_FINDER => [255, 255, 255], // light (false)
+ QRMatrix::M_ALIGNMENT_DARK => [255, 0, 255],
+ QRMatrix::M_ALIGNMENT => [255, 255, 255],
+ QRMatrix::M_DATA_DARK => [0, 0, 0],
+ QRMatrix::M_DATA => [255, 255, 255],
+];
+```
+
+
+Render the output:
+
+```php
+$data = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ';
+$out = (new QRCode($options))->render($data); // -> data:application/pdf;base64,...
+
+echo $out;
+```
+
+
+Return the `FPDF` instance (will ignore other output options):
+
+```php
+$options->returnResource = true;
+
+/** @var \FPDF $fpdf */
+$fpdf = (new QRCode($options))->render($data);
+
+// do stuff with the FPDF instance...
+
+// ...dump output
+header('application/pdf');
+
+echo $fpdf->Output('S');
+```
+
+
+## Additional methods
+
+| method | return | description |
+|---------------------------------------------------|--------|------------------------------|
+| (protected) `initFPDF()` | `FPDF` | Initializes an FPDF instance |
+| (protected) `module(int $x, int $y, int $M_TYPE)` | `void` | Renders a single module |
+
+
## Options that affect this module
-| property | type |
-|--------------------------------|----------------|
-| `$returnResource` | `bool` |
-| `$imageBase64` | `bool` |
-| `$bgColor` | `mixed` |
-| `$drawLightModules` | `bool` |
-| `$fpdfMeasureUnit` | `string` |
+| property | type |
+|---------------------|----------|
+| `$bgColor` | `array` |
+| `$drawLightModules` | `bool` |
+| `$fpdfMeasureUnit` | `string` |
+| `$outputBase64` | `bool` |
+| `$returnResource` | `bool` |
+| `$scale` | `ìnt` |
### Options that have no effect
-| property | reason |
-|------------------------|-----------------|
-| `$drawCircularModules` | N/A |
-| `$circleRadius` | N/A |
-| `$keepAsSquare` | N/A |
-| `$connectPaths` | N/A |
-| `$excludeFromConnect` | N/A |
-| `$scale` | not implemented |
-| `$imageTransparent` | N/A |
-
-
+| property | reason |
+|------------------------|--------|
+| `$circleRadius` | N/A |
+| `$connectPaths` | N/A |
+| `$drawCircularModules` | N/A |
+| `$excludeFromConnect` | N/A |
+| `$imageTransparent` | N/A |
+| `$keepAsSquare` | N/A |
diff --git a/_sources/Built-In-Output-QRGdImage.md.txt b/_sources/Built-In-Output-QRGdImage.md.txt
index d1fafe85d..09cc3f5ed 100644
--- a/_sources/Built-In-Output-QRGdImage.md.txt
+++ b/_sources/Built-In-Output-QRGdImage.md.txt
@@ -3,27 +3,104 @@
[Class `QRGdImage`](https://github.com/chillerlan/php-qrcode/blob/main/src/Output/QRGdImage.php): [GdImage](https://www.php.net/manual/book.image) raster graphic output (GIF, JPG, PNG)
+## Example
+
+See: [GdImage example](https://github.com/chillerlan/php-qrcode/blob/main/examples/image.php)
+
+Set the options:
+```php
+$options = new QROptions;
+
+// $outputType can be one of: GDIMAGE_BMP, GDIMAGE_GIF, GDIMAGE_JPG, GDIMAGE_PNG, GDIMAGE_WEBP
+$options->outputType = QROutputInterface::GDIMAGE_WEBP;
+$options->quality = 90;
+// the size of one qr module in pixels
+$options->scale = 20;
+$options->bgColor = [200, 150, 200];
+$options->imageTransparent = true;
+// the color that will be set transparent
+// @see https://www.php.net/manual/en/function.imagecolortransparent
+$options->transparencyColor = [200, 150, 200];
+$options->drawCircularModules = true;
+$options->drawLightModules = true;
+$options->circleRadius = 0.4;
+$options->keepAsSquare = [
+ QRMatrix::M_FINDER_DARK,
+ QRMatrix::M_FINDER_DOT,
+ QRMatrix::M_ALIGNMENT_DARK,
+];
+$options->moduleValues = [
+ QRMatrix::M_FINDER_DARK => [0, 63, 255], // dark (true)
+ QRMatrix::M_FINDER_DOT => [0, 63, 255], // finder dot, dark (true)
+ QRMatrix::M_FINDER => [233, 233, 233], // light (false)
+ QRMatrix::M_ALIGNMENT_DARK => [255, 0, 255],
+ QRMatrix::M_ALIGNMENT => [233, 233, 233],
+ QRMatrix::M_DATA_DARK => [0, 0, 0],
+ QRMatrix::M_DATA => [233, 233, 233],
+];
+```
+
+Render the output:
+
+```php
+$data = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ';
+$out = (new QRCode($options))->render($data); // -> data:image/webp;base64,...
+
+printf('
', $alt, $out); +``` + + +Return the `GdImage` instance/resource (will ignore other output options): + +```php +$options->returnResource = true; + +/** @var \GdImage|resource $gdImage */ +$gdImage = (new QRCode($options))->render($data); + +// do stuff with the GdImage instance... +$size = imagesx($gdImage); +// ... + +// ...dump output +header('Content-type: image/jpeg'); + +imagejpeg($gdImage); +imagedestroy($gdImage); +``` + + +## Additional methods + +| method | return | description | +|---------------------------------------------------|----------|-------------------------------------------------------------------| +| (protected) `drawImage()` | `void` | Draws the QR image | +| (protected) `dumpImage()` | `string` | Creates the final image by calling the desired GD output function | +| (protected) `module(int $x, int $y, int $M_TYPE)` | `void` | Renders a single module | +| (protected) `setBgColor()` | `void` | Sets the background color | +| (protected) `setTransparencyColor()` | `void` | Sets the transparency color | + + ## Options that affect this module -| property | type | -|--------------------------------|----------------| -| `$returnResource` | `bool` | -| `$imageBase64` | `bool` | -| `$bgColor` | `mixed` | -| `$drawLightModules` | `bool` | -| `$drawCircularModules` | `bool` | -| `$circleRadius` | `float` | -| `$keepAsSquare` | `array` | -| `$scale` | `int` | -| `$imageTransparent` | `bool` | -| `$transparencyColor` | `mixed` | -| `$pngCompression` | `int` | -| `$jpegQuality` | `int` | +| property | type | +|------------------------|----------------| +| `$bgColor` | `mixed` | +| `$circleRadius` | `float` | +| `$drawCircularModules` | `bool` | +| `$drawLightModules` | `bool` | +| `$imageTransparent` | `bool` | +| `$quality` | `int` | +| `$keepAsSquare` | `array` | +| `$outputBase64` | `bool` | +| `$returnResource` | `bool` | +| `$scale` | `int` | +| `$transparencyColor` | `mixed` | ### Options that have no effect -| property | reason | -|--------------------------------|--------| -| `$connectPaths` | N/A | -| `$excludeFromConnect` | N/A | +| property | reason | +|-----------------------|--------| +| `$connectPaths` | N/A | +| `$excludeFromConnect` | N/A | diff --git a/_sources/Built-In-Output-QRImagick.md.txt b/_sources/Built-In-Output-QRImagick.md.txt index 5d3d26957..7fe94abba 100644 --- a/_sources/Built-In-Output-QRImagick.md.txt +++ b/_sources/Built-In-Output-QRImagick.md.txt @@ -9,28 +9,103 @@ Please follow the installation guides for your operating system: - [PHP Imagick by Example](https://phpimagick.com/) ([github.com/Imagick/ImagickDemos](https://github.com/Imagick/ImagickDemos)) +## Example + +See: [ImageMagick example](https://github.com/chillerlan/php-qrcode/blob/main/examples/imagick.php) + +Set the options: +```php +$options = new QROptions; + +$options->outputType = QROutputInterface::IMAGICK; +$options->imagickFormat = 'webp'; // e.g. png32, jpeg, webp +$options->quality = 90; +$options->scale = 20; +$options->bgColor = '#ccccaa'; +$options->imageTransparent = true; +$options->transparencyColor = '#ccccaa'; +$options->drawLightModules = true; +$options->drawCircularModules = true; +$options->circleRadius = 0.4; +$options->keepAsSquare = [ + QRMatrix::M_FINDER_DARK, + QRMatrix::M_FINDER_DOT, + QRMatrix::M_ALIGNMENT_DARK, +]; +$options->moduleValues = [ + QRMatrix::M_FINDER_DARK => '#A71111', // dark (true) + QRMatrix::M_FINDER_DOT => '#A71111', // finder dot, dark (true) + QRMatrix::M_FINDER => '#FFBFBF', // light (false) + QRMatrix::M_ALIGNMENT_DARK => '#A70364', + QRMatrix::M_ALIGNMENT => '#FFC9C9', + QRMatrix::M_VERSION_DARK => '#650098', + QRMatrix::M_VERSION => '#E0B8FF', +]; +``` + + +Render the output: + +```php +$data = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'; +$out = (new QRCode($options))->render($data); // -> data:image/webp;base64,... + +printf('
QRCode HTML Example + + + + + + + +``` + + +## Additional methods + +| method | return | description | +|----------------------------------------------|----------|-------------------------------------------------------------------------| +| (protected) `createMarkup(bool $saveToFile)` | `string` | Returns the fully parsed and rendered markup string for the given input | +| (protected) `getCssClass(int $M_TYPE = 0)` | `string` | Returns a string with all css classes for the current element | + ## Options that affect this module -| property | type | -|--------------------------------|----------------| -| `$eol` | `string` | -| `$cssClass` | `string` | -| `$markupDark` | `string` | -| `$markupLight` | `string` | +| property | type | +|----------------|----------| +| `$cssClass` | `string` | +| `$eol` | `string` | +| `$markupDark` | `string` | +| `$markupLight` | `string` | ### Options that have no effect -| property | reason | -|--------------------------------|---------| -| `$returnResource` | N/A | -| `$imageBase64` | N/A | -| `$bgColor` | via CSS | -| `$drawLightModules` | N/A | -| `$drawCircularModules` | N/A | -| `$circleRadius` | N/A | -| `$keepAsSquare` | N/A | -| `$connectPaths` | N/A | -| `$excludeFromConnect` | N/A | -| `$scale` | via CSS | -| `$imageTransparent` | N/A | +| property | reason | +|------------------------|---------| +| `$bgColor` | via CSS | +| `$circleRadius` | N/A | +| `$connectPaths` | N/A | +| `$drawCircularModules` | N/A | +| `$drawLightModules` | N/A | +| `$excludeFromConnect` | N/A | +| `$imageTransparent` | N/A | +| `$keepAsSquare` | N/A | +| `$outputBase64` | N/A | +| `$returnResource` | N/A | +| `$scale` | via CSS | diff --git a/_sources/Built-In-Output-QRMarkupSVG.md.txt b/_sources/Built-In-Output-QRMarkupSVG.md.txt index fa7cb93df..96a92f022 100644 --- a/_sources/Built-In-Output-QRMarkupSVG.md.txt +++ b/_sources/Built-In-Output-QRMarkupSVG.md.txt @@ -2,35 +2,103 @@ [Class `QRMarkupSVG`](https://github.com/chillerlan/php-qrcode/blob/main/src/Output/QRMarkupSVG.php): [Scalable Vector Graphics](https://developer.mozilla.org/en-US/docs/Glossary/SVG) (SVG) output +## Example + +See: [ImageMagick example](https://github.com/chillerlan/php-qrcode/blob/main/examples/imagick.php) + +Set the options: + +```php +$options = new QROptions; + +$options->version = 7; +$options->outputType = QROutputInterface::MARKUP_SVG; +// if set to false, the light modules won't be rendered +$options->drawLightModules = true; +// empty the default value to remove the fill* and opacity* attributes from theelements +$options->markupDark = ''; +$options->markupLight = ''; +// draw the modules as circles isntead of squares +$options->drawCircularModules = true; +$options->circleRadius = 0.4; +// connect paths to avoid render glitches +// @see https://github.com/chillerlan/php-qrcode/issues/57 +$options->connectPaths = true; +// keep modules of these types as square +$options->keepAsSquare = [ + QRMatrix::M_FINDER_DARK, + QRMatrix::M_FINDER_DOT, + QRMatrix::M_ALIGNMENT_DARK, +]; +// add a gradient via the element +// @see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs +// @see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/linearGradient +$options->svgDefs = ' + + + '; +``` + + +Render the output: + +```php +$data = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'; +$out = (new QRCode($options))->render($data); // -> data:image/svg+xml;base64,PD94bWwgdmVyc2... + +printf('+ + + + + +
- QREps
- QREps
- QREps
- QREps
- QREps
- QREps
- QREps
- QREps
- QREps
- QREps
- QREps
- QREps
- QREps
- QREps
- QREps
- QREps