From 1e21af83f34da5a3a83c6becdec66d0ac88333fe Mon Sep 17 00:00:00 2001 From: codemasher Date: Thu, 13 Jul 2023 16:35:39 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20chillerl?= =?UTF-8?q?an/php-qrcode@ddd9ef0857b5e22d5cad4f1b9227b95c2cfbc878=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-Data-ECI.html | 16 +- classes/chillerlan-QRCode-Data-QRMatrix.html | 270 ++++++++++++++---- .../chillerlan-QRCode-Decoder-Binarizer.html | 6 +- .../chillerlan-QRCode-Decoder-BitMatrix.html | 264 +++++++++++++---- ...hillerlan-QRCode-Detector-GridSampler.html | 70 +++-- ...-QRCode-Detector-PerspectiveTransform.html | 10 +- ...erlan-QRCode-Output-QROutputInterface.html | 38 ++- classes/chillerlan-QRCode-QROptions.html | 120 ++++---- classes/chillerlan-QRCode-QROptionsTrait.html | 120 ++++---- ...erlan-QRCodeTest-Output-QRImagickTest.html | 4 +- js/searchIndex.js | 189 ++++++------ reports/deprecated.html | 2 +- 12 files changed, 742 insertions(+), 367 deletions(-) diff --git a/classes/chillerlan-QRCode-Data-ECI.html b/classes/chillerlan-QRCode-Data-ECI.html index eefda7e0b..744b3941a 100644 --- a/classes/chillerlan-QRCode-Data-ECI.html +++ b/classes/chillerlan-QRCode-Data-ECI.html @@ -511,7 +511,7 @@

@@ -622,7 +622,7 @@

@@ -680,7 +680,7 @@

@@ -738,7 +738,7 @@

@@ -781,6 +781,14 @@

+
+
+ throws +
+
+ QRCodeDataException + +
diff --git a/classes/chillerlan-QRCode-Data-QRMatrix.html b/classes/chillerlan-QRCode-Data-QRMatrix.html index 8b68318f4..25e3f46c9 100644 --- a/classes/chillerlan-QRCode-Data-QRMatrix.html +++ b/classes/chillerlan-QRCode-Data-QRMatrix.html @@ -192,6 +192,13 @@

 = 0b100000000001 +
+ +
+ M_DARKMODULE_LIGHT + +  = 0b1 +
@@ -227,6 +234,13 @@

 = 0b110000000000

+
+ +
+ M_FINDER_DOT_LIGHT + +  = 0b10000000000 +
@@ -283,6 +297,13 @@

 = 0b1000

+
+ +
+ M_SEPARATOR_DARK + +  = 0b100000001000 +
@@ -402,7 +423,7 @@

 : bool

-
checks whether the module at ($x, $y) is in the given array of $M_TYPES, +
Checks whether the module at ($x, $y) is in the given array of $M_TYPES, returns true if a match is found, otherwise false.
@@ -461,6 +482,13 @@

shortcut to initialize the functional patterns
+
+ invert() + +  : self +
+
Inverts the values of the whole matrix
+
mask() @@ -613,7 +641,7 @@

@@ -640,7 +668,7 @@

@@ -667,7 +695,7 @@

@@ -694,7 +722,7 @@

@@ -711,6 +739,33 @@

+ +
+

+ M_DARKMODULE_LIGHT + +

+ + + + + + public + int + M_DARKMODULE_LIGHT + = 0b1 + + + + + + +
+
+

+ M_FINDER_DOT_LIGHT + +

+ + + + + + public + int + M_FINDER_DOT_LIGHT + = 0b10000000000 + + + + + + +
+
+

+ M_SEPARATOR_DARK + +

+ + + + + + public + int + M_SEPARATOR_DARK + = 0b100000001000 + + + + + + +

@@ -1072,7 +1181,7 @@

@@ -1099,7 +1208,7 @@

@@ -1126,7 +1235,7 @@

@@ -1153,7 +1262,7 @@

@@ -1180,7 +1289,7 @@

@@ -1207,7 +1316,7 @@

@@ -1234,7 +1343,7 @@

@@ -1291,7 +1400,7 @@

@@ -1325,7 +1434,7 @@

@@ -1365,7 +1474,7 @@

@@ -1398,7 +1507,7 @@

@@ -1432,7 +1541,7 @@

@@ -1470,7 +1579,7 @@

@@ -1522,7 +1631,7 @@

@@ -1574,7 +1683,7 @@

@@ -1640,7 +1749,7 @@

@@ -1702,11 +1811,11 @@

-

checks whether the module at ($x, $y) is in the given array of $M_TYPES, +

Checks whether the module at ($x, $y) is in the given array of $M_TYPES, returns true if a match is found, otherwise false.

@@ -1763,7 +1872,7 @@

@@ -1826,7 +1935,7 @@

@@ -1878,7 +1987,7 @@

@@ -1911,7 +2020,7 @@

@@ -1944,7 +2053,7 @@

@@ -1988,7 +2097,7 @@

@@ -2023,7 +2132,7 @@

@@ -2056,7 +2165,7 @@

@@ -2070,6 +2179,41 @@

+

Return values
+ self + — + + +

+
+

+ invert() + +

+ + +

Inverts the values of the whole matrix

+ + + public + invert() : self + +

ISO/IEC 18004:2015 Section 6.2 - Reflectance reversal

+
+ + + +
Return values
self — @@ -2089,7 +2233,7 @@

@@ -2135,7 +2279,7 @@

@@ -2198,7 +2342,7 @@

@@ -2272,7 +2416,7 @@

@@ -2305,7 +2449,7 @@

@@ -2376,7 +2520,7 @@

@@ -2411,7 +2555,7 @@

@@ -2495,7 +2639,7 @@

@@ -2530,7 +2674,7 @@

@@ -2565,7 +2709,7 @@

@@ -2611,7 +2755,7 @@

@@ -2712,7 +2856,7 @@

@@ -2772,7 +2916,7 @@

@@ -2807,7 +2951,7 @@

@@ -2842,7 +2986,7 @@

@@ -2877,7 +3021,7 @@

@@ -2940,7 +3084,7 @@

@@ -3003,7 +3147,7 @@

@@ -3047,7 +3191,7 @@

diff --git a/classes/chillerlan-QRCode-Decoder-Binarizer.html b/classes/chillerlan-QRCode-Decoder-Binarizer.html index 161361bf3..e0e082f5e 100644 --- a/classes/chillerlan-QRCode-Decoder-Binarizer.html +++ b/classes/chillerlan-QRCode-Decoder-Binarizer.html @@ -687,7 +687,7 @@

@@ -771,7 +771,7 @@

@@ -841,7 +841,7 @@

diff --git a/classes/chillerlan-QRCode-Decoder-BitMatrix.html b/classes/chillerlan-QRCode-Decoder-BitMatrix.html index f50d6147d..a1fe912ec 100644 --- a/classes/chillerlan-QRCode-Decoder-BitMatrix.html +++ b/classes/chillerlan-QRCode-Decoder-BitMatrix.html @@ -180,6 +180,13 @@

 = 0b100000000001

+
+ +
+ M_DARKMODULE_LIGHT + +  = 0b1 +
@@ -215,6 +222,13 @@

 = 0b110000000000

+
+ +
+ M_FINDER_DOT_LIGHT + +  = 0b10000000000 +
@@ -271,6 +285,13 @@

 = 0b1000

+
+ +
+ M_SEPARATOR_DARK + +  = 0b100000001000 +
@@ -475,7 +496,7 @@

 : bool

-
checks whether the module at ($x, $y) is in the given array of $M_TYPES, +
Checks whether the module at ($x, $y) is in the given array of $M_TYPES, returns true if a match is found, otherwise false.
@@ -534,6 +555,13 @@

shortcut to initialize the functional patterns
+
+ invert() + +  : self +
+
Inverts the values of the whole matrix
+
mask() @@ -758,7 +786,7 @@

@@ -785,7 +813,7 @@

@@ -812,7 +840,7 @@

@@ -839,7 +867,7 @@

@@ -856,6 +884,33 @@

+ +
+

+ M_DARKMODULE_LIGHT + +

+ + + + + + public + int + M_DARKMODULE_LIGHT + = 0b1 + + + + + + +
+
+

+ M_FINDER_DOT_LIGHT + +

+ + + + + + public + int + M_FINDER_DOT_LIGHT + = 0b10000000000 + + + + + + +
+
+

+ M_SEPARATOR_DARK + +

+ + + + + + public + int + M_SEPARATOR_DARK + = 0b100000001000 + + + + + + +

@@ -1217,7 +1326,7 @@

@@ -1244,7 +1353,7 @@

@@ -1271,7 +1380,7 @@

@@ -1298,7 +1407,7 @@

@@ -1325,7 +1434,7 @@

@@ -1352,7 +1461,7 @@

@@ -1379,7 +1488,7 @@

@@ -1560,7 +1669,7 @@

@@ -1594,7 +1703,7 @@

@@ -1634,7 +1743,7 @@

@@ -1667,7 +1776,7 @@

@@ -1701,7 +1810,7 @@

@@ -1834,7 +1943,7 @@

@@ -1886,7 +1995,7 @@

@@ -1952,7 +2061,7 @@

@@ -2014,11 +2123,11 @@

-

checks whether the module at ($x, $y) is in the given array of $M_TYPES, +

Checks whether the module at ($x, $y) is in the given array of $M_TYPES, returns true if a match is found, otherwise false.

@@ -2075,7 +2184,7 @@

@@ -2138,7 +2247,7 @@

@@ -2190,7 +2299,7 @@

@@ -2223,7 +2332,7 @@

@@ -2256,7 +2365,7 @@

@@ -2300,7 +2409,7 @@

@@ -2335,7 +2444,7 @@

@@ -2368,7 +2477,7 @@

@@ -2382,6 +2491,41 @@

+

Return values
+ self + — + + +

+
+

+ invert() + +

+ + +

Inverts the values of the whole matrix

+ + + public + invert() : self + +

ISO/IEC 18004:2015 Section 6.2 - Reflectance reversal

+
+ + + +
Return values
self — @@ -2401,7 +2545,7 @@

@@ -2447,7 +2591,7 @@

@@ -2510,7 +2654,7 @@

@@ -2699,7 +2843,7 @@

@@ -2732,7 +2876,7 @@

@@ -2803,7 +2947,7 @@

@@ -2838,7 +2982,7 @@

@@ -2922,7 +3066,7 @@

@@ -2957,7 +3101,7 @@

@@ -2992,7 +3136,7 @@

@@ -3192,7 +3336,7 @@

@@ -3227,7 +3371,7 @@

@@ -3262,7 +3406,7 @@

@@ -3297,7 +3441,7 @@

@@ -3360,7 +3504,7 @@

@@ -3423,7 +3567,7 @@

@@ -3467,7 +3611,7 @@

diff --git a/classes/chillerlan-QRCode-Detector-GridSampler.html b/classes/chillerlan-QRCode-Detector-GridSampler.html index f75034d3c..12ef6bf52 100644 --- a/classes/chillerlan-QRCode-Detector-GridSampler.html +++ b/classes/chillerlan-QRCode-Detector-GridSampler.html @@ -174,7 +174,14 @@

-
+
+ $points + +  : array<string|int, mixed> +
+
+ +
sampleGrid()  : BitMatrix @@ -198,6 +205,46 @@

+
+

+ Properties + +

+
+

+ $points + + + +

+ + + + + private + array<string|int, mixed> + $points + + +
+ +
+ + + +
+

@@ -217,7 +264,7 @@

@@ -299,7 +346,7 @@

@@ -308,7 +355,7 @@

private - checkAndNudgePoints(BitMatrix $matrix, array<string|int, float> $points) : void + checkAndNudgePoints(int $dimension) : void

This method will actually "nudge" the endpoints back onto the image if they are found to be barely (less than 1 pixel) off the image. This accounts for imperfect detection of finder @@ -320,20 +367,11 @@

Parameters
- $matrix - : BitMatrix -
-
-

image into which the points should map

-
- -
-
- $points - : array<string|int, float> + $dimension + : int
-

actual points in x1,y1,...,xn,yn form

+

matrix width/height

diff --git a/classes/chillerlan-QRCode-Detector-PerspectiveTransform.html b/classes/chillerlan-QRCode-Detector-PerspectiveTransform.html index 37219e044..a81ac7938 100644 --- a/classes/chillerlan-QRCode-Detector-PerspectiveTransform.html +++ b/classes/chillerlan-QRCode-Detector-PerspectiveTransform.html @@ -241,7 +241,7 @@

transformPoints() -  : void +  : array<string|int, array<string|int, mixed>>
@@ -803,7 +803,7 @@

public - transformPoints(array<string|int, mixed> &$xValues[, array<string|int, mixed> &$yValues = null ]) : void + transformPoints(array<string|int, mixed> $xValues[, array<string|int, mixed> $yValues = null ]) : array<string|int, array<string|int, mixed>>

Parameters
@@ -829,9 +829,11 @@
Parameters
Return values
- void + array<string|int, array<string|int, mixed>> — - +

[$xValues, $yValues|null]

+
+

 = [ // light \chillerlan\QRCode\Data\QRMatrix::M_NULL => false, + \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT => false, \chillerlan\QRCode\Data\QRMatrix::M_DATA => false, \chillerlan\QRCode\Data\QRMatrix::M_FINDER => false, \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR => false, @@ -169,11 +170,13 @@

\chillerlan\QRCode\Data\QRMatrix::M_VERSION => false, \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE => false, \chillerlan\QRCode\Data\QRMatrix::M_LOGO => false, + \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT => false, \chillerlan\QRCode\Data\QRMatrix::M_TEST => false, // dark \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE => true, \chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK => true, + \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK => true, @@ -184,7 +187,7 @@

\chillerlan\QRCode\Data\QRMatrix::M_TEST_DARK => true, ]

-
+
Map of module type => default value
EPS @@ -234,6 +237,7 @@

 = [ // light \chillerlan\QRCode\Data\QRMatrix::M_NULL => 'null', + \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT => 'darkmodule-light', \chillerlan\QRCode\Data\QRMatrix::M_DATA => 'data', \chillerlan\QRCode\Data\QRMatrix::M_FINDER => 'finder', \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR => 'separator', @@ -243,11 +247,13 @@

\chillerlan\QRCode\Data\QRMatrix::M_VERSION => 'version', \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE => 'quietzone', \chillerlan\QRCode\Data\QRMatrix::M_LOGO => 'logo', + \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT => 'finder-dot-light', \chillerlan\QRCode\Data\QRMatrix::M_TEST => 'test', // dark \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE => 'darkmodule', \chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK => 'data-dark', \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK => 'finder-dark', + \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK => 'separator-dark', \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK => 'alignment-dark', \chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK => 'timing-dark', \chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK => 'format-dark', @@ -258,7 +264,7 @@

\chillerlan\QRCode\Data\QRMatrix::M_TEST_DARK => 'test-dark', ]

-
+
Map of module type => readable name (for CSS etc.)
MARKUP_HTML @@ -279,7 +285,7 @@

 = [self::MARKUP_SVG => \chillerlan\QRCode\Output\QRMarkupSVG::class, self::MARKUP_HTML => \chillerlan\QRCode\Output\QRMarkupHTML::class, self::GDIMAGE_PNG => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_GIF => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_JPG => \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]

-
Map of built-in output modes => modules
+
Map of built-in output modes => class FQN
STRING_JSON @@ -300,7 +306,7 @@

 : mixed

-
generates the output, optionally dumps it to a file, and returns it
+
Generates the output, optionally dumps it to a file, and returns it
moduleValueIsValid() @@ -355,11 +361,12 @@

- +

Map of module type => default value

+ public array<string|int, bool> @@ -367,6 +374,7 @@

= [ // light \chillerlan\QRCode\Data\QRMatrix::M_NULL => false, + \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT => false, \chillerlan\QRCode\Data\QRMatrix::M_DATA => false, \chillerlan\QRCode\Data\QRMatrix::M_FINDER => false, \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR => false, @@ -376,11 +384,13 @@

\chillerlan\QRCode\Data\QRMatrix::M_VERSION => false, \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE => false, \chillerlan\QRCode\Data\QRMatrix::M_LOGO => false, + \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT => false, \chillerlan\QRCode\Data\QRMatrix::M_TEST => false, // dark \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE => true, \chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK => true, + \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK => true, @@ -569,11 +579,12 @@

- +

Map of module type => readable name (for CSS etc.)

+ public array<string|int, string> @@ -581,6 +592,7 @@

= [ // light \chillerlan\QRCode\Data\QRMatrix::M_NULL => 'null', + \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT => 'darkmodule-light', \chillerlan\QRCode\Data\QRMatrix::M_DATA => 'data', \chillerlan\QRCode\Data\QRMatrix::M_FINDER => 'finder', \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR => 'separator', @@ -590,11 +602,13 @@

\chillerlan\QRCode\Data\QRMatrix::M_VERSION => 'version', \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE => 'quietzone', \chillerlan\QRCode\Data\QRMatrix::M_LOGO => 'logo', + \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT => 'finder-dot-light', \chillerlan\QRCode\Data\QRMatrix::M_TEST => 'test', // dark \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE => 'darkmodule', \chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK => 'data-dark', \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK => 'finder-dark', + \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK => 'separator-dark', \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK => 'alignment-dark', \chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK => 'timing-dark', \chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK => 'format-dark', @@ -679,7 +693,7 @@

-

Map of built-in output modes => modules

+

Map of built-in output modes => class FQN

public @@ -768,11 +782,11 @@

-

generates the output, optionally dumps it to a file, and returns it

+

Generates the output, optionally dumps it to a file, and returns it

public @@ -830,7 +844,7 @@

diff --git a/classes/chillerlan-QRCode-QROptions.html b/classes/chillerlan-QRCode-QROptions.html index 7b62dad1a..c62a980d8 100644 --- a/classes/chillerlan-QRCode-QROptions.html +++ b/classes/chillerlan-QRCode-QROptions.html @@ -182,42 +182,42 @@

 : string|null

-
/path/to/cache.file
+
Optional cache file path `/path/to/cache.file`
$circleRadius  : float
-
specifies the radius of the modules when $drawCircularModules is set to true
+
Specifies the radius of the modules when $drawCircularModules is set to true
$connectPaths  : bool
-
whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.
+
Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.
$cssClass  : string
-
a common css class
+
A common css class
$drawCircularModules  : bool
-
specify whether to draw the modules as filled circles
+
Specify whether to draw the modules as filled circles
$drawLightModules  : bool
-
whether to draw the light (false) modules
+
Whether to draw the light (false) modules
$eccLevel @@ -231,14 +231,14 @@

 : string

-
newline string
+
Newline string
$excludeFromConnect  : array<string|int, mixed>
-
specify which paths/patterns to exclude from connecting if $connectPaths is set to true
+
Specify which paths/patterns to exclude from connecting if $connectPaths is set to true
$fpdfMeasureUnit @@ -252,14 +252,14 @@

 : bool

-
toggle base64 or raw image data (if applicable)
+
Toggle base64 or raw image data (if applicable)
$imageTransparent  : bool
-
toggle transparency
+
Toggle transparency
$imagickFormat @@ -280,49 +280,49 @@

 : array<string|int, mixed>

-
specifies which module types to exclude when $drawCircularModules is set to true
+
Specifies which module types to exclude when $drawCircularModules is set to true
$logoSpaceHeight  : int|null
-
height of the logo space
+
Height of the logo space
$logoSpaceStartX  : int|null
-
optional horizontal start position of the logo space (top left corner)
+
Optional horizontal start position of the logo space (top left corner)
$logoSpaceStartY  : int|null
-
optional vertical start position of the logo space (top left corner)
+
Optional vertical start position of the logo space (top left corner)
$logoSpaceWidth  : int|null
-
width of the logo space
+
Width of the logo space
$markupDark  : string
-
markup substitute for dark (CSS value)
+
Markup substitute for dark (CSS value)
$markupLight  : string
-
markup substitute for light (CSS value)
+
Markup substitute for light (CSS value)
$maskPattern @@ -343,14 +343,14 @@

 : string|null

-
the FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM
+
The FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM
$outputType  : string
-
The output type
+
The built-in output type
$pngCompression @@ -371,21 +371,21 @@

 : bool

-
grayscale the image before reading
+
Grayscale the image before reading
$readerIncreaseContrast  : bool
-
increase the contrast before reading
+
Increase the contrast before reading
$readerUseImagickIfAvailable  : bool
-
use Imagick (if available) when reading QR Codes
+
Use Imagick (if available) when reading QR Codes
$returnResource @@ -399,7 +399,7 @@

 : int

-
pixel size of a QR code module
+
Pixel size of a QR code module
$svgAddXmlHeader @@ -413,14 +413,14 @@

 : string

-
anything between <defs>
+
Anything in the <defs> tag
$svgHeight  : string|null
-
optional "height" attribute with the specified value (note that the value is not checked!)
+
Optional "height" attribute with the specified value (note that the value is not checked!)
$svgOpacity @@ -441,28 +441,28 @@

 : int|null

-
SVG viewBox size. a single integer number which defines width/height of the viewBox attribute.
+
SVG viewBox size. A single integer number which defines width/height of the viewBox attribute.
$svgWidth  : string|null
-
optional "width" attribute with the specified value (note that the value is not checked!)
+
Optional "width" attribute with the specified value (note that the value is not checked!)
$textDark  : string
-
string substitute for dark
+
String substitute for dark
$textLight  : string
-
string substitute for light
+
String substitute for light
$transparencyColor @@ -706,8 +706,8 @@

= null
    -
  • QRGdImage: defaults to "white"
    • -
  • QRImagick: defaults to [255, 255, 255]
    • +
  • QRImagick: defaults to "white"
    • +
  • QRGdImage: defaults to [255, 255, 255]
  • QRFpdf: defaults to blank internally (white page)
@@ -736,7 +736,7 @@

-

/path/to/cache.file

+

Optional cache file path `/path/to/cache.file`

protected @@ -772,7 +772,7 @@

-

specifies the radius of the modules when $drawCircularModules is set to true

+

Specifies the radius of the modules when $drawCircularModules is set to true

protected @@ -806,7 +806,7 @@

-

whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.

+

Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.

protected @@ -854,7 +854,7 @@

-

a common css class

+

A common css class

protected @@ -888,7 +888,7 @@

-

specify whether to draw the modules as filled circles

+

Specify whether to draw the modules as filled circles

protected @@ -949,7 +949,7 @@

-

whether to draw the light (false) modules

+

Whether to draw the light (false) modules

protected @@ -1047,7 +1047,7 @@

-

newline string

+

Newline string

protected @@ -1081,7 +1081,7 @@

-

specify which paths/patterns to exclude from connecting if $connectPaths is set to true

+

Specify which paths/patterns to exclude from connecting if $connectPaths is set to true

protected @@ -1163,7 +1163,7 @@

-

toggle base64 or raw image data (if applicable)

+

Toggle base64 or raw image data (if applicable)

protected @@ -1197,7 +1197,7 @@

-

toggle transparency

+

Toggle transparency

protected @@ -1352,7 +1352,7 @@

-

specifies which module types to exclude when $drawCircularModules is set to true

+

Specifies which module types to exclude when $drawCircularModules is set to true

protected @@ -1386,7 +1386,7 @@

-

height of the logo space

+

Height of the logo space

protected @@ -1422,7 +1422,7 @@

-

optional horizontal start position of the logo space (top left corner)

+

Optional horizontal start position of the logo space (top left corner)

protected @@ -1456,7 +1456,7 @@

-

optional vertical start position of the logo space (top left corner)

+

Optional vertical start position of the logo space (top left corner)

protected @@ -1490,7 +1490,7 @@

-

width of the logo space

+

Width of the logo space

protected @@ -1526,7 +1526,7 @@

-

markup substitute for dark (CSS value)

+

Markup substitute for dark (CSS value)

protected @@ -1560,7 +1560,7 @@

-

markup substitute for light (CSS value)

+

Markup substitute for light (CSS value)

protected @@ -1669,7 +1669,7 @@

-

the FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM

+

The FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM

protected @@ -1703,7 +1703,7 @@

-

The output type

+

The built-in output type

protected @@ -1830,7 +1830,7 @@

-

grayscale the image before reading

+

Grayscale the image before reading

protected @@ -1864,7 +1864,7 @@

-

increase the contrast before reading

+

Increase the contrast before reading

protected @@ -1900,7 +1900,7 @@

use Imagick (if available) when reading QR Codes

+

Use Imagick (if available) when reading QR Codes

protected @@ -1989,7 +1989,7 @@

-

pixel size of a QR code module

+

Pixel size of a QR code module

protected @@ -2059,7 +2059,7 @@

-

anything between <defs>

+

Anything in the <defs> tag

protected @@ -2107,7 +2107,7 @@

-

optional "height" attribute with the specified value (note that the value is not checked!)

+

Optional "height" attribute with the specified value (note that the value is not checked!)

protected @@ -2236,7 +2236,7 @@

-

SVG viewBox size. a single integer number which defines width/height of the viewBox attribute.

+

SVG viewBox size. A single integer number which defines width/height of the viewBox attribute.

protected @@ -2294,7 +2294,7 @@

-

optional "width" attribute with the specified value (note that the value is not checked!)

+

Optional "width" attribute with the specified value (note that the value is not checked!)

protected @@ -2342,7 +2342,7 @@

-

string substitute for dark

+

String substitute for dark

protected @@ -2376,7 +2376,7 @@

-

string substitute for light

+

String substitute for light

protected diff --git a/classes/chillerlan-QRCode-QROptionsTrait.html b/classes/chillerlan-QRCode-QROptionsTrait.html index df014d0c4..e436d05d1 100644 --- a/classes/chillerlan-QRCode-QROptionsTrait.html +++ b/classes/chillerlan-QRCode-QROptionsTrait.html @@ -166,42 +166,42 @@

 : string|null

-
/path/to/cache.file
+
Optional cache file path `/path/to/cache.file`
$circleRadius  : float
-
specifies the radius of the modules when $drawCircularModules is set to true
+
Specifies the radius of the modules when $drawCircularModules is set to true
$connectPaths  : bool
-
whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.
+
Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.
$cssClass  : string
-
a common css class
+
A common css class
$drawCircularModules  : bool
-
specify whether to draw the modules as filled circles
+
Specify whether to draw the modules as filled circles
$drawLightModules  : bool
-
whether to draw the light (false) modules
+
Whether to draw the light (false) modules
$eccLevel @@ -215,14 +215,14 @@

 : string

-
newline string
+
Newline string
$excludeFromConnect  : array<string|int, mixed>
-
specify which paths/patterns to exclude from connecting if $connectPaths is set to true
+
Specify which paths/patterns to exclude from connecting if $connectPaths is set to true
$fpdfMeasureUnit @@ -236,14 +236,14 @@

 : bool

-
toggle base64 or raw image data (if applicable)
+
Toggle base64 or raw image data (if applicable)
$imageTransparent  : bool
-
toggle transparency
+
Toggle transparency
$imagickFormat @@ -264,49 +264,49 @@

 : array<string|int, mixed>

-
specifies which module types to exclude when $drawCircularModules is set to true
+
Specifies which module types to exclude when $drawCircularModules is set to true
$logoSpaceHeight  : int|null
-
height of the logo space
+
Height of the logo space
$logoSpaceStartX  : int|null
-
optional horizontal start position of the logo space (top left corner)
+
Optional horizontal start position of the logo space (top left corner)
$logoSpaceStartY  : int|null
-
optional vertical start position of the logo space (top left corner)
+
Optional vertical start position of the logo space (top left corner)
$logoSpaceWidth  : int|null
-
width of the logo space
+
Width of the logo space
$markupDark  : string
-
markup substitute for dark (CSS value)
+
Markup substitute for dark (CSS value)
$markupLight  : string
-
markup substitute for light (CSS value)
+
Markup substitute for light (CSS value)
$maskPattern @@ -327,14 +327,14 @@

 : string|null

-
the FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM
+
The FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM
$outputType  : string
-
The output type
+
The built-in output type
$pngCompression @@ -355,21 +355,21 @@

 : bool

-
grayscale the image before reading
+
Grayscale the image before reading
$readerIncreaseContrast  : bool
-
increase the contrast before reading
+
Increase the contrast before reading
$readerUseImagickIfAvailable  : bool
-
use Imagick (if available) when reading QR Codes
+
Use Imagick (if available) when reading QR Codes
$returnResource @@ -383,7 +383,7 @@

 : int

-
pixel size of a QR code module
+
Pixel size of a QR code module
$svgAddXmlHeader @@ -397,14 +397,14 @@

 : string

-
anything between <defs>
+
Anything in the <defs> tag
$svgHeight  : string|null
-
optional "height" attribute with the specified value (note that the value is not checked!)
+
Optional "height" attribute with the specified value (note that the value is not checked!)
$svgOpacity @@ -425,28 +425,28 @@

 : int|null

-
SVG viewBox size. a single integer number which defines width/height of the viewBox attribute.
+
SVG viewBox size. A single integer number which defines width/height of the viewBox attribute.
$svgWidth  : string|null
-
optional "width" attribute with the specified value (note that the value is not checked!)
+
Optional "width" attribute with the specified value (note that the value is not checked!)
$textDark  : string
-
string substitute for dark
+
String substitute for dark
$textLight  : string
-
string substitute for light
+
String substitute for light
$transparencyColor @@ -688,8 +688,8 @@

= null
    -
  • QRGdImage: defaults to "white"
    • -
  • QRImagick: defaults to [255, 255, 255]
    • +
  • QRImagick: defaults to "white"
    • +
  • QRGdImage: defaults to [255, 255, 255]
  • QRFpdf: defaults to blank internally (white page)
@@ -718,7 +718,7 @@

-

/path/to/cache.file

+

Optional cache file path `/path/to/cache.file`

protected @@ -754,7 +754,7 @@

-

specifies the radius of the modules when $drawCircularModules is set to true

+

Specifies the radius of the modules when $drawCircularModules is set to true

protected @@ -788,7 +788,7 @@

-

whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.

+

Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.

protected @@ -836,7 +836,7 @@

-

a common css class

+

A common css class

protected @@ -870,7 +870,7 @@

-

specify whether to draw the modules as filled circles

+

Specify whether to draw the modules as filled circles

protected @@ -931,7 +931,7 @@

-

whether to draw the light (false) modules

+

Whether to draw the light (false) modules

protected @@ -1029,7 +1029,7 @@

-

newline string

+

Newline string

protected @@ -1063,7 +1063,7 @@

-

specify which paths/patterns to exclude from connecting if $connectPaths is set to true

+

Specify which paths/patterns to exclude from connecting if $connectPaths is set to true

protected @@ -1145,7 +1145,7 @@

-

toggle base64 or raw image data (if applicable)

+

Toggle base64 or raw image data (if applicable)

protected @@ -1179,7 +1179,7 @@

-

toggle transparency

+

Toggle transparency

protected @@ -1334,7 +1334,7 @@

-

specifies which module types to exclude when $drawCircularModules is set to true

+

Specifies which module types to exclude when $drawCircularModules is set to true

protected @@ -1368,7 +1368,7 @@

-

height of the logo space

+

Height of the logo space

protected @@ -1404,7 +1404,7 @@

-

optional horizontal start position of the logo space (top left corner)

+

Optional horizontal start position of the logo space (top left corner)

protected @@ -1438,7 +1438,7 @@

-

optional vertical start position of the logo space (top left corner)

+

Optional vertical start position of the logo space (top left corner)

protected @@ -1472,7 +1472,7 @@

-

width of the logo space

+

Width of the logo space

protected @@ -1508,7 +1508,7 @@

-

markup substitute for dark (CSS value)

+

Markup substitute for dark (CSS value)

protected @@ -1542,7 +1542,7 @@

-

markup substitute for light (CSS value)

+

Markup substitute for light (CSS value)

protected @@ -1651,7 +1651,7 @@

-

the FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM

+

The FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM

protected @@ -1685,7 +1685,7 @@

-

The output type

+

The built-in output type

protected @@ -1812,7 +1812,7 @@

-

grayscale the image before reading

+

Grayscale the image before reading

protected @@ -1846,7 +1846,7 @@

-

increase the contrast before reading

+

Increase the contrast before reading

protected @@ -1882,7 +1882,7 @@

use Imagick (if available) when reading QR Codes

+

Use Imagick (if available) when reading QR Codes

protected @@ -1971,7 +1971,7 @@

-

pixel size of a QR code module

+

Pixel size of a QR code module

protected @@ -2041,7 +2041,7 @@

-

anything between <defs>

+

Anything in the <defs> tag

protected @@ -2089,7 +2089,7 @@

-

optional "height" attribute with the specified value (note that the value is not checked!)

+

Optional "height" attribute with the specified value (note that the value is not checked!)

protected @@ -2218,7 +2218,7 @@

-

SVG viewBox size. a single integer number which defines width/height of the viewBox attribute.

+

SVG viewBox size. A single integer number which defines width/height of the viewBox attribute.

protected @@ -2276,7 +2276,7 @@

-

optional "width" attribute with the specified value (note that the value is not checked!)

+

Optional "width" attribute with the specified value (note that the value is not checked!)

protected @@ -2324,7 +2324,7 @@

-

string substitute for dark

+

String substitute for dark

protected @@ -2358,7 +2358,7 @@

-

string substitute for light

+

String substitute for light

protected diff --git a/classes/chillerlan-QRCodeTest-Output-QRImagickTest.html b/classes/chillerlan-QRCodeTest-Output-QRImagickTest.html index ca5ee01a9..67149959e 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRImagickTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRImagickTest.html @@ -552,7 +552,7 @@

@@ -651,7 +651,7 @@

diff --git a/js/searchIndex.js b/js/searchIndex.js index 20f0c7e0c..bceed68e7 100644 --- a/js/searchIndex.js +++ b/js/searchIndex.js @@ -1273,7 +1273,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AcheckTypeIn\u0028\u0029", "name": "checkTypeIn", - "summary": "checks\u0020whether\u0020the\u0020module\u0020at\u0020\u0028\u0024x,\u0020\u0024y\u0029\u0020is\u0020in\u0020the\u0020given\u0020array\u0020of\u0020\u0024M_TYPES,\nreturns\u0020true\u0020if\u0020a\u0020match\u0020is\u0020found,\u0020otherwise\u0020false.", + "summary": "Checks\u0020whether\u0020the\u0020module\u0020at\u0020\u0028\u0024x,\u0020\u0024y\u0029\u0020is\u0020in\u0020the\u0020given\u0020array\u0020of\u0020\u0024M_TYPES,\nreturns\u0020true\u0020if\u0020a\u0020match\u0020is\u0020found,\u0020otherwise\u0020false.", "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypeIn" }, { "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003Acheck\u0028\u0029", @@ -1330,6 +1330,11 @@ Search.appendIndex( "name": "rotate90", "summary": "Rotates\u0020the\u0020matrix\u0020by\u002090\u0020degrees\u0020clock\u0020wise", "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#method_rotate90" + }, { + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003Ainvert\u0028\u0029", + "name": "invert", + "summary": "Inverts\u0020the\u0020values\u0020of\u0020the\u0020whole\u0020matrix", + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#method_invert" }, { "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AsetLogoSpace\u0028\u0029", "name": "setLogoSpace", @@ -1356,30 +1361,35 @@ Search.appendIndex( "summary": "", "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL" }, { - "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_DARKMODULE", - "name": "M_DARKMODULE", + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_LOGO", + "name": "M_LOGO", "summary": "", - "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE" + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO" + }, { + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_LOGO_DARK", + "name": "M_LOGO_DARK", + "summary": "", + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO_DARK" + }, { + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_TEST", + "name": "M_TEST", + "summary": "", + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST" + }, { + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_TEST_DARK", + "name": "M_TEST_DARK", + "summary": "", + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST_DARK" }, { "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_DATA", "name": "M_DATA", "summary": "", "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA" - }, { - "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_DATA_DARK", - "name": "M_DATA_DARK", - "summary": "", - "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK" }, { "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_FINDER", "name": "M_FINDER", "summary": "", "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER" - }, { - "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_FINDER_DARK", - "name": "M_FINDER_DARK", - "summary": "", - "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK" }, { "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_SEPARATOR", "name": "M_SEPARATOR", @@ -1390,76 +1400,86 @@ Search.appendIndex( "name": "M_ALIGNMENT", "summary": "", "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT" - }, { - "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_ALIGNMENT_DARK", - "name": "M_ALIGNMENT_DARK", - "summary": "", - "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK" }, { "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_TIMING", "name": "M_TIMING", "summary": "", "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING" - }, { - "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_TIMING_DARK", - "name": "M_TIMING_DARK", - "summary": "", - "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK" }, { "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_FORMAT", "name": "M_FORMAT", "summary": "", "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT" - }, { - "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_FORMAT_DARK", - "name": "M_FORMAT_DARK", - "summary": "", - "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK" }, { "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_VERSION", "name": "M_VERSION", "summary": "", "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION" - }, { - "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_VERSION_DARK", - "name": "M_VERSION_DARK", - "summary": "", - "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK" }, { "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_QUIETZONE", "name": "M_QUIETZONE", "summary": "", "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE" }, { - "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_QUIETZONE_DARK", - "name": "M_QUIETZONE_DARK", + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_DARKMODULE", + "name": "M_DARKMODULE", "summary": "", - "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE_DARK" + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE" }, { - "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_LOGO", - "name": "M_LOGO", + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_DATA_DARK", + "name": "M_DATA_DARK", "summary": "", - "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO" + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK" }, { - "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_LOGO_DARK", - "name": "M_LOGO_DARK", + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_FINDER_DARK", + "name": "M_FINDER_DARK", "summary": "", - "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO_DARK" + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK" + }, { + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_ALIGNMENT_DARK", + "name": "M_ALIGNMENT_DARK", + "summary": "", + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK" + }, { + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_TIMING_DARK", + "name": "M_TIMING_DARK", + "summary": "", + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK" + }, { + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_FORMAT_DARK", + "name": "M_FORMAT_DARK", + "summary": "", + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK" + }, { + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_VERSION_DARK", + "name": "M_VERSION_DARK", + "summary": "", + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK" }, { "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_FINDER_DOT", "name": "M_FINDER_DOT", "summary": "", "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT" }, { - "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_TEST", - "name": "M_TEST", + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_DARKMODULE_LIGHT", + "name": "M_DARKMODULE_LIGHT", "summary": "", - "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST" + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE_LIGHT" }, { - "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_TEST_DARK", - "name": "M_TEST_DARK", + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_FINDER_DOT_LIGHT", + "name": "M_FINDER_DOT_LIGHT", "summary": "", - "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST_DARK" + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT_LIGHT" + }, { + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_SEPARATOR_DARK", + "name": "M_SEPARATOR_DARK", + "summary": "", + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR_DARK" + }, { + "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003AM_QUIETZONE_DARK", + "name": "M_QUIETZONE_DARK", + "summary": "", + "url": "classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE_DARK" }, { "fqsen": "\\chillerlan\\QRCode\\Data\\QRMatrix\u003A\u003Aneighbours", "name": "neighbours", @@ -2205,6 +2225,11 @@ Search.appendIndex( "name": "sampleGrid", "summary": "Samples\u0020an\u0020image\u0020for\u0020a\u0020rectangular\u0020matrix\u0020of\u0020bits\u0020of\u0020the\u0020given\u0020dimension.\u0020The\u0020sampling\ntransformation\u0020is\u0020determined\u0020by\u0020the\u0020coordinates\u0020of\u00204\u0020points,\u0020in\u0020the\u0020original\u0020and\u0020transformed\nimage\u0020space.", "url": "classes/chillerlan-QRCode-Detector-GridSampler.html#method_sampleGrid" + }, { + "fqsen": "\\chillerlan\\QRCode\\Detector\\GridSampler\u003A\u003A\u0024points", + "name": "points", + "summary": "", + "url": "classes/chillerlan-QRCode-Detector-GridSampler.html#property_points" }, { "fqsen": "\\chillerlan\\QRCode\\Detector\\PerspectiveTransform", "name": "PerspectiveTransform", @@ -2728,7 +2753,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QROutputInterface\u003A\u003Adump\u0028\u0029", "name": "dump", - "summary": "generates\u0020the\u0020output,\u0020optionally\u0020dumps\u0020it\u0020to\u0020a\u0020file,\u0020and\u0020returns\u0020it", + "summary": "Generates\u0020the\u0020output,\u0020optionally\u0020dumps\u0020it\u0020to\u0020a\u0020file,\u0020and\u0020returns\u0020it", "url": "classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump" }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QROutputInterface\u003A\u003AMARKUP_HTML", @@ -2788,17 +2813,17 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QROutputInterface\u003A\u003AMODES", "name": "MODES", - "summary": "Map\u0020of\u0020built\u002Din\u0020output\u0020modes\u0020\u003D\u003E\u0020modules", + "summary": "Map\u0020of\u0020built\u002Din\u0020output\u0020modes\u0020\u003D\u003E\u0020class\u0020FQN", "url": "classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES" }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QROutputInterface\u003A\u003ADEFAULT_MODULE_VALUES", "name": "DEFAULT_MODULE_VALUES", - "summary": "", + "summary": "Map\u0020of\u0020module\u0020type\u0020\u003D\u003E\u0020default\u0020value", "url": "classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_DEFAULT_MODULE_VALUES" }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QROutputInterface\u003A\u003ALAYERNAMES", "name": "LAYERNAMES", - "summary": "", + "summary": "Map\u0020of\u0020module\u0020type\u0020\u003D\u003E\u0020readable\u0020name\u0020\u0028for\u0020CSS\u0020etc.\u0029", "url": "classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_LAYERNAMES" }, { "fqsen": "\\chillerlan\\QRCode\\Output\\QRString", @@ -3183,12 +3208,12 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024outputType", "name": "outputType", - "summary": "The\u0020output\u0020type", + "summary": "The\u0020built\u002Din\u0020output\u0020type", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024outputInterface", "name": "outputInterface", - "summary": "the\u0020FQCN\u0020of\u0020the\u0020custom\u0020QROutputInterface\u0020if\u0020\u0024outputType\u0020is\u0020set\u0020to\u0020QRCode\u003A\u003AOUTPUT_CUSTOM", + "summary": "The\u0020FQCN\u0020of\u0020the\u0020custom\u0020QROutputInterface\u0020if\u0020\u0024outputType\u0020is\u0020set\u0020to\u0020QRCode\u003A\u003AOUTPUT_CUSTOM", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024returnResource", @@ -3198,17 +3223,17 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024cachefile", "name": "cachefile", - "summary": "\/path\/to\/cache.file", + "summary": "Optional\u0020cache\u0020file\u0020path\u0020\u0060\/path\/to\/cache.file\u0060", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024imageBase64", "name": "imageBase64", - "summary": "toggle\u0020base64\u0020or\u0020raw\u0020image\u0020data\u0020\u0028if\u0020applicable\u0029", + "summary": "Toggle\u0020base64\u0020or\u0020raw\u0020image\u0020data\u0020\u0028if\u0020applicable\u0029", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024eol", "name": "eol", - "summary": "newline\u0020string", + "summary": "Newline\u0020string", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_eol" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024bgColor", @@ -3218,32 +3243,32 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024drawLightModules", "name": "drawLightModules", - "summary": "whether\u0020to\u0020draw\u0020the\u0020light\u0020\u0028false\u0029\u0020modules", + "summary": "Whether\u0020to\u0020draw\u0020the\u0020light\u0020\u0028false\u0029\u0020modules", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024drawCircularModules", "name": "drawCircularModules", - "summary": "specify\u0020whether\u0020to\u0020draw\u0020the\u0020modules\u0020as\u0020filled\u0020circles", + "summary": "Specify\u0020whether\u0020to\u0020draw\u0020the\u0020modules\u0020as\u0020filled\u0020circles", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024circleRadius", "name": "circleRadius", - "summary": "specifies\u0020the\u0020radius\u0020of\u0020the\u0020modules\u0020when\u0020\u0024drawCircularModules\u0020is\u0020set\u0020to\u0020true", + "summary": "Specifies\u0020the\u0020radius\u0020of\u0020the\u0020modules\u0020when\u0020\u0024drawCircularModules\u0020is\u0020set\u0020to\u0020true", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024keepAsSquare", "name": "keepAsSquare", - "summary": "specifies\u0020which\u0020module\u0020types\u0020to\u0020exclude\u0020when\u0020\u0024drawCircularModules\u0020is\u0020set\u0020to\u0020true", + "summary": "Specifies\u0020which\u0020module\u0020types\u0020to\u0020exclude\u0020when\u0020\u0024drawCircularModules\u0020is\u0020set\u0020to\u0020true", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024connectPaths", "name": "connectPaths", - "summary": "whether\u0020to\u0020connect\u0020the\u0020paths\u0020for\u0020the\u0020several\u0020module\u0020types\u0020to\u0020avoid\u0020weird\u0020glitches\u0020when\u0020using\u0020gradients\u0020etc.", + "summary": "Whether\u0020to\u0020connect\u0020the\u0020paths\u0020for\u0020the\u0020several\u0020module\u0020types\u0020to\u0020avoid\u0020weird\u0020glitches\u0020when\u0020using\u0020gradients\u0020etc.", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024excludeFromConnect", "name": "excludeFromConnect", - "summary": "specify\u0020which\u0020paths\/patterns\u0020to\u0020exclude\u0020from\u0020connecting\u0020if\u0020\u0024connectPaths\u0020is\u0020set\u0020to\u0020true", + "summary": "Specify\u0020which\u0020paths\/patterns\u0020to\u0020exclude\u0020from\u0020connecting\u0020if\u0020\u0024connectPaths\u0020is\u0020set\u0020to\u0020true", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024moduleValues", @@ -3258,32 +3283,32 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024logoSpaceWidth", "name": "logoSpaceWidth", - "summary": "width\u0020of\u0020the\u0020logo\u0020space", + "summary": "Width\u0020of\u0020the\u0020logo\u0020space", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024logoSpaceHeight", "name": "logoSpaceHeight", - "summary": "height\u0020of\u0020the\u0020logo\u0020space", + "summary": "Height\u0020of\u0020the\u0020logo\u0020space", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024logoSpaceStartX", "name": "logoSpaceStartX", - "summary": "optional\u0020horizontal\u0020start\u0020position\u0020of\u0020the\u0020logo\u0020space\u0020\u0028top\u0020left\u0020corner\u0029", + "summary": "Optional\u0020horizontal\u0020start\u0020position\u0020of\u0020the\u0020logo\u0020space\u0020\u0028top\u0020left\u0020corner\u0029", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024logoSpaceStartY", "name": "logoSpaceStartY", - "summary": "optional\u0020vertical\u0020start\u0020position\u0020of\u0020the\u0020logo\u0020space\u0020\u0028top\u0020left\u0020corner\u0029", + "summary": "Optional\u0020vertical\u0020start\u0020position\u0020of\u0020the\u0020logo\u0020space\u0020\u0028top\u0020left\u0020corner\u0029", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024scale", "name": "scale", - "summary": "pixel\u0020size\u0020of\u0020a\u0020QR\u0020code\u0020module", + "summary": "Pixel\u0020size\u0020of\u0020a\u0020QR\u0020code\u0020module", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_scale" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024imageTransparent", "name": "imageTransparent", - "summary": "toggle\u0020transparency", + "summary": "Toggle\u0020transparency", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024transparencyColor", @@ -3308,17 +3333,17 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024cssClass", "name": "cssClass", - "summary": "a\u0020common\u0020css\u0020class", + "summary": "A\u0020common\u0020css\u0020class", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024markupDark", "name": "markupDark", - "summary": "markup\u0020substitute\u0020for\u0020dark\u0020\u0028CSS\u0020value\u0029", + "summary": "Markup\u0020substitute\u0020for\u0020dark\u0020\u0028CSS\u0020value\u0029", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024markupLight", "name": "markupLight", - "summary": "markup\u0020substitute\u0020for\u0020light\u0020\u0028CSS\u0020value\u0029", + "summary": "Markup\u0020substitute\u0020for\u0020light\u0020\u0028CSS\u0020value\u0029", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024svgAddXmlHeader", @@ -3333,12 +3358,12 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024svgDefs", "name": "svgDefs", - "summary": "anything\u0020between\u0020\u003Cdefs\u003E", + "summary": "Anything\u0020in\u0020the\u0020\u003Cdefs\u003E\u0020tag", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024svgViewBoxSize", "name": "svgViewBoxSize", - "summary": "SVG\u0020viewBox\u0020size.\u0020a\u0020single\u0020integer\u0020number\u0020which\u0020defines\u0020width\/height\u0020of\u0020the\u0020viewBox\u0020attribute.", + "summary": "SVG\u0020viewBox\u0020size.\u0020A\u0020single\u0020integer\u0020number\u0020which\u0020defines\u0020width\/height\u0020of\u0020the\u0020viewBox\u0020attribute.", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024svgPreserveAspectRatio", @@ -3348,22 +3373,22 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024svgWidth", "name": "svgWidth", - "summary": "optional\u0020\u0022width\u0022\u0020attribute\u0020with\u0020the\u0020specified\u0020value\u0020\u0028note\u0020that\u0020the\u0020value\u0020is\u0020not\u0020checked\u0021\u0029", + "summary": "Optional\u0020\u0022width\u0022\u0020attribute\u0020with\u0020the\u0020specified\u0020value\u0020\u0028note\u0020that\u0020the\u0020value\u0020is\u0020not\u0020checked\u0021\u0029", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024svgHeight", "name": "svgHeight", - "summary": "optional\u0020\u0022height\u0022\u0020attribute\u0020with\u0020the\u0020specified\u0020value\u0020\u0028note\u0020that\u0020the\u0020value\u0020is\u0020not\u0020checked\u0021\u0029", + "summary": "Optional\u0020\u0022height\u0022\u0020attribute\u0020with\u0020the\u0020specified\u0020value\u0020\u0028note\u0020that\u0020the\u0020value\u0020is\u0020not\u0020checked\u0021\u0029", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024textDark", "name": "textDark", - "summary": "string\u0020substitute\u0020for\u0020dark", + "summary": "String\u0020substitute\u0020for\u0020dark", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024textLight", "name": "textLight", - "summary": "string\u0020substitute\u0020for\u0020light", + "summary": "String\u0020substitute\u0020for\u0020light", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024fpdfMeasureUnit", @@ -3373,17 +3398,17 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024readerUseImagickIfAvailable", "name": "readerUseImagickIfAvailable", - "summary": "use\u0020Imagick\u0020\u0028if\u0020available\u0029\u0020when\u0020reading\u0020QR\u0020Codes", + "summary": "Use\u0020Imagick\u0020\u0028if\u0020available\u0029\u0020when\u0020reading\u0020QR\u0020Codes", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024readerGrayscale", "name": "readerGrayscale", - "summary": "grayscale\u0020the\u0020image\u0020before\u0020reading", + "summary": "Grayscale\u0020the\u0020image\u0020before\u0020reading", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_readerGrayscale" }, { "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024readerIncreaseContrast", "name": "readerIncreaseContrast", - "summary": "increase\u0020the\u0020contrast\u0020before\u0020reading", + "summary": "Increase\u0020the\u0020contrast\u0020before\u0020reading", "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast" }, { "fqsen": "\\chillerlan\\QRCodeTest\\Common\\BitBufferTest", diff --git a/reports/deprecated.html b/reports/deprecated.html index 249e39de2..e97058e04 100644 --- a/reports/deprecated.html +++ b/reports/deprecated.html @@ -137,7 +137,7 @@

QRMatrix.php

Reason - 247 + 272 QRMatrix::size()

use QRMatrix::getSize() instead