From 3e0bb47bfe407ff7666250db93755a9d9944a285 Mon Sep 17 00:00:00 2001 From: codemasher Date: Wed, 25 Oct 2023 19:34:09 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20chillerl?= =?UTF-8?q?an/php-qrcode@ab358f2f38c22ca062afa1859f7f95833e4cf71a=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/chillerlan-QRCode-Output-QREps.html | 131 +- classes/chillerlan-QRCode-Output-QRFpdf.html | 135 +- .../chillerlan-QRCode-Output-QRGdImage.html | 233 +- ...chillerlan-QRCode-Output-QRGdImageBMP.html | 2569 ++++++++++++++++ ...chillerlan-QRCode-Output-QRGdImageGIF.html | 2569 ++++++++++++++++ ...hillerlan-QRCode-Output-QRGdImageJPEG.html | 2583 +++++++++++++++++ ...chillerlan-QRCode-Output-QRGdImagePNG.html | 2569 ++++++++++++++++ ...hillerlan-QRCode-Output-QRGdImageWEBP.html | 2569 ++++++++++++++++ classes/chillerlan-QRCode-Output-QRImage.html | 212 +- .../chillerlan-QRCode-Output-QRImagick.html | 62 +- .../chillerlan-QRCode-Output-QRMarkup.html | 64 +- ...chillerlan-QRCode-Output-QRMarkupHTML.html | 125 +- .../chillerlan-QRCode-Output-QRMarkupSVG.html | 139 +- ...lerlan-QRCode-Output-QROutputAbstract.html | 68 +- ...erlan-QRCode-Output-QROutputInterface.html | 694 +++-- .../chillerlan-QRCode-Output-QRString.html | 97 +- ...chillerlan-QRCode-Output-QRStringJSON.html | 1975 +++++++++++++ ...chillerlan-QRCode-Output-QRStringText.html | 2063 +++++++++++++ classes/chillerlan-QRCode-QROptions.html | 306 +- classes/chillerlan-QRCode-QROptionsTrait.html | 306 +- ...an-QRCodeTest-Output-QRGdImageBMPTest.html | 72 +- ...an-QRCodeTest-Output-QRGdImageGIFTest.html | 72 +- ...an-QRCodeTest-Output-QRGdImageJPGTest.html | 72 +- ...an-QRCodeTest-Output-QRGdImagePNGTest.html | 72 +- ...CodeTest-Output-QRGdImageTestAbstract.html | 76 +- ...n-QRCodeTest-Output-QRGdImageWEBPTest.html | 72 +- ...an-QRCodeTest-Output-QRStringJSONTest.html | 47 +- ...an-QRCodeTest-Output-QRStringTEXTTest.html | 41 +- ...RCodeTest-Output-QRStringTestAbstract.html | 910 ------ files/src-output-qrgdimagebmp.html | 343 +++ files/src-output-qrgdimagegif.html | 343 +++ files/src-output-qrgdimagejpeg.html | 343 +++ files/src-output-qrgdimagepng.html | 343 +++ files/src-output-qrgdimagewebp.html | 343 +++ files/src-output-qrstringjson.html | 343 +++ ...ract.html => src-output-qrstringtext.html} | 24 +- files/src-qroptionstrait.html | 2 +- files/tests-output-qrstringjsontest.html | 3 +- files/tests-output-qrstringtexttest.html | 3 +- indices/files.html | 8 +- js/searchIndex.js | 255 +- namespaces/chillerlan-qrcode-output.html | 2 +- namespaces/chillerlan-qrcodetest-output.html | 4 +- packages/Application.html | 6 +- reports/deprecated.html | 176 +- 45 files changed, 21880 insertions(+), 1564 deletions(-) create mode 100644 classes/chillerlan-QRCode-Output-QRGdImageBMP.html create mode 100644 classes/chillerlan-QRCode-Output-QRGdImageGIF.html create mode 100644 classes/chillerlan-QRCode-Output-QRGdImageJPEG.html create mode 100644 classes/chillerlan-QRCode-Output-QRGdImagePNG.html create mode 100644 classes/chillerlan-QRCode-Output-QRGdImageWEBP.html create mode 100644 classes/chillerlan-QRCode-Output-QRStringJSON.html create mode 100644 classes/chillerlan-QRCode-Output-QRStringText.html delete mode 100644 classes/chillerlan-QRCodeTest-Output-QRStringTestAbstract.html create mode 100644 files/src-output-qrgdimagebmp.html create mode 100644 files/src-output-qrgdimagegif.html create mode 100644 files/src-output-qrgdimagejpeg.html create mode 100644 files/src-output-qrgdimagepng.html create mode 100644 files/src-output-qrgdimagewebp.html create mode 100644 files/src-output-qrstringjson.html rename files/{tests-output-qrstringtestabstract.html => src-output-qrstringtext.html} (91%) diff --git a/classes/chillerlan-QRCode-Output-QREps.html b/classes/chillerlan-QRCode-Output-QREps.html index d4b1d4f55..64e4694da 100644 --- a/classes/chillerlan-QRCode-Output-QREps.html +++ b/classes/chillerlan-QRCode-Output-QREps.html @@ -203,6 +203,19 @@ +

+ Constants + + +

+
+
+ MIME_TYPE + +  = 'application/postscript' +
+ +

@@ -211,6 +224,12 @@

+
+ $circleDiameter + +  : float +
+
$circleRadius @@ -419,6 +438,41 @@ in long loops for a significant performance increase. +
+

+ Constants + + +

+
+

+ MIME_TYPE + + +

+ + + + + + public + mixed + MIME_TYPE + = 'application/postscript' + + + + + + + +
+
@@ -433,6 +487,39 @@ in long loops for a significant performance increase. -property -protected " +> +

+ $circleDiameter + + + + +

+ + + + + protected + float + $circleDiameter + + + + + + + +

$circleRadius @@ -1017,7 +1104,7 @@ in long loops for a significant performance increase. @@ -1066,7 +1153,7 @@ in long loops for a significant performance increase. @@ -1125,7 +1212,7 @@ in long loops for a significant performance increase. @@ -1184,7 +1271,7 @@ in long loops for a significant performance increase. @@ -1237,7 +1324,7 @@ $M_TYPE_LAYER - (possibly modified) field value that acts as layer id

@@ -1272,7 +1359,7 @@ in long loops for a significant performance increase.

@@ -1335,7 +1422,7 @@ in long loops for a significant performance increase.

@@ -1399,7 +1486,7 @@ in long loops for a significant performance increase.

@@ -1466,7 +1553,7 @@ in long loops for a significant performance increase.

@@ -1519,7 +1606,7 @@ in long loops for a significant performance increase.

@@ -1557,7 +1644,7 @@ in long loops for a significant performance increase.

@@ -1617,7 +1704,7 @@ in long loops for a significant performance increase.

@@ -1681,7 +1768,7 @@ in long loops for a significant performance increase.

@@ -1761,7 +1848,7 @@ in long loops for a significant performance increase.

@@ -1795,7 +1882,7 @@ in long loops for a significant performance increase.

@@ -1827,7 +1914,7 @@ in long loops for a significant performance increase.

@@ -1835,7 +1922,7 @@ in long loops for a significant performance increase.

protected - toBase64DataURI(string $data, string $mime) : string + toBase64DataURI(string $data[, string $mime = null ]) : string
@@ -1852,7 +1939,7 @@ in long loops for a significant performance increase.

$mime : string -
+ = null

@@ -1971,14 +2058,22 @@ in long loops for a significant performance increase.

  • Table Of Contents
  • +
  • Constants
  • +
  • + +
  • Properties
  • + +
    +

    + $circleDiameter + + + + +

    + + + + + protected + float + $circleDiameter + + + + + +
    QRGdImage.php : - 37 + 43 @@ -841,6 +906,15 @@ in long loops for a significant performance increase. imagecreatetruecolor() + +
    + todo: +
    +
    + +

    add \GdImage type in v6

    +
    +
    @@ -1142,7 +1216,7 @@ in long loops for a significant performance increase. @@ -1196,7 +1270,7 @@ in long loops for a significant performance increase. @@ -1276,7 +1350,7 @@ in long loops for a significant performance increase. @@ -1352,7 +1426,7 @@ in long loops for a significant performance increase. @@ -1411,7 +1485,7 @@ in long loops for a significant performance increase. @@ -1465,7 +1539,7 @@ in long loops for a significant performance increase. @@ -1518,7 +1592,7 @@ $M_TYPE_LAYER - (possibly modified) field value that acts as layer id

    @@ -1553,7 +1627,7 @@ in long loops for a significant performance increase.

    @@ -1606,7 +1680,7 @@ in long loops for a significant performance increase.

    @@ -1638,7 +1712,7 @@ in long loops for a significant performance increase.

    @@ -1689,7 +1763,7 @@ in long loops for a significant performance increase.

    @@ -1753,7 +1827,7 @@ in long loops for a significant performance increase.

    @@ -1820,7 +1894,7 @@ in long loops for a significant performance increase.

    @@ -1873,7 +1947,7 @@ in long loops for a significant performance increase.

    @@ -1911,7 +1985,7 @@ in long loops for a significant performance increase.

    @@ -1967,7 +2041,7 @@ in long loops for a significant performance increase.

    @@ -2024,6 +2098,109 @@ in long loops for a significant performance increase.

    +
    +
    +

    + renderImage() + + +

    + + +

    Renders the image with the gdimage function for the desired output

    + + + protected + renderImage() : void + +
    +
    + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + imagebmp() + + +
    +
    + see +
    +
    + imagegif() + + +
    +
    + see +
    +
    + imagejpeg() + + +
    +
    + see +
    +
    + imagepng() + + +
    +
    + see +
    +
    + imagewebp() + + +
    +
    + see +
    +
    + https://github.com/chillerlan/php-qrcode/issues/223 + + +
    +
    + todo: +
    +
    + +

    v6.0: make abstract and call from child classes

    +
    + +
    +
    + codeCoverageIgnore +
    +
    + + +
    +
    + +
    QROutputAbstract.php : - 201 + 203 @@ -2119,7 +2296,7 @@ in long loops for a significant performance increase.

    @@ -2151,7 +2328,7 @@ in long loops for a significant performance increase.

    @@ -2185,7 +2362,7 @@ in long loops for a significant performance increase.

    @@ -2217,7 +2394,7 @@ in long loops for a significant performance increase.

    @@ -2249,7 +2426,7 @@ in long loops for a significant performance increase.

    @@ -2257,7 +2434,7 @@ in long loops for a significant performance increase.

    protected - toBase64DataURI(string $data, string $mime) : string + toBase64DataURI(string $data[, string $mime = null ]) : string
    @@ -2274,7 +2451,7 @@ in long loops for a significant performance increase.

    $mime : string -
    + = null
    @@ -2402,6 +2579,7 @@ in long loops for a significant performance increase.

    • $background
    • +
    • $circleDiameter
    • $circleRadius
    • $connectPaths
    • $drawCircularModules
    • @@ -2438,6 +2616,7 @@ in long loops for a significant performance increase.

    • getOutputDimensions()
    • module()
    • prepareModuleValue()
    • +
    • renderImage()
    • saveToFile()
    • setBgColor()
    • setMatrixDimensions()
    • diff --git a/classes/chillerlan-QRCode-Output-QRGdImageBMP.html b/classes/chillerlan-QRCode-Output-QRGdImageBMP.html new file mode 100644 index 000000000..628e3debf --- /dev/null +++ b/classes/chillerlan-QRCode-Output-QRGdImageBMP.html @@ -0,0 +1,2569 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
      +

      Documentation

      + + + + + +
      + +
      +
      + + + + +
      +
      + + +
      +

      + QRGdImageBMP + + + extends QRGdImage + + +
      + in package + +
      + + +

      + +
      + + +
      + + + +

      GdImage bmp output

      + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + imagebmp() + + +
      +
      + + + +

      + Table of Contents + + +

      + + + + + + + +

      + Constants + + +

      +
      +
      + MIME_TYPE + +  = 'image/bmp' +
      + +
      + + +

      + Properties + + +

      +
      +
      + $background + +  : int +
      +
      The allocated background color
      + +
      + $circleDiameter + +  : float +
      + +
      + $circleRadius + +  : float +
      + +
      + $connectPaths + +  : bool +
      + +
      + $drawCircularModules + +  : bool +
      + +
      + $drawLightModules + +  : bool +
      + +
      + $eol + +  : string +
      + +
      + $excludeFromConnect + +  : array<string|int, mixed> +
      + +
      + $image + +  : resource|GdImage +
      +
      The GD image resource
      + +
      + $keepAsSquare + +  : array<string|int, mixed> +
      + +
      + $length + +  : int +
      +
      the side length of the QR image (modules * scale)
      + +
      + $matrix + +  : QRMatrix +
      +
      the (filled) data matrix object
      + +
      + $moduleCount + +  : int +
      +
      the current size of the QR matrix
      + +
      + $moduleValues + +  : array<string|int, mixed> +
      +
      an (optional) array of color values for the several QR matrix parts
      + +
      + $options + +  : SettingsContainerInterface|QROptions +
      + +
      + $scale + +  : int +
      + +
      + $upscaled + +  : bool +
      +
      Whether we're running in upscale mode (scale < 20)
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      QROutputAbstract constructor.
      + +
      + dump() + +  : string|resource|GdImage +
      + +
      + moduleValueIsValid() + +  : bool +
      + +
      + checkGD() + +  : void +
      +
      Checks whether GD is installed and if the given mode is supported
      + +
      + collectModules() + +  : array<string|int, mixed> +
      +
      collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules
      + +
      + copyVars() + +  : void +
      +
      Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.
      + +
      + createImage() + +  : GdImage|resource +
      +
      Creates a new GdImage resource and scales it if necessary
      + +
      + drawImage() + +  : void +
      +
      Draws the QR image
      + +
      + dumpImage() + +  : string +
      +
      Creates the final image by calling the desired GD output function
      + +
      + getDefaultModuleValue() + +  : mixed|null +
      +
      Returns a default value for either dark or light modules
      + +
      + getModuleValue() + +  : mixed +
      +
      Returns the prepared value for the given $M_TYPE
      + +
      + getModuleValueAt() + +  : mixed|null +
      +
      Returns the prepared module value at the given coordinate [$x, $y] (convenience)
      + +
      + getOutputDimensions() + +  : array<string|int, mixed> +
      +
      Returns a 2 element array with the current output width and height
      + +
      + module() + +  : void +
      +
      Creates a single QR pixel with the given settings
      + +
      + prepareModuleValue() + +  : mixed|null +
      +
      Prepares the value for the given input ()
      + +
      + renderImage() + +  : void +
      +
      Renders the image with the gdimage function for the desired output
      + +
      + saveToFile() + +  : void +
      +
      Saves the qr $data to a $file. If $file is null, nothing happens.
      + +
      + setBgColor() + +  : void +
      +
      Sets the background color
      + +
      + setMatrixDimensions() + +  : void +
      +
      Sets/updates the matrix dimensions
      + +
      + setModuleValues() + +  : void +
      +
      Sets the initial module values
      + +
      + setTransparencyColor() + +  : void +
      +
      Sets the transparency color
      + +
      + toBase64DataURI() + +  : string +
      +
      Returns a base64 data URI for the given string and mime type
      + +
      + + + + + +
      +

      + Constants + + +

      +
      +

      + MIME_TYPE + + +

      + + + + + + public + mixed + MIME_TYPE + = 'image/bmp' + + + + + + + +
      +
      + + +
      +

      + Properties + + +

      +
      +

      + $background + + + + +

      + + +

      The allocated background color

      + + + protected + int + $background + + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + imagecolorallocate() + + +
      +
      + +
      +
      +

      + $circleDiameter + + + + +

      + + + + + protected + float + $circleDiameter + + + + + + +
      +
      +

      + $circleRadius + + + + +

      + + + + + protected + float + $circleRadius + + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + QROptions::$circleRadius + + +
      +
      + +
      +
      +

      + $connectPaths + + + + +

      + + + + + protected + bool + $connectPaths + + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + QROptions::$connectPaths + + +
      +
      + +
      +
      +

      + $drawCircularModules + + + + +

      + + + + + protected + bool + $drawCircularModules + + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + QROptions::$drawCircularModules + + +
      +
      + +
      +
      +

      + $drawLightModules + + + + +

      + + + + + protected + bool + $drawLightModules + + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + QROptions::$drawLightModules + + +
      +
      + +
      +
      +

      + $eol + + + + +

      + + + + + protected + string + $eol + + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + QROptions::$eol + + +
      +
      + +
      +
      +

      + $excludeFromConnect + + + + +

      + + + + + protected + array<string|int, mixed> + $excludeFromConnect + + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + QROptions::$excludeFromConnect + + +
      +
      + +
      +
      +

      + $image + + + + +

      + + +

      The GD image resource

      + + + protected + resource|GdImage + $image + + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + imagecreatetruecolor() + + +
      +
      + todo: +
      +
      + +

      add \GdImage type in v6

      +
      + +
      +
      + +
      +
      +

      + $keepAsSquare + + + + +

      + + + + + protected + array<string|int, mixed> + $keepAsSquare + + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + QROptions::$keepAsSquare + + +
      +
      + +
      +
      +

      + $length + + + + +

      + + +

      the side length of the QR image (modules * scale)

      + + + protected + int + $length + + + + + + +
      +
      +

      + $matrix + + + + +

      + + +

      the (filled) data matrix object

      + + + protected + QRMatrix + $matrix + + + + + + +
      +
      +

      + $moduleCount + + + + +

      + + +

      the current size of the QR matrix

      + + + protected + int + $moduleCount + + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + QRMatrix::getSize() + + +
      +
      + +
      +
      +

      + $moduleValues + + + + +

      + + +

      an (optional) array of color values for the several QR matrix parts

      + + + protected + array<string|int, mixed> + $moduleValues + + + + + + +
      + +
      +

      + $scale + + + + +

      + + + + + protected + int + $scale + + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + QROptions::$scale + + +
      +
      + +
      +
      +

      + $upscaled + + + + +

      + + +

      Whether we're running in upscale mode (scale < 20)

      + + + protected + bool + $upscaled + = false + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + QROptions::$drawCircularModules + + +
      +
      + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      QROutputAbstract constructor.

      + + + public + __construct(SettingsContainerInterface $options, QRMatrix $matrix) : mixed + +
      +
      + +
      Parameters
      +
      +
      + $options + : SettingsContainerInterface +
      +
      + +
      +
      + $matrix + : QRMatrix +
      +
      + +
      +
      + + + + +
      +
      +

      + dump() + + +

      + + + + + public + dump([string $file = null ]) : string|resource|GdImage + +
      +
      + +
      Parameters
      +
      +
      + $file + : string + = null
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + inheritDoc +
      +
      + + +
      +
      + phan-suppress +
      +
      + +

      PhanUndeclaredTypeReturnType, PhanTypeMismatchReturn

      +
      + +
      +
      + throws +
      +
      + ErrorException + + +
      +
      + +
      +
      Return values
      + string|resource|GdImage +
      + +
      +
      +

      + moduleValueIsValid() + + +

      + + + + + public + static moduleValueIsValid(mixed $value) : bool + +
      +
      + +
      Parameters
      +
      +
      + $value + : mixed +
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + inheritDoc +
      +
      + + +
      +
      + +
      +
      Return values
      + bool +
      + +
      +
      +

      + checkGD() + + +

      + + +

      Checks whether GD is installed and if the given mode is supported

      + + + protected + checkGD() : void + +
      +
      + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + QRCodeOutputException + + +
      +
      + codeCoverageIgnore +
      +
      + + +
      +
      + + +
      +
      +

      + collectModules() + + +

      + + +

      collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules

      + + + protected + collectModules(Closure $transform) : array<string|int, mixed> + +
      +
      +

      The transform callback is called with the following parameters:

      +

      $x - current column +$y - current row +$M_TYPE - field value +$M_TYPE_LAYER - (possibly modified) field value that acts as layer id

      +
      + +
      Parameters
      +
      +
      + $transform + : Closure +
      +
      + +
      +
      + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + copyVars() + + +

      + + +

      Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.

      + + + protected + copyVars() : void + +
      +
      +

      These variables are usually used in the "module" methods and are called up to 31329 times (at version 40).

      +
      + + + + + +
      +
      +

      + createImage() + + +

      + + +

      Creates a new GdImage resource and scales it if necessary

      + + + protected + createImage() : GdImage|resource + +
      +
      +

      we're scaling the image up in order to draw crisp round circles, otherwise they appear square-y on small scales

      +
      + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + https://github.com/chillerlan/php-qrcode/issues/23 + + +
      +
      + +
      +
      Return values
      + GdImage|resource +
      + +
      +
      +

      + drawImage() + + +

      + + +

      Draws the QR image

      + + + protected + drawImage() : void + +
      +
      + + + + + +
      +
      +

      + dumpImage() + + +

      + + +

      Creates the final image by calling the desired GD output function

      + + + protected + dumpImage() : string + +
      +
      + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + QRCodeOutputException + + +
      +
      + +
      +
      Return values
      + string +
      + +
      +
      +

      + getDefaultModuleValue() + + +

      + + +

      Returns a default value for either dark or light modules

      + + + protected + abstract getDefaultModuleValue(bool $isDark) : mixed|null + +
      +
      + +
      Parameters
      +
      +
      + $isDark + : bool +
      +
      + +
      +
      + + + +
      +
      Return values
      + mixed|null + — +

      return value depends on the output class

      +
      + +
      + +
      +
      +

      + getModuleValue() + + +

      + + +

      Returns the prepared value for the given $M_TYPE

      + + + protected + getModuleValue(int $M_TYPE) : mixed + +
      +
      + +
      Parameters
      +
      +
      + $M_TYPE + : int +
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + QRCodeOutputException + +

      if $moduleValues[$M_TYPE] doesn't exist

      +
      + +
      +
      + +
      +
      Return values
      + mixed + — +

      return value depends on the output class

      +
      + +
      + +
      +
      +

      + getModuleValueAt() + + +

      + + +

      Returns the prepared module value at the given coordinate [$x, $y] (convenience)

      + + + protected + getModuleValueAt(int $x, int $y) : mixed|null + +
      +
      + +
      Parameters
      +
      +
      + $x + : int +
      +
      + +
      +
      + $y + : int +
      +
      + +
      +
      + + + +
      +
      Return values
      + mixed|null +
      + +
      +
      +

      + getOutputDimensions() + + +

      + + +

      Returns a 2 element array with the current output width and height

      + + + protected + getOutputDimensions() : array<string|int, mixed> + +
      +
      +

      The type and units of the values depend on the output class. The default value is the current module count * scale.

      +
      + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + module() + + +

      + + +

      Creates a single QR pixel with the given settings

      + + + protected + module(int $x, int $y, int $M_TYPE) : void + +
      +
      + +
      Parameters
      +
      +
      + $x + : int +
      +
      + +
      +
      + $y + : int +
      +
      + +
      +
      + $M_TYPE + : int +
      +
      + +
      +
      + + + + +
      +
      +

      + prepareModuleValue() + + +

      + + +

      Prepares the value for the given input ()

      + + + protected + abstract prepareModuleValue(mixed $value) : mixed|null + +
      +
      + +
      Parameters
      +
      +
      + $value + : mixed +
      +
      + +
      +
      + + + +
      +
      Return values
      + mixed|null + — +

      return value depends on the output class

      +
      + +
      + +
      +
      +

      + renderImage() + + +

      + + +

      Renders the image with the gdimage function for the desired output

      + + + protected + renderImage() : void + +
      +
      + + + +
      + Tags + + +
      +
      +
      + inheritDoc +
      +
      + + +
      +
      + + +
      +
      +

      + saveToFile() + + +

      + + +

      Saves the qr $data to a $file. If $file is null, nothing happens.

      + + + protected + saveToFile(string $data[, string $file = null ]) : void + +
      +
      + +
      Parameters
      +
      +
      + $data + : string +
      +
      + +
      +
      + $file + : string + = null
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + see +
      +
      + file_put_contents() + + +
      +
      + see +
      +
      + QROptions::$cachefile + + +
      +
      + throws +
      +
      + QRCodeOutputException + + +
      +
      + + +
      +
      +

      + setBgColor() + + +

      + + +

      Sets the background color

      + + + protected + setBgColor() : void + +
      +
      + + + + + +
      +
      +

      + setMatrixDimensions() + + +

      + + +

      Sets/updates the matrix dimensions

      + + + protected + setMatrixDimensions() : void + +
      +
      +

      Call this method if you modify the matrix from within your custom module in case the dimensions have been changed

      +
      + + + + + +
      +
      +

      + setModuleValues() + + +

      + + +

      Sets the initial module values

      + + + protected + setModuleValues() : void + +
      +
      + + + + + +
      +
      +

      + setTransparencyColor() + + +

      + + +

      Sets the transparency color

      + + + protected + setTransparencyColor() : void + +
      +
      + + + + + +
      +
      +

      + toBase64DataURI() + + +

      + + +

      Returns a base64 data URI for the given string and mime type

      + + + protected + toBase64DataURI(string $data[, string $mime = null ]) : string + +
      +
      + +
      Parameters
      +
      +
      + $data + : string +
      +
      + +
      +
      + $mime + : string + = null
      +
      + +
      +
      + + + +
      +
      Return values
      + string +
      + +
      +
      + +
      +
      +
      +
      +
      
      +        
      + +
      +
      + + + +
      +
      +
      + +
      + On this page + + +
      + +
      +
      +
      +
      +
      +

      Search results

      + +
      +
      +
        +
        +
        +
        +
        + + +
        + + + + + + + + diff --git a/classes/chillerlan-QRCode-Output-QRGdImageGIF.html b/classes/chillerlan-QRCode-Output-QRGdImageGIF.html new file mode 100644 index 000000000..c3e322ea8 --- /dev/null +++ b/classes/chillerlan-QRCode-Output-QRGdImageGIF.html @@ -0,0 +1,2569 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
        +

        Documentation

        + + + + + +
        + +
        +
        + + + + +
        +
        + + +
        +

        + QRGdImageGIF + + + extends QRGdImage + + +
        + in package + +
        + + +

        + +
        + + +
        + + + +

        GdImage gif output

        + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + imagegif() + + +
        +
        + + + +

        + Table of Contents + + +

        + + + + + + + +

        + Constants + + +

        +
        +
        + MIME_TYPE + +  = 'image/gif' +
        + +
        + + +

        + Properties + + +

        +
        +
        + $background + +  : int +
        +
        The allocated background color
        + +
        + $circleDiameter + +  : float +
        + +
        + $circleRadius + +  : float +
        + +
        + $connectPaths + +  : bool +
        + +
        + $drawCircularModules + +  : bool +
        + +
        + $drawLightModules + +  : bool +
        + +
        + $eol + +  : string +
        + +
        + $excludeFromConnect + +  : array<string|int, mixed> +
        + +
        + $image + +  : resource|GdImage +
        +
        The GD image resource
        + +
        + $keepAsSquare + +  : array<string|int, mixed> +
        + +
        + $length + +  : int +
        +
        the side length of the QR image (modules * scale)
        + +
        + $matrix + +  : QRMatrix +
        +
        the (filled) data matrix object
        + +
        + $moduleCount + +  : int +
        +
        the current size of the QR matrix
        + +
        + $moduleValues + +  : array<string|int, mixed> +
        +
        an (optional) array of color values for the several QR matrix parts
        + +
        + $options + +  : SettingsContainerInterface|QROptions +
        + +
        + $scale + +  : int +
        + +
        + $upscaled + +  : bool +
        +
        Whether we're running in upscale mode (scale < 20)
        + +
        + +

        + Methods + + +

        +
        +
        + __construct() + +  : mixed +
        +
        QROutputAbstract constructor.
        + +
        + dump() + +  : string|resource|GdImage +
        + +
        + moduleValueIsValid() + +  : bool +
        + +
        + checkGD() + +  : void +
        +
        Checks whether GD is installed and if the given mode is supported
        + +
        + collectModules() + +  : array<string|int, mixed> +
        +
        collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules
        + +
        + copyVars() + +  : void +
        +
        Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.
        + +
        + createImage() + +  : GdImage|resource +
        +
        Creates a new GdImage resource and scales it if necessary
        + +
        + drawImage() + +  : void +
        +
        Draws the QR image
        + +
        + dumpImage() + +  : string +
        +
        Creates the final image by calling the desired GD output function
        + +
        + getDefaultModuleValue() + +  : mixed|null +
        +
        Returns a default value for either dark or light modules
        + +
        + getModuleValue() + +  : mixed +
        +
        Returns the prepared value for the given $M_TYPE
        + +
        + getModuleValueAt() + +  : mixed|null +
        +
        Returns the prepared module value at the given coordinate [$x, $y] (convenience)
        + +
        + getOutputDimensions() + +  : array<string|int, mixed> +
        +
        Returns a 2 element array with the current output width and height
        + +
        + module() + +  : void +
        +
        Creates a single QR pixel with the given settings
        + +
        + prepareModuleValue() + +  : mixed|null +
        +
        Prepares the value for the given input ()
        + +
        + renderImage() + +  : void +
        +
        Renders the image with the gdimage function for the desired output
        + +
        + saveToFile() + +  : void +
        +
        Saves the qr $data to a $file. If $file is null, nothing happens.
        + +
        + setBgColor() + +  : void +
        +
        Sets the background color
        + +
        + setMatrixDimensions() + +  : void +
        +
        Sets/updates the matrix dimensions
        + +
        + setModuleValues() + +  : void +
        +
        Sets the initial module values
        + +
        + setTransparencyColor() + +  : void +
        +
        Sets the transparency color
        + +
        + toBase64DataURI() + +  : string +
        +
        Returns a base64 data URI for the given string and mime type
        + +
        + + + + + +
        +

        + Constants + + +

        +
        +

        + MIME_TYPE + + +

        + + + + + + public + mixed + MIME_TYPE + = 'image/gif' + + + + + + + +
        +
        + + +
        +

        + Properties + + +

        +
        +

        + $background + + + + +

        + + +

        The allocated background color

        + + + protected + int + $background + + + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + imagecolorallocate() + + +
        +
        + +
        +
        +

        + $circleDiameter + + + + +

        + + + + + protected + float + $circleDiameter + + + + + + +
        +
        +

        + $circleRadius + + + + +

        + + + + + protected + float + $circleRadius + + + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + QROptions::$circleRadius + + +
        +
        + +
        +
        +

        + $connectPaths + + + + +

        + + + + + protected + bool + $connectPaths + + + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + QROptions::$connectPaths + + +
        +
        + +
        +
        +

        + $drawCircularModules + + + + +

        + + + + + protected + bool + $drawCircularModules + + + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + QROptions::$drawCircularModules + + +
        +
        + +
        +
        +

        + $drawLightModules + + + + +

        + + + + + protected + bool + $drawLightModules + + + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + QROptions::$drawLightModules + + +
        +
        + +
        +
        +

        + $eol + + + + +

        + + + + + protected + string + $eol + + + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + QROptions::$eol + + +
        +
        + +
        +
        +

        + $excludeFromConnect + + + + +

        + + + + + protected + array<string|int, mixed> + $excludeFromConnect + + + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + QROptions::$excludeFromConnect + + +
        +
        + +
        +
        +

        + $image + + + + +

        + + +

        The GD image resource

        + + + protected + resource|GdImage + $image + + + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + imagecreatetruecolor() + + +
        +
        + todo: +
        +
        + +

        add \GdImage type in v6

        +
        + +
        +
        + +
        +
        +

        + $keepAsSquare + + + + +

        + + + + + protected + array<string|int, mixed> + $keepAsSquare + + + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + QROptions::$keepAsSquare + + +
        +
        + +
        +
        +

        + $length + + + + +

        + + +

        the side length of the QR image (modules * scale)

        + + + protected + int + $length + + + + + + +
        +
        +

        + $matrix + + + + +

        + + +

        the (filled) data matrix object

        + + + protected + QRMatrix + $matrix + + + + + + +
        +
        +

        + $moduleCount + + + + +

        + + +

        the current size of the QR matrix

        + + + protected + int + $moduleCount + + + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + QRMatrix::getSize() + + +
        +
        + +
        +
        +

        + $moduleValues + + + + +

        + + +

        an (optional) array of color values for the several QR matrix parts

        + + + protected + array<string|int, mixed> + $moduleValues + + + + + + +
        + +
        +

        + $scale + + + + +

        + + + + + protected + int + $scale + + + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + QROptions::$scale + + +
        +
        + +
        +
        +

        + $upscaled + + + + +

        + + +

        Whether we're running in upscale mode (scale < 20)

        + + + protected + bool + $upscaled + = false + + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + QROptions::$drawCircularModules + + +
        +
        + +
        +
        + +
        +

        + Methods + + +

        +
        +

        + __construct() + + +

        + + +

        QROutputAbstract constructor.

        + + + public + __construct(SettingsContainerInterface $options, QRMatrix $matrix) : mixed + +
        +
        + +
        Parameters
        +
        +
        + $options + : SettingsContainerInterface +
        +
        + +
        +
        + $matrix + : QRMatrix +
        +
        + +
        +
        + + + + +
        +
        +

        + dump() + + +

        + + + + + public + dump([string $file = null ]) : string|resource|GdImage + +
        +
        + +
        Parameters
        +
        +
        + $file + : string + = null
        +
        + +
        +
        + + +
        + Tags + + +
        +
        +
        + inheritDoc +
        +
        + + +
        +
        + phan-suppress +
        +
        + +

        PhanUndeclaredTypeReturnType, PhanTypeMismatchReturn

        +
        + +
        +
        + throws +
        +
        + ErrorException + + +
        +
        + +
        +
        Return values
        + string|resource|GdImage +
        + +
        +
        +

        + moduleValueIsValid() + + +

        + + + + + public + static moduleValueIsValid(mixed $value) : bool + +
        +
        + +
        Parameters
        +
        +
        + $value + : mixed +
        +
        + +
        +
        + + +
        + Tags + + +
        +
        +
        + inheritDoc +
        +
        + + +
        +
        + +
        +
        Return values
        + bool +
        + +
        +
        +

        + checkGD() + + +

        + + +

        Checks whether GD is installed and if the given mode is supported

        + + + protected + checkGD() : void + +
        +
        + + + +
        + Tags + + +
        +
        +
        + throws +
        +
        + QRCodeOutputException + + +
        +
        + codeCoverageIgnore +
        +
        + + +
        +
        + + +
        +
        +

        + collectModules() + + +

        + + +

        collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules

        + + + protected + collectModules(Closure $transform) : array<string|int, mixed> + +
        +
        +

        The transform callback is called with the following parameters:

        +

        $x - current column +$y - current row +$M_TYPE - field value +$M_TYPE_LAYER - (possibly modified) field value that acts as layer id

        +
        + +
        Parameters
        +
        +
        + $transform + : Closure +
        +
        + +
        +
        + + + +
        +
        Return values
        + array<string|int, mixed> +
        + +
        +
        +

        + copyVars() + + +

        + + +

        Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.

        + + + protected + copyVars() : void + +
        +
        +

        These variables are usually used in the "module" methods and are called up to 31329 times (at version 40).

        +
        + + + + + +
        +
        +

        + createImage() + + +

        + + +

        Creates a new GdImage resource and scales it if necessary

        + + + protected + createImage() : GdImage|resource + +
        +
        +

        we're scaling the image up in order to draw crisp round circles, otherwise they appear square-y on small scales

        +
        + + + +
        + Tags + + +
        +
        +
        + see +
        +
        + https://github.com/chillerlan/php-qrcode/issues/23 + + +
        +
        + +
        +
        Return values
        + GdImage|resource +
        + +
        +
        +

        + drawImage() + + +

        + + +

        Draws the QR image

        + + + protected + drawImage() : void + +
        +
        + + + + + +
        +
        +

        + dumpImage() + + +

        + + +

        Creates the final image by calling the desired GD output function

        + + + protected + dumpImage() : string + +
        +
        + + + +
        + Tags + + +
        +
        +
        + throws +
        +
        + QRCodeOutputException + + +
        +
        + +
        +
        Return values
        + string +
        + +
        +
        +

        + getDefaultModuleValue() + + +

        + + +

        Returns a default value for either dark or light modules

        + + + protected + abstract getDefaultModuleValue(bool $isDark) : mixed|null + +
        +
        + +
        Parameters
        +
        +
        + $isDark + : bool +
        +
        + +
        +
        + + + +
        +
        Return values
        + mixed|null + — +

        return value depends on the output class

        +
        + +
        + +
        +
        +

        + getModuleValue() + + +

        + + +

        Returns the prepared value for the given $M_TYPE

        + + + protected + getModuleValue(int $M_TYPE) : mixed + +
        +
        + +
        Parameters
        +
        +
        + $M_TYPE + : int +
        +
        + +
        +
        + + +
        + Tags + + +
        +
        +
        + throws +
        +
        + QRCodeOutputException + +

        if $moduleValues[$M_TYPE] doesn't exist

        +
        + +
        +
        + +
        +
        Return values
        + mixed + — +

        return value depends on the output class

        +
        + +
        + +
        +
        +

        + getModuleValueAt() + + +

        + + +

        Returns the prepared module value at the given coordinate [$x, $y] (convenience)

        + + + protected + getModuleValueAt(int $x, int $y) : mixed|null + +
        +
        + +
        Parameters
        +
        +
        + $x + : int +
        +
        + +
        +
        + $y + : int +
        +
        + +
        +
        + + + +
        +
        Return values
        + mixed|null +
        + +
        +
        +

        + getOutputDimensions() + + +

        + + +

        Returns a 2 element array with the current output width and height

        + + + protected + getOutputDimensions() : array<string|int, mixed> + +
        +
        +

        The type and units of the values depend on the output class. The default value is the current module count * scale.

        +
        + + + + +
        +
        Return values
        + array<string|int, mixed> +
        + +
        +
        +

        + module() + + +

        + + +

        Creates a single QR pixel with the given settings

        + + + protected + module(int $x, int $y, int $M_TYPE) : void + +
        +
        + +
        Parameters
        +
        +
        + $x + : int +
        +
        + +
        +
        + $y + : int +
        +
        + +
        +
        + $M_TYPE + : int +
        +
        + +
        +
        + + + + +
        +
        +

        + prepareModuleValue() + + +

        + + +

        Prepares the value for the given input ()

        + + + protected + abstract prepareModuleValue(mixed $value) : mixed|null + +
        +
        + +
        Parameters
        +
        +
        + $value + : mixed +
        +
        + +
        +
        + + + +
        +
        Return values
        + mixed|null + — +

        return value depends on the output class

        +
        + +
        + +
        +
        +

        + renderImage() + + +

        + + +

        Renders the image with the gdimage function for the desired output

        + + + protected + renderImage() : void + +
        +
        + + + +
        + Tags + + +
        +
        +
        + inheritDoc +
        +
        + + +
        +
        + + +
        +
        +

        + saveToFile() + + +

        + + +

        Saves the qr $data to a $file. If $file is null, nothing happens.

        + + + protected + saveToFile(string $data[, string $file = null ]) : void + +
        +
        + +
        Parameters
        +
        +
        + $data + : string +
        +
        + +
        +
        + $file + : string + = null
        +
        + +
        +
        + + +
        + Tags + + +
        +
        +
        + see +
        +
        + file_put_contents() + + +
        +
        + see +
        +
        + QROptions::$cachefile + + +
        +
        + throws +
        +
        + QRCodeOutputException + + +
        +
        + + +
        +
        +

        + setBgColor() + + +

        + + +

        Sets the background color

        + + + protected + setBgColor() : void + +
        +
        + + + + + +
        +
        +

        + setMatrixDimensions() + + +

        + + +

        Sets/updates the matrix dimensions

        + + + protected + setMatrixDimensions() : void + +
        +
        +

        Call this method if you modify the matrix from within your custom module in case the dimensions have been changed

        +
        + + + + + +
        +
        +

        + setModuleValues() + + +

        + + +

        Sets the initial module values

        + + + protected + setModuleValues() : void + +
        +
        + + + + + +
        +
        +

        + setTransparencyColor() + + +

        + + +

        Sets the transparency color

        + + + protected + setTransparencyColor() : void + +
        +
        + + + + + +
        +
        +

        + toBase64DataURI() + + +

        + + +

        Returns a base64 data URI for the given string and mime type

        + + + protected + toBase64DataURI(string $data[, string $mime = null ]) : string + +
        +
        + +
        Parameters
        +
        +
        + $data + : string +
        +
        + +
        +
        + $mime + : string + = null
        +
        + +
        +
        + + + +
        +
        Return values
        + string +
        + +
        +
        + +
        +
        +
        +
        +
        
        +        
        + +
        +
        + + + +
        +
        +
        + +
        + On this page + + +
        + +
        +
        +
        +
        +
        +

        Search results

        + +
        +
        +
          +
          +
          +
          +
          + + +
          + + + + + + + + diff --git a/classes/chillerlan-QRCode-Output-QRGdImageJPEG.html b/classes/chillerlan-QRCode-Output-QRGdImageJPEG.html new file mode 100644 index 000000000..62fd831eb --- /dev/null +++ b/classes/chillerlan-QRCode-Output-QRGdImageJPEG.html @@ -0,0 +1,2583 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
          +

          Documentation

          + + + + + +
          + +
          +
          + + + + +
          +
          + + +
          +

          + QRGdImageJPEG + + + extends QRGdImage + + +
          + in package + +
          + + +

          + +
          + + +
          + + + +

          GdImage jpeg output

          + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + imagejpeg() + + +
          +
          + + + +

          + Table of Contents + + +

          + + + + + + + +

          + Constants + + +

          +
          +
          + MIME_TYPE + +  = 'image/jpg' +
          + +
          + + +

          + Properties + + +

          +
          +
          + $background + +  : int +
          +
          The allocated background color
          + +
          + $circleDiameter + +  : float +
          + +
          + $circleRadius + +  : float +
          + +
          + $connectPaths + +  : bool +
          + +
          + $drawCircularModules + +  : bool +
          + +
          + $drawLightModules + +  : bool +
          + +
          + $eol + +  : string +
          + +
          + $excludeFromConnect + +  : array<string|int, mixed> +
          + +
          + $image + +  : resource|GdImage +
          +
          The GD image resource
          + +
          + $keepAsSquare + +  : array<string|int, mixed> +
          + +
          + $length + +  : int +
          +
          the side length of the QR image (modules * scale)
          + +
          + $matrix + +  : QRMatrix +
          +
          the (filled) data matrix object
          + +
          + $moduleCount + +  : int +
          +
          the current size of the QR matrix
          + +
          + $moduleValues + +  : array<string|int, mixed> +
          +
          an (optional) array of color values for the several QR matrix parts
          + +
          + $options + +  : SettingsContainerInterface|QROptions +
          + +
          + $scale + +  : int +
          + +
          + $upscaled + +  : bool +
          +
          Whether we're running in upscale mode (scale < 20)
          + +
          + +

          + Methods + + +

          +
          +
          + __construct() + +  : mixed +
          +
          QROutputAbstract constructor.
          + +
          + dump() + +  : string|resource|GdImage +
          + +
          + moduleValueIsValid() + +  : bool +
          + +
          + checkGD() + +  : void +
          +
          Checks whether GD is installed and if the given mode is supported
          + +
          + collectModules() + +  : array<string|int, mixed> +
          +
          collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules
          + +
          + copyVars() + +  : void +
          +
          Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.
          + +
          + createImage() + +  : GdImage|resource +
          +
          Creates a new GdImage resource and scales it if necessary
          + +
          + drawImage() + +  : void +
          +
          Draws the QR image
          + +
          + dumpImage() + +  : string +
          +
          Creates the final image by calling the desired GD output function
          + +
          + getDefaultModuleValue() + +  : mixed|null +
          +
          Returns a default value for either dark or light modules
          + +
          + getModuleValue() + +  : mixed +
          +
          Returns the prepared value for the given $M_TYPE
          + +
          + getModuleValueAt() + +  : mixed|null +
          +
          Returns the prepared module value at the given coordinate [$x, $y] (convenience)
          + +
          + getOutputDimensions() + +  : array<string|int, mixed> +
          +
          Returns a 2 element array with the current output width and height
          + +
          + module() + +  : void +
          +
          Creates a single QR pixel with the given settings
          + +
          + prepareModuleValue() + +  : mixed|null +
          +
          Prepares the value for the given input ()
          + +
          + renderImage() + +  : void +
          +
          Renders the image with the gdimage function for the desired output
          + +
          + saveToFile() + +  : void +
          +
          Saves the qr $data to a $file. If $file is null, nothing happens.
          + +
          + setBgColor() + +  : void +
          +
          Sets the background color
          + +
          + setMatrixDimensions() + +  : void +
          +
          Sets/updates the matrix dimensions
          + +
          + setModuleValues() + +  : void +
          +
          Sets the initial module values
          + +
          + setTransparencyColor() + +  : void +
          +
          Sets the transparency color
          + +
          + toBase64DataURI() + +  : string +
          +
          Returns a base64 data URI for the given string and mime type
          + +
          + + + + + +
          +

          + Constants + + +

          +
          +

          + MIME_TYPE + + +

          + + + + + + public + mixed + MIME_TYPE + = 'image/jpg' + + + + + + + +
          +
          + + +
          +

          + Properties + + +

          +
          +

          + $background + + + + +

          + + +

          The allocated background color

          + + + protected + int + $background + + + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + imagecolorallocate() + + +
          +
          + +
          +
          +

          + $circleDiameter + + + + +

          + + + + + protected + float + $circleDiameter + + + + + + +
          +
          +

          + $circleRadius + + + + +

          + + + + + protected + float + $circleRadius + + + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + QROptions::$circleRadius + + +
          +
          + +
          +
          +

          + $connectPaths + + + + +

          + + + + + protected + bool + $connectPaths + + + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + QROptions::$connectPaths + + +
          +
          + +
          +
          +

          + $drawCircularModules + + + + +

          + + + + + protected + bool + $drawCircularModules + + + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + QROptions::$drawCircularModules + + +
          +
          + +
          +
          +

          + $drawLightModules + + + + +

          + + + + + protected + bool + $drawLightModules + + + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + QROptions::$drawLightModules + + +
          +
          + +
          +
          +

          + $eol + + + + +

          + + + + + protected + string + $eol + + + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + QROptions::$eol + + +
          +
          + +
          +
          +

          + $excludeFromConnect + + + + +

          + + + + + protected + array<string|int, mixed> + $excludeFromConnect + + + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + QROptions::$excludeFromConnect + + +
          +
          + +
          +
          +

          + $image + + + + +

          + + +

          The GD image resource

          + + + protected + resource|GdImage + $image + + + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + imagecreatetruecolor() + + +
          +
          + todo: +
          +
          + +

          add \GdImage type in v6

          +
          + +
          +
          + +
          +
          +

          + $keepAsSquare + + + + +

          + + + + + protected + array<string|int, mixed> + $keepAsSquare + + + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + QROptions::$keepAsSquare + + +
          +
          + +
          +
          +

          + $length + + + + +

          + + +

          the side length of the QR image (modules * scale)

          + + + protected + int + $length + + + + + + +
          +
          +

          + $matrix + + + + +

          + + +

          the (filled) data matrix object

          + + + protected + QRMatrix + $matrix + + + + + + +
          +
          +

          + $moduleCount + + + + +

          + + +

          the current size of the QR matrix

          + + + protected + int + $moduleCount + + + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + QRMatrix::getSize() + + +
          +
          + +
          +
          +

          + $moduleValues + + + + +

          + + +

          an (optional) array of color values for the several QR matrix parts

          + + + protected + array<string|int, mixed> + $moduleValues + + + + + + +
          + +
          +

          + $scale + + + + +

          + + + + + protected + int + $scale + + + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + QROptions::$scale + + +
          +
          + +
          +
          +

          + $upscaled + + + + +

          + + +

          Whether we're running in upscale mode (scale < 20)

          + + + protected + bool + $upscaled + = false + + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + QROptions::$drawCircularModules + + +
          +
          + +
          +
          + +
          +

          + Methods + + +

          +
          +

          + __construct() + + +

          + + +

          QROutputAbstract constructor.

          + + + public + __construct(SettingsContainerInterface $options, QRMatrix $matrix) : mixed + +
          +
          + +
          Parameters
          +
          +
          + $options + : SettingsContainerInterface +
          +
          + +
          +
          + $matrix + : QRMatrix +
          +
          + +
          +
          + + + + +
          +
          +

          + dump() + + +

          + + + + + public + dump([string $file = null ]) : string|resource|GdImage + +
          +
          + +
          Parameters
          +
          +
          + $file + : string + = null
          +
          + +
          +
          + + +
          + Tags + + +
          +
          +
          + inheritDoc +
          +
          + + +
          +
          + phan-suppress +
          +
          + +

          PhanUndeclaredTypeReturnType, PhanTypeMismatchReturn

          +
          + +
          +
          + throws +
          +
          + ErrorException + + +
          +
          + +
          +
          Return values
          + string|resource|GdImage +
          + +
          +
          +

          + moduleValueIsValid() + + +

          + + + + + public + static moduleValueIsValid(mixed $value) : bool + +
          +
          + +
          Parameters
          +
          +
          + $value + : mixed +
          +
          + +
          +
          + + +
          + Tags + + +
          +
          +
          + inheritDoc +
          +
          + + +
          +
          + +
          +
          Return values
          + bool +
          + +
          +
          +

          + checkGD() + + +

          + + +

          Checks whether GD is installed and if the given mode is supported

          + + + protected + checkGD() : void + +
          +
          + + + +
          + Tags + + +
          +
          +
          + throws +
          +
          + QRCodeOutputException + + +
          +
          + codeCoverageIgnore +
          +
          + + +
          +
          + + +
          +
          +

          + collectModules() + + +

          + + +

          collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules

          + + + protected + collectModules(Closure $transform) : array<string|int, mixed> + +
          +
          +

          The transform callback is called with the following parameters:

          +

          $x - current column +$y - current row +$M_TYPE - field value +$M_TYPE_LAYER - (possibly modified) field value that acts as layer id

          +
          + +
          Parameters
          +
          +
          + $transform + : Closure +
          +
          + +
          +
          + + + +
          +
          Return values
          + array<string|int, mixed> +
          + +
          +
          +

          + copyVars() + + +

          + + +

          Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.

          + + + protected + copyVars() : void + +
          +
          +

          These variables are usually used in the "module" methods and are called up to 31329 times (at version 40).

          +
          + + + + + +
          +
          +

          + createImage() + + +

          + + +

          Creates a new GdImage resource and scales it if necessary

          + + + protected + createImage() : GdImage|resource + +
          +
          +

          we're scaling the image up in order to draw crisp round circles, otherwise they appear square-y on small scales

          +
          + + + +
          + Tags + + +
          +
          +
          + see +
          +
          + https://github.com/chillerlan/php-qrcode/issues/23 + + +
          +
          + +
          +
          Return values
          + GdImage|resource +
          + +
          +
          +

          + drawImage() + + +

          + + +

          Draws the QR image

          + + + protected + drawImage() : void + +
          +
          + + + + + +
          +
          +

          + dumpImage() + + +

          + + +

          Creates the final image by calling the desired GD output function

          + + + protected + dumpImage() : string + +
          +
          + + + +
          + Tags + + +
          +
          +
          + throws +
          +
          + QRCodeOutputException + + +
          +
          + +
          +
          Return values
          + string +
          + +
          +
          +

          + getDefaultModuleValue() + + +

          + + +

          Returns a default value for either dark or light modules

          + + + protected + abstract getDefaultModuleValue(bool $isDark) : mixed|null + +
          +
          + +
          Parameters
          +
          +
          + $isDark + : bool +
          +
          + +
          +
          + + + +
          +
          Return values
          + mixed|null + — +

          return value depends on the output class

          +
          + +
          + +
          +
          +

          + getModuleValue() + + +

          + + +

          Returns the prepared value for the given $M_TYPE

          + + + protected + getModuleValue(int $M_TYPE) : mixed + +
          +
          + +
          Parameters
          +
          +
          + $M_TYPE + : int +
          +
          + +
          +
          + + +
          + Tags + + +
          +
          +
          + throws +
          +
          + QRCodeOutputException + +

          if $moduleValues[$M_TYPE] doesn't exist

          +
          + +
          +
          + +
          +
          Return values
          + mixed + — +

          return value depends on the output class

          +
          + +
          + +
          +
          +

          + getModuleValueAt() + + +

          + + +

          Returns the prepared module value at the given coordinate [$x, $y] (convenience)

          + + + protected + getModuleValueAt(int $x, int $y) : mixed|null + +
          +
          + +
          Parameters
          +
          +
          + $x + : int +
          +
          + +
          +
          + $y + : int +
          +
          + +
          +
          + + + +
          +
          Return values
          + mixed|null +
          + +
          +
          +

          + getOutputDimensions() + + +

          + + +

          Returns a 2 element array with the current output width and height

          + + + protected + getOutputDimensions() : array<string|int, mixed> + +
          +
          +

          The type and units of the values depend on the output class. The default value is the current module count * scale.

          +
          + + + + +
          +
          Return values
          + array<string|int, mixed> +
          + +
          +
          +

          + module() + + +

          + + +

          Creates a single QR pixel with the given settings

          + + + protected + module(int $x, int $y, int $M_TYPE) : void + +
          +
          + +
          Parameters
          +
          +
          + $x + : int +
          +
          + +
          +
          + $y + : int +
          +
          + +
          +
          + $M_TYPE + : int +
          +
          + +
          +
          + + + + +
          +
          +

          + prepareModuleValue() + + +

          + + +

          Prepares the value for the given input ()

          + + + protected + abstract prepareModuleValue(mixed $value) : mixed|null + +
          +
          + +
          Parameters
          +
          +
          + $value + : mixed +
          +
          + +
          +
          + + + +
          +
          Return values
          + mixed|null + — +

          return value depends on the output class

          +
          + +
          + +
          +
          +

          + renderImage() + + +

          + + +

          Renders the image with the gdimage function for the desired output

          + + + protected + renderImage() : void + +
          +
          + + + +
          + Tags + + +
          +
          +
          + inheritDoc +
          +
          + + +
          +
          + + +
          +
          +

          + saveToFile() + + +

          + + +

          Saves the qr $data to a $file. If $file is null, nothing happens.

          + + + protected + saveToFile(string $data[, string $file = null ]) : void + +
          +
          + +
          Parameters
          +
          +
          + $data + : string +
          +
          + +
          +
          + $file + : string + = null
          +
          + +
          +
          + + +
          + Tags + + +
          +
          +
          + see +
          +
          + file_put_contents() + + +
          +
          + see +
          +
          + QROptions::$cachefile + + +
          +
          + throws +
          +
          + QRCodeOutputException + + +
          +
          + + +
          +
          +

          + setBgColor() + + +

          + + +

          Sets the background color

          + + + protected + setBgColor() : void + +
          +
          + + + + + +
          +
          +

          + setMatrixDimensions() + + +

          + + +

          Sets/updates the matrix dimensions

          + + + protected + setMatrixDimensions() : void + +
          +
          +

          Call this method if you modify the matrix from within your custom module in case the dimensions have been changed

          +
          + + + + + +
          +
          +

          + setModuleValues() + + +

          + + +

          Sets the initial module values

          + + + protected + setModuleValues() : void + +
          +
          + + + + + +
          +
          +

          + setTransparencyColor() + + +

          + + +

          Sets the transparency color

          + + + protected + setTransparencyColor() : void + +
          +
          + + + +
          + Tags + + +
          +
          +
          + inheritDoc +
          +
          + + +
          +
          + + +
          +
          +

          + toBase64DataURI() + + +

          + + +

          Returns a base64 data URI for the given string and mime type

          + + + protected + toBase64DataURI(string $data[, string $mime = null ]) : string + +
          +
          + +
          Parameters
          +
          +
          + $data + : string +
          +
          + +
          +
          + $mime + : string + = null
          +
          + +
          +
          + + + +
          +
          Return values
          + string +
          + +
          +
          + +
          +
          +
          +
          +
          
          +        
          + +
          +
          + + + +
          +
          +
          + +
          + On this page + + +
          + +
          +
          +
          +
          +
          +

          Search results

          + +
          +
          +
            +
            +
            +
            +
            + + +
            + + + + + + + + diff --git a/classes/chillerlan-QRCode-Output-QRGdImagePNG.html b/classes/chillerlan-QRCode-Output-QRGdImagePNG.html new file mode 100644 index 000000000..6088d1388 --- /dev/null +++ b/classes/chillerlan-QRCode-Output-QRGdImagePNG.html @@ -0,0 +1,2569 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
            +

            Documentation

            + + + + + +
            + +
            +
            + + + + +
            +
            + + +
            +

            + QRGdImagePNG + + + extends QRGdImage + + +
            + in package + +
            + + +

            + +
            + + +
            + + + +

            GdImage png output

            + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + imagepng() + + +
            +
            + + + +

            + Table of Contents + + +

            + + + + + + + +

            + Constants + + +

            +
            +
            + MIME_TYPE + +  = 'image/png' +
            + +
            + + +

            + Properties + + +

            +
            +
            + $background + +  : int +
            +
            The allocated background color
            + +
            + $circleDiameter + +  : float +
            + +
            + $circleRadius + +  : float +
            + +
            + $connectPaths + +  : bool +
            + +
            + $drawCircularModules + +  : bool +
            + +
            + $drawLightModules + +  : bool +
            + +
            + $eol + +  : string +
            + +
            + $excludeFromConnect + +  : array<string|int, mixed> +
            + +
            + $image + +  : resource|GdImage +
            +
            The GD image resource
            + +
            + $keepAsSquare + +  : array<string|int, mixed> +
            + +
            + $length + +  : int +
            +
            the side length of the QR image (modules * scale)
            + +
            + $matrix + +  : QRMatrix +
            +
            the (filled) data matrix object
            + +
            + $moduleCount + +  : int +
            +
            the current size of the QR matrix
            + +
            + $moduleValues + +  : array<string|int, mixed> +
            +
            an (optional) array of color values for the several QR matrix parts
            + +
            + $options + +  : SettingsContainerInterface|QROptions +
            + +
            + $scale + +  : int +
            + +
            + $upscaled + +  : bool +
            +
            Whether we're running in upscale mode (scale < 20)
            + +
            + +

            + Methods + + +

            +
            +
            + __construct() + +  : mixed +
            +
            QROutputAbstract constructor.
            + +
            + dump() + +  : string|resource|GdImage +
            + +
            + moduleValueIsValid() + +  : bool +
            + +
            + checkGD() + +  : void +
            +
            Checks whether GD is installed and if the given mode is supported
            + +
            + collectModules() + +  : array<string|int, mixed> +
            +
            collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules
            + +
            + copyVars() + +  : void +
            +
            Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.
            + +
            + createImage() + +  : GdImage|resource +
            +
            Creates a new GdImage resource and scales it if necessary
            + +
            + drawImage() + +  : void +
            +
            Draws the QR image
            + +
            + dumpImage() + +  : string +
            +
            Creates the final image by calling the desired GD output function
            + +
            + getDefaultModuleValue() + +  : mixed|null +
            +
            Returns a default value for either dark or light modules
            + +
            + getModuleValue() + +  : mixed +
            +
            Returns the prepared value for the given $M_TYPE
            + +
            + getModuleValueAt() + +  : mixed|null +
            +
            Returns the prepared module value at the given coordinate [$x, $y] (convenience)
            + +
            + getOutputDimensions() + +  : array<string|int, mixed> +
            +
            Returns a 2 element array with the current output width and height
            + +
            + module() + +  : void +
            +
            Creates a single QR pixel with the given settings
            + +
            + prepareModuleValue() + +  : mixed|null +
            +
            Prepares the value for the given input ()
            + +
            + renderImage() + +  : void +
            +
            Renders the image with the gdimage function for the desired output
            + +
            + saveToFile() + +  : void +
            +
            Saves the qr $data to a $file. If $file is null, nothing happens.
            + +
            + setBgColor() + +  : void +
            +
            Sets the background color
            + +
            + setMatrixDimensions() + +  : void +
            +
            Sets/updates the matrix dimensions
            + +
            + setModuleValues() + +  : void +
            +
            Sets the initial module values
            + +
            + setTransparencyColor() + +  : void +
            +
            Sets the transparency color
            + +
            + toBase64DataURI() + +  : string +
            +
            Returns a base64 data URI for the given string and mime type
            + +
            + + + + + +
            +

            + Constants + + +

            +
            +

            + MIME_TYPE + + +

            + + + + + + public + mixed + MIME_TYPE + = 'image/png' + + + + + + + +
            +
            + + +
            +

            + Properties + + +

            +
            +

            + $background + + + + +

            + + +

            The allocated background color

            + + + protected + int + $background + + + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + imagecolorallocate() + + +
            +
            + +
            +
            +

            + $circleDiameter + + + + +

            + + + + + protected + float + $circleDiameter + + + + + + +
            +
            +

            + $circleRadius + + + + +

            + + + + + protected + float + $circleRadius + + + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + QROptions::$circleRadius + + +
            +
            + +
            +
            +

            + $connectPaths + + + + +

            + + + + + protected + bool + $connectPaths + + + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + QROptions::$connectPaths + + +
            +
            + +
            +
            +

            + $drawCircularModules + + + + +

            + + + + + protected + bool + $drawCircularModules + + + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + QROptions::$drawCircularModules + + +
            +
            + +
            +
            +

            + $drawLightModules + + + + +

            + + + + + protected + bool + $drawLightModules + + + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + QROptions::$drawLightModules + + +
            +
            + +
            +
            +

            + $eol + + + + +

            + + + + + protected + string + $eol + + + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + QROptions::$eol + + +
            +
            + +
            +
            +

            + $excludeFromConnect + + + + +

            + + + + + protected + array<string|int, mixed> + $excludeFromConnect + + + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + QROptions::$excludeFromConnect + + +
            +
            + +
            +
            +

            + $image + + + + +

            + + +

            The GD image resource

            + + + protected + resource|GdImage + $image + + + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + imagecreatetruecolor() + + +
            +
            + todo: +
            +
            + +

            add \GdImage type in v6

            +
            + +
            +
            + +
            +
            +

            + $keepAsSquare + + + + +

            + + + + + protected + array<string|int, mixed> + $keepAsSquare + + + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + QROptions::$keepAsSquare + + +
            +
            + +
            +
            +

            + $length + + + + +

            + + +

            the side length of the QR image (modules * scale)

            + + + protected + int + $length + + + + + + +
            +
            +

            + $matrix + + + + +

            + + +

            the (filled) data matrix object

            + + + protected + QRMatrix + $matrix + + + + + + +
            +
            +

            + $moduleCount + + + + +

            + + +

            the current size of the QR matrix

            + + + protected + int + $moduleCount + + + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + QRMatrix::getSize() + + +
            +
            + +
            +
            +

            + $moduleValues + + + + +

            + + +

            an (optional) array of color values for the several QR matrix parts

            + + + protected + array<string|int, mixed> + $moduleValues + + + + + + +
            + +
            +

            + $scale + + + + +

            + + + + + protected + int + $scale + + + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + QROptions::$scale + + +
            +
            + +
            +
            +

            + $upscaled + + + + +

            + + +

            Whether we're running in upscale mode (scale < 20)

            + + + protected + bool + $upscaled + = false + + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + QROptions::$drawCircularModules + + +
            +
            + +
            +
            + +
            +

            + Methods + + +

            +
            +

            + __construct() + + +

            + + +

            QROutputAbstract constructor.

            + + + public + __construct(SettingsContainerInterface $options, QRMatrix $matrix) : mixed + +
            +
            + +
            Parameters
            +
            +
            + $options + : SettingsContainerInterface +
            +
            + +
            +
            + $matrix + : QRMatrix +
            +
            + +
            +
            + + + + +
            +
            +

            + dump() + + +

            + + + + + public + dump([string $file = null ]) : string|resource|GdImage + +
            +
            + +
            Parameters
            +
            +
            + $file + : string + = null
            +
            + +
            +
            + + +
            + Tags + + +
            +
            +
            + inheritDoc +
            +
            + + +
            +
            + phan-suppress +
            +
            + +

            PhanUndeclaredTypeReturnType, PhanTypeMismatchReturn

            +
            + +
            +
            + throws +
            +
            + ErrorException + + +
            +
            + +
            +
            Return values
            + string|resource|GdImage +
            + +
            +
            +

            + moduleValueIsValid() + + +

            + + + + + public + static moduleValueIsValid(mixed $value) : bool + +
            +
            + +
            Parameters
            +
            +
            + $value + : mixed +
            +
            + +
            +
            + + +
            + Tags + + +
            +
            +
            + inheritDoc +
            +
            + + +
            +
            + +
            +
            Return values
            + bool +
            + +
            +
            +

            + checkGD() + + +

            + + +

            Checks whether GD is installed and if the given mode is supported

            + + + protected + checkGD() : void + +
            +
            + + + +
            + Tags + + +
            +
            +
            + throws +
            +
            + QRCodeOutputException + + +
            +
            + codeCoverageIgnore +
            +
            + + +
            +
            + + +
            +
            +

            + collectModules() + + +

            + + +

            collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules

            + + + protected + collectModules(Closure $transform) : array<string|int, mixed> + +
            +
            +

            The transform callback is called with the following parameters:

            +

            $x - current column +$y - current row +$M_TYPE - field value +$M_TYPE_LAYER - (possibly modified) field value that acts as layer id

            +
            + +
            Parameters
            +
            +
            + $transform + : Closure +
            +
            + +
            +
            + + + +
            +
            Return values
            + array<string|int, mixed> +
            + +
            +
            +

            + copyVars() + + +

            + + +

            Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.

            + + + protected + copyVars() : void + +
            +
            +

            These variables are usually used in the "module" methods and are called up to 31329 times (at version 40).

            +
            + + + + + +
            +
            +

            + createImage() + + +

            + + +

            Creates a new GdImage resource and scales it if necessary

            + + + protected + createImage() : GdImage|resource + +
            +
            +

            we're scaling the image up in order to draw crisp round circles, otherwise they appear square-y on small scales

            +
            + + + +
            + Tags + + +
            +
            +
            + see +
            +
            + https://github.com/chillerlan/php-qrcode/issues/23 + + +
            +
            + +
            +
            Return values
            + GdImage|resource +
            + +
            +
            +

            + drawImage() + + +

            + + +

            Draws the QR image

            + + + protected + drawImage() : void + +
            +
            + + + + + +
            +
            +

            + dumpImage() + + +

            + + +

            Creates the final image by calling the desired GD output function

            + + + protected + dumpImage() : string + +
            +
            + + + +
            + Tags + + +
            +
            +
            + throws +
            +
            + QRCodeOutputException + + +
            +
            + +
            +
            Return values
            + string +
            + +
            +
            +

            + getDefaultModuleValue() + + +

            + + +

            Returns a default value for either dark or light modules

            + + + protected + abstract getDefaultModuleValue(bool $isDark) : mixed|null + +
            +
            + +
            Parameters
            +
            +
            + $isDark + : bool +
            +
            + +
            +
            + + + +
            +
            Return values
            + mixed|null + — +

            return value depends on the output class

            +
            + +
            + +
            +
            +

            + getModuleValue() + + +

            + + +

            Returns the prepared value for the given $M_TYPE

            + + + protected + getModuleValue(int $M_TYPE) : mixed + +
            +
            + +
            Parameters
            +
            +
            + $M_TYPE + : int +
            +
            + +
            +
            + + +
            + Tags + + +
            +
            +
            + throws +
            +
            + QRCodeOutputException + +

            if $moduleValues[$M_TYPE] doesn't exist

            +
            + +
            +
            + +
            +
            Return values
            + mixed + — +

            return value depends on the output class

            +
            + +
            + +
            +
            +

            + getModuleValueAt() + + +

            + + +

            Returns the prepared module value at the given coordinate [$x, $y] (convenience)

            + + + protected + getModuleValueAt(int $x, int $y) : mixed|null + +
            +
            + +
            Parameters
            +
            +
            + $x + : int +
            +
            + +
            +
            + $y + : int +
            +
            + +
            +
            + + + +
            +
            Return values
            + mixed|null +
            + +
            +
            +

            + getOutputDimensions() + + +

            + + +

            Returns a 2 element array with the current output width and height

            + + + protected + getOutputDimensions() : array<string|int, mixed> + +
            +
            +

            The type and units of the values depend on the output class. The default value is the current module count * scale.

            +
            + + + + +
            +
            Return values
            + array<string|int, mixed> +
            + +
            +
            +

            + module() + + +

            + + +

            Creates a single QR pixel with the given settings

            + + + protected + module(int $x, int $y, int $M_TYPE) : void + +
            +
            + +
            Parameters
            +
            +
            + $x + : int +
            +
            + +
            +
            + $y + : int +
            +
            + +
            +
            + $M_TYPE + : int +
            +
            + +
            +
            + + + + +
            +
            +

            + prepareModuleValue() + + +

            + + +

            Prepares the value for the given input ()

            + + + protected + abstract prepareModuleValue(mixed $value) : mixed|null + +
            +
            + +
            Parameters
            +
            +
            + $value + : mixed +
            +
            + +
            +
            + + + +
            +
            Return values
            + mixed|null + — +

            return value depends on the output class

            +
            + +
            + +
            +
            +

            + renderImage() + + +

            + + +

            Renders the image with the gdimage function for the desired output

            + + + protected + renderImage() : void + +
            +
            + + + +
            + Tags + + +
            +
            +
            + inheritDoc +
            +
            + + +
            +
            + + +
            +
            +

            + saveToFile() + + +

            + + +

            Saves the qr $data to a $file. If $file is null, nothing happens.

            + + + protected + saveToFile(string $data[, string $file = null ]) : void + +
            +
            + +
            Parameters
            +
            +
            + $data + : string +
            +
            + +
            +
            + $file + : string + = null
            +
            + +
            +
            + + +
            + Tags + + +
            +
            +
            + see +
            +
            + file_put_contents() + + +
            +
            + see +
            +
            + QROptions::$cachefile + + +
            +
            + throws +
            +
            + QRCodeOutputException + + +
            +
            + + +
            +
            +

            + setBgColor() + + +

            + + +

            Sets the background color

            + + + protected + setBgColor() : void + +
            +
            + + + + + +
            +
            +

            + setMatrixDimensions() + + +

            + + +

            Sets/updates the matrix dimensions

            + + + protected + setMatrixDimensions() : void + +
            +
            +

            Call this method if you modify the matrix from within your custom module in case the dimensions have been changed

            +
            + + + + + +
            +
            +

            + setModuleValues() + + +

            + + +

            Sets the initial module values

            + + + protected + setModuleValues() : void + +
            +
            + + + + + +
            +
            +

            + setTransparencyColor() + + +

            + + +

            Sets the transparency color

            + + + protected + setTransparencyColor() : void + +
            +
            + + + + + +
            +
            +

            + toBase64DataURI() + + +

            + + +

            Returns a base64 data URI for the given string and mime type

            + + + protected + toBase64DataURI(string $data[, string $mime = null ]) : string + +
            +
            + +
            Parameters
            +
            +
            + $data + : string +
            +
            + +
            +
            + $mime + : string + = null
            +
            + +
            +
            + + + +
            +
            Return values
            + string +
            + +
            +
            + +
            +
            +
            +
            +
            
            +        
            + +
            +
            + + + +
            +
            +
            + +
            + On this page + + +
            + +
            +
            +
            +
            +
            +

            Search results

            + +
            +
            +
              +
              +
              +
              +
              + + +
              + + + + + + + + diff --git a/classes/chillerlan-QRCode-Output-QRGdImageWEBP.html b/classes/chillerlan-QRCode-Output-QRGdImageWEBP.html new file mode 100644 index 000000000..2d91b40eb --- /dev/null +++ b/classes/chillerlan-QRCode-Output-QRGdImageWEBP.html @@ -0,0 +1,2569 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
              +

              Documentation

              + + + + + +
              + +
              +
              + + + + +
              +
              + + +
              +

              + QRGdImageWEBP + + + extends QRGdImage + + +
              + in package + +
              + + +

              + +
              + + +
              + + + +

              GdImage webp output

              + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + imagewebp() + + +
              +
              + + + +

              + Table of Contents + + +

              + + + + + + + +

              + Constants + + +

              +
              +
              + MIME_TYPE + +  = 'image/webp' +
              + +
              + + +

              + Properties + + +

              +
              +
              + $background + +  : int +
              +
              The allocated background color
              + +
              + $circleDiameter + +  : float +
              + +
              + $circleRadius + +  : float +
              + +
              + $connectPaths + +  : bool +
              + +
              + $drawCircularModules + +  : bool +
              + +
              + $drawLightModules + +  : bool +
              + +
              + $eol + +  : string +
              + +
              + $excludeFromConnect + +  : array<string|int, mixed> +
              + +
              + $image + +  : resource|GdImage +
              +
              The GD image resource
              + +
              + $keepAsSquare + +  : array<string|int, mixed> +
              + +
              + $length + +  : int +
              +
              the side length of the QR image (modules * scale)
              + +
              + $matrix + +  : QRMatrix +
              +
              the (filled) data matrix object
              + +
              + $moduleCount + +  : int +
              +
              the current size of the QR matrix
              + +
              + $moduleValues + +  : array<string|int, mixed> +
              +
              an (optional) array of color values for the several QR matrix parts
              + +
              + $options + +  : SettingsContainerInterface|QROptions +
              + +
              + $scale + +  : int +
              + +
              + $upscaled + +  : bool +
              +
              Whether we're running in upscale mode (scale < 20)
              + +
              + +

              + Methods + + +

              +
              +
              + __construct() + +  : mixed +
              +
              QROutputAbstract constructor.
              + +
              + dump() + +  : string|resource|GdImage +
              + +
              + moduleValueIsValid() + +  : bool +
              + +
              + checkGD() + +  : void +
              +
              Checks whether GD is installed and if the given mode is supported
              + +
              + collectModules() + +  : array<string|int, mixed> +
              +
              collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules
              + +
              + copyVars() + +  : void +
              +
              Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.
              + +
              + createImage() + +  : GdImage|resource +
              +
              Creates a new GdImage resource and scales it if necessary
              + +
              + drawImage() + +  : void +
              +
              Draws the QR image
              + +
              + dumpImage() + +  : string +
              +
              Creates the final image by calling the desired GD output function
              + +
              + getDefaultModuleValue() + +  : mixed|null +
              +
              Returns a default value for either dark or light modules
              + +
              + getModuleValue() + +  : mixed +
              +
              Returns the prepared value for the given $M_TYPE
              + +
              + getModuleValueAt() + +  : mixed|null +
              +
              Returns the prepared module value at the given coordinate [$x, $y] (convenience)
              + +
              + getOutputDimensions() + +  : array<string|int, mixed> +
              +
              Returns a 2 element array with the current output width and height
              + +
              + module() + +  : void +
              +
              Creates a single QR pixel with the given settings
              + +
              + prepareModuleValue() + +  : mixed|null +
              +
              Prepares the value for the given input ()
              + +
              + renderImage() + +  : void +
              +
              Renders the image with the gdimage function for the desired output
              + +
              + saveToFile() + +  : void +
              +
              Saves the qr $data to a $file. If $file is null, nothing happens.
              + +
              + setBgColor() + +  : void +
              +
              Sets the background color
              + +
              + setMatrixDimensions() + +  : void +
              +
              Sets/updates the matrix dimensions
              + +
              + setModuleValues() + +  : void +
              +
              Sets the initial module values
              + +
              + setTransparencyColor() + +  : void +
              +
              Sets the transparency color
              + +
              + toBase64DataURI() + +  : string +
              +
              Returns a base64 data URI for the given string and mime type
              + +
              + + + + + +
              +

              + Constants + + +

              +
              +

              + MIME_TYPE + + +

              + + + + + + public + mixed + MIME_TYPE + = 'image/webp' + + + + + + + +
              +
              + + +
              +

              + Properties + + +

              +
              +

              + $background + + + + +

              + + +

              The allocated background color

              + + + protected + int + $background + + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + imagecolorallocate() + + +
              +
              + +
              +
              +

              + $circleDiameter + + + + +

              + + + + + protected + float + $circleDiameter + + + + + + +
              +
              +

              + $circleRadius + + + + +

              + + + + + protected + float + $circleRadius + + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + QROptions::$circleRadius + + +
              +
              + +
              +
              +

              + $connectPaths + + + + +

              + + + + + protected + bool + $connectPaths + + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + QROptions::$connectPaths + + +
              +
              + +
              +
              +

              + $drawCircularModules + + + + +

              + + + + + protected + bool + $drawCircularModules + + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + QROptions::$drawCircularModules + + +
              +
              + +
              +
              +

              + $drawLightModules + + + + +

              + + + + + protected + bool + $drawLightModules + + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + QROptions::$drawLightModules + + +
              +
              + +
              +
              +

              + $eol + + + + +

              + + + + + protected + string + $eol + + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + QROptions::$eol + + +
              +
              + +
              +
              +

              + $excludeFromConnect + + + + +

              + + + + + protected + array<string|int, mixed> + $excludeFromConnect + + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + QROptions::$excludeFromConnect + + +
              +
              + +
              +
              +

              + $image + + + + +

              + + +

              The GD image resource

              + + + protected + resource|GdImage + $image + + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + imagecreatetruecolor() + + +
              +
              + todo: +
              +
              + +

              add \GdImage type in v6

              +
              + +
              +
              + +
              +
              +

              + $keepAsSquare + + + + +

              + + + + + protected + array<string|int, mixed> + $keepAsSquare + + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + QROptions::$keepAsSquare + + +
              +
              + +
              +
              +

              + $length + + + + +

              + + +

              the side length of the QR image (modules * scale)

              + + + protected + int + $length + + + + + + +
              +
              +

              + $matrix + + + + +

              + + +

              the (filled) data matrix object

              + + + protected + QRMatrix + $matrix + + + + + + +
              +
              +

              + $moduleCount + + + + +

              + + +

              the current size of the QR matrix

              + + + protected + int + $moduleCount + + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + QRMatrix::getSize() + + +
              +
              + +
              +
              +

              + $moduleValues + + + + +

              + + +

              an (optional) array of color values for the several QR matrix parts

              + + + protected + array<string|int, mixed> + $moduleValues + + + + + + +
              + +
              +

              + $scale + + + + +

              + + + + + protected + int + $scale + + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + QROptions::$scale + + +
              +
              + +
              +
              +

              + $upscaled + + + + +

              + + +

              Whether we're running in upscale mode (scale < 20)

              + + + protected + bool + $upscaled + = false + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + QROptions::$drawCircularModules + + +
              +
              + +
              +
              + +
              +

              + Methods + + +

              +
              +

              + __construct() + + +

              + + +

              QROutputAbstract constructor.

              + + + public + __construct(SettingsContainerInterface $options, QRMatrix $matrix) : mixed + +
              +
              + +
              Parameters
              +
              +
              + $options + : SettingsContainerInterface +
              +
              + +
              +
              + $matrix + : QRMatrix +
              +
              + +
              +
              + + + + +
              +
              +

              + dump() + + +

              + + + + + public + dump([string $file = null ]) : string|resource|GdImage + +
              +
              + +
              Parameters
              +
              +
              + $file + : string + = null
              +
              + +
              +
              + + +
              + Tags + + +
              +
              +
              + inheritDoc +
              +
              + + +
              +
              + phan-suppress +
              +
              + +

              PhanUndeclaredTypeReturnType, PhanTypeMismatchReturn

              +
              + +
              +
              + throws +
              +
              + ErrorException + + +
              +
              + +
              +
              Return values
              + string|resource|GdImage +
              + +
              +
              +

              + moduleValueIsValid() + + +

              + + + + + public + static moduleValueIsValid(mixed $value) : bool + +
              +
              + +
              Parameters
              +
              +
              + $value + : mixed +
              +
              + +
              +
              + + +
              + Tags + + +
              +
              +
              + inheritDoc +
              +
              + + +
              +
              + +
              +
              Return values
              + bool +
              + +
              +
              +

              + checkGD() + + +

              + + +

              Checks whether GD is installed and if the given mode is supported

              + + + protected + checkGD() : void + +
              +
              + + + +
              + Tags + + +
              +
              +
              + throws +
              +
              + QRCodeOutputException + + +
              +
              + codeCoverageIgnore +
              +
              + + +
              +
              + + +
              +
              +

              + collectModules() + + +

              + + +

              collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules

              + + + protected + collectModules(Closure $transform) : array<string|int, mixed> + +
              +
              +

              The transform callback is called with the following parameters:

              +

              $x - current column +$y - current row +$M_TYPE - field value +$M_TYPE_LAYER - (possibly modified) field value that acts as layer id

              +
              + +
              Parameters
              +
              +
              + $transform + : Closure +
              +
              + +
              +
              + + + +
              +
              Return values
              + array<string|int, mixed> +
              + +
              +
              +

              + copyVars() + + +

              + + +

              Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.

              + + + protected + copyVars() : void + +
              +
              +

              These variables are usually used in the "module" methods and are called up to 31329 times (at version 40).

              +
              + + + + + +
              +
              +

              + createImage() + + +

              + + +

              Creates a new GdImage resource and scales it if necessary

              + + + protected + createImage() : GdImage|resource + +
              +
              +

              we're scaling the image up in order to draw crisp round circles, otherwise they appear square-y on small scales

              +
              + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + https://github.com/chillerlan/php-qrcode/issues/23 + + +
              +
              + +
              +
              Return values
              + GdImage|resource +
              + +
              +
              +

              + drawImage() + + +

              + + +

              Draws the QR image

              + + + protected + drawImage() : void + +
              +
              + + + + + +
              +
              +

              + dumpImage() + + +

              + + +

              Creates the final image by calling the desired GD output function

              + + + protected + dumpImage() : string + +
              +
              + + + +
              + Tags + + +
              +
              +
              + throws +
              +
              + QRCodeOutputException + + +
              +
              + +
              +
              Return values
              + string +
              + +
              +
              +

              + getDefaultModuleValue() + + +

              + + +

              Returns a default value for either dark or light modules

              + + + protected + abstract getDefaultModuleValue(bool $isDark) : mixed|null + +
              +
              + +
              Parameters
              +
              +
              + $isDark + : bool +
              +
              + +
              +
              + + + +
              +
              Return values
              + mixed|null + — +

              return value depends on the output class

              +
              + +
              + +
              +
              +

              + getModuleValue() + + +

              + + +

              Returns the prepared value for the given $M_TYPE

              + + + protected + getModuleValue(int $M_TYPE) : mixed + +
              +
              + +
              Parameters
              +
              +
              + $M_TYPE + : int +
              +
              + +
              +
              + + +
              + Tags + + +
              +
              +
              + throws +
              +
              + QRCodeOutputException + +

              if $moduleValues[$M_TYPE] doesn't exist

              +
              + +
              +
              + +
              +
              Return values
              + mixed + — +

              return value depends on the output class

              +
              + +
              + +
              +
              +

              + getModuleValueAt() + + +

              + + +

              Returns the prepared module value at the given coordinate [$x, $y] (convenience)

              + + + protected + getModuleValueAt(int $x, int $y) : mixed|null + +
              +
              + +
              Parameters
              +
              +
              + $x + : int +
              +
              + +
              +
              + $y + : int +
              +
              + +
              +
              + + + +
              +
              Return values
              + mixed|null +
              + +
              +
              +

              + getOutputDimensions() + + +

              + + +

              Returns a 2 element array with the current output width and height

              + + + protected + getOutputDimensions() : array<string|int, mixed> + +
              +
              +

              The type and units of the values depend on the output class. The default value is the current module count * scale.

              +
              + + + + +
              +
              Return values
              + array<string|int, mixed> +
              + +
              +
              +

              + module() + + +

              + + +

              Creates a single QR pixel with the given settings

              + + + protected + module(int $x, int $y, int $M_TYPE) : void + +
              +
              + +
              Parameters
              +
              +
              + $x + : int +
              +
              + +
              +
              + $y + : int +
              +
              + +
              +
              + $M_TYPE + : int +
              +
              + +
              +
              + + + + +
              +
              +

              + prepareModuleValue() + + +

              + + +

              Prepares the value for the given input ()

              + + + protected + abstract prepareModuleValue(mixed $value) : mixed|null + +
              +
              + +
              Parameters
              +
              +
              + $value + : mixed +
              +
              + +
              +
              + + + +
              +
              Return values
              + mixed|null + — +

              return value depends on the output class

              +
              + +
              + +
              +
              +

              + renderImage() + + +

              + + +

              Renders the image with the gdimage function for the desired output

              + + + protected + renderImage() : void + +
              +
              + + + +
              + Tags + + +
              +
              +
              + inheritDoc +
              +
              + + +
              +
              + + +
              +
              +

              + saveToFile() + + +

              + + +

              Saves the qr $data to a $file. If $file is null, nothing happens.

              + + + protected + saveToFile(string $data[, string $file = null ]) : void + +
              +
              + +
              Parameters
              +
              +
              + $data + : string +
              +
              + +
              +
              + $file + : string + = null
              +
              + +
              +
              + + +
              + Tags + + +
              +
              +
              + see +
              +
              + file_put_contents() + + +
              +
              + see +
              +
              + QROptions::$cachefile + + +
              +
              + throws +
              +
              + QRCodeOutputException + + +
              +
              + + +
              +
              +

              + setBgColor() + + +

              + + +

              Sets the background color

              + + + protected + setBgColor() : void + +
              +
              + + + + + +
              +
              +

              + setMatrixDimensions() + + +

              + + +

              Sets/updates the matrix dimensions

              + + + protected + setMatrixDimensions() : void + +
              +
              +

              Call this method if you modify the matrix from within your custom module in case the dimensions have been changed

              +
              + + + + + +
              +
              +

              + setModuleValues() + + +

              + + +

              Sets the initial module values

              + + + protected + setModuleValues() : void + +
              +
              + + + + + +
              +
              +

              + setTransparencyColor() + + +

              + + +

              Sets the transparency color

              + + + protected + setTransparencyColor() : void + +
              +
              + + + + + +
              +
              +

              + toBase64DataURI() + + +

              + + +

              Returns a base64 data URI for the given string and mime type

              + + + protected + toBase64DataURI(string $data[, string $mime = null ]) : string + +
              +
              + +
              Parameters
              +
              +
              + $data + : string +
              +
              + +
              +
              + $mime + : string + = null
              +
              + +
              +
              + + + +
              +
              Return values
              + string +
              + +
              +
              + +
              +
              +
              +
              +
              
              +        
              + +
              +
              + + + +
              +
              +
              + +
              + On this page + + +
              + +
              +
              +
              +
              +
              +

              Search results

              + +
              +
              +
                +
                +
                +
                +
                + + +
                + + + + + + + + diff --git a/classes/chillerlan-QRCode-Output-QRImage.html b/classes/chillerlan-QRCode-Output-QRImage.html index 9457d6b44..09ac52af9 100644 --- a/classes/chillerlan-QRCode-Output-QRImage.html +++ b/classes/chillerlan-QRCode-Output-QRImage.html @@ -204,6 +204,12 @@
                The allocated background color
                +
                + $circleDiameter + +  : float +
                +
                $circleRadius @@ -413,6 +419,13 @@ in long loops for a significant performance increase.
                Prepares the value for the given input ()
                +
                + renderImage() + +  : void +
                +
                Renders the image with the gdimage function for the desired output
                +
                saveToFile() @@ -486,7 +499,7 @@ in long loops for a significant performance increase. @@ -517,6 +530,39 @@ in long loops for a significant performance increase. +
            • +
              +

              + $circleDiameter + + + + +

              + + + + + protected + float + $circleDiameter + + + + + +
              QRGdImage.php : - 37 + 43 @@ -851,6 +897,15 @@ in long loops for a significant performance increase. imagecreatetruecolor() + +
              + todo: +
              +
              + +

              add \GdImage type in v6

              +
              +
              @@ -1152,7 +1207,7 @@ in long loops for a significant performance increase. @@ -1206,7 +1261,7 @@ in long loops for a significant performance increase. @@ -1255,7 +1310,7 @@ in long loops for a significant performance increase. @@ -1331,7 +1386,7 @@ in long loops for a significant performance increase. @@ -1390,7 +1445,7 @@ in long loops for a significant performance increase. @@ -1444,7 +1499,7 @@ in long loops for a significant performance increase. @@ -1497,7 +1552,7 @@ $M_TYPE_LAYER - (possibly modified) field value that acts as layer id

              @@ -1532,7 +1587,7 @@ in long loops for a significant performance increase.

              @@ -1585,7 +1640,7 @@ in long loops for a significant performance increase.

              @@ -1617,7 +1672,7 @@ in long loops for a significant performance increase.

              @@ -1668,7 +1723,7 @@ in long loops for a significant performance increase.

              @@ -1718,7 +1773,7 @@ in long loops for a significant performance increase.

              @@ -1785,7 +1840,7 @@ in long loops for a significant performance increase.

              @@ -1838,7 +1893,7 @@ in long loops for a significant performance increase.

              @@ -1876,7 +1931,7 @@ in long loops for a significant performance increase.

              @@ -1932,7 +1987,7 @@ in long loops for a significant performance increase.

              @@ -1967,6 +2022,109 @@ in long loops for a significant performance increase.

              +
              +
              +

              + renderImage() + + +

              + + +

              Renders the image with the gdimage function for the desired output

              + + + protected + renderImage() : void + +
              +
              + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + imagebmp() + + +
              +
              + see +
              +
              + imagegif() + + +
              +
              + see +
              +
              + imagejpeg() + + +
              +
              + see +
              +
              + imagepng() + + +
              +
              + see +
              +
              + imagewebp() + + +
              +
              + see +
              +
              + https://github.com/chillerlan/php-qrcode/issues/223 + + +
              +
              + todo: +
              +
              + +

              v6.0: make abstract and call from child classes

              +
              + +
              +
              + codeCoverageIgnore +
              +
              + + +
              +
              + +
              QROutputAbstract.php : - 201 + 203 @@ -2062,7 +2220,7 @@ in long loops for a significant performance increase.

              @@ -2094,7 +2252,7 @@ in long loops for a significant performance increase.

              @@ -2128,7 +2286,7 @@ in long loops for a significant performance increase.

              @@ -2160,7 +2318,7 @@ in long loops for a significant performance increase.

              @@ -2192,7 +2350,7 @@ in long loops for a significant performance increase.

              @@ -2200,7 +2358,7 @@ in long loops for a significant performance increase.

              protected - toBase64DataURI(string $data, string $mime) : string + toBase64DataURI(string $data[, string $mime = null ]) : string
              @@ -2217,7 +2375,7 @@ in long loops for a significant performance increase.

              $mime : string -
              + = null
              @@ -2345,6 +2503,7 @@ in long loops for a significant performance increase.

            • +
              +

              + $circleDiameter + + + + +

              + + + + + protected + float + $circleDiameter + + + + + +
              QROutputAbstract.php : - 227 + 229 @@ -1397,7 +1436,7 @@ $M_TYPE_LAYER - (possibly modified) field value that acts as layer id

              @@ -1564,7 +1603,7 @@ in long loops for a significant performance increase.

              @@ -1631,7 +1670,7 @@ in long loops for a significant performance increase.

              @@ -1684,7 +1723,7 @@ in long loops for a significant performance increase.

              @@ -1842,7 +1881,7 @@ in long loops for a significant performance increase.

              @@ -1954,7 +1993,7 @@ in long loops for a significant performance increase.

              @@ -1988,7 +2027,7 @@ in long loops for a significant performance increase.

              @@ -2052,7 +2091,7 @@ in long loops for a significant performance increase.

              @@ -2060,7 +2099,7 @@ in long loops for a significant performance increase.

              protected - toBase64DataURI(string $data, string $mime) : string + toBase64DataURI(string $data[, string $mime = null ]) : string
              @@ -2077,7 +2116,7 @@ in long loops for a significant performance increase.

              $mime : string -
              + = null
              @@ -2205,6 +2244,7 @@ in long loops for a significant performance increase.

            • +

              $circleRadius @@ -982,7 +1021,7 @@ in long loops for a significant performance increase. @@ -1168,7 +1207,7 @@ note: css4 colors are not included

              @@ -1221,7 +1260,7 @@ $M_TYPE_LAYER - (possibly modified) field value that acts as layer id

              @@ -1412,7 +1451,7 @@ in long loops for a significant performance increase.

              @@ -1479,7 +1518,7 @@ in long loops for a significant performance increase.

              @@ -1532,7 +1571,7 @@ in long loops for a significant performance increase.

              @@ -1634,7 +1673,7 @@ in long loops for a significant performance increase.

              @@ -1714,7 +1753,7 @@ in long loops for a significant performance increase.

              @@ -1748,7 +1787,7 @@ in long loops for a significant performance increase.

              @@ -1780,7 +1819,7 @@ in long loops for a significant performance increase.

              @@ -1788,7 +1827,7 @@ in long loops for a significant performance increase.

              protected - toBase64DataURI(string $data, string $mime) : string + toBase64DataURI(string $data[, string $mime = null ]) : string
              @@ -1805,7 +1844,7 @@ in long loops for a significant performance increase.

              $mime : string -
              + = null
              @@ -1932,6 +1971,7 @@ in long loops for a significant performance increase.

            • Properties
            • +

              $circleRadius @@ -980,7 +1067,7 @@ in long loops for a significant performance increase. @@ -1166,7 +1253,7 @@ note: css4 colors are not included

              @@ -1219,7 +1306,7 @@ $M_TYPE_LAYER - (possibly modified) field value that acts as layer id

              @@ -1254,7 +1341,7 @@ in long loops for a significant performance increase.

              @@ -1360,7 +1447,7 @@ in long loops for a significant performance increase.

              @@ -1410,7 +1497,7 @@ in long loops for a significant performance increase.

              @@ -1477,7 +1564,7 @@ in long loops for a significant performance increase.

              @@ -1530,7 +1617,7 @@ in long loops for a significant performance increase.

              @@ -1568,7 +1655,7 @@ in long loops for a significant performance increase.

              @@ -1618,7 +1705,7 @@ in long loops for a significant performance increase.

              @@ -1698,7 +1785,7 @@ in long loops for a significant performance increase.

              @@ -1732,7 +1819,7 @@ in long loops for a significant performance increase.

              @@ -1764,7 +1851,7 @@ in long loops for a significant performance increase.

              @@ -1772,7 +1859,7 @@ in long loops for a significant performance increase.

              protected - toBase64DataURI(string $data, string $mime) : string + toBase64DataURI(string $data[, string $mime = null ]) : string
              @@ -1789,7 +1876,7 @@ in long loops for a significant performance increase.

              $mime : string -
              + = null
              @@ -1908,14 +1995,22 @@ in long loops for a significant performance increase.

            • Table Of Contents
            • +
            • Constants
            • +
            • + +
            • Properties
            • +

              $circleRadius @@ -1053,7 +1140,7 @@ in long loops for a significant performance increase. @@ -1161,7 +1248,7 @@ in long loops for a significant performance increase. @@ -1239,7 +1326,7 @@ note: css4 colors are not included

              @@ -1292,7 +1379,7 @@ $M_TYPE_LAYER - (possibly modified) field value that acts as layer id

              @@ -1327,7 +1414,7 @@ in long loops for a significant performance increase.

              @@ -1387,7 +1474,7 @@ in long loops for a significant performance increase.

              @@ -1447,7 +1534,7 @@ in long loops for a significant performance increase.

              @@ -1497,7 +1584,7 @@ in long loops for a significant performance increase.

              @@ -1564,7 +1651,7 @@ in long loops for a significant performance increase.

              @@ -1617,7 +1704,7 @@ in long loops for a significant performance increase.

              @@ -1666,7 +1753,7 @@ in long loops for a significant performance increase.

              @@ -1725,7 +1812,7 @@ in long loops for a significant performance increase.

              @@ -1776,7 +1863,7 @@ in long loops for a significant performance increase.

              @@ -1851,7 +1938,7 @@ in long loops for a significant performance increase.

              @@ -1919,7 +2006,7 @@ in long loops for a significant performance increase.

              @@ -1955,7 +2042,7 @@ in long loops for a significant performance increase.

              @@ -2005,7 +2092,7 @@ in long loops for a significant performance increase.

              @@ -2085,7 +2172,7 @@ in long loops for a significant performance increase.

              @@ -2119,7 +2206,7 @@ in long loops for a significant performance increase.

              @@ -2151,7 +2238,7 @@ in long loops for a significant performance increase.

              @@ -2159,7 +2246,7 @@ in long loops for a significant performance increase.

              protected - toBase64DataURI(string $data, string $mime) : string + toBase64DataURI(string $data[, string $mime = null ]) : string
              @@ -2176,7 +2263,7 @@ in long loops for a significant performance increase.

              $mime : string -
              + = null
              @@ -2295,14 +2382,22 @@ in long loops for a significant performance increase.

            • Table Of Contents
            • +
            • Constants
            • +
            • + +
            • Properties
            • +
              + $circleDiameter + +  : float +
              +
              $circleRadius @@ -377,6 +383,39 @@ in long loops for a significant performance increase. -property -protected " +> +

              + $circleDiameter + + + + +

              + + + + + protected + float + $circleDiameter + + + + + + +
              +

              $circleRadius @@ -961,7 +1000,7 @@ in long loops for a significant performance increase. @@ -1010,7 +1049,7 @@ in long loops for a significant performance increase. @@ -1063,7 +1102,7 @@ $M_TYPE_LAYER - (possibly modified) field value that acts as layer id

              @@ -1098,7 +1137,7 @@ in long loops for a significant performance increase.

              @@ -1148,7 +1187,7 @@ in long loops for a significant performance increase.

              @@ -1215,7 +1254,7 @@ in long loops for a significant performance increase.

              @@ -1268,7 +1307,7 @@ in long loops for a significant performance increase.

              @@ -1306,7 +1345,7 @@ in long loops for a significant performance increase.

              @@ -1356,7 +1395,7 @@ in long loops for a significant performance increase.

              @@ -1436,7 +1475,7 @@ in long loops for a significant performance increase.

              @@ -1470,7 +1509,7 @@ in long loops for a significant performance increase.

              @@ -1502,7 +1541,7 @@ in long loops for a significant performance increase.

              @@ -1510,7 +1549,7 @@ in long loops for a significant performance increase.

              protected - toBase64DataURI(string $data, string $mime) : string + toBase64DataURI(string $data[, string $mime = null ]) : string
              @@ -1527,7 +1566,7 @@ in long loops for a significant performance increase.

              $mime : string -
              + = null
              @@ -1654,6 +1693,7 @@ in long loops for a significant performance increase.

            • Properties
              • +
              • $circleDiameter
              • $circleRadius
              • $connectPaths
              • $drawCircularModules
              • diff --git a/classes/chillerlan-QRCode-Output-QROutputInterface.html b/classes/chillerlan-QRCode-Output-QROutputInterface.html index a10d9bad1..bd037a510 100644 --- a/classes/chillerlan-QRCode-Output-QROutputInterface.html +++ b/classes/chillerlan-QRCode-Output-QROutputInterface.html @@ -293,7 +293,7 @@
                MODES -  = [self::MARKUP_SVG => \chillerlan\QRCode\Output\QRMarkupSVG::class, self::MARKUP_HTML => \chillerlan\QRCode\Output\QRMarkupHTML::class, self::GDIMAGE_BMP => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_GIF => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_JPG => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_PNG => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_WEBP => \chillerlan\QRCode\Output\QRGdImage::class, self::STRING_JSON => \chillerlan\QRCode\Output\QRString::class, self::STRING_TEXT => \chillerlan\QRCode\Output\QRString::class, self::IMAGICK => \chillerlan\QRCode\Output\QRImagick::class, self::FPDF => \chillerlan\QRCode\Output\QRFpdf::class, self::EPS => \chillerlan\QRCode\Output\QREps::class] +  = [self::MARKUP_SVG => \chillerlan\QRCode\Output\QRMarkupSVG::class, self::MARKUP_HTML => \chillerlan\QRCode\Output\QRMarkupHTML::class, self::GDIMAGE_BMP => \chillerlan\QRCode\Output\QRGdImageBMP::class, self::GDIMAGE_GIF => \chillerlan\QRCode\Output\QRGdImageGIF::class, self::GDIMAGE_JPG => \chillerlan\QRCode\Output\QRGdImageJPEG::class, self::GDIMAGE_PNG => \chillerlan\QRCode\Output\QRGdImagePNG::class, self::GDIMAGE_WEBP => \chillerlan\QRCode\Output\QRGdImageWEBP::class, self::STRING_JSON => \chillerlan\QRCode\Output\QRStringJSON::class, self::STRING_TEXT => \chillerlan\QRCode\Output\QRStringText::class, self::IMAGICK => \chillerlan\QRCode\Output\QRImagick::class, self::FPDF => \chillerlan\QRCode\Output\QRFpdf::class, self::EPS => \chillerlan\QRCode\Output\QREps::class]
                Map of built-in output modes => class FQN
                @@ -345,7 +345,7 @@
            • -
              + -
              + -
              + -
              +

              GDIMAGE_BMP

              - - - - - public - string - GDIMAGE_BMP - = 'bmp' - - - - - - - -
              -
              -

              - GDIMAGE_GIF - - -

              - - - - - - public - string - GDIMAGE_GIF - = 'gif' - - - - - - - -
              -
              -

              - GDIMAGE_JPG - - -

              - - - - - - public - string - GDIMAGE_JPG - = 'jpg' - - - - - - - -
              -
              -

              - GDIMAGE_PNG - - -

              - - - - - - public - string - GDIMAGE_PNG - = 'png' - - - - - - - -
              -
              -

              - GDIMAGE_WEBP - - -

              - - - - - - public - string - GDIMAGE_WEBP - = 'webp' - - - - - - - -
              - + + + + + -
              + -
              + -
              +

              MODES @@ -773,26 +1048,51 @@

              Map of built-in output modes => class FQN

              - + public array<string|int, string> MODES - = [self::MARKUP_SVG => \chillerlan\QRCode\Output\QRMarkupSVG::class, self::MARKUP_HTML => \chillerlan\QRCode\Output\QRMarkupHTML::class, self::GDIMAGE_BMP => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_GIF => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_JPG => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_PNG => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_WEBP => \chillerlan\QRCode\Output\QRGdImage::class, self::STRING_JSON => \chillerlan\QRCode\Output\QRString::class, self::STRING_TEXT => \chillerlan\QRCode\Output\QRString::class, self::IMAGICK => \chillerlan\QRCode\Output\QRImagick::class, self::FPDF => \chillerlan\QRCode\Output\QRFpdf::class, self::EPS => \chillerlan\QRCode\Output\QREps::class] + = [self::MARKUP_SVG => \chillerlan\QRCode\Output\QRMarkupSVG::class, self::MARKUP_HTML => \chillerlan\QRCode\Output\QRMarkupHTML::class, self::GDIMAGE_BMP => \chillerlan\QRCode\Output\QRGdImageBMP::class, self::GDIMAGE_GIF => \chillerlan\QRCode\Output\QRGdImageGIF::class, self::GDIMAGE_JPG => \chillerlan\QRCode\Output\QRGdImageJPEG::class, self::GDIMAGE_PNG => \chillerlan\QRCode\Output\QRGdImagePNG::class, self::GDIMAGE_WEBP => \chillerlan\QRCode\Output\QRGdImageWEBP::class, self::STRING_JSON => \chillerlan\QRCode\Output\QRStringJSON::class, self::STRING_TEXT => \chillerlan\QRCode\Output\QRStringText::class, self::IMAGICK => \chillerlan\QRCode\Output\QRImagick::class, self::FPDF => \chillerlan\QRCode\Output\QRFpdf::class, self::EPS => \chillerlan\QRCode\Output\QREps::class] +
              + Tags + + +
              +
              +
              + deprecated +
              +
              + 5.0.0 + +
              +
              + +
              +
              + see +
              +
              + https://github.com/chillerlan/php-qrcode/issues/223 + + +
              +

              -
              + -
              + @@ -870,7 +1220,7 @@ @@ -931,7 +1281,7 @@ you need to supply the $file parameter here in that case (or handle the option v diff --git a/classes/chillerlan-QRCode-Output-QRString.html b/classes/chillerlan-QRCode-Output-QRString.html index b6fd60c95..200965af9 100644 --- a/classes/chillerlan-QRCode-Output-QRString.html +++ b/classes/chillerlan-QRCode-Output-QRString.html @@ -141,7 +141,7 @@ @@ -149,6 +149,23 @@ +
              + Tags + + +
              +
              +
              + deprecated +
              +
              + 5.0.0 + +

              this class will be removed in future versions, use one of QRStringText or QRStringJSON instead

              +
              + +
              +
              @@ -172,6 +189,12 @@
              +
              + $circleDiameter + +  : float +
              +
              $circleRadius @@ -401,6 +424,39 @@ in long loops for a significant performance increase. -property -protected " +> +

              + $circleDiameter + + + + +

              + + + + + protected + float + $circleDiameter + + + + + + +
              +

              $circleRadius @@ -985,7 +1041,7 @@ in long loops for a significant performance increase. @@ -1034,7 +1090,7 @@ in long loops for a significant performance increase. @@ -1124,7 +1180,7 @@ in long loops for a significant performance increase. @@ -1183,7 +1239,7 @@ in long loops for a significant performance increase. @@ -1242,7 +1298,7 @@ in long loops for a significant performance increase. @@ -1295,7 +1351,7 @@ $M_TYPE_LAYER - (possibly modified) field value that acts as layer id

              @@ -1330,7 +1386,7 @@ in long loops for a significant performance increase.

              @@ -1394,7 +1450,7 @@ in long loops for a significant performance increase.

              @@ -1461,7 +1517,7 @@ in long loops for a significant performance increase.

              @@ -1514,7 +1570,7 @@ in long loops for a significant performance increase.

              @@ -1552,7 +1608,7 @@ in long loops for a significant performance increase.

              @@ -1603,7 +1659,7 @@ in long loops for a significant performance increase.

              @@ -1667,7 +1723,7 @@ in long loops for a significant performance increase.

              @@ -1747,7 +1803,7 @@ in long loops for a significant performance increase.

              @@ -1781,7 +1837,7 @@ in long loops for a significant performance increase.

              @@ -1813,7 +1869,7 @@ in long loops for a significant performance increase.

              @@ -1849,7 +1905,7 @@ in long loops for a significant performance increase.

              @@ -1857,7 +1913,7 @@ in long loops for a significant performance increase.

              protected - toBase64DataURI(string $data, string $mime) : string + toBase64DataURI(string $data[, string $mime = null ]) : string
              @@ -1874,7 +1930,7 @@ in long loops for a significant performance increase.

              $mime : string -
              + = null
              @@ -2001,6 +2057,7 @@ in long loops for a significant performance increase.

            • Properties
              • +
              • $circleDiameter
              • $circleRadius
              • $connectPaths
              • $drawCircularModules
              • diff --git a/classes/chillerlan-QRCode-Output-QRStringJSON.html b/classes/chillerlan-QRCode-Output-QRStringJSON.html new file mode 100644 index 000000000..fccf09f56 --- /dev/null +++ b/classes/chillerlan-QRCode-Output-QRStringJSON.html @@ -0,0 +1,1975 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                +

                Documentation

                + + + + + +
                + +
                +
                + + + + +
                +
                + + +
                +

                + QRStringJSON + + + extends QROutputAbstract + + +
                + in package + +
                + + +

                + +
                + + +
                + + + +

                common output abstract

                + + + + + + +

                + Table of Contents + + +

                + + + + + + + +

                + Constants + + +

                +
                +
                + MIME_TYPE + +  = 'application/json' +
                + +
                + + +

                + Properties + + +

                +
                +
                + $circleDiameter + +  : float +
                + +
                + $circleRadius + +  : float +
                + +
                + $connectPaths + +  : bool +
                + +
                + $drawCircularModules + +  : bool +
                + +
                + $drawLightModules + +  : bool +
                + +
                + $eol + +  : string +
                + +
                + $excludeFromConnect + +  : array<string|int, mixed> +
                + +
                + $keepAsSquare + +  : array<string|int, mixed> +
                + +
                + $length + +  : int +
                +
                the side length of the QR image (modules * scale)
                + +
                + $matrix + +  : QRMatrix +
                +
                the (filled) data matrix object
                + +
                + $moduleCount + +  : int +
                +
                the current size of the QR matrix
                + +
                + $moduleValues + +  : array<string|int, mixed> +
                +
                an (optional) array of color values for the several QR matrix parts
                + +
                + $options + +  : SettingsContainerInterface|QROptions +
                + +
                + $scale + +  : int +
                + +
                + +

                + Methods + + +

                +
                +
                + __construct() + +  : mixed +
                +
                QROutputAbstract constructor.
                + +
                + dump() + +  : string +
                + +
                + moduleValueIsValid() + +  : bool +
                +
                unused - required by interface
                + +
                + collectModules() + +  : array<string|int, mixed> +
                +
                collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules
                + +
                + copyVars() + +  : void +
                +
                Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.
                + +
                + getDefaultModuleValue() + +  : mixed|null +
                +
                unused - required by interface
                + +
                + getModuleValue() + +  : mixed +
                +
                Returns the prepared value for the given $M_TYPE
                + +
                + getModuleValueAt() + +  : mixed|null +
                +
                Returns the prepared module value at the given coordinate [$x, $y] (convenience)
                + +
                + getOutputDimensions() + +  : array<string|int, mixed> +
                +
                Returns a 2 element array with the current output width and height
                + +
                + prepareModuleValue() + +  : mixed|null +
                +
                unused - required by interface
                + +
                + saveToFile() + +  : void +
                +
                Saves the qr $data to a $file. If $file is null, nothing happens.
                + +
                + setMatrixDimensions() + +  : void +
                +
                Sets/updates the matrix dimensions
                + +
                + setModuleValues() + +  : void +
                +
                Sets the initial module values
                + +
                + toBase64DataURI() + +  : string +
                +
                Returns a base64 data URI for the given string and mime type
                + +
                + + + + + +
                +

                + Constants + + +

                +
                +

                + MIME_TYPE + + +

                + + + + + + public + mixed + MIME_TYPE + = 'application/json' + + + + + + + +
                +
                + + +
                +

                + Properties + + +

                +
                +

                + $circleDiameter + + + + +

                + + + + + protected + float + $circleDiameter + + + + + + +
                +
                +

                + $circleRadius + + + + +

                + + + + + protected + float + $circleRadius + + + + + +
                + Tags + + +
                +
                +
                + see +
                +
                + QROptions::$circleRadius + + +
                +
                + +
                +
                +

                + $connectPaths + + + + +

                + + + + + protected + bool + $connectPaths + + + + + +
                + Tags + + +
                +
                +
                + see +
                +
                + QROptions::$connectPaths + + +
                +
                + +
                +
                +

                + $drawCircularModules + + + + +

                + + + + + protected + bool + $drawCircularModules + + + + + +
                + Tags + + +
                +
                +
                + see +
                +
                + QROptions::$drawCircularModules + + +
                +
                + +
                +
                +

                + $drawLightModules + + + + +

                + + + + + protected + bool + $drawLightModules + + + + + +
                + Tags + + +
                +
                +
                + see +
                +
                + QROptions::$drawLightModules + + +
                +
                + +
                +
                +

                + $eol + + + + +

                + + + + + protected + string + $eol + + + + + +
                + Tags + + +
                +
                +
                + see +
                +
                + QROptions::$eol + + +
                +
                + +
                +
                +

                + $excludeFromConnect + + + + +

                + + + + + protected + array<string|int, mixed> + $excludeFromConnect + + + + + +
                + Tags + + +
                +
                +
                + see +
                +
                + QROptions::$excludeFromConnect + + +
                +
                + +
                +
                +

                + $keepAsSquare + + + + +

                + + + + + protected + array<string|int, mixed> + $keepAsSquare + + + + + +
                + Tags + + +
                +
                +
                + see +
                +
                + QROptions::$keepAsSquare + + +
                +
                + +
                +
                +

                + $length + + + + +

                + + +

                the side length of the QR image (modules * scale)

                + + + protected + int + $length + + + + + + +
                +
                +

                + $matrix + + + + +

                + + +

                the (filled) data matrix object

                + + + protected + QRMatrix + $matrix + + + + + + +
                +
                +

                + $moduleCount + + + + +

                + + +

                the current size of the QR matrix

                + + + protected + int + $moduleCount + + + + + +
                + Tags + + +
                +
                +
                + see +
                +
                + QRMatrix::getSize() + + +
                +
                + +
                +
                +

                + $moduleValues + + + + +

                + + +

                an (optional) array of color values for the several QR matrix parts

                + + + protected + array<string|int, mixed> + $moduleValues + + + + + + +
                + +
                +

                + $scale + + + + +

                + + + + + protected + int + $scale + + + + + +
                + Tags + + +
                +
                +
                + see +
                +
                + QROptions::$scale + + +
                +
                + +
                +
                + +
                +

                + Methods + + +

                +
                +

                + __construct() + + +

                + + +

                QROutputAbstract constructor.

                + + + public + __construct(SettingsContainerInterface $options, QRMatrix $matrix) : mixed + +
                +
                + +
                Parameters
                +
                +
                + $options + : SettingsContainerInterface +
                +
                + +
                +
                + $matrix + : QRMatrix +
                +
                + +
                +
                + + + + +
                +
                +

                + dump() + + +

                + + + + + public + dump([string $file = null ]) : string + +
                +
                + +
                Parameters
                +
                +
                + $file + : string + = null
                +
                + +
                +
                + + +
                + Tags + + +
                +
                +
                + inheritDoc +
                +
                + + +
                +
                + throws +
                +
                + JsonException + + +
                +
                + +
                +
                Return values
                + string +
                + +
                +
                +

                + moduleValueIsValid() + + +

                + + +

                unused - required by interface

                + + + public + static moduleValueIsValid(mixed $value) : bool + +
                +
                + +
                Parameters
                +
                +
                + $value + : mixed +
                +
                + +
                +
                + + +
                + Tags + + +
                +
                +
                + inheritDoc +
                +
                + + +
                +
                + +
                +
                Return values
                + bool +
                + +
                +
                +

                + collectModules() + + +

                + + +

                collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules

                + + + protected + collectModules(Closure $transform) : array<string|int, mixed> + +
                +
                +

                The transform callback is called with the following parameters:

                +

                $x - current column +$y - current row +$M_TYPE - field value +$M_TYPE_LAYER - (possibly modified) field value that acts as layer id

                +
                + +
                Parameters
                +
                +
                + $transform + : Closure +
                +
                + +
                +
                + + + +
                +
                Return values
                + array<string|int, mixed> +
                + +
                +
                +

                + copyVars() + + +

                + + +

                Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.

                + + + protected + copyVars() : void + +
                +
                +

                These variables are usually used in the "module" methods and are called up to 31329 times (at version 40).

                +
                + + + + + +
                +
                +

                + getDefaultModuleValue() + + +

                + + +

                unused - required by interface

                + + + protected + getDefaultModuleValue(bool $isDark) : mixed|null + +
                +
                + +
                Parameters
                +
                +
                + $isDark + : bool +
                +
                + +
                +
                + + +
                + Tags + + +
                +
                +
                + inheritDoc +
                +
                + + +
                +
                + +
                +
                Return values
                + mixed|null + — +

                return value depends on the output class

                +
                + +
                + +
                +
                +

                + getModuleValue() + + +

                + + +

                Returns the prepared value for the given $M_TYPE

                + + + protected + getModuleValue(int $M_TYPE) : mixed + +
                +
                + +
                Parameters
                +
                +
                + $M_TYPE + : int +
                +
                + +
                +
                + + +
                + Tags + + +
                +
                +
                + throws +
                +
                + QRCodeOutputException + +

                if $moduleValues[$M_TYPE] doesn't exist

                +
                + +
                +
                + +
                +
                Return values
                + mixed + — +

                return value depends on the output class

                +
                + +
                + +
                +
                +

                + getModuleValueAt() + + +

                + + +

                Returns the prepared module value at the given coordinate [$x, $y] (convenience)

                + + + protected + getModuleValueAt(int $x, int $y) : mixed|null + +
                +
                + +
                Parameters
                +
                +
                + $x + : int +
                +
                + +
                +
                + $y + : int +
                +
                + +
                +
                + + + +
                +
                Return values
                + mixed|null +
                + +
                +
                +

                + getOutputDimensions() + + +

                + + +

                Returns a 2 element array with the current output width and height

                + + + protected + getOutputDimensions() : array<string|int, mixed> + +
                +
                +

                The type and units of the values depend on the output class. The default value is the current module count * scale.

                +
                + + + + +
                +
                Return values
                + array<string|int, mixed> +
                + +
                +
                +

                + prepareModuleValue() + + +

                + + +

                unused - required by interface

                + + + protected + prepareModuleValue(mixed $value) : mixed|null + +
                +
                + +
                Parameters
                +
                +
                + $value + : mixed +
                +
                + +
                +
                + + +
                + Tags + + +
                +
                +
                + inheritDoc +
                +
                + + +
                +
                + +
                +
                Return values
                + mixed|null + — +

                return value depends on the output class

                +
                + +
                + +
                +
                +

                + saveToFile() + + +

                + + +

                Saves the qr $data to a $file. If $file is null, nothing happens.

                + + + protected + saveToFile(string $data[, string $file = null ]) : void + +
                +
                + +
                Parameters
                +
                +
                + $data + : string +
                +
                + +
                +
                + $file + : string + = null
                +
                + +
                +
                + + +
                + Tags + + +
                +
                +
                + see +
                +
                + file_put_contents() + + +
                +
                + see +
                +
                + QROptions::$cachefile + + +
                +
                + throws +
                +
                + QRCodeOutputException + + +
                +
                + + +
                +
                +

                + setMatrixDimensions() + + +

                + + +

                Sets/updates the matrix dimensions

                + + + protected + setMatrixDimensions() : void + +
                +
                +

                Call this method if you modify the matrix from within your custom module in case the dimensions have been changed

                +
                + + + + + +
                +
                +

                + setModuleValues() + + +

                + + +

                Sets the initial module values

                + + + protected + setModuleValues() : void + +
                +
                + + + + + +
                +
                +

                + toBase64DataURI() + + +

                + + +

                Returns a base64 data URI for the given string and mime type

                + + + protected + toBase64DataURI(string $data[, string $mime = null ]) : string + +
                +
                + +
                Parameters
                +
                +
                + $data + : string +
                +
                + +
                +
                + $mime + : string + = null
                +
                + +
                +
                + + + +
                +
                Return values
                + string +
                + +
                +
                + +
                +
                +
                +
                +
                
                +        
                + +
                +
                + + + +
                +
                +
                + +
                + On this page + + +
                + +
                +
                +
                +
                +
                +

                Search results

                + +
                +
                +
                  +
                  +
                  +
                  +
                  + + +
                  + + + + + + + + diff --git a/classes/chillerlan-QRCode-Output-QRStringText.html b/classes/chillerlan-QRCode-Output-QRStringText.html new file mode 100644 index 000000000..9c7643e67 --- /dev/null +++ b/classes/chillerlan-QRCode-Output-QRStringText.html @@ -0,0 +1,2063 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                  +

                  Documentation

                  + + + + + +
                  + +
                  +
                  + + + + +
                  +
                  + + +
                  +

                  + QRStringText + + + extends QROutputAbstract + + +
                  + in package + +
                  + + +

                  + +
                  + + +
                  + + + +

                  common output abstract

                  + + + + + + +

                  + Table of Contents + + +

                  + + + + + + + +

                  + Constants + + +

                  +
                  +
                  + MIME_TYPE + +  = 'text/plain' +
                  + +
                  + + +

                  + Properties + + +

                  +
                  +
                  + $circleDiameter + +  : float +
                  + +
                  + $circleRadius + +  : float +
                  + +
                  + $connectPaths + +  : bool +
                  + +
                  + $drawCircularModules + +  : bool +
                  + +
                  + $drawLightModules + +  : bool +
                  + +
                  + $eol + +  : string +
                  + +
                  + $excludeFromConnect + +  : array<string|int, mixed> +
                  + +
                  + $keepAsSquare + +  : array<string|int, mixed> +
                  + +
                  + $length + +  : int +
                  +
                  the side length of the QR image (modules * scale)
                  + +
                  + $matrix + +  : QRMatrix +
                  +
                  the (filled) data matrix object
                  + +
                  + $moduleCount + +  : int +
                  +
                  the current size of the QR matrix
                  + +
                  + $moduleValues + +  : array<string|int, mixed> +
                  +
                  an (optional) array of color values for the several QR matrix parts
                  + +
                  + $options + +  : SettingsContainerInterface|QROptions +
                  + +
                  + $scale + +  : int +
                  + +
                  + +

                  + Methods + + +

                  +
                  +
                  + __construct() + +  : mixed +
                  +
                  QROutputAbstract constructor.
                  + +
                  + ansi8() + +  : string +
                  +
                  a little helper to create a proper ANSI 8-bit color escape sequence
                  + +
                  + dump() + +  : string +
                  + +
                  + moduleValueIsValid() + +  : bool +
                  + +
                  + collectModules() + +  : array<string|int, mixed> +
                  +
                  collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules
                  + +
                  + copyVars() + +  : void +
                  +
                  Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.
                  + +
                  + getDefaultModuleValue() + +  : mixed|null +
                  +
                  Returns a default value for either dark or light modules
                  + +
                  + getModuleValue() + +  : mixed +
                  +
                  Returns the prepared value for the given $M_TYPE
                  + +
                  + getModuleValueAt() + +  : mixed|null +
                  +
                  Returns the prepared module value at the given coordinate [$x, $y] (convenience)
                  + +
                  + getOutputDimensions() + +  : array<string|int, mixed> +
                  +
                  Returns a 2 element array with the current output width and height
                  + +
                  + prepareModuleValue() + +  : mixed|null +
                  +
                  Prepares the value for the given input ()
                  + +
                  + saveToFile() + +  : void +
                  +
                  Saves the qr $data to a $file. If $file is null, nothing happens.
                  + +
                  + setMatrixDimensions() + +  : void +
                  +
                  Sets/updates the matrix dimensions
                  + +
                  + setModuleValues() + +  : void +
                  +
                  Sets the initial module values
                  + +
                  + toBase64DataURI() + +  : string +
                  +
                  Returns a base64 data URI for the given string and mime type
                  + +
                  + + + + + +
                  +

                  + Constants + + +

                  +
                  +

                  + MIME_TYPE + + +

                  + + + + + + public + mixed + MIME_TYPE + = 'text/plain' + + + + + + + +
                  +
                  + + +
                  +

                  + Properties + + +

                  +
                  +

                  + $circleDiameter + + + + +

                  + + + + + protected + float + $circleDiameter + + + + + + +
                  +
                  +

                  + $circleRadius + + + + +

                  + + + + + protected + float + $circleRadius + + + + + +
                  + Tags + + +
                  +
                  +
                  + see +
                  +
                  + QROptions::$circleRadius + + +
                  +
                  + +
                  +
                  +

                  + $connectPaths + + + + +

                  + + + + + protected + bool + $connectPaths + + + + + +
                  + Tags + + +
                  +
                  +
                  + see +
                  +
                  + QROptions::$connectPaths + + +
                  +
                  + +
                  +
                  +

                  + $drawCircularModules + + + + +

                  + + + + + protected + bool + $drawCircularModules + + + + + +
                  + Tags + + +
                  +
                  +
                  + see +
                  +
                  + QROptions::$drawCircularModules + + +
                  +
                  + +
                  +
                  +

                  + $drawLightModules + + + + +

                  + + + + + protected + bool + $drawLightModules + + + + + +
                  + Tags + + +
                  +
                  +
                  + see +
                  +
                  + QROptions::$drawLightModules + + +
                  +
                  + +
                  +
                  +

                  + $eol + + + + +

                  + + + + + protected + string + $eol + + + + + +
                  + Tags + + +
                  +
                  +
                  + see +
                  +
                  + QROptions::$eol + + +
                  +
                  + +
                  +
                  +

                  + $excludeFromConnect + + + + +

                  + + + + + protected + array<string|int, mixed> + $excludeFromConnect + + + + + +
                  + Tags + + +
                  +
                  +
                  + see +
                  +
                  + QROptions::$excludeFromConnect + + +
                  +
                  + +
                  +
                  +

                  + $keepAsSquare + + + + +

                  + + + + + protected + array<string|int, mixed> + $keepAsSquare + + + + + +
                  + Tags + + +
                  +
                  +
                  + see +
                  +
                  + QROptions::$keepAsSquare + + +
                  +
                  + +
                  +
                  +

                  + $length + + + + +

                  + + +

                  the side length of the QR image (modules * scale)

                  + + + protected + int + $length + + + + + + +
                  +
                  +

                  + $matrix + + + + +

                  + + +

                  the (filled) data matrix object

                  + + + protected + QRMatrix + $matrix + + + + + + +
                  +
                  +

                  + $moduleCount + + + + +

                  + + +

                  the current size of the QR matrix

                  + + + protected + int + $moduleCount + + + + + +
                  + Tags + + +
                  +
                  +
                  + see +
                  +
                  + QRMatrix::getSize() + + +
                  +
                  + +
                  +
                  +

                  + $moduleValues + + + + +

                  + + +

                  an (optional) array of color values for the several QR matrix parts

                  + + + protected + array<string|int, mixed> + $moduleValues + + + + + + +
                  + +
                  +

                  + $scale + + + + +

                  + + + + + protected + int + $scale + + + + + +
                  + Tags + + +
                  +
                  +
                  + see +
                  +
                  + QROptions::$scale + + +
                  +
                  + +
                  +
                  + +
                  +

                  + Methods + + +

                  +
                  +

                  + __construct() + + +

                  + + +

                  QROutputAbstract constructor.

                  + + + public + __construct(SettingsContainerInterface $options, QRMatrix $matrix) : mixed + +
                  +
                  + +
                  Parameters
                  +
                  +
                  + $options + : SettingsContainerInterface +
                  +
                  + +
                  +
                  + $matrix + : QRMatrix +
                  +
                  + +
                  +
                  + + + + +
                  +
                  +

                  + ansi8() + + +

                  + + +

                  a little helper to create a proper ANSI 8-bit color escape sequence

                  + + + public + static ansi8(string $str, int $color[, bool $background = null ]) : string + +
                  +
                  + +
                  Parameters
                  +
                  +
                  + $str + : string +
                  +
                  + +
                  +
                  + $color + : int +
                  +
                  + +
                  +
                  + $background + : bool + = null
                  +
                  + +
                  +
                  + + +
                  + Tags + + +
                  +
                  +
                  + see +
                  +
                  + https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit + + +
                  +
                  + see +
                  +
                  + https://en.wikipedia.org/wiki/Block_Elements + + +
                  +
                  + codeCoverageIgnore +
                  +
                  + + +
                  +
                  + +
                  +
                  Return values
                  + string +
                  + +
                  +
                  +

                  + dump() + + +

                  + + + + + public + dump([string $file = null ]) : string + +
                  +
                  + +
                  Parameters
                  +
                  +
                  + $file + : string + = null
                  +
                  + +
                  +
                  + + +
                  + Tags + + +
                  +
                  +
                  + inheritDoc +
                  +
                  + + +
                  +
                  + +
                  +
                  Return values
                  + string +
                  + +
                  +
                  +

                  + moduleValueIsValid() + + +

                  + + + + + public + static moduleValueIsValid(mixed $value) : bool + +
                  +
                  + +
                  Parameters
                  +
                  +
                  + $value + : mixed +
                  +
                  + +
                  +
                  + + +
                  + Tags + + +
                  +
                  +
                  + inheritDoc +
                  +
                  + + +
                  +
                  + +
                  +
                  Return values
                  + bool +
                  + +
                  +
                  +

                  + collectModules() + + +

                  + + +

                  collects the modules per QRMatrix::M_* type and runs a $transform function on each module and +returns an array with the transformed modules

                  + + + protected + collectModules(Closure $transform) : array<string|int, mixed> + +
                  +
                  +

                  The transform callback is called with the following parameters:

                  +

                  $x - current column +$y - current row +$M_TYPE - field value +$M_TYPE_LAYER - (possibly modified) field value that acts as layer id

                  +
                  + +
                  Parameters
                  +
                  +
                  + $transform + : Closure +
                  +
                  + +
                  +
                  + + + +
                  +
                  Return values
                  + array<string|int, mixed> +
                  + +
                  +
                  +

                  + copyVars() + + +

                  + + +

                  Creates copies of several QROptions values to avoid calling the magic getters +in long loops for a significant performance increase.

                  + + + protected + copyVars() : void + +
                  +
                  +

                  These variables are usually used in the "module" methods and are called up to 31329 times (at version 40).

                  +
                  + + + + + +
                  +
                  +

                  + getDefaultModuleValue() + + +

                  + + +

                  Returns a default value for either dark or light modules

                  + + + protected + getDefaultModuleValue(bool $isDark) : mixed|null + +
                  +
                  + +
                  Parameters
                  +
                  +
                  + $isDark + : bool +
                  +
                  + +
                  +
                  + + +
                  + Tags + + +
                  +
                  +
                  + inheritDoc +
                  +
                  + + +
                  +
                  + +
                  +
                  Return values
                  + mixed|null + — +

                  return value depends on the output class

                  +
                  + +
                  + +
                  +
                  +

                  + getModuleValue() + + +

                  + + +

                  Returns the prepared value for the given $M_TYPE

                  + + + protected + getModuleValue(int $M_TYPE) : mixed + +
                  +
                  + +
                  Parameters
                  +
                  +
                  + $M_TYPE + : int +
                  +
                  + +
                  +
                  + + +
                  + Tags + + +
                  +
                  +
                  + throws +
                  +
                  + QRCodeOutputException + +

                  if $moduleValues[$M_TYPE] doesn't exist

                  +
                  + +
                  +
                  + +
                  +
                  Return values
                  + mixed + — +

                  return value depends on the output class

                  +
                  + +
                  + +
                  +
                  +

                  + getModuleValueAt() + + +

                  + + +

                  Returns the prepared module value at the given coordinate [$x, $y] (convenience)

                  + + + protected + getModuleValueAt(int $x, int $y) : mixed|null + +
                  +
                  + +
                  Parameters
                  +
                  +
                  + $x + : int +
                  +
                  + +
                  +
                  + $y + : int +
                  +
                  + +
                  +
                  + + + +
                  +
                  Return values
                  + mixed|null +
                  + +
                  +
                  +

                  + getOutputDimensions() + + +

                  + + +

                  Returns a 2 element array with the current output width and height

                  + + + protected + getOutputDimensions() : array<string|int, mixed> + +
                  +
                  +

                  The type and units of the values depend on the output class. The default value is the current module count * scale.

                  +
                  + + + + +
                  +
                  Return values
                  + array<string|int, mixed> +
                  + +
                  +
                  +

                  + prepareModuleValue() + + +

                  + + +

                  Prepares the value for the given input ()

                  + + + protected + prepareModuleValue(mixed $value) : mixed|null + +
                  +
                  + +
                  Parameters
                  +
                  +
                  + $value + : mixed +
                  +
                  + +
                  +
                  + + +
                  + Tags + + +
                  +
                  +
                  + inheritDoc +
                  +
                  + + +
                  +
                  + +
                  +
                  Return values
                  + mixed|null + — +

                  return value depends on the output class

                  +
                  + +
                  + +
                  +
                  +

                  + saveToFile() + + +

                  + + +

                  Saves the qr $data to a $file. If $file is null, nothing happens.

                  + + + protected + saveToFile(string $data[, string $file = null ]) : void + +
                  +
                  + +
                  Parameters
                  +
                  +
                  + $data + : string +
                  +
                  + +
                  +
                  + $file + : string + = null
                  +
                  + +
                  +
                  + + +
                  + Tags + + +
                  +
                  +
                  + see +
                  +
                  + file_put_contents() + + +
                  +
                  + see +
                  +
                  + QROptions::$cachefile + + +
                  +
                  + throws +
                  +
                  + QRCodeOutputException + + +
                  +
                  + + +
                  +
                  +

                  + setMatrixDimensions() + + +

                  + + +

                  Sets/updates the matrix dimensions

                  + + + protected + setMatrixDimensions() : void + +
                  +
                  +

                  Call this method if you modify the matrix from within your custom module in case the dimensions have been changed

                  +
                  + + + + + +
                  +
                  +

                  + setModuleValues() + + +

                  + + +

                  Sets the initial module values

                  + + + protected + setModuleValues() : void + +
                  +
                  + + + + + +
                  +
                  +

                  + toBase64DataURI() + + +

                  + + +

                  Returns a base64 data URI for the given string and mime type

                  + + + protected + toBase64DataURI(string $data[, string $mime = null ]) : string + +
                  +
                  + +
                  Parameters
                  +
                  +
                  + $data + : string +
                  +
                  + +
                  +
                  + $mime + : string + = null
                  +
                  + +
                  +
                  + + + +
                  +
                  Return values
                  + string +
                  + +
                  +
                  + +
                  +
                  +
                  +
                  +
                  
                  +        
                  + +
                  +
                  + + + +
                  +
                  +
                  + +
                  + On this page + + +
                  + +
                  +
                  +
                  +
                  +
                  +

                  Search results

                  + +
                  +
                  +
                    +
                    +
                    +
                    +
                    + + +
                    + + + + + + + + diff --git a/classes/chillerlan-QRCode-QROptions.html b/classes/chillerlan-QRCode-QROptions.html index 27e0c41ff..0a66e94b7 100644 --- a/classes/chillerlan-QRCode-QROptions.html +++ b/classes/chillerlan-QRCode-QROptions.html @@ -265,6 +265,14 @@
                    Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)
                    +
                    + $gdImageUseUpscale + +  : bool +
                    +
                    Toggles the usage of internal upscaling when `QROptions::$drawCircularModules` is set to `true` and +`QROptions::$scale` is less than 20
                    +
                    $imageBase64 @@ -317,6 +325,13 @@
                    Whether to return matrix values in JSON as booleans or `$M_TYPE` integers
                    +
                    + $jsonFlags + +  : int +
                    +
                    Sets the flags to use for the `json_encode()` call
                    +
                    $keepAsSquare @@ -697,7 +712,7 @@ @@ -803,7 +818,7 @@ @@ -848,7 +863,7 @@ @@ -908,7 +923,7 @@ takes precedence over the QROptions::$cachefile @@ -944,7 +959,7 @@ takes precedence over the QROptions::$cachefile @@ -993,7 +1008,7 @@ takes precedence over the QROptions::$cachefile @@ -1027,7 +1042,7 @@ takes precedence over the QROptions::$cachefile @@ -1097,7 +1112,7 @@ using imagefilledellipse() and then scaled back @@ -1211,7 +1226,7 @@ using imagefilledellipse() and then scaled back @@ -1247,7 +1262,7 @@ using imagefilledellipse() and then scaled back @@ -1281,7 +1296,7 @@ using imagefilledellipse() and then scaled back @@ -1312,6 +1327,64 @@ using imagefilledellipse() and then scaled back +
                • +
                  imagefilledellipse() and then scaled back @@ -1388,7 +1461,7 @@ using imagefilledellipse() and then scaled back @@ -1446,7 +1519,7 @@ using imagefilledellipse() and then scaled back @@ -1500,7 +1573,7 @@ using imagefilledellipse() and then scaled back @@ -1558,7 +1631,7 @@ using imagefilledellipse() and then scaled back @@ -1615,7 +1688,7 @@ using imagefilledellipse() and then scaled back @@ -1666,7 +1739,7 @@ using imagefilledellipse() and then scaled back @@ -1724,7 +1797,7 @@ using imagefilledellipse() and then scaled back @@ -1740,6 +1813,55 @@ using imagefilledellipse() and then scaled back +
                  +
                  imagefilledellipse() and then scaled back @@ -1794,7 +1916,7 @@ using imagefilledellipse() and then scaled back @@ -1830,7 +1952,7 @@ using imagefilledellipse() and then scaled back @@ -1864,7 +1986,7 @@ using imagefilledellipse() and then scaled back @@ -1898,7 +2020,7 @@ using imagefilledellipse() and then scaled back @@ -1985,7 +2107,7 @@ using imagefilledellipse() and then scaled back @@ -2043,7 +2165,7 @@ using imagefilledellipse() and then scaled back @@ -2082,7 +2204,7 @@ using imagefilledellipse() and then scaled back phpdocumentor-element -property -protected - " + -deprecated " >

                  $outputInterface @@ -2094,13 +2216,13 @@ using imagefilledellipse() and then scaled back

                  The FQCN of the custom `QROutputInterface`

                  - + protected string|null $outputInterface @@ -2111,6 +2233,24 @@ using imagefilledellipse() and then scaled back +
                  + Tags + + +
                  +
                  +
                  + deprecated +
                  +
                  + 5.0.0 + +

                  the nullable type will be removed in future versions +and the default value will be set to QRMarkupSVG::class

                  +
                  + +
                  +

                  imagefilledellipse() and then scaled back phpdocumentor-element -property -protected - " + -deprecated " >

                  $outputType @@ -2130,13 +2270,13 @@ using imagefilledellipse() and then scaled back

                  The built-in output type

                  - + protected string $outputType @@ -2247,6 +2387,24 @@ using imagefilledellipse() and then scaled back QRString + +
                  + see +
                  +
                  + https://github.com/chillerlan/php-qrcode/issues/223 + + +
                  +
                  + deprecated +
                  +
                  + 5.0.0 + +

                  use QROptions::$outputInterface instead

                  +
                  +
                  @@ -2268,7 +2426,7 @@ using imagefilledellipse() and then scaled back @@ -2326,7 +2484,7 @@ using imagefilledellipse() and then scaled back @@ -2341,19 +2499,19 @@ using imagefilledellipse() and then scaled back

                  The given value depends on the used output type:

                  • -QROutputInterface::GDIMAGE_BMP: [0...1] +QRGdImageBMP: [0...1]
                  • -QROutputInterface::GDIMAGE_JPG: [0...100] +QRGdImageJPEG: [0...100]
                  • -QROutputInterface::GDIMAGE_WEBP: [0...9] +QRGdImageWEBP: [0...9]
                  • -QROutputInterface::GDIMAGE_PNG: [0...100] +QRGdImagePNG: [0...100]
                  • -QROutputInterface::IMAGICK: [0...100] +QRImagick: [0...100]
                  @@ -2462,7 +2620,7 @@ using imagefilledellipse() and then scaled back @@ -2496,7 +2654,7 @@ using imagefilledellipse() and then scaled back @@ -2532,7 +2690,7 @@ using imagefilledellipse() and then scaled back @@ -2566,7 +2724,7 @@ using imagefilledellipse() and then scaled back @@ -2629,7 +2787,7 @@ and QROptions::$outputBase64. (default: QROptionsTrait.php : - 297 + 303 @@ -2663,7 +2821,7 @@ and QROptions::$outputBase64. (default: QROptionsTrait.php : - 374 + 392 @@ -2699,7 +2857,7 @@ and QROptions::$outputBase64. (default: QROptionsTrait.php : - 381 + 399 @@ -2748,7 +2906,7 @@ and QROptions::$outputBase64. (default: QROptionsTrait.php : - 388 + 406 @@ -2797,7 +2955,7 @@ and QROptions::$outputBase64. (default: QROptionsTrait.php : - 398 + 416 @@ -2849,7 +3007,7 @@ When set to false, the module values map will b @@ -2883,7 +3041,7 @@ When set to false, the module values map will b @@ -3078,7 +3236,7 @@ When set to false, the module values map will b @@ -3124,7 +3282,7 @@ When set to false, the module values map will b @@ -3192,7 +3350,7 @@ When set to false, the module values map will b @@ -3259,7 +3417,7 @@ When set to false, the module values map will b @@ -3326,7 +3484,7 @@ When set to false, the module values map will b @@ -3393,7 +3551,7 @@ When set to false, the module values map will b @@ -3460,7 +3618,7 @@ When set to false, the module values map will b @@ -3502,7 +3660,7 @@ When set to false, the module values map will b @@ -3558,7 +3716,7 @@ When set to false, the module values map will b @@ -3632,7 +3790,7 @@ When set to false, the module values map will b @@ -3705,7 +3863,7 @@ When set to false, the module values map will b @@ -3778,7 +3936,7 @@ When set to false, the module values map will b @@ -3851,7 +4009,7 @@ When set to false, the module values map will b @@ -3893,7 +4051,7 @@ When set to false, the module values map will b @@ -3935,7 +4093,7 @@ When set to false, the module values map will b @@ -3977,7 +4135,7 @@ When set to false, the module values map will b @@ -4019,7 +4177,7 @@ When set to false, the module values map will b @@ -4092,7 +4250,7 @@ When set to false, the module values map will b @@ -4134,7 +4292,7 @@ When set to false, the module values map will b @@ -4176,7 +4334,7 @@ When set to false, the module values map will b @@ -4218,7 +4376,7 @@ When set to false, the module values map will b @@ -4260,7 +4418,7 @@ When set to false, the module values map will b @@ -4302,7 +4460,7 @@ When set to false, the module values map will b @@ -4463,6 +4621,7 @@ When set to false, the module values map will b
                • $eol
                • $excludeFromConnect
                • $fpdfMeasureUnit
                • +
                • $gdImageUseUpscale
                • $imageBase64
                • $imageTransparencyBG
                • $imageTransparent
                • @@ -4471,6 +4630,7 @@ When set to false, the module values map will b
                • $invertMatrix
                • $jpegQuality
                • $jsonAsBooleans
                • +
                • $jsonFlags
                • $keepAsSquare
                • $logoSpaceHeight
                • $logoSpaceStartX
                • diff --git a/classes/chillerlan-QRCode-QROptionsTrait.html b/classes/chillerlan-QRCode-QROptionsTrait.html index dfced64e6..ed4e37bd2 100644 --- a/classes/chillerlan-QRCode-QROptionsTrait.html +++ b/classes/chillerlan-QRCode-QROptionsTrait.html @@ -244,6 +244,14 @@
                  Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)
                  +
                  + $gdImageUseUpscale + +  : bool +
                  +
                  Toggles the usage of internal upscaling when `QROptions::$drawCircularModules` is set to `true` and +`QROptions::$scale` is less than 20
                  +
                  $imageBase64 @@ -296,6 +304,13 @@
                  Whether to return matrix values in JSON as booleans or `$M_TYPE` integers
                  +
                  + $jsonFlags + +  : int +
                  +
                  Sets the flags to use for the `json_encode()` call
                  +
                  $keepAsSquare @@ -676,7 +691,7 @@ @@ -782,7 +797,7 @@ @@ -827,7 +842,7 @@ @@ -887,7 +902,7 @@ takes precedence over the QROptions::$cachefile @@ -923,7 +938,7 @@ takes precedence over the QROptions::$cachefile @@ -972,7 +987,7 @@ takes precedence over the QROptions::$cachefile @@ -1006,7 +1021,7 @@ takes precedence over the QROptions::$cachefile @@ -1076,7 +1091,7 @@ using imagefilledellipse() and then scaled back @@ -1190,7 +1205,7 @@ using imagefilledellipse() and then scaled back @@ -1226,7 +1241,7 @@ using imagefilledellipse() and then scaled back @@ -1260,7 +1275,7 @@ using imagefilledellipse() and then scaled back @@ -1291,6 +1306,64 @@ using imagefilledellipse() and then scaled back +

                  +
                  imagefilledellipse() and then scaled back @@ -1367,7 +1440,7 @@ using imagefilledellipse() and then scaled back @@ -1425,7 +1498,7 @@ using imagefilledellipse() and then scaled back @@ -1479,7 +1552,7 @@ using imagefilledellipse() and then scaled back @@ -1537,7 +1610,7 @@ using imagefilledellipse() and then scaled back @@ -1594,7 +1667,7 @@ using imagefilledellipse() and then scaled back @@ -1645,7 +1718,7 @@ using imagefilledellipse() and then scaled back @@ -1703,7 +1776,7 @@ using imagefilledellipse() and then scaled back @@ -1719,6 +1792,55 @@ using imagefilledellipse() and then scaled back +
                  +
                  imagefilledellipse() and then scaled back @@ -1773,7 +1895,7 @@ using imagefilledellipse() and then scaled back @@ -1809,7 +1931,7 @@ using imagefilledellipse() and then scaled back @@ -1843,7 +1965,7 @@ using imagefilledellipse() and then scaled back @@ -1877,7 +1999,7 @@ using imagefilledellipse() and then scaled back @@ -1964,7 +2086,7 @@ using imagefilledellipse() and then scaled back @@ -2022,7 +2144,7 @@ using imagefilledellipse() and then scaled back @@ -2061,7 +2183,7 @@ using imagefilledellipse() and then scaled back phpdocumentor-element -property -protected - " + -deprecated " >

                  $outputInterface @@ -2073,13 +2195,13 @@ using imagefilledellipse() and then scaled back

                  The FQCN of the custom `QROutputInterface`

                  - + protected string|null $outputInterface @@ -2090,6 +2212,24 @@ using imagefilledellipse() and then scaled back +
                  + Tags + + +
                  +
                  +
                  + deprecated +
                  +
                  + 5.0.0 + +

                  the nullable type will be removed in future versions +and the default value will be set to QRMarkupSVG::class

                  +
                  + +
                  +

                  imagefilledellipse() and then scaled back phpdocumentor-element -property -protected - " + -deprecated " >

                  $outputType @@ -2109,13 +2249,13 @@ using imagefilledellipse() and then scaled back

                  The built-in output type

                  - + protected string $outputType @@ -2226,6 +2366,24 @@ using imagefilledellipse() and then scaled back QRString + +
                  + see +
                  +
                  + https://github.com/chillerlan/php-qrcode/issues/223 + + +
                  +
                  + deprecated +
                  +
                  + 5.0.0 + +

                  use QROptions::$outputInterface instead

                  +
                  +
                  @@ -2247,7 +2405,7 @@ using imagefilledellipse() and then scaled back @@ -2305,7 +2463,7 @@ using imagefilledellipse() and then scaled back @@ -2320,19 +2478,19 @@ using imagefilledellipse() and then scaled back

                  The given value depends on the used output type:

                  • -QROutputInterface::GDIMAGE_BMP: [0...1] +QRGdImageBMP: [0...1]
                  • -QROutputInterface::GDIMAGE_JPG: [0...100] +QRGdImageJPEG: [0...100]
                  • -QROutputInterface::GDIMAGE_WEBP: [0...9] +QRGdImageWEBP: [0...9]
                  • -QROutputInterface::GDIMAGE_PNG: [0...100] +QRGdImagePNG: [0...100]
                  • -QROutputInterface::IMAGICK: [0...100] +QRImagick: [0...100]
                  @@ -2441,7 +2599,7 @@ using imagefilledellipse() and then scaled back @@ -2475,7 +2633,7 @@ using imagefilledellipse() and then scaled back @@ -2511,7 +2669,7 @@ using imagefilledellipse() and then scaled back @@ -2545,7 +2703,7 @@ using imagefilledellipse() and then scaled back @@ -2608,7 +2766,7 @@ and QROptions::$outputBase64. (default: QROptionsTrait.php : - 297 + 303 @@ -2642,7 +2800,7 @@ and QROptions::$outputBase64. (default: QROptionsTrait.php : - 374 + 392 @@ -2678,7 +2836,7 @@ and QROptions::$outputBase64. (default: QROptionsTrait.php : - 381 + 399 @@ -2727,7 +2885,7 @@ and QROptions::$outputBase64. (default: QROptionsTrait.php : - 388 + 406 @@ -2776,7 +2934,7 @@ and QROptions::$outputBase64. (default: QROptionsTrait.php : - 398 + 416 @@ -2828,7 +2986,7 @@ When set to false, the module values map will b @@ -2862,7 +3020,7 @@ When set to false, the module values map will b @@ -3057,7 +3215,7 @@ When set to false, the module values map will b @@ -3103,7 +3261,7 @@ When set to false, the module values map will b @@ -3171,7 +3329,7 @@ When set to false, the module values map will b @@ -3238,7 +3396,7 @@ When set to false, the module values map will b @@ -3305,7 +3463,7 @@ When set to false, the module values map will b @@ -3372,7 +3530,7 @@ When set to false, the module values map will b @@ -3439,7 +3597,7 @@ When set to false, the module values map will b @@ -3481,7 +3639,7 @@ When set to false, the module values map will b @@ -3537,7 +3695,7 @@ When set to false, the module values map will b @@ -3611,7 +3769,7 @@ When set to false, the module values map will b @@ -3684,7 +3842,7 @@ When set to false, the module values map will b @@ -3757,7 +3915,7 @@ When set to false, the module values map will b @@ -3830,7 +3988,7 @@ When set to false, the module values map will b @@ -3872,7 +4030,7 @@ When set to false, the module values map will b @@ -3914,7 +4072,7 @@ When set to false, the module values map will b @@ -3956,7 +4114,7 @@ When set to false, the module values map will b @@ -3998,7 +4156,7 @@ When set to false, the module values map will b @@ -4071,7 +4229,7 @@ When set to false, the module values map will b @@ -4113,7 +4271,7 @@ When set to false, the module values map will b @@ -4155,7 +4313,7 @@ When set to false, the module values map will b @@ -4197,7 +4355,7 @@ When set to false, the module values map will b @@ -4239,7 +4397,7 @@ When set to false, the module values map will b @@ -4281,7 +4439,7 @@ When set to false, the module values map will b @@ -4441,6 +4599,7 @@ When set to false, the module values map will b
                • $eol
                • $excludeFromConnect
                • $fpdfMeasureUnit
                • +
                • $gdImageUseUpscale
                • $imageBase64
                • $imageTransparencyBG
                • $imageTransparent
                • @@ -4449,6 +4608,7 @@ When set to false, the module values map will b
                • $invertMatrix
                • $jpegQuality
                • $jsonAsBooleans
                • +
                • $jsonFlags
                • $keepAsSquare
                • $logoSpaceHeight
                • $logoSpaceStartX
                • diff --git a/classes/chillerlan-QRCodeTest-Output-QRGdImageBMPTest.html b/classes/chillerlan-QRCodeTest-Output-QRGdImageBMPTest.html index 7fec85e1d..f300de465 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRGdImageBMPTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRGdImageBMPTest.html @@ -143,7 +143,7 @@ @@ -181,7 +181,7 @@
                  - $FQN + $FQN  : string
                  @@ -224,6 +224,12 @@  : array<string|int, mixed> +
                  + testBase64MimeType() + +  : void +
                  +
                  testInstance() @@ -327,15 +333,15 @@ >

                  $FQN - +

                  @@ -344,7 +350,7 @@ protected string $FQN -
                  + = \chillerlan\QRCode\Output\QRGdImageBMP::class
                  @@ -467,7 +473,7 @@ @@ -525,6 +531,37 @@ array<string|int, mixed> +

                  +
                  +

                  + testBase64MimeType() + + +

                  + + + + + public + testBase64MimeType() : void + +
                  +
                  + + + + +
                  QRGdImageTestAbstract.php : - 67 + 64 @@ -586,6 +623,22 @@ +
                  + Tags + + +
                  +
                  +
                  + todo: +
                  +
                  + +

                  remove php version check in v6

                  +
                  + +
                  +
                  @@ -895,7 +948,7 @@
                • +
                  +

                  + testBase64MimeType() + + +

                  + + + + + public + testBase64MimeType() : void + +
                  +
                  + + + + +
                  QRGdImageTestAbstract.php : - 67 + 64 @@ -586,6 +623,22 @@ +
                  + Tags + + +
                  +
                  +
                  + todo: +
                  +
                  + +

                  remove php version check in v6

                  +
                  + +
                  +
                  @@ -895,7 +948,7 @@
                • +
                  +

                  + testBase64MimeType() + + +

                  + + + + + public + testBase64MimeType() : void + +
                  +
                  + + + + +
                  QRGdImageTestAbstract.php : - 67 + 64 @@ -586,6 +623,22 @@ +
                  + Tags + + +
                  +
                  +
                  + todo: +
                  +
                  + +

                  remove php version check in v6

                  +
                  + +
                  +
                  @@ -895,7 +948,7 @@
                • +
                  +

                  + testBase64MimeType() + + +

                  + + + + + public + testBase64MimeType() : void + +
                  +
                  + + + + +
                  QRGdImageTestAbstract.php : - 67 + 64 @@ -586,6 +623,22 @@ +
                  + Tags + + +
                  +
                  +
                  + todo: +
                  +
                  + +

                  remove php version check in v6

                  +
                  + +
                  +
                  @@ -895,7 +948,7 @@
                • +
                  +

                  + testBase64MimeType() + + +

                  + + + + + public + testBase64MimeType() : void + +
                  +
                  + + + + +
                  QRGdImageTestAbstract.php : - 67 + 64 @@ -586,6 +623,22 @@ +
                  + Tags + + +
                  +
                  +
                  + todo: +
                  +
                  + +

                  remove php version check in v6

                  +
                  + +
                  +
                  @@ -667,7 +720,7 @@ @@ -777,7 +830,7 @@ @@ -923,7 +976,7 @@
                • +
                  +

                  + testBase64MimeType() + + +

                  + + + + + public + testBase64MimeType() : void + +
                  +
                  + + + + +
                  QRGdImageTestAbstract.php : - 67 + 64 @@ -586,6 +623,22 @@ +
                  + Tags + + +
                  +
                  +
                  + todo: +
                  +
                  + +

                  remove php version check in v6

                  +
                  + +
                  +
                  @@ -895,7 +948,7 @@
                  • $builddir
                  • -
                  • $FQN
                  • +
                  • $FQN
                  • $matrix
                  • $options
                  • $outputInterface
                  • @@ -907,6 +960,7 @@
                    • moduleValueProvider()
                    • +
                    • testBase64MimeType()
                    • testInstance()
                    • testOutputGetResource()
                    • testRenderToCacheFile()
                    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html b/classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html index 9ddd2fe46..546d48f7e 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html @@ -120,7 +120,7 @@ QRStringJSONTest - extends QRStringTestAbstract + extends QROutputTestAbstract
                      @@ -143,11 +143,12 @@ -

                      Tests the QRString output module

                      +

                      Test abstract for the several (built-in) output modules, +should also be used to test custom output modules

                      @@ -181,7 +182,7 @@
                      - $FQN + $FQN  : string
                      @@ -219,7 +220,7 @@
                      - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
                      @@ -250,6 +251,7 @@  : void +
                      covers the module values settings
                      testValidateModuleValues() @@ -262,6 +264,7 @@  : void
                      +
                      Attempts to create a directory under /.build and instances several required objects
                      @@ -319,15 +322,15 @@ >

                      $FQN - +

                      @@ -336,7 +339,7 @@ protected string $FQN - + = \chillerlan\QRCode\Output\QRStringJSON::class @@ -459,7 +462,7 @@ @@ -487,24 +490,24 @@ class="phpdocumentor-element -method -public - -abstract -static " + -static " >

                      moduleValueProvider() - +

                      public - abstract static moduleValueProvider() : array<string|int, mixed> + static moduleValueProvider() : array<string|int, mixed>
                      @@ -628,11 +631,12 @@ - +

                      covers the module values settings

                      + public testSetModuleValues() : void @@ -723,11 +727,12 @@ - +

                      Attempts to create a directory under /.build and instances several required objects

                      + protected setUp() : void @@ -868,7 +873,7 @@
                      • $builddir
                      • -
                      • $FQN
                      • +
                      • $FQN
                      • $matrix
                      • $options
                      • $outputInterface
                      • @@ -879,7 +884,7 @@
                      • Methods
                        • -
                        • moduleValueProvider()
                        • +
                        • moduleValueProvider()
                        • testInstance()
                        • testRenderToCacheFile()
                        • testSaveException()
                        • diff --git a/classes/chillerlan-QRCodeTest-Output-QRStringTEXTTest.html b/classes/chillerlan-QRCodeTest-Output-QRStringTEXTTest.html index 3c81b70f7..f4c0a1e60 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRStringTEXTTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRStringTEXTTest.html @@ -120,7 +120,7 @@ QRStringTEXTTest - extends QRStringTestAbstract + extends QROutputTestAbstract
                          @@ -143,11 +143,12 @@ -

                          Tests the QRString output module

                          +

                          Test abstract for the several (built-in) output modules, +should also be used to test custom output modules

                          @@ -181,7 +182,7 @@
                          - $FQN + $FQN  : string
                          @@ -219,7 +220,7 @@
                          - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
                          @@ -250,6 +251,7 @@  : void +
                          covers the module values settings
                          testValidateModuleValues() @@ -320,15 +322,15 @@ >

                          $FQN - +

                          @@ -337,7 +339,7 @@ protected string $FQN - + = \chillerlan\QRCode\Output\QRStringText::class @@ -460,7 +462,7 @@ @@ -488,24 +490,24 @@ class="phpdocumentor-element -method -public - -abstract -static " + -static " >

                          moduleValueProvider() - +

                          public - abstract static moduleValueProvider() : array<string|int, mixed> + static moduleValueProvider() : array<string|int, mixed>
                          @@ -629,11 +631,12 @@ - +

                          covers the module values settings

                          + public testSetModuleValues() : void @@ -870,7 +873,7 @@
                          • $builddir
                          • -
                          • $FQN
                          • +
                          • $FQN
                          • $matrix
                          • $options
                          • $outputInterface
                          • @@ -881,7 +884,7 @@
                          • Methods
                            • -
                            • moduleValueProvider()
                            • +
                            • moduleValueProvider()
                            • testInstance()
                            • testRenderToCacheFile()
                            • testSaveException()
                            • diff --git a/classes/chillerlan-QRCodeTest-Output-QRStringTestAbstract.html b/classes/chillerlan-QRCodeTest-Output-QRStringTestAbstract.html deleted file mode 100644 index 14b791736..000000000 --- a/classes/chillerlan-QRCodeTest-Output-QRStringTestAbstract.html +++ /dev/null @@ -1,910 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - - - -
                              -

                              Documentation

                              - - - - - -
                              - -
                              -
                              - - - - -
                              -
                              - - -
                              -

                              - QRStringTestAbstract - - - extends QROutputTestAbstract - - -
                              - in package - -
                              - - -

                              - -
                              - - -
                              AbstractYes
                              - -
                              - - - -

                              Tests the QRString output module

                              - - - - - - -

                              - Table of Contents - - -

                              - - - - - - - - - -

                              - Properties - - -

                              -
                              -
                              - $builddir - -  : string -
                              - -
                              - $FQN - -  : string -
                              - -
                              - $matrix - -  : QRMatrix -
                              - -
                              - $options - -  : QROptions|SettingsContainerInterface -
                              - -
                              - $outputInterface - -  : QROutputInterface -
                              - -
                              - $type - -  : string -
                              - -
                              - -

                              - Methods - - -

                              -
                              -
                              - moduleValueProvider() - -  : array<string|int, mixed> -
                              - -
                              - testInstance() - -  : void -
                              -
                              Validate the instance of the interface
                              - -
                              - testRenderToCacheFile() - -  : void -
                              -
                              coverage of the built-in output modules
                              - -
                              - testSaveException() - -  : void -
                              -
                              Tests if an exception is thrown when trying to write a cache file to an invalid destination
                              - -
                              - testSetModuleValues() - -  : void -
                              -
                              covers the module values settings
                              - -
                              - testValidateModuleValues() - -  : void -
                              - -
                              - setUp() - -  : void -
                              -
                              Attempts to create a directory under /.build and instances several required objects
                              - -
                              - - - - - - - -
                              -

                              - Properties - - -

                              -
                              -

                              - $builddir - - - - -

                              - - - - - protected - string - $builddir - = __DIR__ . '/../../.build/output_test' - - - - - -
                              -
                              -

                              - $FQN - - - - -

                              - - - - - protected - string - $FQN - = \chillerlan\QRCode\Output\QRString::class - - - - - -
                              - - - - -
                              - -
                              -

                              - Methods - - -

                              -
                              -

                              - moduleValueProvider() - - -

                              - - - - - public - static moduleValueProvider() : array<string|int, mixed> - -
                              -
                              - - - - -
                              -
                              Return values
                              - array<string|int, mixed> -
                              - -
                              -
                              -

                              - testInstance() - - -

                              - - -

                              Validate the instance of the interface

                              - - - public - testInstance() : void - -
                              -
                              - - - - - -
                              -
                              -

                              - testRenderToCacheFile() - - -

                              - - -

                              coverage of the built-in output modules

                              - - - public - testRenderToCacheFile() : void - -
                              -
                              - - - - - -
                              -
                              -

                              - testSaveException() - - -

                              - - -

                              Tests if an exception is thrown when trying to write a cache file to an invalid destination

                              - - - public - testSaveException() : void - -
                              -
                              - - - - - -
                              -
                              -

                              - testSetModuleValues() - - -

                              - - -

                              covers the module values settings

                              - - - public - abstract testSetModuleValues() : void - -
                              -
                              - - - - - -
                              -
                              -

                              - testValidateModuleValues() - - -

                              - - - - - public - testValidateModuleValues(mixed $value, bool $expected) : void - -
                              -
                              - -
                              Parameters
                              -
                              -
                              - $value - : mixed -
                              -
                              - -
                              -
                              - $expected - : bool -
                              -
                              - -
                              -
                              - - -
                              - Tags - - -
                              -
                              -
                              - dataProvider -
                              -
                              - -

                              moduleValueProvider

                              -
                              - -
                              -
                              - - -
                              -
                              -

                              - setUp() - - -

                              - - -

                              Attempts to create a directory under /.build and instances several required objects

                              - - - protected - setUp() : void - -
                              -
                              - - - - - -
                              -
                              - -
                              -
                              -
                              -
                              -
                              
                              -        
                              - -
                              -
                              - - - -
                              -
                              -
                              - -
                              - On this page - - -
                              - -
                              -
                              -
                              -
                              -
                              -

                              Search results

                              - -
                              -
                              -
                                -
                                -
                                -
                                -
                                - - -
                                - - - - - - - - diff --git a/files/src-output-qrgdimagebmp.html b/files/src-output-qrgdimagebmp.html new file mode 100644 index 000000000..3b6f07f8b --- /dev/null +++ b/files/src-output-qrgdimagebmp.html @@ -0,0 +1,343 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                +

                                Documentation

                                + + + + + +
                                + +
                                +
                                + + + + +
                                +
                                +
                                  +
                                + +
                                +

                                QRGdImageBMP.php

                                + +

                                Class QRGdImageBMP

                                + + + +
                                + Tags + + +
                                +
                                +
                                + created +
                                +
                                + +

                                25.10.2023

                                +
                                + +
                                +
                                + author +
                                +
                                + +

                                smiley smiley@chillerlan.net

                                +
                                + +
                                +
                                + copyright +
                                +
                                + +

                                2023 smiley

                                +
                                + +
                                +
                                + license +
                                +
                                + +

                                MIT

                                +
                                + +
                                +
                                + noinspection +
                                +
                                + +

                                PhpComposerExtensionStubsInspection

                                +
                                + +
                                +
                                + + + +

                                + Table of Contents + + +

                                + + + + +

                                + Classes + + +

                                +
                                +
                                QRGdImageBMP
                                GdImage bmp output
                                + + + + + + + + + + + + + +
                                +
                                +
                                +
                                +
                                
                                +        
                                + +
                                +
                                + + + +
                                +
                                +
                                + +
                                + On this page + +
                                  +
                                • Table Of Contents
                                • +
                                • + +
                                • + + +
                                +
                                + +
                                +
                                +
                                +
                                +
                                +

                                Search results

                                + +
                                +
                                +
                                  +
                                  +
                                  +
                                  +
                                  + + +
                                  + + + + + + + + diff --git a/files/src-output-qrgdimagegif.html b/files/src-output-qrgdimagegif.html new file mode 100644 index 000000000..6c42c02da --- /dev/null +++ b/files/src-output-qrgdimagegif.html @@ -0,0 +1,343 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                  +

                                  Documentation

                                  + + + + + +
                                  + +
                                  +
                                  + + + + +
                                  +
                                  +
                                    +
                                  + +
                                  +

                                  QRGdImageGIF.php

                                  + +

                                  Class QRGdImageGIF

                                  + + + +
                                  + Tags + + +
                                  +
                                  +
                                  + created +
                                  +
                                  + +

                                  25.10.2023

                                  +
                                  + +
                                  +
                                  + author +
                                  +
                                  + +

                                  smiley smiley@chillerlan.net

                                  +
                                  + +
                                  +
                                  + copyright +
                                  +
                                  + +

                                  2023 smiley

                                  +
                                  + +
                                  +
                                  + license +
                                  +
                                  + +

                                  MIT

                                  +
                                  + +
                                  +
                                  + noinspection +
                                  +
                                  + +

                                  PhpComposerExtensionStubsInspection

                                  +
                                  + +
                                  +
                                  + + + +

                                  + Table of Contents + + +

                                  + + + + +

                                  + Classes + + +

                                  +
                                  +
                                  QRGdImageGIF
                                  GdImage gif output
                                  + + + + + + + + + + + + + +
                                  +
                                  +
                                  +
                                  +
                                  
                                  +        
                                  + +
                                  +
                                  + + + +
                                  +
                                  +
                                  + +
                                  + On this page + +
                                    +
                                  • Table Of Contents
                                  • +
                                  • + +
                                  • + + +
                                  +
                                  + +
                                  +
                                  +
                                  +
                                  +
                                  +

                                  Search results

                                  + +
                                  +
                                  +
                                    +
                                    +
                                    +
                                    +
                                    + + +
                                    + + + + + + + + diff --git a/files/src-output-qrgdimagejpeg.html b/files/src-output-qrgdimagejpeg.html new file mode 100644 index 000000000..7ff761710 --- /dev/null +++ b/files/src-output-qrgdimagejpeg.html @@ -0,0 +1,343 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                    +

                                    Documentation

                                    + + + + + +
                                    + +
                                    +
                                    + + + + +
                                    +
                                    +
                                      +
                                    + +
                                    +

                                    QRGdImageJPEG.php

                                    + +

                                    Class QRGdImageJPEG

                                    + + + +
                                    + Tags + + +
                                    +
                                    +
                                    + created +
                                    +
                                    + +

                                    25.10.2023

                                    +
                                    + +
                                    +
                                    + author +
                                    +
                                    + +

                                    smiley smiley@chillerlan.net

                                    +
                                    + +
                                    +
                                    + copyright +
                                    +
                                    + +

                                    2023 smiley

                                    +
                                    + +
                                    +
                                    + license +
                                    +
                                    + +

                                    MIT

                                    +
                                    + +
                                    +
                                    + noinspection +
                                    +
                                    + +

                                    PhpComposerExtensionStubsInspection

                                    +
                                    + +
                                    +
                                    + + + +

                                    + Table of Contents + + +

                                    + + + + +

                                    + Classes + + +

                                    +
                                    +
                                    QRGdImageJPEG
                                    GdImage jpeg output
                                    + + + + + + + + + + + + + +
                                    +
                                    +
                                    +
                                    +
                                    
                                    +        
                                    + +
                                    +
                                    + + + +
                                    +
                                    +
                                    + +
                                    + On this page + +
                                      +
                                    • Table Of Contents
                                    • +
                                    • + +
                                    • + + +
                                    +
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    Search results

                                    + +
                                    +
                                    +
                                      +
                                      +
                                      +
                                      +
                                      + + +
                                      + + + + + + + + diff --git a/files/src-output-qrgdimagepng.html b/files/src-output-qrgdimagepng.html new file mode 100644 index 000000000..e26ec41f9 --- /dev/null +++ b/files/src-output-qrgdimagepng.html @@ -0,0 +1,343 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                      +

                                      Documentation

                                      + + + + + +
                                      + +
                                      +
                                      + + + + +
                                      +
                                      +
                                        +
                                      + +
                                      +

                                      QRGdImagePNG.php

                                      + +

                                      Class QRGdImagePNG

                                      + + + +
                                      + Tags + + +
                                      +
                                      +
                                      + created +
                                      +
                                      + +

                                      25.10.2023

                                      +
                                      + +
                                      +
                                      + author +
                                      +
                                      + +

                                      smiley smiley@chillerlan.net

                                      +
                                      + +
                                      +
                                      + copyright +
                                      +
                                      + +

                                      2023 smiley

                                      +
                                      + +
                                      +
                                      + license +
                                      +
                                      + +

                                      MIT

                                      +
                                      + +
                                      +
                                      + noinspection +
                                      +
                                      + +

                                      PhpComposerExtensionStubsInspection

                                      +
                                      + +
                                      +
                                      + + + +

                                      + Table of Contents + + +

                                      + + + + +

                                      + Classes + + +

                                      +
                                      +
                                      QRGdImagePNG
                                      GdImage png output
                                      + + + + + + + + + + + + + +
                                      +
                                      +
                                      +
                                      +
                                      
                                      +        
                                      + +
                                      +
                                      + + + +
                                      +
                                      +
                                      + +
                                      + On this page + +
                                        +
                                      • Table Of Contents
                                      • +
                                      • + +
                                      • + + +
                                      +
                                      + +
                                      +
                                      +
                                      +
                                      +
                                      +

                                      Search results

                                      + +
                                      +
                                      +
                                        +
                                        +
                                        +
                                        +
                                        + + +
                                        + + + + + + + + diff --git a/files/src-output-qrgdimagewebp.html b/files/src-output-qrgdimagewebp.html new file mode 100644 index 000000000..0a7c624d6 --- /dev/null +++ b/files/src-output-qrgdimagewebp.html @@ -0,0 +1,343 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                        +

                                        Documentation

                                        + + + + + +
                                        + +
                                        +
                                        + + + + +
                                        +
                                        +
                                          +
                                        + +
                                        +

                                        QRGdImageWEBP.php

                                        + +

                                        Class QRGdImageWEBP

                                        + + + +
                                        + Tags + + +
                                        +
                                        +
                                        + created +
                                        +
                                        + +

                                        25.10.2023

                                        +
                                        + +
                                        +
                                        + author +
                                        +
                                        + +

                                        smiley smiley@chillerlan.net

                                        +
                                        + +
                                        +
                                        + copyright +
                                        +
                                        + +

                                        2023 smiley

                                        +
                                        + +
                                        +
                                        + license +
                                        +
                                        + +

                                        MIT

                                        +
                                        + +
                                        +
                                        + noinspection +
                                        +
                                        + +

                                        PhpComposerExtensionStubsInspection

                                        +
                                        + +
                                        +
                                        + + + +

                                        + Table of Contents + + +

                                        + + + + +

                                        + Classes + + +

                                        +
                                        +
                                        QRGdImageWEBP
                                        GdImage webp output
                                        + + + + + + + + + + + + + +
                                        +
                                        +
                                        +
                                        +
                                        
                                        +        
                                        + +
                                        +
                                        + + + +
                                        +
                                        +
                                        + +
                                        + On this page + +
                                          +
                                        • Table Of Contents
                                        • +
                                        • + +
                                        • + + +
                                        +
                                        + +
                                        +
                                        +
                                        +
                                        +
                                        +

                                        Search results

                                        + +
                                        +
                                        +
                                          +
                                          +
                                          +
                                          +
                                          + + +
                                          + + + + + + + + diff --git a/files/src-output-qrstringjson.html b/files/src-output-qrstringjson.html new file mode 100644 index 000000000..0989c079b --- /dev/null +++ b/files/src-output-qrstringjson.html @@ -0,0 +1,343 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                          +

                                          Documentation

                                          + + + + + +
                                          + +
                                          +
                                          + + + + +
                                          +
                                          +
                                            +
                                          + +
                                          +

                                          QRStringJSON.php

                                          + +

                                          Class QRStringJSON

                                          + + + +
                                          + Tags + + +
                                          +
                                          +
                                          + created +
                                          +
                                          + +

                                          25.10.2023

                                          +
                                          + +
                                          +
                                          + author +
                                          +
                                          + +

                                          smiley smiley@chillerlan.net

                                          +
                                          + +
                                          +
                                          + copyright +
                                          +
                                          + +

                                          2023 smiley

                                          +
                                          + +
                                          +
                                          + license +
                                          +
                                          + +

                                          MIT

                                          +
                                          + +
                                          +
                                          + noinspection +
                                          +
                                          + +

                                          PhpComposerExtensionStubsInspection

                                          +
                                          + +
                                          +
                                          + + + +

                                          + Table of Contents + + +

                                          + + + + +

                                          + Classes + + +

                                          +
                                          +
                                          QRStringJSON
                                          common output abstract
                                          + + + + + + + + + + + + + +
                                          +
                                          +
                                          +
                                          +
                                          
                                          +        
                                          + +
                                          +
                                          + + + +
                                          +
                                          +
                                          + +
                                          + On this page + +
                                            +
                                          • Table Of Contents
                                          • +
                                          • + +
                                          • + + +
                                          +
                                          + +
                                          +
                                          +
                                          +
                                          +
                                          +

                                          Search results

                                          + +
                                          +
                                          +
                                            +
                                            +
                                            +
                                            +
                                            + + +
                                            + + + + + + + + diff --git a/files/tests-output-qrstringtestabstract.html b/files/src-output-qrstringtext.html similarity index 91% rename from files/tests-output-qrstringtestabstract.html rename to files/src-output-qrstringtext.html index 39e237ad3..506004ad9 100644 --- a/files/tests-output-qrstringtestabstract.html +++ b/files/src-output-qrstringtext.html @@ -113,15 +113,15 @@
                                          -

                                          QRStringTestAbstract.php

                                          +

                                          QRStringText.php

                                          -

                                          Class QRStringTestAbstract

                                          +

                                          Class QRStringText

                                          Tags - +
                                          @@ -130,7 +130,7 @@
                                      • -

                                        24.12.2017

                                        +

                                        25.10.2023

                                        @@ -139,7 +139,7 @@
                                        -

                                        Smiley smiley@chillerlan.net

                                        +

                                        smiley smiley@chillerlan.net

                                        @@ -148,7 +148,7 @@
                                        -

                                        2017 Smiley

                                        +

                                        2023 smiley

                                        @@ -167,7 +167,7 @@

                                        Table of Contents - +

                                        @@ -176,11 +176,11 @@

                                        Classes - +

                                        -
                                        QRStringTestAbstract
                                        Tests the QRString output module
                                        +
                                        QRStringText
                                        common output abstract
                                        @@ -198,7 +198,7 @@
                                        -
                                        
                                        +            
                                        
                                                 
                                        @@ -297,7 +297,7 @@
                                      • Table Of Contents
                                      • @@ -319,7 +319,7 @@
                                        - + diff --git a/files/src-qroptionstrait.html b/files/src-qroptionstrait.html index 141cf627f..da8226fc7 100644 --- a/files/src-qroptionstrait.html +++ b/files/src-qroptionstrait.html @@ -168,7 +168,7 @@
                                        -

                                        PhpUnused

                                        +

                                        PhpUnused, PhpComposerExtensionStubsInspection

                                        diff --git a/files/tests-output-qrstringjsontest.html b/files/tests-output-qrstringjsontest.html index 2e76933e6..446ad6db2 100644 --- a/files/tests-output-qrstringjsontest.html +++ b/files/tests-output-qrstringjsontest.html @@ -180,7 +180,8 @@
                                        -
                                        QRStringJSONTest
                                        Tests the QRString output module
                                        +
                                        QRStringJSONTest
                                        Test abstract for the several (built-in) output modules, +should also be used to test custom output modules
                                        diff --git a/files/tests-output-qrstringtexttest.html b/files/tests-output-qrstringtexttest.html index 0856c9c86..66694d76f 100644 --- a/files/tests-output-qrstringtexttest.html +++ b/files/tests-output-qrstringtexttest.html @@ -180,7 +180,8 @@
                                        -
                                        QRStringTEXTTest
                                        Tests the QRString output module
                                        +
                                        QRStringTEXTTest
                                        Test abstract for the several (built-in) output modules, +should also be used to test custom output modules
                                        diff --git a/indices/files.html b/indices/files.html index 9d0c25c19..0c5eba1a1 100644 --- a/indices/files.html +++ b/indices/files.html @@ -211,11 +211,16 @@
                                      • QRFpdf.php
                                      • QRFpdfTest.php
                                      • QRGdImage.php
                                      • +
                                      • QRGdImageBMP.php
                                      • QRGdImageBMPTest.php
                                      • +
                                      • QRGdImageGIF.php
                                      • QRGdImageGIFTest.php
                                      • +
                                      • QRGdImageJPEG.php
                                      • QRGdImageJPGTest.php
                                      • +
                                      • QRGdImagePNG.php
                                      • QRGdImagePNGTest.php
                                      • QRGdImageTestAbstract.php
                                      • +
                                      • QRGdImageWEBP.php
                                      • QRGdImageWEBPTest.php
                                      • QRImage.php
                                      • QRImagick.php
                                      • @@ -236,9 +241,10 @@
                                      • QROutputInterface.php
                                      • QROutputTestAbstract.php
                                      • QRString.php
                                      • +
                                      • QRStringJSON.php
                                      • QRStringJSONTest.php
                                      • QRStringTEXTTest.php
                                      • -
                                      • QRStringTestAbstract.php
                                      • +
                                      • QRStringText.php

                                      R

                                        diff --git a/js/searchIndex.js b/js/searchIndex.js index 415c6d39d..ec2555141 100644 --- a/js/searchIndex.js +++ b/js/searchIndex.js @@ -2425,6 +2425,11 @@ Search.appendIndex( "name": "module", "summary": "Returns\u0020a\u0020path\u0020segment\u0020for\u0020a\u0020single\u0020module", "url": "classes/chillerlan-QRCode-Output-QREps.html#method_module" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QREps\u003A\u003AMIME_TYPE", + "name": "MIME_TYPE", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QREps.html#constant_MIME_TYPE" }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QRFpdf", "name": "QRFpdf", @@ -2465,6 +2470,11 @@ Search.appendIndex( "name": "module", "summary": "Renders\u0020a\u0020single\u0020module", "url": "classes/chillerlan-QRCode-Output-QRFpdf.html#method_module" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRFpdf\u003A\u003AMIME_TYPE", + "name": "MIME_TYPE", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRFpdf.html#constant_MIME_TYPE" }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QRFpdf\u003A\u003A\u0024fpdf", "name": "fpdf", @@ -2535,6 +2545,11 @@ Search.appendIndex( "name": "module", "summary": "Creates\u0020a\u0020single\u0020QR\u0020pixel\u0020with\u0020the\u0020given\u0020settings", "url": "classes/chillerlan-QRCode-Output-QRGdImage.html#method_module" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImage\u003A\u003ArenderImage\u0028\u0029", + "name": "renderImage", + "summary": "Renders\u0020the\u0020image\u0020with\u0020the\u0020gdimage\u0020function\u0020for\u0020the\u0020desired\u0020output", + "url": "classes/chillerlan-QRCode-Output-QRGdImage.html#method_renderImage" }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImage\u003A\u003AdumpImage\u0028\u0029", "name": "dumpImage", @@ -2555,6 +2570,86 @@ Search.appendIndex( "name": "upscaled", "summary": "Whether\u0020we\u0027re\u0020running\u0020in\u0020upscale\u0020mode\u0020\u0028scale\u0020\u003C\u002020\u0029", "url": "classes/chillerlan-QRCode-Output-QRGdImage.html#property_upscaled" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageBMP", + "name": "QRGdImageBMP", + "summary": "GdImage\u0020bmp\u0020output", + "url": "classes/chillerlan-QRCode-Output-QRGdImageBMP.html" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageBMP\u003A\u003ArenderImage\u0028\u0029", + "name": "renderImage", + "summary": "Renders\u0020the\u0020image\u0020with\u0020the\u0020gdimage\u0020function\u0020for\u0020the\u0020desired\u0020output", + "url": "classes/chillerlan-QRCode-Output-QRGdImageBMP.html#method_renderImage" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageBMP\u003A\u003AMIME_TYPE", + "name": "MIME_TYPE", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRGdImageBMP.html#constant_MIME_TYPE" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageGIF", + "name": "QRGdImageGIF", + "summary": "GdImage\u0020gif\u0020output", + "url": "classes/chillerlan-QRCode-Output-QRGdImageGIF.html" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageGIF\u003A\u003ArenderImage\u0028\u0029", + "name": "renderImage", + "summary": "Renders\u0020the\u0020image\u0020with\u0020the\u0020gdimage\u0020function\u0020for\u0020the\u0020desired\u0020output", + "url": "classes/chillerlan-QRCode-Output-QRGdImageGIF.html#method_renderImage" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageGIF\u003A\u003AMIME_TYPE", + "name": "MIME_TYPE", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRGdImageGIF.html#constant_MIME_TYPE" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageJPEG", + "name": "QRGdImageJPEG", + "summary": "GdImage\u0020jpeg\u0020output", + "url": "classes/chillerlan-QRCode-Output-QRGdImageJPEG.html" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageJPEG\u003A\u003AsetTransparencyColor\u0028\u0029", + "name": "setTransparencyColor", + "summary": "Sets\u0020the\u0020transparency\u0020color", + "url": "classes/chillerlan-QRCode-Output-QRGdImageJPEG.html#method_setTransparencyColor" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageJPEG\u003A\u003ArenderImage\u0028\u0029", + "name": "renderImage", + "summary": "Renders\u0020the\u0020image\u0020with\u0020the\u0020gdimage\u0020function\u0020for\u0020the\u0020desired\u0020output", + "url": "classes/chillerlan-QRCode-Output-QRGdImageJPEG.html#method_renderImage" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageJPEG\u003A\u003AMIME_TYPE", + "name": "MIME_TYPE", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRGdImageJPEG.html#constant_MIME_TYPE" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImagePNG", + "name": "QRGdImagePNG", + "summary": "GdImage\u0020png\u0020output", + "url": "classes/chillerlan-QRCode-Output-QRGdImagePNG.html" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImagePNG\u003A\u003ArenderImage\u0028\u0029", + "name": "renderImage", + "summary": "Renders\u0020the\u0020image\u0020with\u0020the\u0020gdimage\u0020function\u0020for\u0020the\u0020desired\u0020output", + "url": "classes/chillerlan-QRCode-Output-QRGdImagePNG.html#method_renderImage" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImagePNG\u003A\u003AMIME_TYPE", + "name": "MIME_TYPE", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRGdImagePNG.html#constant_MIME_TYPE" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageWEBP", + "name": "QRGdImageWEBP", + "summary": "GdImage\u0020webp\u0020output", + "url": "classes/chillerlan-QRCode-Output-QRGdImageWEBP.html" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageWEBP\u003A\u003ArenderImage\u0028\u0029", + "name": "renderImage", + "summary": "Renders\u0020the\u0020image\u0020with\u0020the\u0020gdimage\u0020function\u0020for\u0020the\u0020desired\u0020output", + "url": "classes/chillerlan-QRCode-Output-QRGdImageWEBP.html#method_renderImage" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRGdImageWEBP\u003A\u003AMIME_TYPE", + "name": "MIME_TYPE", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRGdImageWEBP.html#constant_MIME_TYPE" }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QRImage", "name": "QRImage", @@ -2675,6 +2770,11 @@ Search.appendIndex( "name": "createMarkup", "summary": "returns\u0020the\u0020fully\u0020parsed\u0020and\u0020rendered\u0020markup\u0020string\u0020for\u0020the\u0020given\u0020input", "url": "classes/chillerlan-QRCode-Output-QRMarkupHTML.html#method_createMarkup" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRMarkupHTML\u003A\u003AMIME_TYPE", + "name": "MIME_TYPE", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRMarkupHTML.html#constant_MIME_TYPE" }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QRMarkupSVG", "name": "QRMarkupSVG", @@ -2725,6 +2825,11 @@ Search.appendIndex( "name": "module", "summary": "returns\u0020a\u0020path\u0020segment\u0020for\u0020a\u0020single\u0020module", "url": "classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_module" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRMarkupSVG\u003A\u003AMIME_TYPE", + "name": "MIME_TYPE", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRMarkupSVG.html#constant_MIME_TYPE" }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QROutputAbstract", "name": "QROutputAbstract", @@ -2855,6 +2960,11 @@ Search.appendIndex( "name": "circleRadius", "summary": "", "url": "classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QROutputAbstract\u003A\u003A\u0024circleDiameter", + "name": "circleDiameter", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter" }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QROutputInterface", "name": "QROutputInterface", @@ -2990,6 +3100,71 @@ Search.appendIndex( "name": "ansi8", "summary": "a\u0020little\u0020helper\u0020to\u0020create\u0020a\u0020proper\u0020ANSI\u00208\u002Dbit\u0020color\u0020escape\u0020sequence", "url": "classes/chillerlan-QRCode-Output-QRString.html#method_ansi8" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringJSON", + "name": "QRStringJSON", + "summary": "common\u0020output\u0020abstract", + "url": "classes/chillerlan-QRCode-Output-QRStringJSON.html" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringJSON\u003A\u003Adump\u0028\u0029", + "name": "dump", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRStringJSON.html#method_dump" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringJSON\u003A\u003AprepareModuleValue\u0028\u0029", + "name": "prepareModuleValue", + "summary": "unused\u0020\u002D\u0020required\u0020by\u0020interface", + "url": "classes/chillerlan-QRCode-Output-QRStringJSON.html#method_prepareModuleValue" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringJSON\u003A\u003AgetDefaultModuleValue\u0028\u0029", + "name": "getDefaultModuleValue", + "summary": "unused\u0020\u002D\u0020required\u0020by\u0020interface", + "url": "classes/chillerlan-QRCode-Output-QRStringJSON.html#method_getDefaultModuleValue" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringJSON\u003A\u003AmoduleValueIsValid\u0028\u0029", + "name": "moduleValueIsValid", + "summary": "unused\u0020\u002D\u0020required\u0020by\u0020interface", + "url": "classes/chillerlan-QRCode-Output-QRStringJSON.html#method_moduleValueIsValid" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringJSON\u003A\u003AMIME_TYPE", + "name": "MIME_TYPE", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRStringJSON.html#constant_MIME_TYPE" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringText", + "name": "QRStringText", + "summary": "common\u0020output\u0020abstract", + "url": "classes/chillerlan-QRCode-Output-QRStringText.html" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringText\u003A\u003AmoduleValueIsValid\u0028\u0029", + "name": "moduleValueIsValid", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRStringText.html#method_moduleValueIsValid" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringText\u003A\u003AprepareModuleValue\u0028\u0029", + "name": "prepareModuleValue", + "summary": "Prepares\u0020the\u0020value\u0020for\u0020the\u0020given\u0020input\u0020\u0028\u0029", + "url": "classes/chillerlan-QRCode-Output-QRStringText.html#method_prepareModuleValue" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringText\u003A\u003AgetDefaultModuleValue\u0028\u0029", + "name": "getDefaultModuleValue", + "summary": "Returns\u0020a\u0020default\u0020value\u0020for\u0020either\u0020dark\u0020or\u0020light\u0020modules", + "url": "classes/chillerlan-QRCode-Output-QRStringText.html#method_getDefaultModuleValue" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringText\u003A\u003Adump\u0028\u0029", + "name": "dump", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRStringText.html#method_dump" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringText\u003A\u003Aansi8\u0028\u0029", + "name": "ansi8", + "summary": "a\u0020little\u0020helper\u0020to\u0020create\u0020a\u0020proper\u0020ANSI\u00208\u002Dbit\u0020color\u0020escape\u0020sequence", + "url": "classes/chillerlan-QRCode-Output-QRStringText.html#method_ansi8" + }, { + "fqsen": "\\chillerlan\\QRCode\\Output\\QRStringText\u003A\u003AMIME_TYPE", + "name": "MIME_TYPE", + "summary": "", + "url": "classes/chillerlan-QRCode-Output-QRStringText.html#constant_MIME_TYPE" }, { "fqsen": "\\chillerlan\\QRCode\\QRCode", "name": "QRCode", @@ -3505,6 +3680,11 @@ Search.appendIndex( "name": "quality", "summary": "Compression\u0020quality", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_quality" + }, { + "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024gdImageUseUpscale", + "name": "gdImageUseUpscale", + "summary": "Toggles\u0020the\u0020usage\u0020of\u0020internal\u0020upscaling\u0020when\u0020\u0060QROptions\u003A\u003A\u0024drawCircularModules\u0060\u0020is\u0020set\u0020to\u0020\u0060true\u0060\u0020and\n\u0060QROptions\u003A\u003A\u0024scale\u0060\u0020is\u0020less\u0020than\u002020", + "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_gdImageUseUpscale" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024imagickFormat", "name": "imagickFormat", @@ -3540,6 +3720,11 @@ Search.appendIndex( "name": "textLineStart", "summary": "An\u0020optional\u0020line\u0020prefix,\u0020e.g.\u0020empty\u0020space\u0020to\u0020align\u0020the\u0020QR\u0020Code\u0020in\u0020a\u0020console", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart" + }, { + "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024jsonFlags", + "name": "jsonFlags", + "summary": "Sets\u0020the\u0020flags\u0020to\u0020use\u0020for\u0020the\u0020\u0060json_encode\u0028\u0029\u0060\u0020call", + "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonFlags" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024jsonAsBooleans", "name": "jsonAsBooleans", @@ -4365,6 +4550,11 @@ Search.appendIndex( "name": "type", "summary": "", "url": "classes/chillerlan-QRCodeTest-Output-QRGdImageBMPTest.html#property_type" + }, { + "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRGdImageBMPTest\u003A\u003A\u0024FQN", + "name": "FQN", + "summary": "", + "url": "classes/chillerlan-QRCodeTest-Output-QRGdImageBMPTest.html#property_FQN" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRGdImageGIFTest", "name": "QRGdImageGIFTest", @@ -4375,6 +4565,11 @@ Search.appendIndex( "name": "type", "summary": "", "url": "classes/chillerlan-QRCodeTest-Output-QRGdImageGIFTest.html#property_type" + }, { + "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRGdImageGIFTest\u003A\u003A\u0024FQN", + "name": "FQN", + "summary": "", + "url": "classes/chillerlan-QRCodeTest-Output-QRGdImageGIFTest.html#property_FQN" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRGdImageJPGTest", "name": "QRGdImageJPGTest", @@ -4385,6 +4580,11 @@ Search.appendIndex( "name": "type", "summary": "", "url": "classes/chillerlan-QRCodeTest-Output-QRGdImageJPGTest.html#property_type" + }, { + "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRGdImageJPGTest\u003A\u003A\u0024FQN", + "name": "FQN", + "summary": "", + "url": "classes/chillerlan-QRCodeTest-Output-QRGdImageJPGTest.html#property_FQN" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRGdImagePNGTest", "name": "QRGdImagePNGTest", @@ -4395,6 +4595,11 @@ Search.appendIndex( "name": "type", "summary": "", "url": "classes/chillerlan-QRCodeTest-Output-QRGdImagePNGTest.html#property_type" + }, { + "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRGdImagePNGTest\u003A\u003A\u0024FQN", + "name": "FQN", + "summary": "", + "url": "classes/chillerlan-QRCodeTest-Output-QRGdImagePNGTest.html#property_FQN" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRGdImageTestAbstract", "name": "QRGdImageTestAbstract", @@ -4421,10 +4626,10 @@ Search.appendIndex( "summary": "", "url": "classes/chillerlan-QRCodeTest-Output-QRGdImageTestAbstract.html#method_testOutputGetResource" }, { - "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRGdImageTestAbstract\u003A\u003A\u0024FQN", - "name": "FQN", + "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRGdImageTestAbstract\u003A\u003AtestBase64MimeType\u0028\u0029", + "name": "testBase64MimeType", "summary": "", - "url": "classes/chillerlan-QRCodeTest-Output-QRGdImageTestAbstract.html#property_FQN" + "url": "classes/chillerlan-QRCodeTest-Output-QRGdImageTestAbstract.html#method_testBase64MimeType" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRGdImageWEBPTest", "name": "QRGdImageWEBPTest", @@ -4435,6 +4640,11 @@ Search.appendIndex( "name": "type", "summary": "", "url": "classes/chillerlan-QRCodeTest-Output-QRGdImageWEBPTest.html#property_type" + }, { + "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRGdImageWEBPTest\u003A\u003A\u0024FQN", + "name": "FQN", + "summary": "", + "url": "classes/chillerlan-QRCodeTest-Output-QRGdImageWEBPTest.html#property_FQN" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRImagickTest", "name": "QRImagickTest", @@ -4593,17 +4803,22 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringJSONTest", "name": "QRStringJSONTest", - "summary": "Tests\u0020the\u0020QRString\u0020output\u0020module", + "summary": "Test\u0020abstract\u0020for\u0020the\u0020several\u0020\u0028built\u002Din\u0029\u0020output\u0020modules,\nshould\u0020also\u0020be\u0020used\u0020to\u0020test\u0020custom\u0020output\u0020modules", "url": "classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringJSONTest\u003A\u003AsetUp\u0028\u0029", "name": "setUp", - "summary": "", + "summary": "Attempts\u0020to\u0020create\u0020a\u0020directory\u0020under\u0020\/.build\u0020and\u0020instances\u0020several\u0020required\u0020objects", "url": "classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html#method_setUp" + }, { + "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringJSONTest\u003A\u003AmoduleValueProvider\u0028\u0029", + "name": "moduleValueProvider", + "summary": "", + "url": "classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html#method_moduleValueProvider" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringJSONTest\u003A\u003AtestSetModuleValues\u0028\u0029", "name": "testSetModuleValues", - "summary": "", + "summary": "covers\u0020the\u0020module\u0020values\u0020settings", "url": "classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html#method_testSetModuleValues" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringJSONTest\u003A\u003A\u0024type", @@ -4611,35 +4826,35 @@ Search.appendIndex( "summary": "", "url": "classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html#property_type" }, { - "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringTestAbstract", - "name": "QRStringTestAbstract", - "summary": "Tests\u0020the\u0020QRString\u0020output\u0020module", - "url": "classes/chillerlan-QRCodeTest-Output-QRStringTestAbstract.html" - }, { - "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringTestAbstract\u003A\u003AmoduleValueProvider\u0028\u0029", - "name": "moduleValueProvider", - "summary": "", - "url": "classes/chillerlan-QRCodeTest-Output-QRStringTestAbstract.html#method_moduleValueProvider" - }, { - "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringTestAbstract\u003A\u003A\u0024FQN", + "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringJSONTest\u003A\u003A\u0024FQN", "name": "FQN", "summary": "", - "url": "classes/chillerlan-QRCodeTest-Output-QRStringTestAbstract.html#property_FQN" + "url": "classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html#property_FQN" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringTEXTTest", "name": "QRStringTEXTTest", - "summary": "Tests\u0020the\u0020QRString\u0020output\u0020module", + "summary": "Test\u0020abstract\u0020for\u0020the\u0020several\u0020\u0028built\u002Din\u0029\u0020output\u0020modules,\nshould\u0020also\u0020be\u0020used\u0020to\u0020test\u0020custom\u0020output\u0020modules", "url": "classes/chillerlan-QRCodeTest-Output-QRStringTEXTTest.html" + }, { + "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringTEXTTest\u003A\u003AmoduleValueProvider\u0028\u0029", + "name": "moduleValueProvider", + "summary": "", + "url": "classes/chillerlan-QRCodeTest-Output-QRStringTEXTTest.html#method_moduleValueProvider" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringTEXTTest\u003A\u003AtestSetModuleValues\u0028\u0029", "name": "testSetModuleValues", - "summary": "", + "summary": "covers\u0020the\u0020module\u0020values\u0020settings", "url": "classes/chillerlan-QRCodeTest-Output-QRStringTEXTTest.html#method_testSetModuleValues" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringTEXTTest\u003A\u003A\u0024type", "name": "type", "summary": "", "url": "classes/chillerlan-QRCodeTest-Output-QRStringTEXTTest.html#property_type" + }, { + "fqsen": "\\chillerlan\\QRCodeTest\\Output\\QRStringTEXTTest\u003A\u003A\u0024FQN", + "name": "FQN", + "summary": "", + "url": "classes/chillerlan-QRCodeTest-Output-QRStringTEXTTest.html#property_FQN" }, { "fqsen": "\\chillerlan\\QRCodeTest\\QRCodeReaderGDTest", "name": "QRCodeReaderGDTest", diff --git a/namespaces/chillerlan-qrcode-output.html b/namespaces/chillerlan-qrcode-output.html index b93cda993..6d6f24f23 100644 --- a/namespaces/chillerlan-qrcode-output.html +++ b/namespaces/chillerlan-qrcode-output.html @@ -140,7 +140,7 @@
                                        -
                                        QRCodeOutputException
                                        An exception container
                                        QREps
                                        Encapsulated Postscript (EPS) output
                                        QRFpdf
                                        QRFpdf output module (requires fpdf)
                                        QRGdImage
                                        Converts the matrix into GD images, raw or base64 output (requires ext-gd)
                                        QRImage
                                        Converts the matrix into GD images, raw or base64 output (requires ext-gd)
                                        QRImagick
                                        ImageMagick output module (requires ext-imagick)
                                        QRMarkup
                                        Abstract for markup types: HTML, SVG, ... XML anyone?
                                        QRMarkupHTML
                                        HTML output (a cheap markup substitute when SVG is not available or not an option)
                                        QRMarkupSVG
                                        SVG output
                                        QROutputAbstract
                                        common output abstract
                                        QRString
                                        Converts the matrix data into string types
                                        +
                                        QRCodeOutputException
                                        An exception container
                                        QREps
                                        Encapsulated Postscript (EPS) output
                                        QRFpdf
                                        QRFpdf output module (requires fpdf)
                                        QRGdImage
                                        Converts the matrix into GD images, raw or base64 output (requires ext-gd)
                                        QRGdImageBMP
                                        GdImage bmp output
                                        QRGdImageGIF
                                        GdImage gif output
                                        QRGdImageJPEG
                                        GdImage jpeg output
                                        QRGdImagePNG
                                        GdImage png output
                                        QRGdImageWEBP
                                        GdImage webp output
                                        QRImage
                                        Converts the matrix into GD images, raw or base64 output (requires ext-gd)
                                        QRImagick
                                        ImageMagick output module (requires ext-imagick)
                                        QRMarkup
                                        Abstract for markup types: HTML, SVG, ... XML anyone?
                                        QRMarkupHTML
                                        HTML output (a cheap markup substitute when SVG is not available or not an option)
                                        QRMarkupSVG
                                        SVG output
                                        QROutputAbstract
                                        common output abstract
                                        QRString
                                        Converts the matrix data into string types
                                        QRStringJSON
                                        common output abstract
                                        QRStringText
                                        common output abstract
                                        diff --git a/namespaces/chillerlan-qrcodetest-output.html b/namespaces/chillerlan-qrcodetest-output.html index 24fd3a3fd..d712b0c9f 100644 --- a/namespaces/chillerlan-qrcodetest-output.html +++ b/namespaces/chillerlan-qrcodetest-output.html @@ -135,7 +135,9 @@
                                        QREpsTest
                                        Test abstract for the several (built-in) output modules, should also be used to test custom output modules
                                        QRFpdfTest
                                        Tests the QRFpdf output module
                                        QRGdImageBMPTest
                                        Tests the QRGdImage output module
                                        QRGdImageGIFTest
                                        Tests the QRGdImage output module
                                        QRGdImageJPGTest
                                        Tests the QRGdImage output module
                                        QRGdImagePNGTest
                                        Tests the QRGdImage output module
                                        QRGdImageTestAbstract
                                        Tests the QRGdImage output module
                                        QRGdImageWEBPTest
                                        Tests the QRGdImage output module
                                        QRImagickTest
                                        Tests the QRImagick output module
                                        QRMarkupHTMLTest
                                        Tests the QRMarkup output module
                                        QRMarkupSVGTest
                                        Tests the QRMarkup output module
                                        QRMarkupTestAbstract
                                        Tests the QRMarkup output module
                                        QROutputTestAbstract
                                        Test abstract for the several (built-in) output modules, -should also be used to test custom output modules
                                        QRStringJSONTest
                                        Tests the QRString output module
                                        QRStringTestAbstract
                                        Tests the QRString output module
                                        QRStringTEXTTest
                                        Tests the QRString output module
                                        +should also be used to test custom output modules
                                        QRStringJSONTest
                                        Test abstract for the several (built-in) output modules, +should also be used to test custom output modules
                                        QRStringTEXTTest
                                        Test abstract for the several (built-in) output modules, +should also be used to test custom output modules
                                        diff --git a/packages/Application.html b/packages/Application.html index 750e2439a..7ac1f31e7 100644 --- a/packages/Application.html +++ b/packages/Application.html @@ -164,9 +164,11 @@ Imaging library, but which may not be available in other environments such as J2 versa.
                                        PerspectiveTransform
                                        This class implements a perspective transform in two dimensions. Given four source and four destination points, it will compute the transformation implied between them. The code is based directly upon section 3.4.2 of George Wolberg's "Digital Image Warping"; see pages 54-56.
                                        QRCodeDetectorException
                                        An exception container
                                        ResultPoint
                                        Encapsulates a point of interest in an image containing a barcode. Typically, this -would be the location of a finder pattern or the corner of the barcode, for example.
                                        QRCodeOutputException
                                        An exception container
                                        QREps
                                        Encapsulated Postscript (EPS) output
                                        QRFpdf
                                        QRFpdf output module (requires fpdf)
                                        QRGdImage
                                        Converts the matrix into GD images, raw or base64 output (requires ext-gd)
                                        QRImage
                                        Converts the matrix into GD images, raw or base64 output (requires ext-gd)
                                        QRImagick
                                        ImageMagick output module (requires ext-imagick)
                                        QRMarkup
                                        Abstract for markup types: HTML, SVG, ... XML anyone?
                                        QRMarkupHTML
                                        HTML output (a cheap markup substitute when SVG is not available or not an option)
                                        QRMarkupSVG
                                        SVG output
                                        QROutputAbstract
                                        common output abstract
                                        QRString
                                        Converts the matrix data into string types
                                        QRCode
                                        Turns a text string into a Model 2 QR Code
                                        QRCodeException
                                        An exception container
                                        QROptions
                                        The QRCode settings container
                                        BitBufferTest
                                        BitBuffer coverage test
                                        EccLevelTest
                                        EccLevel coverage test
                                        ECICharsetTest
                                        MaskPatternTest
                                        ModeTest
                                        Mode coverage test
                                        VersionTest
                                        Version coverage test
                                        AlphaNumTest
                                        Tests the AlphaNum class
                                        ByteTest
                                        Tests the Byte class
                                        DataInterfaceTestAbstract
                                        The data interface test abstract
                                        ECITest
                                        Tests the ECI class
                                        HanziTest
                                        Tests the Hanzi/GB2312 class
                                        KanjiTest
                                        Tests the Kanji class
                                        NumberTest
                                        Tests the Number class
                                        QRDataTest
                                        QRMatrixTest
                                        Tests the QRMatrix class
                                        QREpsTest
                                        Test abstract for the several (built-in) output modules, +would be the location of a finder pattern or the corner of the barcode, for example.
                                        QRCodeOutputException
                                        An exception container
                                        QREps
                                        Encapsulated Postscript (EPS) output
                                        QRFpdf
                                        QRFpdf output module (requires fpdf)
                                        QRGdImage
                                        Converts the matrix into GD images, raw or base64 output (requires ext-gd)
                                        QRGdImageBMP
                                        GdImage bmp output
                                        QRGdImageGIF
                                        GdImage gif output
                                        QRGdImageJPEG
                                        GdImage jpeg output
                                        QRGdImagePNG
                                        GdImage png output
                                        QRGdImageWEBP
                                        GdImage webp output
                                        QRImage
                                        Converts the matrix into GD images, raw or base64 output (requires ext-gd)
                                        QRImagick
                                        ImageMagick output module (requires ext-imagick)
                                        QRMarkup
                                        Abstract for markup types: HTML, SVG, ... XML anyone?
                                        QRMarkupHTML
                                        HTML output (a cheap markup substitute when SVG is not available or not an option)
                                        QRMarkupSVG
                                        SVG output
                                        QROutputAbstract
                                        common output abstract
                                        QRString
                                        Converts the matrix data into string types
                                        QRStringJSON
                                        common output abstract
                                        QRStringText
                                        common output abstract
                                        QRCode
                                        Turns a text string into a Model 2 QR Code
                                        QRCodeException
                                        An exception container
                                        QROptions
                                        The QRCode settings container
                                        BitBufferTest
                                        BitBuffer coverage test
                                        EccLevelTest
                                        EccLevel coverage test
                                        ECICharsetTest
                                        MaskPatternTest
                                        ModeTest
                                        Mode coverage test
                                        VersionTest
                                        Version coverage test
                                        AlphaNumTest
                                        Tests the AlphaNum class
                                        ByteTest
                                        Tests the Byte class
                                        DataInterfaceTestAbstract
                                        The data interface test abstract
                                        ECITest
                                        Tests the ECI class
                                        HanziTest
                                        Tests the Hanzi/GB2312 class
                                        KanjiTest
                                        Tests the Kanji class
                                        NumberTest
                                        Tests the Number class
                                        QRDataTest
                                        QRMatrixTest
                                        Tests the QRMatrix class
                                        QREpsTest
                                        Test abstract for the several (built-in) output modules, should also be used to test custom output modules
                                        QRFpdfTest
                                        Tests the QRFpdf output module
                                        QRGdImageBMPTest
                                        Tests the QRGdImage output module
                                        QRGdImageGIFTest
                                        Tests the QRGdImage output module
                                        QRGdImageJPGTest
                                        Tests the QRGdImage output module
                                        QRGdImagePNGTest
                                        Tests the QRGdImage output module
                                        QRGdImageTestAbstract
                                        Tests the QRGdImage output module
                                        QRGdImageWEBPTest
                                        Tests the QRGdImage output module
                                        QRImagickTest
                                        Tests the QRImagick output module
                                        QRMarkupHTMLTest
                                        Tests the QRMarkup output module
                                        QRMarkupSVGTest
                                        Tests the QRMarkup output module
                                        QRMarkupTestAbstract
                                        Tests the QRMarkup output module
                                        QROutputTestAbstract
                                        Test abstract for the several (built-in) output modules, -should also be used to test custom output modules
                                        QRStringJSONTest
                                        Tests the QRString output module
                                        QRStringTestAbstract
                                        Tests the QRString output module
                                        QRStringTEXTTest
                                        Tests the QRString output module
                                        QRCodeReaderGDTest
                                        Tests the GD based reader
                                        QRCodeReaderImagickTest
                                        Tests the Imagick based reader
                                        QRCodeReaderTestAbstract
                                        Tests the QR Code reader
                                        QRCodeTest
                                        Tests basic functions of the QRCode class
                                        QROptionsTest
                                        QROptions test
                                        +should also be used to test custom output modules
                                        QRStringJSONTest
                                        Test abstract for the several (built-in) output modules, +should also be used to test custom output modules
                                        QRStringTEXTTest
                                        Test abstract for the several (built-in) output modules, +should also be used to test custom output modules
                                        QRCodeReaderGDTest
                                        Tests the GD based reader
                                        QRCodeReaderImagickTest
                                        Tests the Imagick based reader
                                        QRCodeReaderTestAbstract
                                        Tests the QR Code reader
                                        QRCodeTest
                                        Tests basic functions of the QRCode class
                                        QROptionsTest
                                        QROptions test

                                        Traits diff --git a/reports/deprecated.html b/reports/deprecated.html index e54f11a7c..51ae171f2 100644 --- a/reports/deprecated.html +++ b/reports/deprecated.html @@ -121,9 +121,18 @@ + + + + + + + + + @@ -145,6 +154,22 @@ + +
                                        src/Data/QRMatrix.php
                                        src/Output/QRGdImage.php
                                        src/Output/QRImage.php
                                        src/Output/QROutputInterface.php
                                        src/Output/QRString.php
                                        src/QRCode.php264 QRMatrix::size()

                                        use QRMatrix::getSize() instead

                                        +
                                        + +

                                        QRGdImage.php

                                        + + + + + + + + + +
                                        LineElementReason
                                        33QRGdImage

                                        this class will be made abstract in future versions, +calling it directly is deprecated - use one of the child classes instead

                                        @@ -160,6 +185,114 @@ 17 QRImage

                                        backward compatibility, use QRGdImage instead

                                        + + + + +

                                        QROutputInterface.php

                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                        LineElementReason
                                        25QROutputInterface::MARKUP_HTML +
                                        32QROutputInterface::MARKUP_SVG +
                                        39QROutputInterface::GDIMAGE_BMP +
                                        46QROutputInterface::GDIMAGE_GIF +
                                        53QROutputInterface::GDIMAGE_JPG +
                                        60QROutputInterface::GDIMAGE_PNG +
                                        67QROutputInterface::GDIMAGE_WEBP +
                                        74QROutputInterface::STRING_JSON +
                                        81QROutputInterface::STRING_TEXT +
                                        88QROutputInterface::IMAGICK +
                                        95QROutputInterface::FPDF +
                                        102QROutputInterface::EPS +
                                        109QROutputInterface::CUSTOM +
                                        118QROutputInterface::MODES +
                                        + +

                                        QRString.php

                                        + + + + + + + + + +
                                        LineElementReason
                                        23QRString

                                        this class will be removed in future versions, use one of QRStringText or QRStringJSON instead

                                        @@ -319,91 +452,104 @@ Reason - 573 + 602 QROptionsTrait::set_imageBase64()

                                        use QROptions::$outputBase64 instead

                                        - 584 + 613 QROptionsTrait::get_imageBase64()

                                        use QROptions::$outputBase64 instead

                                        - 599 + 628 QROptionsTrait::set_jpegQuality()

                                        use QROptions::$quality instead

                                        - 608 + 637 QROptionsTrait::get_jpegQuality()

                                        use QROptions::$quality instead

                                        - 623 + 652 QROptionsTrait::set_pngCompression()

                                        use QROptions::$quality instead

                                        - 632 + 661 QROptionsTrait::get_pngCompression()

                                        use QROptions::$quality instead

                                        - 647 + 676 QROptionsTrait::set_imageTransparencyBG()

                                        use QROptions::$transparencyColor instead

                                        - 656 + 685 QROptionsTrait::get_imageTransparencyBG()

                                        use QROptions::$transparencyColor instead

                                        - 671 + 700 QROptionsTrait::set_imagickBG()

                                        use QROptions::$bgColor instead

                                        - 680 + 709 QROptionsTrait::get_imagickBG()

                                        use QROptions::$bgColor instead

                                        - 564 + 126 + QROptionsTrait::$outputType +

                                        use QROptions::$outputInterface instead

                                        + + + + 136 + QROptionsTrait::$outputInterface +

                                        the nullable type will be removed in future versions +and the default value will be set to QRMarkupSVG::class

                                        + + + + 593 QROptionsTrait::$imageBase64

                                        use QROptions::$outputBase64 instead

                                        - 592 + 621 QROptionsTrait::$jpegQuality

                                        use QROptions::$quality instead

                                        - 616 + 645 QROptionsTrait::$pngCompression

                                        use QROptions::$quality instead

                                        - 640 + 669 QROptionsTrait::$imageTransparencyBG

                                        use QROptions::$transparencyColor instead

                                        - 664 + 693 QROptionsTrait::$imagickBG

                                        use QROptions::$bgColor instead