diff --git a/classes/Output-QRGdImageAVIFTest.html b/classes/Output-QRGdImageAVIFTest.html index acd9b02c1..463df3b9b 100644 --- a/classes/Output-QRGdImageAVIFTest.html +++ b/classes/Output-QRGdImageAVIFTest.html @@ -166,6 +166,7 @@ +

Table of Contents @@ -185,7 +186,7 @@

- buildDir + buildDir  = 'output-test'
@@ -200,19 +201,19 @@
- $matrix + $matrix  : QRMatrix
- $options + $options  : SettingsContainerInterface|QROptions
- $outputInterface + $outputInterface  : QROutputInterface
@@ -226,93 +227,93 @@
- moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
- testBase64MimeType() + testBase64MimeType()  : void
- testOutputGetResource() + testOutputGetResource()  : void
- testRenderToCacheFile() + testRenderToCacheFile()  : void
coverage of the built-in output modules
- testSaveException() + testSaveException()  : void
Tests if an exception is thrown when trying to write a cache file to an invalid destination
- testSetModuleValues() + testSetModuleValues()  : void
covers the module values settings
- testValidateModuleValues() + testValidateModuleValues()  : void
- createBuildDir() + createBuildDir()  : void
attempts to create the build dir
- getBuildDir() + getBuildDir()  : string
returns the full (real) path to the given build path
- getBuildFileContent() + getBuildFileContent()  : string
returns the contents of the given build file
- getBuildFilePath() + getBuildFilePath()  : string
returns the full (real) path to the given build file
- getBuildPath() + getBuildPath()  : string
returns the full raw path to the build dir
- getOutputInterface() + getOutputInterface()  : QROutputInterface
- setUp() + setUp()  : void
@@ -344,6 +345,7 @@ + protected mixed @@ -390,6 +392,7 @@ + protected QRMatrix @@ -425,6 +428,7 @@ + protected SettingsContainerInterface|QROptions @@ -460,6 +464,7 @@ + protected QROutputInterface @@ -509,6 +514,7 @@ + @@ -546,6 +552,7 @@ + @@ -579,6 +586,7 @@ + @@ -613,6 +621,7 @@ + @@ -647,6 +656,7 @@ + @@ -681,6 +691,7 @@ +
Tags @@ -726,6 +737,7 @@
+
Parameters
@@ -791,6 +803,7 @@
+
Parameters
@@ -850,6 +863,7 @@
+
Parameters
@@ -913,6 +927,7 @@
+
Parameters
@@ -961,6 +976,7 @@
+
Parameters
@@ -1024,6 +1040,7 @@
+
Parameters
@@ -1071,6 +1088,7 @@
+
Parameters
@@ -1128,6 +1146,7 @@ +
Tags @@ -1260,36 +1279,36 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Common-BitBuffer.html b/classes/chillerlan-QRCode-Common-BitBuffer.html index 7a0120ee8..516fe1fec 100644 --- a/classes/chillerlan-QRCode-Common-BitBuffer.html +++ b/classes/chillerlan-QRCode-Common-BitBuffer.html @@ -165,6 +165,7 @@ +

    Table of Contents @@ -186,28 +187,28 @@

    - $bitsRead + $bitsRead  : int
    Read count (bits)
    - $buffer + $buffer  : array<string|int, int>
    The buffer content
    - $bytesRead + $bytesRead  : int
    Read count (bytes)
    - $length + $length  : int
    @@ -222,61 +223,61 @@
    - __construct() + __construct()  : mixed
    BitBuffer constructor.
    - available() + available()  : int
    - clear() + clear()  : self
    Clears the buffer and resets the stats
    - getBuffer() + getBuffer()  : array<string|int, mixed>
    returns the buffer content
    - getLength() + getLength()  : int
    returns the current buffer length
    - put() + put()  : self
    appends a sequence of bits
    - putBit() + putBit()  : self
    appends a single bit
    - read() + read()  : int
    - rewind() + rewind()  : self
    @@ -318,6 +319,7 @@

    Read count (bits)

    + private int @@ -354,6 +356,7 @@

    The buffer content

    + private array<string|int, int> @@ -390,6 +393,7 @@

    Read count (bytes)

    + private int @@ -426,6 +430,7 @@

    Length of the content (bits)

    + private int @@ -474,6 +479,7 @@
    +
    Parameters
    @@ -519,6 +525,7 @@ + @@ -561,6 +568,7 @@ + @@ -596,6 +604,7 @@
    +

    to debug: array_map(fn($v) => sprintf('%08b', $v), $bitBuffer->getBuffer())

    @@ -639,6 +648,7 @@ + @@ -675,6 +685,7 @@
    +
    Parameters
    @@ -730,6 +741,7 @@
    +
    Parameters
    @@ -777,6 +789,7 @@
    +
    Parameters
    @@ -859,6 +872,7 @@ + @@ -981,25 +995,25 @@
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Common-ECICharset.html b/classes/chillerlan-QRCode-Common-ECICharset.html index 6bbb8be98..ae49eb9ff 100644 --- a/classes/chillerlan-QRCode-Common-ECICharset.html +++ b/classes/chillerlan-QRCode-Common-ECICharset.html @@ -165,6 +165,7 @@ +

    Table of Contents @@ -184,151 +185,151 @@

    - BIG5 + BIG5  = 28
    - CP437 + CP437  = 0
    - CP437_WO_GLI + CP437_WO_GLI  = 2
    - EUC_KR + EUC_KR  = 30
    - GB18030 + GB18030  = 29
    - ISO_IEC_10646_UCS_2 + ISO_IEC_10646_UCS_2  = 25
    - ISO_IEC_10646_UTF_8 + ISO_IEC_10646_UTF_8  = 26
    - ISO_IEC_646_1991 + ISO_IEC_646_1991  = 27
    - ISO_IEC_8859_1 + ISO_IEC_8859_1  = 3
    - ISO_IEC_8859_10 + ISO_IEC_8859_10  = 12
    - ISO_IEC_8859_11 + ISO_IEC_8859_11  = 13
    - ISO_IEC_8859_13 + ISO_IEC_8859_13  = 15
    - ISO_IEC_8859_14 + ISO_IEC_8859_14  = 16
    - ISO_IEC_8859_15 + ISO_IEC_8859_15  = 17
    - ISO_IEC_8859_16 + ISO_IEC_8859_16  = 18
    - ISO_IEC_8859_1_GLI + ISO_IEC_8859_1_GLI  = 1
    - ISO_IEC_8859_2 + ISO_IEC_8859_2  = 4
    - ISO_IEC_8859_3 + ISO_IEC_8859_3  = 5
    - ISO_IEC_8859_4 + ISO_IEC_8859_4  = 6
    - ISO_IEC_8859_5 + ISO_IEC_8859_5  = 7
    - ISO_IEC_8859_6 + ISO_IEC_8859_6  = 8
    - ISO_IEC_8859_7 + ISO_IEC_8859_7  = 9
    - ISO_IEC_8859_8 + ISO_IEC_8859_8  = 10
    - ISO_IEC_8859_9 + ISO_IEC_8859_9  = 11
    - MB_ENCODINGS + MB_ENCODINGS  = [ self::CP437 => null, @@ -367,31 +368,31 @@
    map of charset id -> name
    - SHIFT_JIS + SHIFT_JIS  = 20
    - WINDOWS_1250_LATIN_2 + WINDOWS_1250_LATIN_2  = 21
    - WINDOWS_1251_CYRILLIC + WINDOWS_1251_CYRILLIC  = 22
    - WINDOWS_1252_LATIN_1 + WINDOWS_1252_LATIN_1  = 23
    - WINDOWS_1256_ARABIC + WINDOWS_1256_ARABIC  = 24
    @@ -406,7 +407,7 @@
    - $charsetID + $charsetID  : int
    @@ -421,20 +422,20 @@
    - __construct() + __construct()  : mixed
    - getID() + getID()  : int
    Returns the current character set ID
    - getName() + getName()  : string|null
    @@ -466,6 +467,7 @@ + public mixed @@ -496,6 +498,7 @@ + public mixed @@ -526,6 +529,7 @@ + public mixed @@ -556,6 +560,7 @@ + public mixed @@ -586,6 +591,7 @@ + public mixed @@ -616,6 +622,7 @@ + public mixed @@ -646,6 +653,7 @@ + public mixed @@ -676,6 +684,7 @@ + public mixed @@ -706,6 +715,7 @@ + public mixed @@ -736,6 +746,7 @@ + public mixed @@ -766,6 +777,7 @@ + public mixed @@ -796,6 +808,7 @@ + public mixed @@ -826,6 +839,7 @@ + public mixed @@ -856,6 +870,7 @@ + public mixed @@ -886,6 +901,7 @@ + public mixed @@ -916,6 +932,7 @@ + public mixed @@ -946,6 +963,7 @@ + public mixed @@ -976,6 +994,7 @@ + public mixed @@ -1006,6 +1025,7 @@ + public mixed @@ -1036,6 +1056,7 @@ + public mixed @@ -1066,6 +1087,7 @@ + public mixed @@ -1096,6 +1118,7 @@ + public mixed @@ -1126,6 +1149,7 @@ + public mixed @@ -1156,6 +1180,7 @@ + public mixed @@ -1187,6 +1212,7 @@

    map of charset id -> name

    + public mixed @@ -1264,6 +1290,7 @@ + public mixed @@ -1294,6 +1321,7 @@ + public mixed @@ -1324,6 +1352,7 @@ + public mixed @@ -1354,6 +1383,7 @@ + public mixed @@ -1384,6 +1414,7 @@ + public mixed @@ -1431,6 +1462,7 @@

    The current ECI character set ID

    + private int @@ -1478,6 +1510,7 @@
    +
    Parameters
    @@ -1539,6 +1572,7 @@ + @@ -1577,6 +1611,7 @@ +
    Tags @@ -1722,52 +1757,52 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Common-EccLevel.html b/classes/chillerlan-QRCode-Common-EccLevel.html index ae647cb11..a97ad0518 100644 --- a/classes/chillerlan-QRCode-Common-EccLevel.html +++ b/classes/chillerlan-QRCode-Common-EccLevel.html @@ -165,6 +165,7 @@ +

    Table of Contents @@ -184,31 +185,31 @@

    - H + H  = 0b10
    - L + L  = 0b1
    - M + M  = 0b0
    - Q + Q  = 0b11
    - FORMAT_PATTERN + FORMAT_PATTERN  = [[ // L @@ -255,7 +256,7 @@
    ISO/IEC 18004:2000 Section 8.9 - Format Information
    - MAX_BITS + MAX_BITS  = [ // [ L, M, Q, H] // v => modules @@ -354,7 +355,7 @@
    - $eccLevel + $eccLevel  : int
    @@ -369,48 +370,48 @@
    - __construct() + __construct()  : mixed
    - __toString() + __toString()  : string
    returns the string representation of the current ECC level
    - getformatPattern() + getformatPattern()  : int
    returns the format pattern for the given $eccLevel and $maskPattern
    - getLevel() + getLevel()  : int
    returns the current ECC level
    - getMaxBits() + getMaxBits()  : array<string|int, int>
    returns an array with the max bit lengths for version 1-40 and the current ECC level
    - getMaxBitsForVersion() + getMaxBitsForVersion()  : int
    Returns the maximum bit length for the given version and current ECC level
    - getOrdinal() + getOrdinal()  : int
    @@ -442,6 +443,7 @@ + public int @@ -472,6 +474,7 @@ + public int @@ -502,6 +505,7 @@ + public int @@ -532,6 +536,7 @@ + public int @@ -563,6 +568,7 @@

    ISO/IEC 18004:2000 Section 8.9 - Format Information

    + private array<string|int, array<string|int, int>> @@ -636,6 +642,7 @@

    ISO/IEC 18004:2000 Tables 7-11 - Number of symbol characters and input data capacity for versions 1 to 40

    + private array<string|int, array<string|int, int>> @@ -766,6 +773,7 @@

    The current ECC level value

    + private int @@ -818,6 +826,7 @@ H: 0b10

    +
    Parameters
    @@ -881,6 +890,7 @@ H: 0b10

    + @@ -917,6 +927,7 @@ H: 0b10

    +
    Parameters
    @@ -967,6 +978,7 @@ H: 0b10

    + @@ -1005,6 +1017,7 @@ H: 0b10

    + @@ -1041,6 +1054,7 @@ H: 0b10

    +
    Parameters
    @@ -1088,6 +1102,7 @@ H: 0b10

    +

    references to the keys of the following tables:

    @@ -1246,32 +1261,32 @@ H: 0b10

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Common-GDLuminanceSource.html b/classes/chillerlan-QRCode-Common-GDLuminanceSource.html index 98f806c88..07b5ab12a 100644 --- a/classes/chillerlan-QRCode-Common-GDLuminanceSource.html +++ b/classes/chillerlan-QRCode-Common-GDLuminanceSource.html @@ -169,6 +169,7 @@ It does not support rotation.

    +

    Table of Contents @@ -190,31 +191,31 @@ It does not support rotation.

    - $height + $height  : int
    - $luminances + $luminances  : array<string|int, mixed>
    - $options + $options  : SettingsContainerInterface|QROptions
    - $width + $width  : int
    - $gdImage + $gdImage  : GdImage
    @@ -228,34 +229,34 @@ It does not support rotation.

    - __construct() + __construct()  : mixed
    GDLuminanceSource constructor.
    - fromBlob() + fromBlob()  : static
    Creates a LuminanceSource instance from the given data blob
    - fromFile() + fromFile()  : static
    Creates a LuminanceSource instance from the given file
    - getHeight() + getHeight()  : int
    - getLuminances() + getLuminances()  : array<string|int, mixed>
    @@ -263,7 +264,7 @@ It does not support rotation.

    `int luminance = array[y * width + x] & 0xff`
    - getRow() + getRow()  : array<string|int, mixed>
    @@ -274,25 +275,25 @@ to only fetch this row rather than the whole image, since no 2D Readers may be i getLuminances() may never be called.
    - getWidth() + getWidth()  : int
    - checkFile() + checkFile()  : string
    - setLuminancePixel() + setLuminancePixel()  : void
    - setLuminancePixels() + setLuminancePixels()  : void
    @@ -332,6 +333,7 @@ getLuminances() may never be called. + protected int @@ -367,6 +369,7 @@ getLuminances() may never be called. + protected array<string|int, mixed> @@ -402,6 +405,7 @@ getLuminances() may never be called. + protected SettingsContainerInterface|QROptions @@ -437,6 +441,7 @@ getLuminances() may never be called. + protected int @@ -472,6 +477,7 @@ getLuminances() may never be called. + private GdImage @@ -520,6 +526,7 @@ getLuminances() may never be called.
    +
    Parameters
    @@ -586,6 +593,7 @@ getLuminances() may never be called.
    +
    Parameters
    @@ -655,6 +663,7 @@ getLuminances() may never be called.
    +
    Parameters
    @@ -725,6 +734,7 @@ getLuminances() may never be called. +
    Tags @@ -782,6 +792,7 @@ getLuminances() may never be called. +
    Tags @@ -842,6 +853,7 @@ getLuminances() may never be called.

    +
    Parameters
    @@ -911,6 +923,7 @@ getLuminances() may never be called.

    +
    Tags @@ -964,6 +977,7 @@ getLuminances() may never be called.

    +
    Parameters
    @@ -1026,6 +1040,7 @@ getLuminances() may never be called.

    +
    Parameters
    @@ -1085,6 +1100,7 @@ getLuminances() may never be called.

    + @@ -1203,27 +1219,27 @@ getLuminances() may never be called.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Common-GF256.html b/classes/chillerlan-QRCode-Common-GF256.html index 3666435ec..0460ae7c3 100644 --- a/classes/chillerlan-QRCode-Common-GF256.html +++ b/classes/chillerlan-QRCode-Common-GF256.html @@ -159,6 +159,7 @@

    This class contains utility methods for performing mathematical operations over the Galois Fields. Operations use a given primitive polynomial in calculations.

    +

    Throughout this package, elements of the GF are represented as an int for convenience and speed (but at the cost of memory).

    @@ -213,13 +214,13 @@ for convenience and speed (but at the cost of memory).

    - expTable + expTable  = [1, 2, 4, 8, 16, 32, 64, 128, 29, 58, 116, 232, 205, 135, 19, 38, 76, 152, 45, 90, 180, 117, 234, 201, 143, 3, 6, 12, 24, 48, 96, 192, 157, 39, 78, 156, 37, 74, 148, 53, 106, 212, 181, 119, 238, 193, 159, 35, 70, 140, 5, 10, 20, 40, 80, 160, 93, 186, 105, 210, 185, 111, 222, 161, 95, 190, 97, 194, 153, 47, 94, 188, 101, 202, 137, 15, 30, 60, 120, 240, 253, 231, 211, 187, 107, 214, 177, 127, 254, 225, 223, 163, 91, 182, 113, 226, 217, 175, 67, 134, 17, 34, 68, 136, 13, 26, 52, 104, 208, 189, 103, 206, 129, 31, 62, 124, 248, 237, 199, 147, 59, 118, 236, 197, 151, 51, 102, 204, 133, 23, 46, 92, 184, 109, 218, 169, 79, 158, 33, 66, 132, 21, 42, 84, 168, 77, 154, 41, 82, 164, 85, 170, 73, 146, 57, 114, 228, 213, 183, 115, 230, 209, 191, 99, 198, 145, 63, 126, 252, 229, 215, 179, 123, 246, 241, 255, 227, 219, 171, 75, 150, 49, 98, 196, 149, 55, 110, 220, 165, 87, 174, 65, 130, 25, 50, 100, 200, 141, 7, 14, 28, 56, 112, 224, 221, 167, 83, 166, 81, 162, 89, 178, 121, 242, 249, 239, 195, 155, 43, 86, 172, 69, 138, 9, 18, 36, 72, 144, 61, 122, 244, 245, 247, 243, 251, 235, 203, 139, 11, 22, 44, 88, 176, 125, 250, 233, 207, 131, 27, 54, 108, 216, 173, 71, 142, 1]
    - logTable + logTable  = [ 0, @@ -495,38 +496,38 @@ where the least-significant bit represents the constant coefficient
    - addOrSubtract() + addOrSubtract()  : int
    Implements both addition and subtraction -- they are the same in GF(size).
    - buildMonomial() + buildMonomial()  : GenericGFPoly
    - exp() + exp()  : int
    - inverse() + inverse()  : int
    - log() + log()  : int
    - multiply() + multiply()  : int
    @@ -557,6 +558,7 @@ where the least-significant bit represents the constant coefficient + private mixed @@ -589,6 +591,7 @@ where the least-significant bit represents the constant coefficient

    irreducible polynomial whose coefficients are represented by the bits of an int, where the least-significant bit represents the constant coefficient

    + private mixed @@ -899,6 +902,7 @@ where the least-significant bit represents the constant coefficient

    +
    Parameters
    @@ -957,6 +961,7 @@ where the least-significant bit represents the constant coefficient

    +
    Parameters
    @@ -1030,6 +1035,7 @@ where the least-significant bit represents the constant coefficient

    +
    Parameters
    @@ -1081,6 +1087,7 @@ where the least-significant bit represents the constant coefficient

    +
    Parameters
    @@ -1147,6 +1154,7 @@ where the least-significant bit represents the constant coefficient

    +
    Parameters
    @@ -1213,6 +1221,7 @@ where the least-significant bit represents the constant coefficient

    +
    Parameters
    @@ -1357,8 +1366,8 @@ where the least-significant bit represents the constant coefficient

  • Constants
    • @@ -1366,12 +1375,12 @@ where the least-significant bit represents the constant coefficient

  • Methods
    • diff --git a/classes/chillerlan-QRCode-Common-GenericGFPoly.html b/classes/chillerlan-QRCode-Common-GenericGFPoly.html index d981ee7bb..c1d49ebac 100644 --- a/classes/chillerlan-QRCode-Common-GenericGFPoly.html +++ b/classes/chillerlan-QRCode-Common-GenericGFPoly.html @@ -158,6 +158,7 @@

    Represents a polynomial whose coefficients are elements of a GF.

    +

    Instances of this class are immutable.

    Much credit is due to William Rucklidge since portions of this code are an indirect port of his C++ Reed-Solomon implementation.

    @@ -206,7 +207,7 @@ port of his C++ Reed-Solomon implementation.

    - $coefficients + $coefficients  : array<string|int, mixed>
    @@ -220,73 +221,73 @@ port of his C++ Reed-Solomon implementation.

    - __construct() + __construct()  : mixed
    - addOrSubtract() + addOrSubtract()  : self
    - divide() + divide()  : array<string|int, GenericGFPoly>
    - evaluateAt() + evaluateAt()  : int
    - getCoefficient() + getCoefficient()  : int
    - getCoefficients() + getCoefficients()  : array<string|int, int>
    - getDegree() + getDegree()  : int
    - isZero() + isZero()  : bool
    - mod() + mod()  : self
    - multiply() + multiply()  : self
    - multiplyByMonomial() + multiplyByMonomial()  : self
    - multiplyInt() + multiplyInt()  : self
    @@ -326,6 +327,7 @@ port of his C++ Reed-Solomon implementation.

    + private array<string|int, mixed> @@ -373,6 +375,7 @@ port of his C++ Reed-Solomon implementation.

    +
    Parameters
    @@ -444,6 +447,7 @@ is not a constant polynomial (that is, it is not the monomial "0")

    +
    Parameters
    @@ -491,6 +495,7 @@ is not a constant polynomial (that is, it is not the monomial "0")

    +
    Parameters
    @@ -557,6 +562,7 @@ is not a constant polynomial (that is, it is not the monomial "0")

    +
    Parameters
    @@ -608,6 +614,7 @@ is not a constant polynomial (that is, it is not the monomial "0")

    +
    Parameters
    @@ -661,6 +668,7 @@ is not a constant polynomial (that is, it is not the monomial "0")

    + @@ -698,6 +706,7 @@ is not a constant polynomial (that is, it is not the monomial "0")

    + @@ -739,6 +748,7 @@ is not a constant polynomial (that is, it is not the monomial "0")

    + @@ -778,6 +788,7 @@ is not a constant polynomial (that is, it is not the monomial "0")

    +
    Parameters
    @@ -825,6 +836,7 @@ is not a constant polynomial (that is, it is not the monomial "0")

    +
    Parameters
    @@ -872,6 +884,7 @@ is not a constant polynomial (that is, it is not the monomial "0")

    +
    Parameters
    @@ -941,6 +954,7 @@ is not a constant polynomial (that is, it is not the monomial "0")

    +
    Parameters
    @@ -1075,25 +1089,25 @@ is not a constant polynomial (that is, it is not the monomial "0")

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Common-IMagickLuminanceSource.html b/classes/chillerlan-QRCode-Common-IMagickLuminanceSource.html index 34366fbb8..7d889f3ec 100644 --- a/classes/chillerlan-QRCode-Common-IMagickLuminanceSource.html +++ b/classes/chillerlan-QRCode-Common-IMagickLuminanceSource.html @@ -169,6 +169,7 @@ It does not support rotation.

    +

    Table of Contents @@ -190,31 +191,31 @@ It does not support rotation.

    - $height + $height  : int
    - $luminances + $luminances  : array<string|int, mixed>
    - $options + $options  : SettingsContainerInterface|QROptions
    - $width + $width  : int
    - $imagick + $imagick  : Imagick
    @@ -228,34 +229,34 @@ It does not support rotation.

    - __construct() + __construct()  : mixed
    IMagickLuminanceSource constructor.
    - fromBlob() + fromBlob()  : static
    Creates a LuminanceSource instance from the given data blob
    - fromFile() + fromFile()  : static
    Creates a LuminanceSource instance from the given file
    - getHeight() + getHeight()  : int
    - getLuminances() + getLuminances()  : array<string|int, mixed>
    @@ -263,7 +264,7 @@ It does not support rotation.

    `int luminance = array[y * width + x] & 0xff`
    - getRow() + getRow()  : array<string|int, mixed>
    @@ -274,25 +275,25 @@ to only fetch this row rather than the whole image, since no 2D Readers may be i getLuminances() may never be called.
    - getWidth() + getWidth()  : int
    - checkFile() + checkFile()  : string
    - setLuminancePixel() + setLuminancePixel()  : void
    - setLuminancePixels() + setLuminancePixels()  : void
    @@ -332,6 +333,7 @@ getLuminances() may never be called. + protected int @@ -367,6 +369,7 @@ getLuminances() may never be called. + protected array<string|int, mixed> @@ -402,6 +405,7 @@ getLuminances() may never be called. + protected SettingsContainerInterface|QROptions @@ -437,6 +441,7 @@ getLuminances() may never be called. + protected int @@ -472,6 +477,7 @@ getLuminances() may never be called. + private Imagick @@ -520,6 +526,7 @@ getLuminances() may never be called.
    +
    Parameters
    @@ -571,6 +578,7 @@ getLuminances() may never be called.
    +
    Parameters
    @@ -640,6 +648,7 @@ getLuminances() may never be called.
    +
    Parameters
    @@ -710,6 +719,7 @@ getLuminances() may never be called. +
    Tags @@ -767,6 +777,7 @@ getLuminances() may never be called. +
    Tags @@ -827,6 +838,7 @@ getLuminances() may never be called.

    +
    Parameters
    @@ -896,6 +908,7 @@ getLuminances() may never be called.

    +
    Tags @@ -949,6 +962,7 @@ getLuminances() may never be called.

    +
    Parameters
    @@ -1011,6 +1025,7 @@ getLuminances() may never be called.

    +
    Parameters
    @@ -1070,6 +1085,7 @@ getLuminances() may never be called.

    + @@ -1188,27 +1204,27 @@ getLuminances() may never be called.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Common-LuminanceSourceAbstract.html b/classes/chillerlan-QRCode-Common-LuminanceSourceAbstract.html index 3bc875fd3..5c501effd 100644 --- a/classes/chillerlan-QRCode-Common-LuminanceSourceAbstract.html +++ b/classes/chillerlan-QRCode-Common-LuminanceSourceAbstract.html @@ -164,6 +164,7 @@ platforms into a standard interface for requesting greyscale luminance values. Tags @@ -213,25 +214,25 @@ platforms into a standard interface for requesting greyscale luminance values.
    - $height + $height  : int
    - $luminances + $luminances  : array<string|int, mixed>
    - $options + $options  : SettingsContainerInterface|QROptions
    - $width + $width  : int
    @@ -245,19 +246,19 @@ platforms into a standard interface for requesting greyscale luminance values.
    - __construct() + __construct()  : mixed
    - getHeight() + getHeight()  : int
    - getLuminances() + getLuminances()  : array<string|int, mixed>
    @@ -265,7 +266,7 @@ platforms into a standard interface for requesting greyscale luminance values.
    - getRow() + getRow()  : array<string|int, mixed>
    @@ -276,19 +277,19 @@ to only fetch this row rather than the whole image, since no 2D Readers may be i getLuminances() may never be called.
    - getWidth() + getWidth()  : int
    - checkFile() + checkFile()  : string
    - setLuminancePixel() + setLuminancePixel()  : void
    @@ -328,6 +329,7 @@ getLuminances() may never be called. + protected int @@ -363,6 +365,7 @@ getLuminances() may never be called. + protected array<string|int, mixed> @@ -398,6 +401,7 @@ getLuminances() may never be called. + protected SettingsContainerInterface|QROptions @@ -433,6 +437,7 @@ getLuminances() may never be called. + protected int @@ -480,6 +485,7 @@ getLuminances() may never be called.
    +
    Parameters
    @@ -539,6 +545,7 @@ getLuminances() may never be called. +
    Tags @@ -596,6 +603,7 @@ getLuminances() may never be called. +
    Tags @@ -656,6 +664,7 @@ getLuminances() may never be called.

    +
    Parameters
    @@ -725,6 +734,7 @@ getLuminances() may never be called.

    +
    Tags @@ -778,6 +788,7 @@ getLuminances() may never be called.

    +
    Parameters
    @@ -840,6 +851,7 @@ getLuminances() may never be called.

    +
    Parameters
    @@ -984,23 +996,23 @@ getLuminances() may never be called.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Common-LuminanceSourceInterface.html b/classes/chillerlan-QRCode-Common-LuminanceSourceInterface.html index a6430d1df..ff04df07b 100644 --- a/classes/chillerlan-QRCode-Common-LuminanceSourceInterface.html +++ b/classes/chillerlan-QRCode-Common-LuminanceSourceInterface.html @@ -153,6 +153,7 @@ +

    Table of Contents @@ -175,27 +176,27 @@

    - fromBlob() + fromBlob()  : static
    Creates a LuminanceSource instance from the given data blob
    - fromFile() + fromFile()  : static
    Creates a LuminanceSource instance from the given file
    - getHeight() + getHeight()  : int
    - getLuminances() + getLuminances()  : array<string|int, mixed>
    @@ -203,7 +204,7 @@ `int luminance = array[y * width + x] & 0xff`
    - getRow() + getRow()  : array<string|int, mixed>
    @@ -214,7 +215,7 @@ to only fetch this row rather than the whole image, since no 2D Readers may be i getLuminances() may never be called.
    - getWidth() + getWidth()  : int
    @@ -259,6 +260,7 @@ getLuminances() may never be called.
    +
    Parameters
    @@ -314,6 +316,7 @@ getLuminances() may never be called.
    +
    Parameters
    @@ -370,6 +373,7 @@ getLuminances() may never be called. + @@ -413,6 +417,7 @@ getLuminances() may never be called. + @@ -459,6 +464,7 @@ getLuminances() may never be called.

    +
    Parameters
    @@ -529,6 +535,7 @@ getLuminances() may never be called.

    + @@ -654,12 +661,12 @@ getLuminances() may never be called.

  • Methods
    • diff --git a/classes/chillerlan-QRCode-Common-MaskPattern.html b/classes/chillerlan-QRCode-Common-MaskPattern.html index d61d97691..ca9803ab9 100644 --- a/classes/chillerlan-QRCode-Common-MaskPattern.html +++ b/classes/chillerlan-QRCode-Common-MaskPattern.html @@ -161,6 +161,7 @@ ISO/IEC 18004:2000 Section 8.8.2 - Evaluation of masking results

    +
    Tags @@ -208,85 +209,85 @@ ISO/IEC 18004:2000 Section 8.8.2 - Evaluation of masking results

    - AUTO + AUTO  = -1
    - PATTERN_000 + PATTERN_000  = 0b0
    - PATTERN_001 + PATTERN_001  = 0b1
    - PATTERN_010 + PATTERN_010  = 0b10
    - PATTERN_011 + PATTERN_011  = 0b11
    - PATTERN_100 + PATTERN_100  = 0b100
    - PATTERN_101 + PATTERN_101  = 0b101
    - PATTERN_110 + PATTERN_110  = 0b110
    - PATTERN_111 + PATTERN_111  = 0b111
    - PATTERNS + PATTERNS  = [self::PATTERN_000, self::PATTERN_001, self::PATTERN_010, self::PATTERN_011, self::PATTERN_100, self::PATTERN_101, self::PATTERN_110, self::PATTERN_111]
    - PENALTY_N1 + PENALTY_N1  = 3
    - PENALTY_N2 + PENALTY_N2  = 3
    - PENALTY_N3 + PENALTY_N3  = 40
    - PENALTY_N4 + PENALTY_N4  = 10
    @@ -301,7 +302,7 @@ ISO/IEC 18004:2000 Section 8.8.2 - Evaluation of masking results

    - $maskPattern + $maskPattern  : int
    @@ -316,35 +317,35 @@ ISO/IEC 18004:2000 Section 8.8.2 - Evaluation of masking results

    - __construct() + __construct()  : mixed
    MaskPattern constructor.
    - getBestPattern() + getBestPattern()  : self
    Evaluates the matrix of the given data interface and returns a new mask pattern instance for the best result
    - getMask() + getMask()  : Closure
    Returns a closure that applies the mask for the chosen mask pattern.
    - getPattern() + getPattern()  : int
    Returns the current mask pattern
    - testRule1() + testRule1()  : int
    @@ -352,7 +353,7 @@ ISO/IEC 18004:2000 Section 8.8.2 - Evaluation of masking results

    give penalty to them. Example: 00000 or 11111.
    - testRule2() + testRule2()  : int
    @@ -361,7 +362,7 @@ penalty to them. This is actually equivalent to the spec's rule, which is t penalty proportional to (M-1)x(N-1), because this is the number of 2x2 blocks inside such a block.
    - testRule3() + testRule3()  : int
    @@ -370,7 +371,7 @@ starting with black, or 4:1:1:3:1:1 starting with white, and give penalty to the find patterns like 000010111010000, we give penalty once.
    - testRule4() + testRule4()  : int
    @@ -378,19 +379,19 @@ find patterns like 000010111010000, we give penalty once. penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.
    - applyRule1() + applyRule1()  : int
    - isWhiteHorizontal() + isWhiteHorizontal()  : bool
    - isWhiteVertical() + isWhiteVertical()  : bool
    @@ -421,6 +422,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + public int @@ -466,6 +468,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + public mixed @@ -496,6 +499,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + public mixed @@ -526,6 +530,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + public mixed @@ -556,6 +561,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + public mixed @@ -586,6 +592,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + public mixed @@ -616,6 +623,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + public mixed @@ -646,6 +654,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + public mixed @@ -676,6 +685,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + public mixed @@ -706,6 +716,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + public array<string|int, int> @@ -736,6 +747,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + private mixed @@ -766,6 +778,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + private mixed @@ -796,6 +809,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + private mixed @@ -826,6 +840,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. + private mixed @@ -873,6 +888,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.

    The current mask pattern value (0-7)

    + private int @@ -921,6 +937,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.
    +
    Parameters
    @@ -980,6 +997,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.
    +
    Parameters
    @@ -1027,6 +1045,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.
    +

    Note that the diagram in section 6.8.1 is misleading since it indicates that $i is column position and $j is row position. In fact, as the text says, $i is row position and $j is column position.

    @@ -1094,6 +1113,7 @@ and $j is row position. In fact, as the text says, $i is row position and $j is + @@ -1131,6 +1151,7 @@ give penalty to them. Example: 00000 or 11111.

    +
    Parameters
    @@ -1195,6 +1216,7 @@ penalty proportional to (M-1)x(N-1), because this is the number of 2x2 blocks in
    +
    Parameters
    @@ -1259,6 +1281,7 @@ find patterns like 000010111010000, we give penalty once.

    +
    Parameters
    @@ -1322,6 +1345,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.

    +
    Parameters
    @@ -1383,6 +1407,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.

    +
    Parameters
    @@ -1430,6 +1455,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.

    +
    Parameters
    @@ -1498,6 +1524,7 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.

    +
    Parameters
    @@ -1660,44 +1687,44 @@ penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Common-Mode.html b/classes/chillerlan-QRCode-Common-Mode.html index cddbbab13..207e174ea 100644 --- a/classes/chillerlan-QRCode-Common-Mode.html +++ b/classes/chillerlan-QRCode-Common-Mode.html @@ -165,6 +165,7 @@ +

    Table of Contents @@ -184,75 +185,75 @@

    - ALPHANUM + ALPHANUM  = 0b10
    - BYTE + BYTE  = 0b100
    - ECI + ECI  = 0b111
    - FNC1_FIRST + FNC1_FIRST  = 0b101
    - FNC1_SECOND + FNC1_SECOND  = 0b1001
    - HANZI + HANZI  = 0b1101
    - INTERFACES + INTERFACES  = [self::NUMBER => \chillerlan\QRCode\Data\Number::class, self::ALPHANUM => \chillerlan\QRCode\Data\AlphaNum::class, self::KANJI => \chillerlan\QRCode\Data\Kanji::class, self::HANZI => \chillerlan\QRCode\Data\Hanzi::class, self::BYTE => \chillerlan\QRCode\Data\Byte::class]
    Map of data mode => interface (detection order)
    - KANJI + KANJI  = 0b1000
    - LENGTH_BITS + LENGTH_BITS  = [self::NUMBER => [10, 12, 14], self::ALPHANUM => [9, 11, 13], self::BYTE => [8, 16, 16], self::KANJI => [8, 10, 12], self::HANZI => [8, 10, 12], self::ECI => [0, 0, 0]]
    mode length bits for the version breakpoints 1-9, 10-26 and 27-40
    - NUMBER + NUMBER  = 0b1
    - STRCTURED_APPEND + STRCTURED_APPEND  = 0b11
    - TERMINATOR + TERMINATOR  = 0b0
    @@ -268,7 +269,7 @@
    - getLengthBitsForVersion() + getLengthBitsForVersion()  : int
    @@ -300,6 +301,7 @@ + public int @@ -330,6 +332,7 @@ + public int @@ -360,6 +363,7 @@ + public int @@ -390,6 +394,7 @@ + public int @@ -420,6 +425,7 @@ + public int @@ -450,6 +456,7 @@ + public int @@ -481,6 +488,7 @@

    Map of data mode => interface (detection order)

    + public array<string|int, string> @@ -511,6 +519,7 @@ + public int @@ -542,6 +551,7 @@

    mode length bits for the version breakpoints 1-9, 10-26 and 27-40

    + public mixed @@ -574,6 +584,7 @@ + public int @@ -604,6 +615,7 @@ + public int @@ -634,6 +646,7 @@ + public int @@ -686,6 +699,7 @@
    +
    Parameters
    @@ -841,18 +855,18 @@
  • Constants
    • @@ -860,7 +874,7 @@
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Common-Version.html b/classes/chillerlan-QRCode-Common-Version.html index b57b720cc..85ea99050 100644 --- a/classes/chillerlan-QRCode-Common-Version.html +++ b/classes/chillerlan-QRCode-Common-Version.html @@ -165,6 +165,7 @@ +

    Table of Contents @@ -184,35 +185,35 @@

    - AUTO + AUTO  = -1
    Enable version auto detection
    - ALIGNMENT_PATTERN + ALIGNMENT_PATTERN  = [1 => [], 2 => [6, 18], 3 => [6, 22], 4 => [6, 26], 5 => [6, 30], 6 => [6, 34], 7 => [6, 22, 38], 8 => [6, 24, 42], 9 => [6, 26, 46], 10 => [6, 28, 50], 11 => [6, 30, 54], 12 => [6, 32, 58], 13 => [6, 34, 62], 14 => [6, 26, 46, 66], 15 => [6, 26, 48, 70], 16 => [6, 26, 50, 74], 17 => [6, 30, 54, 78], 18 => [6, 30, 56, 82], 19 => [6, 30, 58, 86], 20 => [6, 34, 62, 90], 21 => [6, 28, 50, 72, 94], 22 => [6, 26, 50, 74, 98], 23 => [6, 30, 54, 78, 102], 24 => [6, 28, 54, 80, 106], 25 => [6, 32, 58, 84, 110], 26 => [6, 30, 58, 86, 114], 27 => [6, 34, 62, 90, 118], 28 => [6, 26, 50, 74, 98, 122], 29 => [6, 30, 54, 78, 102, 126], 30 => [6, 26, 52, 78, 104, 130], 31 => [6, 30, 56, 82, 108, 134], 32 => [6, 34, 60, 86, 112, 138], 33 => [6, 30, 58, 86, 114, 142], 34 => [6, 34, 62, 90, 118, 146], 35 => [6, 30, 54, 78, 102, 126, 150], 36 => [6, 24, 50, 76, 102, 128, 154], 37 => [6, 28, 54, 80, 106, 132, 158], 38 => [6, 32, 58, 84, 110, 136, 162], 39 => [6, 26, 54, 82, 110, 138, 166], 40 => [6, 30, 58, 86, 114, 142, 170]]
    ISO/IEC 18004:2000 Annex E, Table E.1 - Row/column coordinates of center module of Alignment Patterns
    - RSBLOCKS + RSBLOCKS  = [1 => [[7, [[1, 19], [0, 0]]], [10, [[1, 16], [0, 0]]], [13, [[1, 13], [0, 0]]], [17, [[1, 9], [0, 0]]]], 2 => [[10, [[1, 34], [0, 0]]], [16, [[1, 28], [0, 0]]], [22, [[1, 22], [0, 0]]], [28, [[1, 16], [0, 0]]]], 3 => [[15, [[1, 55], [0, 0]]], [26, [[1, 44], [0, 0]]], [18, [[2, 17], [0, 0]]], [22, [[2, 13], [0, 0]]]], 4 => [[20, [[1, 80], [0, 0]]], [18, [[2, 32], [0, 0]]], [26, [[2, 24], [0, 0]]], [16, [[4, 9], [0, 0]]]], 5 => [[26, [[1, 108], [0, 0]]], [24, [[2, 43], [0, 0]]], [18, [[2, 15], [2, 16]]], [22, [[2, 11], [2, 12]]]], 6 => [[18, [[2, 68], [0, 0]]], [16, [[4, 27], [0, 0]]], [24, [[4, 19], [0, 0]]], [28, [[4, 15], [0, 0]]]], 7 => [[20, [[2, 78], [0, 0]]], [18, [[4, 31], [0, 0]]], [18, [[2, 14], [4, 15]]], [26, [[4, 13], [1, 14]]]], 8 => [[24, [[2, 97], [0, 0]]], [22, [[2, 38], [2, 39]]], [22, [[4, 18], [2, 19]]], [26, [[4, 14], [2, 15]]]], 9 => [[30, [[2, 116], [0, 0]]], [22, [[3, 36], [2, 37]]], [20, [[4, 16], [4, 17]]], [24, [[4, 12], [4, 13]]]], 10 => [[18, [[2, 68], [2, 69]]], [26, [[4, 43], [1, 44]]], [24, [[6, 19], [2, 20]]], [28, [[6, 15], [2, 16]]]], 11 => [[20, [[4, 81], [0, 0]]], [30, [[1, 50], [4, 51]]], [28, [[4, 22], [4, 23]]], [24, [[3, 12], [8, 13]]]], 12 => [[24, [[2, 92], [2, 93]]], [22, [[6, 36], [2, 37]]], [26, [[4, 20], [6, 21]]], [28, [[7, 14], [4, 15]]]], 13 => [[26, [[4, 107], [0, 0]]], [22, [[8, 37], [1, 38]]], [24, [[8, 20], [4, 21]]], [22, [[12, 11], [4, 12]]]], 14 => [[30, [[3, 115], [1, 116]]], [24, [[4, 40], [5, 41]]], [20, [[11, 16], [5, 17]]], [24, [[11, 12], [5, 13]]]], 15 => [[22, [[5, 87], [1, 88]]], [24, [[5, 41], [5, 42]]], [30, [[5, 24], [7, 25]]], [24, [[11, 12], [7, 13]]]], 16 => [[24, [[5, 98], [1, 99]]], [28, [[7, 45], [3, 46]]], [24, [[15, 19], [2, 20]]], [30, [[3, 15], [13, 16]]]], 17 => [[28, [[1, 107], [5, 108]]], [28, [[10, 46], [1, 47]]], [28, [[1, 22], [15, 23]]], [28, [[2, 14], [17, 15]]]], 18 => [[30, [[5, 120], [1, 121]]], [26, [[9, 43], [4, 44]]], [28, [[17, 22], [1, 23]]], [28, [[2, 14], [19, 15]]]], 19 => [[28, [[3, 113], [4, 114]]], [26, [[3, 44], [11, 45]]], [26, [[17, 21], [4, 22]]], [26, [[9, 13], [16, 14]]]], 20 => [[28, [[3, 107], [5, 108]]], [26, [[3, 41], [13, 42]]], [30, [[15, 24], [5, 25]]], [28, [[15, 15], [10, 16]]]], 21 => [[28, [[4, 116], [4, 117]]], [26, [[17, 42], [0, 0]]], [28, [[17, 22], [6, 23]]], [30, [[19, 16], [6, 17]]]], 22 => [[28, [[2, 111], [7, 112]]], [28, [[17, 46], [0, 0]]], [30, [[7, 24], [16, 25]]], [24, [[34, 13], [0, 0]]]], 23 => [[30, [[4, 121], [5, 122]]], [28, [[4, 47], [14, 48]]], [30, [[11, 24], [14, 25]]], [30, [[16, 15], [14, 16]]]], 24 => [[30, [[6, 117], [4, 118]]], [28, [[6, 45], [14, 46]]], [30, [[11, 24], [16, 25]]], [30, [[30, 16], [2, 17]]]], 25 => [[26, [[8, 106], [4, 107]]], [28, [[8, 47], [13, 48]]], [30, [[7, 24], [22, 25]]], [30, [[22, 15], [13, 16]]]], 26 => [[28, [[10, 114], [2, 115]]], [28, [[19, 46], [4, 47]]], [28, [[28, 22], [6, 23]]], [30, [[33, 16], [4, 17]]]], 27 => [[30, [[8, 122], [4, 123]]], [28, [[22, 45], [3, 46]]], [30, [[8, 23], [26, 24]]], [30, [[12, 15], [28, 16]]]], 28 => [[30, [[3, 117], [10, 118]]], [28, [[3, 45], [23, 46]]], [30, [[4, 24], [31, 25]]], [30, [[11, 15], [31, 16]]]], 29 => [[30, [[7, 116], [7, 117]]], [28, [[21, 45], [7, 46]]], [30, [[1, 23], [37, 24]]], [30, [[19, 15], [26, 16]]]], 30 => [[30, [[5, 115], [10, 116]]], [28, [[19, 47], [10, 48]]], [30, [[15, 24], [25, 25]]], [30, [[23, 15], [25, 16]]]], 31 => [[30, [[13, 115], [3, 116]]], [28, [[2, 46], [29, 47]]], [30, [[42, 24], [1, 25]]], [30, [[23, 15], [28, 16]]]], 32 => [[30, [[17, 115], [0, 0]]], [28, [[10, 46], [23, 47]]], [30, [[10, 24], [35, 25]]], [30, [[19, 15], [35, 16]]]], 33 => [[30, [[17, 115], [1, 116]]], [28, [[14, 46], [21, 47]]], [30, [[29, 24], [19, 25]]], [30, [[11, 15], [46, 16]]]], 34 => [[30, [[13, 115], [6, 116]]], [28, [[14, 46], [23, 47]]], [30, [[44, 24], [7, 25]]], [30, [[59, 16], [1, 17]]]], 35 => [[30, [[12, 121], [7, 122]]], [28, [[12, 47], [26, 48]]], [30, [[39, 24], [14, 25]]], [30, [[22, 15], [41, 16]]]], 36 => [[30, [[6, 121], [14, 122]]], [28, [[6, 47], [34, 48]]], [30, [[46, 24], [10, 25]]], [30, [[2, 15], [64, 16]]]], 37 => [[30, [[17, 122], [4, 123]]], [28, [[29, 46], [14, 47]]], [30, [[49, 24], [10, 25]]], [30, [[24, 15], [46, 16]]]], 38 => [[30, [[4, 122], [18, 123]]], [28, [[13, 46], [32, 47]]], [30, [[48, 24], [14, 25]]], [30, [[42, 15], [32, 16]]]], 39 => [[30, [[20, 117], [4, 118]]], [28, [[40, 47], [7, 48]]], [30, [[43, 24], [22, 25]]], [30, [[10, 15], [67, 16]]]], 40 => [[30, [[19, 118], [6, 119]]], [28, [[18, 47], [31, 48]]], [30, [[34, 24], [34, 25]]], [30, [[20, 15], [61, 16]]]]]
    ISO/IEC 18004:2000 Tables 13-22 - Error correction characteristics
    - TOTAL_CODEWORDS + TOTAL_CODEWORDS  = [1 => 26, 2 => 44, 3 => 70, 4 => 100, 5 => 134, 6 => 172, 7 => 196, 8 => 242, 9 => 292, 10 => 346, 11 => 404, 12 => 466, 13 => 532, 14 => 581, 15 => 655, 16 => 733, 17 => 815, 18 => 901, 19 => 991, 20 => 1085, 21 => 1156, 22 => 1258, 23 => 1364, 24 => 1474, 25 => 1588, 26 => 1706, 27 => 1828, 28 => 1921, 29 => 2051, 30 => 2185, 31 => 2323, 32 => 2465, 33 => 2611, 34 => 2761, 35 => 2876, 36 => 3034, 37 => 3196, 38 => 3362, 39 => 3532, 40 => 3706]
    ISO/IEC 18004:2000 Table 1 - Data capacity of all versions of QR Code
    - VERSION_PATTERN + VERSION_PATTERN  = [7 => 0b111110010010100, 8 => 0b1000010110111100, 9 => 0b1001101010011001, 10 => 0b1010010011010011, 11 => 0b1011101111110110, 12 => 0b1100011101100010, 13 => 0b1101100001000111, 14 => 0b1110011000001101, 15 => 0b1111100100101000, 16 => 0b10000101101111000, 17 => 0b10001010001011101, 18 => 0b10010101000010111, 19 => 0b10011010100110010, 20 => 0b10100100110100110, 21 => 0b10101011010000011, 22 => 0b10110100011001001, 23 => 0b10111011111101100, 24 => 0b11000111011000100, 25 => 0b11001000111100001, 26 => 0b11010111110101011, 27 => 0b11011000010001110, 28 => 0b11100110000011010, 29 => 0b11101001100111111, 30 => 0b11110110101110101, 31 => 0b11111001001010000, 32 => 0b100000100111010101, 33 => 0b100001011011110000, 34 => 0b100010100010111010, 35 => 0b100011011110011111, 36 => 0b100100101100001011, 37 => 0b100101010000101110, 38 => 0b100110101001100100, 39 => 0b100111010101000001, 40 => 0b101000110001101001]
    @@ -228,7 +229,7 @@
    - $version + $version  : int
    @@ -243,56 +244,56 @@
    - __construct() + __construct()  : mixed
    Version constructor.
    - __toString() + __toString()  : string
    returns the current version number as string
    - getAlignmentPattern() + getAlignmentPattern()  : array<string|int, int>
    the alignment patterns for the current version
    - getDimension() + getDimension()  : int
    the matrix size for the given version
    - getRSBlocks() + getRSBlocks()  : array<string|int, mixed>
    returns ECC block information for the given $version and $eccLevel
    - getTotalCodewords() + getTotalCodewords()  : int
    returns the maximum codewords for the current version
    - getVersionNumber() + getVersionNumber()  : int
    returns the current version number
    - getVersionPattern() + getVersionPattern()  : int|null
    @@ -325,6 +326,7 @@

    Enable version auto detection

    + public int @@ -371,6 +373,7 @@

    ISO/IEC 18004:2000 Annex E, Table E.1 - Row/column coordinates of center module of Alignment Patterns

    + private array<string|int, array<string|int, int>> @@ -404,6 +407,7 @@

    ISO/IEC 18004:2000 Tables 13-22 - Error correction characteristics

    + private mixed @@ -450,6 +454,7 @@

    ISO/IEC 18004:2000 Table 1 - Data capacity of all versions of QR Code

    + private mixed @@ -481,6 +486,7 @@

    ISO/IEC 18004:2000 Annex D, Table D.1 - Version information bit stream for each version

    + private array<string|int, int> @@ -530,6 +536,7 @@

    QR Code version number

    + private int @@ -578,6 +585,7 @@
    +
    Parameters
    @@ -639,6 +647,7 @@ + @@ -677,6 +686,7 @@ + @@ -715,6 +725,7 @@ + @@ -751,6 +762,7 @@
    +
    Parameters
    @@ -801,6 +813,7 @@ + @@ -839,6 +852,7 @@ + @@ -877,6 +891,7 @@ + @@ -999,32 +1014,32 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Data-AlphaNum.html b/classes/chillerlan-QRCode-Data-AlphaNum.html index 5427f5b21..744f3de8e 100644 --- a/classes/chillerlan-QRCode-Data-AlphaNum.html +++ b/classes/chillerlan-QRCode-Data-AlphaNum.html @@ -161,6 +161,7 @@

    Alphanumeric mode: 0 to 9, A to Z, space, $ % * + - . / :

    +

    ISO/IEC 18004:2000 Section 8.3.3 ISO/IEC 18004:2000 Section 8.4.3

    @@ -190,13 +191,13 @@ ISO/IEC 18004:2000 Section 8.4.3

    - DATAMODE + DATAMODE  = \chillerlan\QRCode\Common\Mode::ALPHANUM
    - CHAR_TO_ORD + CHAR_TO_ORD  = ['0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5, '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'A' => 10, 'B' => 11, 'C' => 12, 'D' => 13, 'E' => 14, 'F' => 15, 'G' => 16, 'H' => 17, 'I' => 18, 'J' => 19, 'K' => 20, 'L' => 21, 'M' => 22, 'N' => 23, 'O' => 24, 'P' => 25, 'Q' => 26, 'R' => 27, 'S' => 28, 'T' => 29, 'U' => 30, 'V' => 31, 'W' => 32, 'X' => 33, 'Y' => 34, 'Z' => 35, ' ' => 36, '$' => 37, '%' => 38, '*' => 39, '+' => 40, '-' => 41, '.' => 42, '/' => 43, ':' => 44]
    @@ -212,7 +213,7 @@ ISO/IEC 18004:2000 Section 8.4.3

    - $data + $data  : string
    @@ -227,56 +228,56 @@ ISO/IEC 18004:2000 Section 8.4.3

    - __construct() + __construct()  : mixed
    QRDataModeAbstract constructor.
    - convertEncoding() + convertEncoding()  : string
    encoding conversion helper
    - decodeSegment() + decodeSegment()  : string
    reads a segment from the BitBuffer and decodes in the current data mode
    - getLengthInBits() + getLengthInBits()  : int
    retruns the length in bits of the data string
    - validateString() + validateString()  : bool
    checks if the given string qualifies for the encoder module
    - write() + write()  : static
    writes the actual data string to the BitBuffer, uses the given version to determine the length bits
    - getCharCount() + getCharCount()  : int
    returns the character count of the $data string
    - getLengthBits() + getLengthBits()  : int
    @@ -308,6 +309,7 @@ ISO/IEC 18004:2000 Section 8.4.3

    + public mixed @@ -353,6 +355,7 @@ ISO/IEC 18004:2000 Section 8.4.3

    ISO/IEC 18004:2000 Table 5

    + private array<string|int, int> @@ -400,6 +403,7 @@ ISO/IEC 18004:2000 Section 8.4.3

    The data to write

    + protected string @@ -448,6 +452,7 @@ ISO/IEC 18004:2000 Section 8.4.3

    +
    Parameters
    @@ -507,6 +512,7 @@ ISO/IEC 18004:2000 Section 8.4.3

    +
    Parameters
    @@ -569,6 +575,7 @@ ISO/IEC 18004:2000 Section 8.4.3

    +
    Parameters
    @@ -648,6 +655,7 @@ ISO/IEC 18004:2000 Section 8.4.3

    +
    Tags @@ -698,6 +706,7 @@ ISO/IEC 18004:2000 Section 8.4.3

    +
    Parameters
    @@ -760,6 +769,7 @@ ISO/IEC 18004:2000 Section 8.4.3

    +
    Parameters
    @@ -831,6 +841,7 @@ ISO/IEC 18004:2000 Section 8.4.3

    + @@ -867,6 +878,7 @@ ISO/IEC 18004:2000 Section 8.4.3

    +
    Parameters
    @@ -1001,29 +1013,29 @@ ISO/IEC 18004:2000 Section 8.4.3

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Data-Byte.html b/classes/chillerlan-QRCode-Data-Byte.html index d88d0b21c..13d78dd3d 100644 --- a/classes/chillerlan-QRCode-Data-Byte.html +++ b/classes/chillerlan-QRCode-Data-Byte.html @@ -161,6 +161,7 @@

    8-bit Byte mode, ISO-8859-1 or UTF-8

    +

    ISO/IEC 18004:2000 Section 8.3.4 ISO/IEC 18004:2000 Section 8.4.4

    @@ -190,7 +191,7 @@ ISO/IEC 18004:2000 Section 8.4.4

    - DATAMODE + DATAMODE  = \chillerlan\QRCode\Common\Mode::BYTE
    @@ -205,7 +206,7 @@ ISO/IEC 18004:2000 Section 8.4.4

    - $data + $data  : string
    @@ -220,56 +221,56 @@ ISO/IEC 18004:2000 Section 8.4.4

    - __construct() + __construct()  : mixed
    QRDataModeAbstract constructor.
    - convertEncoding() + convertEncoding()  : string
    encoding conversion helper
    - decodeSegment() + decodeSegment()  : string
    reads a segment from the BitBuffer and decodes in the current data mode
    - getLengthInBits() + getLengthInBits()  : int
    retruns the length in bits of the data string
    - validateString() + validateString()  : bool
    checks if the given string qualifies for the encoder module
    - write() + write()  : static
    writes the actual data string to the BitBuffer, uses the given version to determine the length bits
    - getCharCount() + getCharCount()  : int
    returns the character count of the $data string
    - getLengthBits() + getLengthBits()  : int
    @@ -301,6 +302,7 @@ ISO/IEC 18004:2000 Section 8.4.4

    + public mixed @@ -362,6 +364,7 @@ ISO/IEC 18004:2000 Section 8.4.4

    The data to write

    + protected string @@ -410,6 +413,7 @@ ISO/IEC 18004:2000 Section 8.4.4

    +
    Parameters
    @@ -469,6 +473,7 @@ ISO/IEC 18004:2000 Section 8.4.4

    +
    Parameters
    @@ -531,6 +536,7 @@ ISO/IEC 18004:2000 Section 8.4.4

    +
    Parameters
    @@ -610,6 +616,7 @@ ISO/IEC 18004:2000 Section 8.4.4

    +
    Tags @@ -660,6 +667,7 @@ ISO/IEC 18004:2000 Section 8.4.4

    +
    Parameters
    @@ -722,6 +730,7 @@ ISO/IEC 18004:2000 Section 8.4.4

    +
    Parameters
    @@ -793,6 +802,7 @@ ISO/IEC 18004:2000 Section 8.4.4

    + @@ -829,6 +839,7 @@ ISO/IEC 18004:2000 Section 8.4.4

    +
    Parameters
    @@ -963,28 +974,28 @@ ISO/IEC 18004:2000 Section 8.4.4

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Data-ECI.html b/classes/chillerlan-QRCode-Data-ECI.html index 916d3a602..47b76881a 100644 --- a/classes/chillerlan-QRCode-Data-ECI.html +++ b/classes/chillerlan-QRCode-Data-ECI.html @@ -161,6 +161,7 @@

    Adds an ECI Designator

    +

    ISO/IEC 18004:2000 8.4.1.1

    Please note that you have to take care for the correct data encoding when adding with QRCode::add*Segment()

    @@ -190,7 +191,7 @@
    - DATAMODE + DATAMODE  = \chillerlan\QRCode\Common\Mode::ECI
    @@ -205,14 +206,14 @@
    - $data + $data  : string
    The data to write
    - $encoding + $encoding  : int
    @@ -227,63 +228,63 @@
    - __construct() + __construct()  : mixed
    QRDataModeAbstract constructor.
    - convertEncoding() + convertEncoding()  : string
    encoding conversion helper
    - decodeSegment() + decodeSegment()  : string
    Reads and decodes the ECI designator including the following byte sequence
    - getLengthInBits() + getLengthInBits()  : int
    retruns the length in bits of the data string
    - parseValue() + parseValue()  : ECICharset
    Reads and parses the value of an ECI designator
    - validateString() + validateString()  : bool
    checks if the given string qualifies for the encoder module
    - write() + write()  : static
    Writes an ECI designator to the bitbuffer
    - getCharCount() + getCharCount()  : int
    returns the character count of the $data string
    - getLengthBits() + getLengthBits()  : int
    @@ -315,6 +316,7 @@ + public mixed @@ -376,6 +378,7 @@

    The data to write

    + protected string @@ -412,6 +415,7 @@

    The current ECI encoding id

    + private int @@ -460,6 +464,7 @@
    +
    Parameters
    @@ -527,6 +532,7 @@
    +
    Parameters
    @@ -589,6 +595,7 @@
    +
    Parameters
    @@ -661,6 +668,7 @@ +
    Tags @@ -711,6 +719,7 @@
    +
    Parameters
    @@ -774,6 +783,7 @@
    +
    Parameters
    @@ -838,6 +848,7 @@
    +
    Parameters
    @@ -917,6 +928,7 @@ + @@ -953,6 +965,7 @@
    +
    Parameters
    @@ -1087,30 +1100,30 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Data-Hanzi.html b/classes/chillerlan-QRCode-Data-Hanzi.html index deb19bbec..46cb7065f 100644 --- a/classes/chillerlan-QRCode-Data-Hanzi.html +++ b/classes/chillerlan-QRCode-Data-Hanzi.html @@ -161,6 +161,7 @@

    Hanzi (simplified Chinese) mode, GBT18284-2000: 13-bit double-byte characters from the GB2312/GB18030 character set

    +

    Please note that this is not part of the QR Code specification and may not be supported by all readers (ZXing-based ones do).

    @@ -244,20 +245,20 @@
    - DATAMODE + DATAMODE  = \chillerlan\QRCode\Common\Mode::HANZI
    - ENCODING + ENCODING  = 'GB18030'
    possible values: GB2312, GB18030
    - GB2312_SUBSET + GB2312_SUBSET  = 0b1
    @@ -272,7 +273,7 @@
    - $data + $data  : string
    @@ -287,56 +288,56 @@
    - __construct() + __construct()  : mixed
    QRDataModeAbstract constructor.
    - convertEncoding() + convertEncoding()  : string
    encoding conversion helper
    - decodeSegment() + decodeSegment()  : string
    See specification GBT 18284-2000
    - getLengthInBits() + getLengthInBits()  : int
    retruns the length in bits of the data string
    - validateString() + validateString()  : bool
    checks if a string qualifies as Hanzi/GB2312
    - write() + write()  : static
    writes the actual data string to the BitBuffer, uses the given version to determine the length bits
    - getCharCount() + getCharCount()  : int
    returns the character count of the $data string
    - getLengthBits() + getLengthBits()  : int
    @@ -368,6 +369,7 @@ + public mixed @@ -413,6 +415,7 @@

    possible values: GB2312, GB18030

    + public string @@ -443,6 +446,7 @@ + public int @@ -506,6 +510,7 @@

    The data to write

    + protected string @@ -554,6 +559,7 @@
    +
    Parameters
    @@ -613,6 +619,7 @@
    +
    Parameters
    @@ -675,6 +682,7 @@
    +
    Parameters
    @@ -747,6 +755,7 @@ +
    Tags @@ -797,6 +806,7 @@
    +
    Parameters
    @@ -845,6 +855,7 @@
    +
    Parameters
    @@ -926,6 +937,7 @@ +
    Tags @@ -976,6 +988,7 @@
    +
    Parameters
    @@ -1110,30 +1123,30 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Data-Kanji.html b/classes/chillerlan-QRCode-Data-Kanji.html index decbc36c5..d6c04d5ea 100644 --- a/classes/chillerlan-QRCode-Data-Kanji.html +++ b/classes/chillerlan-QRCode-Data-Kanji.html @@ -161,6 +161,7 @@

    Kanji mode: 13-bit double-byte characters from the Shift-JIS character set

    +

    ISO/IEC 18004:2000 Section 8.3.5 ISO/IEC 18004:2000 Section 8.4.5

    @@ -221,13 +222,13 @@ ISO/IEC 18004:2000 Section 8.4.5

    - DATAMODE + DATAMODE  = \chillerlan\QRCode\Common\Mode::KANJI
    - ENCODING + ENCODING  = 'SJIS'
    @@ -243,7 +244,7 @@ ISO/IEC 18004:2000 Section 8.4.5

    - $data + $data  : string
    @@ -258,56 +259,56 @@ ISO/IEC 18004:2000 Section 8.4.5

    - __construct() + __construct()  : mixed
    QRDataModeAbstract constructor.
    - convertEncoding() + convertEncoding()  : string
    encoding conversion helper
    - decodeSegment() + decodeSegment()  : string
    reads a segment from the BitBuffer and decodes in the current data mode
    - getLengthInBits() + getLengthInBits()  : int
    retruns the length in bits of the data string
    - validateString() + validateString()  : bool
    checks if a string qualifies as SJIS Kanji
    - write() + write()  : static
    writes the actual data string to the BitBuffer, uses the given version to determine the length bits
    - getCharCount() + getCharCount()  : int
    returns the character count of the $data string
    - getLengthBits() + getLengthBits()  : int
    @@ -339,6 +340,7 @@ ISO/IEC 18004:2000 Section 8.4.5

    + public mixed @@ -384,6 +386,7 @@ ISO/IEC 18004:2000 Section 8.4.5

    possible values: SJIS, SJIS-2004

    + public string @@ -433,6 +436,7 @@ ISO/IEC 18004:2000 Section 8.4.5

    The data to write

    + protected string @@ -481,6 +485,7 @@ ISO/IEC 18004:2000 Section 8.4.5

    +
    Parameters
    @@ -540,6 +545,7 @@ ISO/IEC 18004:2000 Section 8.4.5

    +
    Parameters
    @@ -602,6 +608,7 @@ ISO/IEC 18004:2000 Section 8.4.5

    +
    Parameters
    @@ -681,6 +688,7 @@ ISO/IEC 18004:2000 Section 8.4.5

    +
    Tags @@ -731,6 +739,7 @@ ISO/IEC 18004:2000 Section 8.4.5

    +
    Parameters
    @@ -779,6 +788,7 @@ ISO/IEC 18004:2000 Section 8.4.5

    +
    Parameters
    @@ -860,6 +870,7 @@ ISO/IEC 18004:2000 Section 8.4.5

    +
    Tags @@ -910,6 +921,7 @@ ISO/IEC 18004:2000 Section 8.4.5

    +
    Parameters
    @@ -1044,29 +1056,29 @@ ISO/IEC 18004:2000 Section 8.4.5

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Data-Number.html b/classes/chillerlan-QRCode-Data-Number.html index 4fde49a3d..7e8b5a6cd 100644 --- a/classes/chillerlan-QRCode-Data-Number.html +++ b/classes/chillerlan-QRCode-Data-Number.html @@ -161,6 +161,7 @@

    Numeric mode: decimal digits 0 to 9

    +

    ISO/IEC 18004:2000 Section 8.3.2 ISO/IEC 18004:2000 Section 8.4.2

    @@ -190,13 +191,13 @@ ISO/IEC 18004:2000 Section 8.4.2

    - DATAMODE + DATAMODE  = \chillerlan\QRCode\Common\Mode::NUMBER
    - NUMBER_TO_ORD + NUMBER_TO_ORD  = ['0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5, '6' => 6, '7' => 7, '8' => 8, '9' => 9]
    @@ -211,7 +212,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    - $data + $data  : string
    @@ -226,63 +227,63 @@ ISO/IEC 18004:2000 Section 8.4.2

    - __construct() + __construct()  : mixed
    QRDataModeAbstract constructor.
    - convertEncoding() + convertEncoding()  : string
    encoding conversion helper
    - decodeSegment() + decodeSegment()  : string
    reads a segment from the BitBuffer and decodes in the current data mode
    - getLengthInBits() + getLengthInBits()  : int
    retruns the length in bits of the data string
    - validateString() + validateString()  : bool
    checks if the given string qualifies for the encoder module
    - write() + write()  : static
    writes the actual data string to the BitBuffer, uses the given version to determine the length bits
    - getCharCount() + getCharCount()  : int
    returns the character count of the $data string
    - getLengthBits() + getLengthBits()  : int
    shortcut
    - parseInt() + parseInt()  : int
    @@ -314,6 +315,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    + public mixed @@ -358,6 +360,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    + private array<string|int, int> @@ -405,6 +408,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    The data to write

    + protected string @@ -453,6 +457,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    +
    Parameters
    @@ -512,6 +517,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    +
    Parameters
    @@ -574,6 +580,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    +
    Parameters
    @@ -653,6 +660,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    +
    Tags @@ -703,6 +711,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    +
    Parameters
    @@ -765,6 +774,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    +
    Parameters
    @@ -836,6 +846,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    + @@ -872,6 +883,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    +
    Parameters
    @@ -920,6 +932,7 @@ ISO/IEC 18004:2000 Section 8.4.2

    +
    Parameters
    @@ -1054,30 +1067,30 @@ ISO/IEC 18004:2000 Section 8.4.2

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Data-QRCodeDataException.html b/classes/chillerlan-QRCode-Data-QRCodeDataException.html index 1e56ff795..d2d55ce83 100644 --- a/classes/chillerlan-QRCode-Data-QRCodeDataException.html +++ b/classes/chillerlan-QRCode-Data-QRCodeDataException.html @@ -168,6 +168,7 @@ +

    Table of Contents diff --git a/classes/chillerlan-QRCode-Data-QRData.html b/classes/chillerlan-QRCode-Data-QRData.html index b28c44505..7f0a0dff3 100644 --- a/classes/chillerlan-QRCode-Data-QRData.html +++ b/classes/chillerlan-QRCode-Data-QRData.html @@ -165,6 +165,7 @@ +

    Table of Contents @@ -186,41 +187,41 @@

    - $bitBuffer + $bitBuffer  : BitBuffer
    a BitBuffer instance
    - $dataSegments + $dataSegments  : array<string|int, QRDataModeInterface>
    - $eccLevel + $eccLevel  : EccLevel
    an EccLevel instance
    - $maxBitsForEcc + $maxBitsForEcc  : array<string|int, int>
    Max bits for the current ECC mode
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $version + $version  : Version
    @@ -235,56 +236,56 @@
    - __construct() + __construct()  : mixed
    QRData constructor.
    - estimateTotalBitLength() + estimateTotalBitLength()  : int
    estimates the total length of the several mode segments in order to guess the minimum version
    - getBitBuffer() + getBitBuffer()  : BitBuffer
    Returns the current BitBuffer instance
    - getMinimumVersion() + getMinimumVersion()  : Version
    returns the minimum version number for the given string
    - setBitBuffer() + setBitBuffer()  : self
    Sets a BitBuffer object
    - setData() + setData()  : self
    Sets the data string (internally called by the constructor)
    - writeMatrix() + writeMatrix()  : QRMatrix
    returns a fresh matrix object with the data written and masked with the given $maskPattern
    - writeBitBuffer() + writeBitBuffer()  : void
    @@ -326,6 +327,7 @@

    a BitBuffer instance

    + private BitBuffer @@ -361,6 +363,7 @@ + private array<string|int, QRDataModeInterface> @@ -397,6 +400,7 @@

    an EccLevel instance

    + private EccLevel @@ -433,6 +437,7 @@

    Max bits for the current ECC mode

    + private array<string|int, int> @@ -469,6 +474,7 @@

    the options instance

    + private SettingsContainerInterface|QROptions @@ -505,6 +511,7 @@

    current QR Code version

    + private Version @@ -553,6 +560,7 @@
    +
    Parameters
    @@ -606,6 +614,7 @@ +
    Tags @@ -659,6 +668,7 @@ +
    Tags @@ -711,6 +721,7 @@ +
    Tags @@ -761,6 +772,7 @@
    +

    This can be used instead of setData(), however, the version auto-detection is not available in this case. The version needs to match the length bits range for the data mode the data has been encoded with, additionally the bit array needs to contain enough pad bits.

    @@ -828,6 +840,7 @@ additionally the bit array needs to contain enough pad bits.

    +

    Subsequent calls will overwrite the current state - use the QRCode::add*Segement() method instead

    @@ -881,6 +894,7 @@ additionally the bit array needs to contain enough pad bits.

    + @@ -919,6 +933,7 @@ additionally the bit array needs to contain enough pad bits.

    +
    Tags @@ -1054,26 +1069,26 @@ additionally the bit array needs to contain enough pad bits.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Data-QRDataModeAbstract.html b/classes/chillerlan-QRCode-Data-QRDataModeAbstract.html index c250886f2..b112e4bbf 100644 --- a/classes/chillerlan-QRCode-Data-QRDataModeAbstract.html +++ b/classes/chillerlan-QRCode-Data-QRDataModeAbstract.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -196,7 +197,7 @@

    - $data + $data  : string
    @@ -211,28 +212,28 @@
    - __construct() + __construct()  : mixed
    QRDataModeAbstract constructor.
    - convertEncoding() + convertEncoding()  : string
    encoding conversion helper
    - getCharCount() + getCharCount()  : int
    returns the character count of the $data string
    - getLengthBits() + getLengthBits()  : int
    @@ -274,6 +275,7 @@

    The data to write

    + protected string @@ -322,6 +324,7 @@
    +
    Parameters
    @@ -381,6 +384,7 @@
    +
    Parameters
    @@ -445,6 +449,7 @@ + @@ -481,6 +486,7 @@
    +
    Parameters
    @@ -615,17 +621,17 @@
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Data-QRDataModeInterface.html b/classes/chillerlan-QRCode-Data-QRDataModeInterface.html index d6e0e9878..62dd7976e 100644 --- a/classes/chillerlan-QRCode-Data-QRDataModeInterface.html +++ b/classes/chillerlan-QRCode-Data-QRDataModeInterface.html @@ -154,6 +154,7 @@ +

    Table of Contents @@ -173,7 +174,7 @@

    - DATAMODE + DATAMODE  = -1
    @@ -190,35 +191,35 @@
    - convertEncoding() + convertEncoding()  : string
    encoding conversion helper
    - decodeSegment() + decodeSegment()  : string
    reads a segment from the BitBuffer and decodes in the current data mode
    - getLengthInBits() + getLengthInBits()  : int
    retruns the length in bits of the data string
    - validateString() + validateString()  : bool
    checks if the given string qualifies for the encoder module
    - write() + write()  : static
    @@ -252,6 +253,7 @@

    the current data mode: Number, Alphanum, Kanji, Hanzi, Byte, ECI

    + public int @@ -319,6 +321,7 @@
    +
    Parameters
    @@ -382,6 +385,7 @@
    +
    Parameters
    @@ -439,6 +443,7 @@ + @@ -475,6 +480,7 @@
    +
    Parameters
    @@ -523,6 +529,7 @@
    +
    Parameters
    @@ -678,18 +685,18 @@
  • Methods
  • Constants
    • diff --git a/classes/chillerlan-QRCode-Data-QRMatrix.html b/classes/chillerlan-QRCode-Data-QRMatrix.html index df048ee1e..f480984c6 100644 --- a/classes/chillerlan-QRCode-Data-QRMatrix.html +++ b/classes/chillerlan-QRCode-Data-QRMatrix.html @@ -159,6 +159,7 @@ maps the ECC coded binary data and applies the mask pattern

    +
    Tags @@ -198,151 +199,151 @@ maps the ECC coded binary data and applies the mask pattern

    - IS_DARK + IS_DARK  = 0b100000000000
    - M_ALIGNMENT + M_ALIGNMENT  = 0b10000
    - M_ALIGNMENT_DARK + M_ALIGNMENT_DARK  = 0b100000010000
    - M_DARKMODULE + M_DARKMODULE  = 0b100000000001
    - M_DARKMODULE_LIGHT + M_DARKMODULE_LIGHT  = 0b1
    - M_DATA + M_DATA  = 0b10
    - M_DATA_DARK + M_DATA_DARK  = 0b100000000010
    - M_FINDER + M_FINDER  = 0b100
    - M_FINDER_DARK + M_FINDER_DARK  = 0b100000000100
    - M_FINDER_DOT + M_FINDER_DOT  = 0b110000000000
    - M_FINDER_DOT_LIGHT + M_FINDER_DOT_LIGHT  = 0b10000000000
    - M_FORMAT + M_FORMAT  = 0b1000000
    - M_FORMAT_DARK + M_FORMAT_DARK  = 0b100001000000
    - M_LOGO + M_LOGO  = 0b1000000000
    - M_LOGO_DARK + M_LOGO_DARK  = 0b101000000000
    - M_NULL + M_NULL  = 0b0
    - M_QUIETZONE + M_QUIETZONE  = 0b100000000
    - M_QUIETZONE_DARK + M_QUIETZONE_DARK  = 0b100100000000
    - M_SEPARATOR + M_SEPARATOR  = 0b1000
    - M_SEPARATOR_DARK + M_SEPARATOR_DARK  = 0b100000001000
    - M_TIMING + M_TIMING  = 0b100000
    - M_TIMING_DARK + M_TIMING_DARK  = 0b100000100000
    - M_VERSION + M_VERSION  = 0b10000000
    - M_VERSION_DARK + M_VERSION_DARK  = 0b100010000000
    - neighbours + neighbours  = [0b1 => [-1, -1], 0b10 => [0, -1], 0b100 => [1, -1], 0b1000 => [1, 0], 0b10000 => [1, 1], 0b100000 => [0, 1], 0b1000000 => [-1, 1], 0b10000000 => [-1, 0]]
    @@ -358,35 +359,35 @@ maps the ECC coded binary data and applies the mask pattern

    - $eccLevel + $eccLevel  : EccLevel|null
    the current ECC level - always set in QRMatrix, may be null in BitMatrix
    - $maskPattern + $maskPattern  : MaskPattern|null
    the mask pattern that was used in the most recent operation, set via:
    - $matrix + $matrix  : array<string|int, array<string|int, int>>
    the actual matrix data array
    - $moduleCount + $moduleCount  : int
    the size (side length) of the matrix, including quiet zone (if created)
    - $version + $version  : Version|null
    @@ -401,35 +402,35 @@ maps the ECC coded binary data and applies the mask pattern

    - __construct() + __construct()  : mixed
    QRMatrix constructor.
    - check() + check()  : bool
    Checks whether the module at ($x, $y) is true (dark) or false (light)
    - checkNeighbours() + checkNeighbours()  : int
    Checks the status of the neighbouring modules for the module at ($x, $y) and returns a bitmask with the results.
    - checkType() + checkType()  : bool
    Checks whether the module at ($x, $y) is of the given $M_TYPE
    - checkTypeIn() + checkTypeIn()  : bool
    @@ -437,175 +438,175 @@ maps the ECC coded binary data and applies the mask pattern

    returns true if a match is found, otherwise false.
    - flip() + flip()  : static
    Flips the value of the module at ($x, $y)
    - get() + get()  : int
    Returns the value of the module at position [$x, $y] or -1 if the coordinate is outside the matrix
    - getEccLevel() + getEccLevel()  : EccLevel|null
    Returns the current ECC level
    - getMaskPattern() + getMaskPattern()  : MaskPattern|null
    Returns the current mask pattern
    - getMatrix() + getMatrix()  : array<string|int, array<string|int, int>>|array<string|int, array<string|int, bool>>
    Returns the data matrix, returns a pure boolean representation if $boolean is set to true
    - getSize() + getSize()  : int
    Returns the absoulute size of the matrix, including quiet zone (after setting it).
    - getVersion() + getVersion()  : Version|null
    Returns the current version number
    - initFunctionalPatterns() + initFunctionalPatterns()  : static
    shortcut to initialize the functional patterns
    - invert() + invert()  : static
    Inverts the values of the whole matrix
    - isDark() + isDark()  : bool
    Checks whether the given $M_TYPE is a dark value
    - mask() + mask()  : static
    Applies/reverses the mask pattern
    - rotate90() + rotate90()  : static
    Rotates the matrix by 90 degrees clock wise
    - set() + set()  : static
    Sets the $M_TYPE value for the module at position [$x, $y]
    - setAlignmentPattern() + setAlignmentPattern()  : static
    Draws the 5x5 alignment patterns
    - setArea() + setArea()  : static
    Fills an area of $width * $height, from the given starting point [$startX, $startY] (top left) with $value for $M_TYPE.
    - setDarkModule() + setDarkModule()  : static
    Sets the "dark module", that is always on the same position 1x1px away from the bottom left finder
    - setFinderPattern() + setFinderPattern()  : static
    Draws the 7x7 finder patterns in the corners top left/right and bottom left
    - setFormatInfo() + setFormatInfo()  : static
    Draws the format info along the finder patterns. If no $maskPattern, all format info modules will be set to false.
    - setLogoSpace() + setLogoSpace()  : static
    Clears a space of $width * $height in order to add a logo or text.
    - setQuietZone() + setQuietZone()  : static
    Draws the "quiet zone" of $size around the matrix
    - setSeparators() + setSeparators()  : static
    Draws the separator lines around the finder patterns
    - setTimingPattern() + setTimingPattern()  : static
    Draws the timing pattern (h/v checkered line between the finder patterns)
    - setVersionNumber() + setVersionNumber()  : static
    Draws the version information, 2x 3x6 pixel
    - writeCodewords() + writeCodewords()  : static
    Maps the interleaved binary $data on the matrix
    - createMatrix() + createMatrix()  : array<string|int, mixed>
    @@ -637,6 +638,7 @@ returns true if a match is found, otherwise false. + public int @@ -667,6 +669,7 @@ returns true if a match is found, otherwise false. + public int @@ -697,6 +700,7 @@ returns true if a match is found, otherwise false. + public int @@ -727,6 +731,7 @@ returns true if a match is found, otherwise false. + public int @@ -757,6 +762,7 @@ returns true if a match is found, otherwise false. + public int @@ -787,6 +793,7 @@ returns true if a match is found, otherwise false. + public int @@ -817,6 +824,7 @@ returns true if a match is found, otherwise false. + public int @@ -847,6 +855,7 @@ returns true if a match is found, otherwise false. + public int @@ -877,6 +886,7 @@ returns true if a match is found, otherwise false. + public int @@ -907,6 +917,7 @@ returns true if a match is found, otherwise false. + public int @@ -937,6 +948,7 @@ returns true if a match is found, otherwise false. + public int @@ -967,6 +979,7 @@ returns true if a match is found, otherwise false. + public int @@ -997,6 +1010,7 @@ returns true if a match is found, otherwise false. + public int @@ -1027,6 +1041,7 @@ returns true if a match is found, otherwise false. + public int @@ -1057,6 +1072,7 @@ returns true if a match is found, otherwise false. + public int @@ -1087,6 +1103,7 @@ returns true if a match is found, otherwise false. + public int @@ -1117,6 +1134,7 @@ returns true if a match is found, otherwise false. + public int @@ -1147,6 +1165,7 @@ returns true if a match is found, otherwise false. + public int @@ -1177,6 +1196,7 @@ returns true if a match is found, otherwise false. + public int @@ -1207,6 +1227,7 @@ returns true if a match is found, otherwise false. + public int @@ -1237,6 +1258,7 @@ returns true if a match is found, otherwise false. + public int @@ -1267,6 +1289,7 @@ returns true if a match is found, otherwise false. + public int @@ -1297,6 +1320,7 @@ returns true if a match is found, otherwise false. + public int @@ -1327,6 +1351,7 @@ returns true if a match is found, otherwise false. + public int @@ -1358,6 +1383,7 @@ returns true if a match is found, otherwise false.

    Map of flag => coord

    + protected array<string|int, mixed> @@ -1420,6 +1446,7 @@ returns true if a match is found, otherwise false.

    the current ECC level - always set in QRMatrix, may be null in BitMatrix

    + protected EccLevel|null @@ -1456,6 +1483,7 @@ returns true if a match is found, otherwise false.

    the mask pattern that was used in the most recent operation, set via:

    + protected MaskPattern|null @@ -1498,6 +1526,7 @@ returns true if a match is found, otherwise false.

    the actual matrix data array

    + protected array<string|int, array<string|int, int>> @@ -1534,6 +1563,7 @@ returns true if a match is found, otherwise false.

    the size (side length) of the matrix, including quiet zone (if created)

    + protected int @@ -1570,6 +1600,7 @@ returns true if a match is found, otherwise false.

    the matrix version - always set in QRMatrix, may be null in BitMatrix

    + protected Version|null @@ -1618,6 +1649,7 @@ returns true if a match is found, otherwise false.
    +
    Parameters
    @@ -1668,6 +1700,7 @@ returns true if a match is found, otherwise false.
    +

    Also, returns false if the given coordinates are out of range.

    @@ -1725,6 +1758,7 @@ returns true if a match is found, otherwise false.
    +

    The 8 flags of the bitmask represent the status of each of the neighbouring fields, starting with the lowest bit for top left, going clockwise:

    0 1 2 @@ -1793,6 +1827,7 @@ starting with the lowest bit for top left, going clockwise:

    +

    true => $value & $M_TYPE === $M_TYPE

    Also, returns false if the given coordinates are out of range.

    @@ -1860,6 +1895,7 @@ returns true if a match is found, otherwise false.

    +
    Parameters
    @@ -1922,6 +1958,7 @@ returns true if a match is found, otherwise false.

    +
    Parameters
    @@ -1977,6 +2014,7 @@ returns true if a match is found, otherwise false.

    +
    Parameters
    @@ -2034,6 +2072,7 @@ returns true if a match is found, otherwise false.

    + @@ -2072,6 +2111,7 @@ returns true if a match is found, otherwise false.

    + @@ -2108,6 +2148,7 @@ returns true if a match is found, otherwise false.

    +
    Parameters
    @@ -2155,6 +2196,7 @@ returns true if a match is found, otherwise false.

    +

    size = version * 4 + 17 [ + 2 * quietzone size]

    @@ -2198,6 +2240,7 @@ returns true if a match is found, otherwise false.

    + @@ -2236,6 +2279,7 @@ returns true if a match is found, otherwise false.

    + @@ -2271,6 +2315,7 @@ returns true if a match is found, otherwise false.

    +

    ISO/IEC 18004:2015 Section 6.2 - Reflectance reversal

    @@ -2312,6 +2357,7 @@ returns true if a match is found, otherwise false.

    +
    Parameters
    @@ -2359,6 +2405,7 @@ returns true if a match is found, otherwise false.

    +

    ISO/IEC 18004:2000 Section 8.8.1

    @@ -2412,6 +2459,7 @@ returns true if a match is found, otherwise false.

    + @@ -2447,6 +2495,7 @@ returns true if a match is found, otherwise false.

    +

    true => $M_TYPE | 0x800 false => $M_TYPE

    @@ -2519,6 +2568,7 @@ false => $M_TYPE

    +

    ISO/IEC 18004:2000 Section 7.3.5

    @@ -2560,6 +2610,7 @@ false => $M_TYPE

    +
    Parameters
    @@ -2642,6 +2693,7 @@ false => $M_TYPE

    +

    4 * version + 9 or moduleCount - 8

    @@ -2682,6 +2734,7 @@ false => $M_TYPE

    +

    ISO/IEC 18004:2000 Section 7.3.2

    @@ -2722,6 +2775,7 @@ false => $M_TYPE

    +

    ISO/IEC 18004:2000 Section 8.9

    @@ -2772,6 +2826,7 @@ false => $M_TYPE

    +

    If no $height is given, the space will be assumed a square of $width.

    Additionally, the logo space can be positioned within the QR Code using $startX and $startY. If either of these are null, the logo space will be centered in that direction. @@ -2875,6 +2930,7 @@ Note that there is no restiction on how many times this method could be called o

    +

    ISO/IEC 18004:2000 Section 7.3.7

    @@ -2940,6 +2996,7 @@ Note that there is no restiction on how many times this method could be called o
    +

    ISO/IEC 18004:2000 Section 7.3.3

    @@ -2980,6 +3037,7 @@ Note that there is no restiction on how many times this method could be called o
    +

    ISO/IEC 18004:2000 Section 7.3.4

    @@ -3020,6 +3078,7 @@ Note that there is no restiction on how many times this method could be called o
    +

    ISO/IEC 18004:2000 Section 8.10

    @@ -3061,6 +3120,7 @@ Note that there is no restiction on how many times this method could be called o
    +
    Parameters
    @@ -3109,6 +3169,7 @@ Note that there is no restiction on how many times this method could be called o
    +
    Parameters
    @@ -3250,78 +3311,78 @@ Note that there is no restiction on how many times this method could be called o
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html b/classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html index ebc787a88..53f2bb07d 100644 --- a/classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html +++ b/classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html @@ -160,6 +160,7 @@ +
    Tags @@ -201,25 +202,25 @@
    - $eccLevel + $eccLevel  : EccLevel
    - $interleavedData + $interleavedData  : array<string|int, mixed>
    - $interleavedDataIndex + $interleavedDataIndex  : int
    - $version + $version  : Version
    @@ -233,27 +234,27 @@
    - __construct() + __construct()  : mixed
    ReedSolomonDecoder constructor
    - interleaveEcBytes() + interleaveEcBytes()  : array<string|int, mixed>
    ECC encoding and interleaving
    - encode() + encode()  : array<string|int, mixed>
    - interleave() + interleave()  : void
    @@ -293,6 +294,7 @@ + private EccLevel @@ -328,6 +330,7 @@ + private array<string|int, mixed> @@ -363,6 +366,7 @@ + private int @@ -398,6 +402,7 @@ + private Version @@ -446,6 +451,7 @@
    +
    Parameters
    @@ -497,6 +503,7 @@
    +
    Parameters
    @@ -559,6 +566,7 @@
    +
    Parameters
    @@ -613,6 +621,7 @@
    +
    Parameters
    @@ -757,20 +766,20 @@
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Decoder-Binarizer.html b/classes/chillerlan-QRCode-Decoder-Binarizer.html index 5aa60a234..bdf0c5e4b 100644 --- a/classes/chillerlan-QRCode-Decoder-Binarizer.html +++ b/classes/chillerlan-QRCode-Decoder-Binarizer.html @@ -161,6 +161,7 @@ GlobalHistogramBinarizer, is fairly efficient for what it does. It is designed f high frequency images of barcodes with black data on white backgrounds. For this application, it does a much better job than a global blackpoint with severe shadows and gradients.

    +

    However, it tends to produce artifacts on lower frequency images and is therefore not a good general purpose binarizer for uses outside ZXing.

    This class extends GlobalHistogramBinarizer, using the older histogram approach for 1D readers, @@ -211,43 +212,43 @@ but for now it was not a win to use local blocks for 1D.

    - BLOCK_SIZE + BLOCK_SIZE  = 8
    - BLOCK_SIZE_MASK + BLOCK_SIZE_MASK  = 7
    - BLOCK_SIZE_POWER + BLOCK_SIZE_POWER  = 3
    - LUMINANCE_BUCKETS + LUMINANCE_BUCKETS  = 32
    - LUMINANCE_SHIFT + LUMINANCE_SHIFT  = 3
    - MIN_DYNAMIC_RANGE + MIN_DYNAMIC_RANGE  = 24
    - MINIMUM_DIMENSION + MINIMUM_DIMENSION  = 40
    @@ -262,13 +263,13 @@ but for now it was not a win to use local blocks for 1D.

    - $luminances + $luminances  : array<string|int, mixed>
    - $source + $source  : LuminanceSourceInterface
    @@ -282,13 +283,13 @@ but for now it was not a win to use local blocks for 1D.

    - __construct() + __construct()  : mixed
    - getBlackMatrix() + getBlackMatrix()  : BitMatrix
    @@ -297,14 +298,14 @@ constructor instead, but there are some advantages to doing it lazily, such as m profiling easier, and not doing heavy lifting when callers don't expect it.
    - calculateBlackPoints() + calculateBlackPoints()  : array<string|int, mixed>
    Calculates a single black point for each block of pixels and saves it away.
    - calculateThresholdForBlock() + calculateThresholdForBlock()  : BitMatrix
    @@ -313,19 +314,19 @@ of the surrounding blocks. Also handles the corner cases (fractional blocks are on the last pixels in the row/column which are also used in the previous block).
    - cap() + cap()  : int
    - estimateBlackPoint() + estimateBlackPoint()  : int
    - getHistogramBlackMatrix() + getHistogramBlackMatrix()  : BitMatrix
    @@ -356,6 +357,7 @@ on the last pixels in the row/column which are also used in the previous block). + private mixed @@ -386,6 +388,7 @@ on the last pixels in the row/column which are also used in the previous block). + private mixed @@ -416,6 +419,7 @@ on the last pixels in the row/column which are also used in the previous block). + private mixed @@ -446,6 +450,7 @@ on the last pixels in the row/column which are also used in the previous block). + private mixed @@ -476,6 +481,7 @@ on the last pixels in the row/column which are also used in the previous block). + private mixed @@ -506,6 +512,7 @@ on the last pixels in the row/column which are also used in the previous block). + private mixed @@ -536,6 +543,7 @@ on the last pixels in the row/column which are also used in the previous block). + private mixed @@ -582,6 +590,7 @@ on the last pixels in the row/column which are also used in the previous block). + private array<string|int, mixed> @@ -617,6 +626,7 @@ on the last pixels in the row/column which are also used in the previous block). + private LuminanceSourceInterface @@ -664,6 +674,7 @@ on the last pixels in the row/column which are also used in the previous block).
    +
    Parameters
    @@ -709,6 +720,7 @@ profiling easier, and not doing heavy lifting when callers don't expect it.
    +

    Converts a 2D array of luminance data to 1 bit data. As above, assume this method is expensive and do not call it repeatedly. This method is intended for decoding 2D barcodes and may or may not apply sharpening. Therefore, a row from this matrix may not be identical to one @@ -756,6 +768,7 @@ fetched using getBlackRow(), so don't mix and match between them.

    +

    See the following thread for a discussion of this algorithm:

    @@ -845,6 +858,7 @@ on the last pixels in the row/column which are also used in the previous block).
    +
    Parameters
    @@ -913,6 +927,7 @@ on the last pixels in the row/column which are also used in the previous block).
    +
    Parameters
    @@ -990,6 +1005,7 @@ on the last pixels in the row/column which are also used in the previous block).
    +
    Parameters
    @@ -1052,6 +1068,7 @@ on the last pixels in the row/column which are also used in the previous block).
    +
    Parameters
    @@ -1193,34 +1210,34 @@ on the last pixels in the row/column which are also used in the previous block).
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Decoder-BitMatrix.html b/classes/chillerlan-QRCode-Decoder-BitMatrix.html index 4e0546c94..20996761a 100644 --- a/classes/chillerlan-QRCode-Decoder-BitMatrix.html +++ b/classes/chillerlan-QRCode-Decoder-BitMatrix.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,158 +188,158 @@

    - IS_DARK + IS_DARK  = 0b100000000000
    - M_ALIGNMENT + M_ALIGNMENT  = 0b10000
    - M_ALIGNMENT_DARK + M_ALIGNMENT_DARK  = 0b100000010000
    - M_DARKMODULE + M_DARKMODULE  = 0b100000000001
    - M_DARKMODULE_LIGHT + M_DARKMODULE_LIGHT  = 0b1
    - M_DATA + M_DATA  = 0b10
    - M_DATA_DARK + M_DATA_DARK  = 0b100000000010
    - M_FINDER + M_FINDER  = 0b100
    - M_FINDER_DARK + M_FINDER_DARK  = 0b100000000100
    - M_FINDER_DOT + M_FINDER_DOT  = 0b110000000000
    - M_FINDER_DOT_LIGHT + M_FINDER_DOT_LIGHT  = 0b10000000000
    - M_FORMAT + M_FORMAT  = 0b1000000
    - M_FORMAT_DARK + M_FORMAT_DARK  = 0b100001000000
    - M_LOGO + M_LOGO  = 0b1000000000
    - M_LOGO_DARK + M_LOGO_DARK  = 0b101000000000
    - M_NULL + M_NULL  = 0b0
    - M_QUIETZONE + M_QUIETZONE  = 0b100000000
    - M_QUIETZONE_DARK + M_QUIETZONE_DARK  = 0b100100000000
    - M_SEPARATOR + M_SEPARATOR  = 0b1000
    - M_SEPARATOR_DARK + M_SEPARATOR_DARK  = 0b100000001000
    - M_TIMING + M_TIMING  = 0b100000
    - M_TIMING_DARK + M_TIMING_DARK  = 0b100000100000
    - M_VERSION + M_VERSION  = 0b10000000
    - M_VERSION_DARK + M_VERSION_DARK  = 0b100010000000
    - neighbours + neighbours  = [0b1 => [-1, -1], 0b10 => [0, -1], 0b100 => [1, -1], 0b1000 => [1, 0], 0b10000 => [1, 1], 0b100000 => [0, 1], 0b1000000 => [-1, 1], 0b10000000 => [-1, 0]]
    Map of flag => coord
    - DECODE_LOOKUP + DECODE_LOOKUP  = [ 0x5412, @@ -409,7 +410,7 @@
    See ISO 18004:2006, Annex C, Table C.1
    - FORMAT_INFO_MASK_QR + FORMAT_INFO_MASK_QR  = 0x5412
    @@ -424,42 +425,42 @@
    - $eccLevel + $eccLevel  : EccLevel|null
    the current ECC level - always set in QRMatrix, may be null in BitMatrix
    - $maskPattern + $maskPattern  : MaskPattern|null
    the mask pattern that was used in the most recent operation, set via:
    - $matrix + $matrix  : array<string|int, array<string|int, int>>
    the actual matrix data array
    - $moduleCount + $moduleCount  : int
    the size (side length) of the matrix, including quiet zone (if created)
    - $version + $version  : Version|null
    the matrix version - always set in QRMatrix, may be null in BitMatrix
    - $mirror + $mirror  : bool
    @@ -474,35 +475,35 @@
    - __construct() + __construct()  : mixed
    QRMatrix constructor.
    - check() + check()  : bool
    Checks whether the module at ($x, $y) is true (dark) or false (light)
    - checkNeighbours() + checkNeighbours()  : int
    Checks the status of the neighbouring modules for the module at ($x, $y) and returns a bitmask with the results.
    - checkType() + checkType()  : bool
    Checks whether the module at ($x, $y) is of the given $M_TYPE
    - checkTypeIn() + checkTypeIn()  : bool
    @@ -510,91 +511,91 @@ returns true if a match is found, otherwise false.
    - flip() + flip()  : static
    Flips the value of the module at ($x, $y)
    - get() + get()  : int
    Returns the value of the module at position [$x, $y] or -1 if the coordinate is outside the matrix
    - getEccLevel() + getEccLevel()  : EccLevel|null
    Returns the current ECC level
    - getMaskPattern() + getMaskPattern()  : MaskPattern|null
    Returns the current mask pattern
    - getMatrix() + getMatrix()  : array<string|int, array<string|int, int>>|array<string|int, array<string|int, bool>>
    Returns the data matrix, returns a pure boolean representation if $boolean is set to true
    - getSize() + getSize()  : int
    Returns the absoulute size of the matrix, including quiet zone (after setting it).
    - getVersion() + getVersion()  : Version|null
    Returns the current version number
    - initFunctionalPatterns() + initFunctionalPatterns()  : static
    shortcut to initialize the functional patterns
    - invert() + invert()  : static
    Inverts the values of the whole matrix
    - isDark() + isDark()  : bool
    Checks whether the given $M_TYPE is a dark value
    - mask() + mask()  : static
    Applies/reverses the mask pattern
    - mirrorDiagonal() + mirrorDiagonal()  : static
    Mirror the bit matrix diagonally in order to attempt a second reading.
    - readCodewords() + readCodewords()  : array<string|int, mixed>
    @@ -603,152 +604,152 @@ correct order in order to reconstruct the codewords bytes contained within the QR Code. Throws if the exact number of bytes expected is not read.
    - resetVersionInfo() + resetVersionInfo()  : static
    Resets the current version info in order to attempt another reading
    - rotate90() + rotate90()  : static
    Rotates the matrix by 90 degrees clock wise
    - set() + set()  : static
    Sets the $M_TYPE value for the module at position [$x, $y]
    - setAlignmentPattern() + setAlignmentPattern()  : static
    Draws the 5x5 alignment patterns
    - setArea() + setArea()  : static
    Fills an area of $width * $height, from the given starting point [$startX, $startY] (top left) with $value for $M_TYPE.
    - setDarkModule() + setDarkModule()  : static
    Sets the "dark module", that is always on the same position 1x1px away from the bottom left finder
    - setFinderPattern() + setFinderPattern()  : static
    Draws the 7x7 finder patterns in the corners top left/right and bottom left
    - setFormatInfo() + setFormatInfo()  : static
    Draws the format info along the finder patterns. If no $maskPattern, all format info modules will be set to false.
    - setLogoSpace() + setLogoSpace()  : static
    Clears a space of $width * $height in order to add a logo or text.
    - setQuietZone() + setQuietZone()  : static
    Draws the "quiet zone" of $size around the matrix
    - setSeparators() + setSeparators()  : static
    Draws the separator lines around the finder patterns
    - setTimingPattern() + setTimingPattern()  : static
    Draws the timing pattern (h/v checkered line between the finder patterns)
    - setVersionNumber() + setVersionNumber()  : static
    Draws the version information, 2x 3x6 pixel
    - writeCodewords() + writeCodewords()  : static
    Maps the interleaved binary $data on the matrix
    - createMatrix() + createMatrix()  : array<string|int, mixed>
    Creates a 2-dimensional array (square) of the given $size
    - copyVersionBit() + copyVersionBit()  : int
    - decodeVersionInformation() + decodeVersionInformation()  : Version|null
    Decodes the version information from the given bit sequence, returns null if no valid match is found.
    - doDecodeFormatInformation() + doDecodeFormatInformation()  : int|null
    Returns information about the format it specifies, or null if it doesn't seem to match any known pattern
    - numBitsDiffering() + numBitsDiffering()  : int
    - readFormatInformation() + readFormatInformation()  : static
    Reads format information from one of its two locations within the QR Code.
    - readVersion() + readVersion()  : static
    Reads version information from one of its two locations within the QR Code.
    - uRShift() + uRShift()  : int
    @@ -779,6 +780,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -809,6 +811,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -839,6 +842,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -869,6 +873,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -899,6 +904,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -929,6 +935,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -959,6 +966,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -989,6 +997,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1019,6 +1028,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1049,6 +1059,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1079,6 +1090,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1109,6 +1121,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1139,6 +1152,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1169,6 +1183,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1199,6 +1214,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1229,6 +1245,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1259,6 +1276,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1289,6 +1307,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1319,6 +1338,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1349,6 +1369,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1379,6 +1400,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1409,6 +1431,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1439,6 +1462,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1469,6 +1493,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + public int @@ -1500,6 +1525,7 @@ QR Code. Throws if the exact number of bytes expected is not read.

    Map of flag => coord

    + protected array<string|int, mixed> @@ -1546,6 +1572,7 @@ QR Code. Throws if the exact number of bytes expected is not read.

    See ISO 18004:2006, Annex C, Table C.1

    + private mixed @@ -1642,6 +1669,7 @@ QR Code. Throws if the exact number of bytes expected is not read. + private mixed @@ -1689,6 +1717,7 @@ QR Code. Throws if the exact number of bytes expected is not read.

    the current ECC level - always set in QRMatrix, may be null in BitMatrix

    + protected EccLevel|null @@ -1725,6 +1754,7 @@ QR Code. Throws if the exact number of bytes expected is not read.

    the mask pattern that was used in the most recent operation, set via:

    + protected MaskPattern|null @@ -1767,6 +1797,7 @@ QR Code. Throws if the exact number of bytes expected is not read.

    the actual matrix data array

    + protected array<string|int, array<string|int, int>> @@ -1803,6 +1834,7 @@ QR Code. Throws if the exact number of bytes expected is not read.

    the size (side length) of the matrix, including quiet zone (if created)

    + protected int @@ -1839,6 +1871,7 @@ QR Code. Throws if the exact number of bytes expected is not read.

    the matrix version - always set in QRMatrix, may be null in BitMatrix

    + protected Version|null @@ -1875,6 +1908,7 @@ QR Code. Throws if the exact number of bytes expected is not read.

    This flag has effect only on the copyVersionBit() method.

    + private bool @@ -1925,6 +1959,7 @@ QR Code. Throws if the exact number of bytes expected is not read.
    +
    Parameters
    @@ -1984,6 +2019,7 @@ QR Code. Throws if the exact number of bytes expected is not read.
    +

    Also, returns false if the given coordinates are out of range.

    @@ -2041,6 +2077,7 @@ QR Code. Throws if the exact number of bytes expected is not read.
    +

    The 8 flags of the bitmask represent the status of each of the neighbouring fields, starting with the lowest bit for top left, going clockwise:

    0 1 2 @@ -2109,6 +2146,7 @@ starting with the lowest bit for top left, going clockwise:

    +

    true => $value & $M_TYPE === $M_TYPE

    Also, returns false if the given coordinates are out of range.

    @@ -2176,6 +2214,7 @@ returns true if a match is found, otherwise false.

    +
    Parameters
    @@ -2238,6 +2277,7 @@ returns true if a match is found, otherwise false.

    +
    Parameters
    @@ -2293,6 +2333,7 @@ returns true if a match is found, otherwise false.

    +
    Parameters
    @@ -2350,6 +2391,7 @@ returns true if a match is found, otherwise false.

    + @@ -2388,6 +2430,7 @@ returns true if a match is found, otherwise false.

    + @@ -2424,6 +2467,7 @@ returns true if a match is found, otherwise false.

    +
    Parameters
    @@ -2471,6 +2515,7 @@ returns true if a match is found, otherwise false.

    +

    size = version * 4 + 17 [ + 2 * quietzone size]

    @@ -2514,6 +2559,7 @@ returns true if a match is found, otherwise false.

    + @@ -2552,6 +2598,7 @@ returns true if a match is found, otherwise false.

    + @@ -2587,6 +2634,7 @@ returns true if a match is found, otherwise false.

    +

    ISO/IEC 18004:2015 Section 6.2 - Reflectance reversal

    @@ -2628,6 +2676,7 @@ returns true if a match is found, otherwise false.

    +
    Parameters
    @@ -2675,6 +2724,7 @@ returns true if a match is found, otherwise false.

    +

    ISO/IEC 18004:2000 Section 8.8.1

    @@ -2728,6 +2778,7 @@ returns true if a match is found, otherwise false.

    + @@ -2768,6 +2819,7 @@ QR Code. Throws if the exact number of bytes expected is not read.

    +
    Tags @@ -2821,6 +2873,7 @@ QR Code. Throws if the exact number of bytes expected is not read.

    + @@ -2859,6 +2912,7 @@ QR Code. Throws if the exact number of bytes expected is not read.

    + @@ -2894,6 +2948,7 @@ QR Code. Throws if the exact number of bytes expected is not read.

    +

    true => $M_TYPE | 0x800 false => $M_TYPE

    @@ -2966,6 +3021,7 @@ false => $M_TYPE

    +

    ISO/IEC 18004:2000 Section 7.3.5

    @@ -3007,6 +3063,7 @@ false => $M_TYPE

    +
    Parameters
    @@ -3089,6 +3146,7 @@ false => $M_TYPE

    +

    4 * version + 9 or moduleCount - 8

    @@ -3129,6 +3187,7 @@ false => $M_TYPE

    +

    ISO/IEC 18004:2000 Section 7.3.2

    @@ -3169,6 +3228,7 @@ false => $M_TYPE

    +

    ISO/IEC 18004:2000 Section 8.9

    @@ -3220,6 +3280,7 @@ false => $M_TYPE

    +
    Parameters
    @@ -3311,6 +3372,7 @@ false => $M_TYPE

    +
    Parameters
    @@ -3380,6 +3442,7 @@ false => $M_TYPE

    +

    ISO/IEC 18004:2000 Section 7.3.3

    @@ -3420,6 +3483,7 @@ false => $M_TYPE

    +

    ISO/IEC 18004:2000 Section 7.3.4

    @@ -3460,6 +3524,7 @@ false => $M_TYPE

    +

    ISO/IEC 18004:2000 Section 8.10

    @@ -3501,6 +3566,7 @@ false => $M_TYPE

    +
    Parameters
    @@ -3549,6 +3615,7 @@ false => $M_TYPE

    +
    Parameters
    @@ -3603,6 +3670,7 @@ false => $M_TYPE

    +
    Parameters
    @@ -3665,6 +3733,7 @@ false => $M_TYPE

    +
    Parameters
    @@ -3713,6 +3782,7 @@ false => $M_TYPE

    +
    Parameters
    @@ -3767,6 +3837,7 @@ false => $M_TYPE

    +
    Parameters
    @@ -3821,6 +3892,7 @@ false => $M_TYPE

    +

    Throws if both format information locations cannot be parsed as the valid encoding of format information.

    @@ -3876,6 +3948,7 @@ false => $M_TYPE

    +

    Throws if both version information locations cannot be parsed as the valid encoding of version information.

    @@ -3940,6 +4013,7 @@ false => $M_TYPE

    +
    Parameters
    @@ -4081,91 +4155,91 @@ false => $M_TYPE

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Decoder-Decoder.html b/classes/chillerlan-QRCode-Decoder-Decoder.html index 95ddc6c91..3ee28ba52 100644 --- a/classes/chillerlan-QRCode-Decoder-Decoder.html +++ b/classes/chillerlan-QRCode-Decoder-Decoder.html @@ -161,6 +161,7 @@ the QR Code from an image.

    +
    Tags @@ -203,31 +204,31 @@ the QR Code from an image.

    - $bitBuffer + $bitBuffer  : BitBuffer
    - $eccLevel + $eccLevel  : EccLevel|null
    - $maskPattern + $maskPattern  : MaskPattern|null
    - $options + $options  : QROptions|SettingsContainerInterface
    - $version + $version  : Version|null
    @@ -241,33 +242,33 @@ the QR Code from an image.

    - __construct() + __construct()  : mixed
    - decode() + decode()  : DecoderResult
    Decodes a QR Code represented as a BitMatrix.
    - decodeAlphanumSegment() + decodeAlphanumSegment()  : string
    - decodeBitStream() + decodeBitStream()  : DecoderResult
    Decode the contents of that stream of bytes
    - decodeMatrix() + decodeMatrix()  : DecoderResult
    @@ -307,6 +308,7 @@ the QR Code from an image.

    + private BitBuffer @@ -342,6 +344,7 @@ the QR Code from an image.

    + private EccLevel|null @@ -377,6 +380,7 @@ the QR Code from an image.

    + private MaskPattern|null @@ -412,6 +416,7 @@ the QR Code from an image.

    + private QROptions|SettingsContainerInterface @@ -447,6 +452,7 @@ the QR Code from an image.

    + private Version|null @@ -494,6 +500,7 @@ the QR Code from an image.

    +
    Parameters
    @@ -537,6 +544,7 @@ the QR Code from an image.

    +

    A 1 or "true" is taken to mean a black module.

    @@ -602,6 +610,7 @@ the QR Code from an image.

    +
    Parameters
    @@ -657,6 +666,7 @@ the QR Code from an image.

    +
    Parameters
    @@ -719,6 +729,7 @@ the QR Code from an image.

    +
    Parameters
    @@ -868,22 +879,22 @@ the QR Code from an image.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Decoder-DecoderResult.html b/classes/chillerlan-QRCode-Decoder-DecoderResult.html index 6a280868a..cff6be9c6 100644 --- a/classes/chillerlan-QRCode-Decoder-DecoderResult.html +++ b/classes/chillerlan-QRCode-Decoder-DecoderResult.html @@ -167,6 +167,7 @@ as well as a String interpretation of those bytes, if applicable.

    +

    Table of Contents @@ -188,85 +189,85 @@ as well as a String interpretation of those bytes, if applicable.

    - $data + $data  : string
    - $eccLevel + $eccLevel  : EccLevel
    - $maskPattern + $maskPattern  : MaskPattern
    - $rawBytes + $rawBytes  : BitBuffer
    - $structuredAppendParity + $structuredAppendParity  : int
    - $structuredAppendSequence + $structuredAppendSequence  : int
    - $version + $version  : Version
    - $data + $data  : string
    - $eccLevel + $eccLevel  : EccLevel
    - $maskPattern + $maskPattern  : MaskPattern
    - $rawBytes + $rawBytes  : BitBuffer
    - $structuredAppendParity + $structuredAppendParity  : int
    - $structuredAppendSequence + $structuredAppendSequence  : int
    - $version + $version  : Version
    @@ -280,33 +281,33 @@ as well as a String interpretation of those bytes, if applicable.

    - __construct() + __construct()  : mixed
    DecoderResult constructor.
    - __get() + __get()  : mixed|null
    - __toString() + __toString()  : string
    - getQRMatrix() + getQRMatrix()  : QRMatrix
    Returns a QRMatrix instance with the settings and data of the reader result
    - hasStructuredAppend() + hasStructuredAppend()  : bool
    @@ -346,6 +347,7 @@ as well as a String interpretation of those bytes, if applicable.

    + public string @@ -381,6 +383,7 @@ as well as a String interpretation of those bytes, if applicable.

    + public EccLevel @@ -416,6 +419,7 @@ as well as a String interpretation of those bytes, if applicable.

    + public MaskPattern @@ -451,6 +455,7 @@ as well as a String interpretation of those bytes, if applicable.

    + public BitBuffer @@ -486,6 +491,7 @@ as well as a String interpretation of those bytes, if applicable.

    + public int @@ -521,6 +527,7 @@ as well as a String interpretation of those bytes, if applicable.

    + public int @@ -556,6 +563,7 @@ as well as a String interpretation of those bytes, if applicable.

    + public Version @@ -591,6 +599,7 @@ as well as a String interpretation of those bytes, if applicable.

    + private string @@ -626,6 +635,7 @@ as well as a String interpretation of those bytes, if applicable.

    + private EccLevel @@ -661,6 +671,7 @@ as well as a String interpretation of those bytes, if applicable.

    + private MaskPattern @@ -696,6 +707,7 @@ as well as a String interpretation of those bytes, if applicable.

    + private BitBuffer @@ -731,6 +743,7 @@ as well as a String interpretation of those bytes, if applicable.

    + private int @@ -766,6 +779,7 @@ as well as a String interpretation of those bytes, if applicable.

    + private int @@ -801,6 +815,7 @@ as well as a String interpretation of those bytes, if applicable.

    + private Version @@ -849,6 +864,7 @@ as well as a String interpretation of those bytes, if applicable.

    +
    Parameters
    @@ -892,6 +908,7 @@ as well as a String interpretation of those bytes, if applicable.

    +
    Parameters
    @@ -941,6 +958,7 @@ as well as a String interpretation of those bytes, if applicable.

    + @@ -979,6 +997,7 @@ as well as a String interpretation of those bytes, if applicable.

    + @@ -1016,6 +1035,7 @@ as well as a String interpretation of those bytes, if applicable.

    + @@ -1138,31 +1158,31 @@ as well as a String interpretation of those bytes, if applicable.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html b/classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html index 1b4038de6..dbebcd776 100644 --- a/classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html +++ b/classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html @@ -168,6 +168,7 @@ +

    Table of Contents diff --git a/classes/chillerlan-QRCode-Decoder-ReedSolomonDecoder.html b/classes/chillerlan-QRCode-Decoder-ReedSolomonDecoder.html index 9006cf5e2..33cef5ac9 100644 --- a/classes/chillerlan-QRCode-Decoder-ReedSolomonDecoder.html +++ b/classes/chillerlan-QRCode-Decoder-ReedSolomonDecoder.html @@ -158,6 +158,7 @@

    Implements Reed-Solomon decoding

    +

    The algorithm will not be explained here, but the following references were helpful in creating this implementation:

      @@ -231,13 +232,13 @@ port of his C++ Reed-Solomon implementation.

    - $eccLevel + $eccLevel  : EccLevel
    - $version + $version  : Version
    @@ -251,21 +252,21 @@ port of his C++ Reed-Solomon implementation.

    - __construct() + __construct()  : mixed
    ReedSolomonDecoder constructor
    - decode() + decode()  : BitBuffer
    Error-correct and copy data blocks together into a stream of bytes
    - correctErrors() + correctErrors()  : array<string|int, mixed>
    @@ -273,7 +274,7 @@ port of his C++ Reed-Solomon implementation.

    correct the errors in-place using Reed-Solomon error correction.
    - decodeWords() + decodeWords()  : array<string|int, int>
    @@ -282,26 +283,26 @@ codewords. Really, this means it uses Reed-Solomon to detect and correct errors, in the input.
    - deinterleaveRawBytes() + deinterleaveRawBytes()  : array<string|int, mixed>
    When QR Codes use multiple data blocks, they are actually interleaved.
    - findErrorLocations() + findErrorLocations()  : array<string|int, mixed>
    - findErrorMagnitudes() + findErrorMagnitudes()  : array<string|int, mixed>
    - runEuclideanAlgorithm() + runEuclideanAlgorithm()  : array<string|int, GenericGFPoly>
    @@ -341,6 +342,7 @@ in the input. + private EccLevel @@ -376,6 +378,7 @@ in the input. + private Version @@ -424,6 +427,7 @@ in the input.
    +
    Parameters
    @@ -475,6 +479,7 @@ in the input.
    +
    Parameters
    @@ -524,6 +529,7 @@ correct the errors in-place using Reed-Solomon error correction.

    +
    Parameters
    @@ -581,6 +587,7 @@ in the input.

    +
    Parameters
    @@ -656,6 +663,7 @@ in the input.

    +

    That is, the first byte of data block 1 to n is written, then the second bytes, and so on. This method will separate the data into original blocks.

    @@ -722,6 +730,7 @@ method will separate the data into original blocks.

    +
    Parameters
    @@ -784,6 +793,7 @@ method will separate the data into original blocks.

    +
    Parameters
    @@ -838,6 +848,7 @@ method will separate the data into original blocks.

    +
    Parameters
    @@ -1005,22 +1016,22 @@ method will separate the data into original blocks.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Detector-AlignmentPattern.html b/classes/chillerlan-QRCode-Detector-AlignmentPattern.html index 5e56cc033..e3d0a0d5a 100644 --- a/classes/chillerlan-QRCode-Detector-AlignmentPattern.html +++ b/classes/chillerlan-QRCode-Detector-AlignmentPattern.html @@ -164,6 +164,7 @@ all but the simplest QR Codes.

    +
    Tags @@ -206,19 +207,19 @@ all but the simplest QR Codes.

    - $estimatedModuleSize + $estimatedModuleSize  : float
    - $x + $x  : float
    - $y + $y  : float
    @@ -232,13 +233,13 @@ all but the simplest QR Codes.

    - __construct() + __construct()  : mixed
    - aboutEquals() + aboutEquals()  : bool
    @@ -246,7 +247,7 @@ all but the simplest QR Codes.

    position and size -- meaning, it is at nearly the same center with nearly the same size.
    - combineEstimate() + combineEstimate()  : static
    @@ -254,19 +255,19 @@ position and size -- meaning, it is at nearly the same center with nearly the sa with a new estimate. It returns a new FinderPattern containing an average of the two.
    - getEstimatedModuleSize() + getEstimatedModuleSize()  : float
    - getX() + getX()  : float
    - getY() + getY()  : float
    @@ -306,6 +307,7 @@ with a new estimate. It returns a new FinderPattern containing an average of the + protected float @@ -341,6 +343,7 @@ with a new estimate. It returns a new FinderPattern containing an average of the + protected float @@ -376,6 +379,7 @@ with a new estimate. It returns a new FinderPattern containing an average of the + protected float @@ -423,6 +427,7 @@ with a new estimate. It returns a new FinderPattern containing an average of the
    +
    Parameters
    @@ -482,6 +487,7 @@ position and size -- meaning, it is at nearly the same center with nearly the sa
    +
    Parameters
    @@ -545,6 +551,7 @@ with a new estimate. It returns a new FinderPattern containing an average of the
    +
    Parameters
    @@ -608,6 +615,7 @@ with a new estimate. It returns a new FinderPattern containing an average of the + @@ -645,6 +653,7 @@ with a new estimate. It returns a new FinderPattern containing an average of the + @@ -682,6 +691,7 @@ with a new estimate. It returns a new FinderPattern containing an average of the + @@ -804,21 +814,21 @@ with a new estimate. It returns a new FinderPattern containing an average of the
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Detector-AlignmentPatternFinder.html b/classes/chillerlan-QRCode-Detector-AlignmentPatternFinder.html index ea88fc40c..67a740520 100644 --- a/classes/chillerlan-QRCode-Detector-AlignmentPatternFinder.html +++ b/classes/chillerlan-QRCode-Detector-AlignmentPatternFinder.html @@ -159,6 +159,7 @@

    This class attempts to find alignment patterns in a QR Code. Alignment patterns look like finder patterns but are smaller and appear at regular intervals throughout the image.

    +

    At the moment this only looks for the bottom-right alignment pattern.

    This is mostly a simplified copy of FinderPatternFinder. It is copied, pasted and stripped down here for maximum performance but does unfortunately duplicate @@ -209,19 +210,19 @@ some code.

    - $matrix + $matrix  : BitMatrix
    - $moduleSize + $moduleSize  : float
    - $possibleCenters + $possibleCenters  : array<string|int, AlignmentPattern>
    @@ -235,14 +236,14 @@ some code.

    - __construct() + __construct()  : mixed
    Creates a finder that will look in a portion of the whole image.
    - find() + find()  : AlignmentPattern|null
    @@ -250,7 +251,7 @@ some code.

    it's pretty performance-critical and so is written to be fast foremost.
    - centerFromEnd() + centerFromEnd()  : float
    @@ -258,7 +259,7 @@ it's pretty performance-critical and so is written to be fast foremost.
    - crossCheckVertical() + crossCheckVertical()  : float|null
    @@ -267,13 +268,13 @@ figures the location of the center of this black/white/black run. alignment pattern to see if the same proportion is detected.
    - foundPatternCross() + foundPatternCross()  : bool
    - handlePossibleCenter() + handlePossibleCenter()  : AlignmentPattern|null
    @@ -317,6 +318,7 @@ found the alignment pattern. + private BitMatrix @@ -352,6 +354,7 @@ found the alignment pattern. + private float @@ -387,6 +390,7 @@ found the alignment pattern. + private array<string|int, AlignmentPattern> @@ -435,6 +439,7 @@ found the alignment pattern.
    +
    Parameters
    @@ -491,6 +496,7 @@ it's pretty performance-critical and so is written to be fast foremost.

    +
    Parameters
    @@ -569,6 +575,7 @@ figures the location of the center of this black/white/black run.

    +
    Parameters
    @@ -626,6 +633,7 @@ alignment pattern to see if the same proportion is detected.

    +
    Parameters
    @@ -705,6 +713,7 @@ observed in any reading state, based on the results of the horizontal scan

    +
    Parameters
    @@ -763,6 +772,7 @@ found the alignment pattern.

    +
    Parameters
    @@ -921,21 +931,21 @@ found the alignment pattern.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Detector-Detector.html b/classes/chillerlan-QRCode-Detector-Detector.html index cd6043f46..9f6a8179a 100644 --- a/classes/chillerlan-QRCode-Detector-Detector.html +++ b/classes/chillerlan-QRCode-Detector-Detector.html @@ -161,6 +161,7 @@ is rotated or skewed, or partially obscured.

    +
    Tags @@ -203,7 +204,7 @@ is rotated or skewed, or partially obscured.

    - $matrix + $matrix  : BitMatrix
    @@ -217,21 +218,21 @@ is rotated or skewed, or partially obscured.

    - __construct() + __construct()  : mixed
    Detector constructor.
    - detect() + detect()  : BitMatrix
    Detects a QR Code in an image.
    - calculateModuleSize() + calculateModuleSize()  : float
    @@ -239,7 +240,7 @@ is rotated or skewed, or partially obscured.

    of the three finder patterns.
    - calculateModuleSizeOneWay() + calculateModuleSizeOneWay()  : float
    @@ -248,7 +249,7 @@ of the three finder patterns. width of each, measuring along the axis between their centers.
    - computeDimension() + computeDimension()  : int
    @@ -256,13 +257,13 @@ width of each, measuring along the axis between their centers. of the finder patterns and estimated module size.
    - createTransform() + createTransform()  : PerspectiveTransform
    - findAlignmentInRegion() + findAlignmentInRegion()  : AlignmentPattern|null
    @@ -270,14 +271,14 @@ of the finder patterns and estimated module size. guessed to contain it.
    - sizeOfBlackWhiteBlackRun() + sizeOfBlackWhiteBlackRun()  : float
    This method traces a line from a po$in the image, in the direction towards another point.
    - sizeOfBlackWhiteBlackRunBothWays() + sizeOfBlackWhiteBlackRunBothWays()  : float
    @@ -320,6 +321,7 @@ of another po$(another finder pattern center), and in the opposite direction too + private BitMatrix @@ -368,6 +370,7 @@ of another po$(another finder pattern center), and in the opposite direction too
    +
    Parameters
    @@ -414,6 +417,7 @@ of another po$(another finder pattern center), and in the opposite direction too + @@ -451,6 +455,7 @@ of the three finder patterns.

    +
    Parameters
    @@ -530,6 +535,7 @@ width of each, measuring along the axis between their centers.

    +
    Parameters
    @@ -586,6 +592,7 @@ of the finder patterns and estimated module size.

    +
    Parameters
    @@ -669,6 +676,7 @@ of the finder patterns and estimated module size.

    +
    Parameters
    @@ -746,6 +754,7 @@ guessed to contain it.

    +
    Parameters
    @@ -826,6 +835,7 @@ guessed to contain it.

    +

    It begins in a black region, and keeps going until it finds white, then black, then white again. It reports the distance from the start to this point.

    This is used when figuring out how wide a finder pattern is, when the finder pattern @@ -903,6 +913,7 @@ of another po$(another finder pattern center), and in the opposite direction too

    +
    Parameters
    @@ -1074,22 +1085,22 @@ of another po$(another finder pattern center), and in the opposite direction too
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Detector-FinderPattern.html b/classes/chillerlan-QRCode-Detector-FinderPattern.html index 9d5a768c9..6ce17c23f 100644 --- a/classes/chillerlan-QRCode-Detector-FinderPattern.html +++ b/classes/chillerlan-QRCode-Detector-FinderPattern.html @@ -165,6 +165,7 @@ as a convenience to the finder's bookkeeping.

    +
    Tags @@ -207,25 +208,25 @@ as a convenience to the finder's bookkeeping.

    - $estimatedModuleSize + $estimatedModuleSize  : float
    - $x + $x  : float
    - $y + $y  : float
    - $count + $count  : int
    @@ -239,13 +240,13 @@ as a convenience to the finder's bookkeeping.

    - __construct() + __construct()  : mixed
    - aboutEquals() + aboutEquals()  : bool
    @@ -253,7 +254,7 @@ as a convenience to the finder's bookkeeping.

    position and size -- meaning, it is at nearly the same center with nearly the same size.
    - combineEstimate() + combineEstimate()  : static
    @@ -262,50 +263,50 @@ with a new estimate. It returns a new FinderPattern containing a weighted averag based on count.
    - distance() + distance()  : float
    - getCount() + getCount()  : int
    - getDistance() + getDistance()  : float
    - getEstimatedModuleSize() + getEstimatedModuleSize()  : float
    - getSquaredDistance() + getSquaredDistance()  : float
    Get square of distance between a and b.
    - getX() + getX()  : float
    - getY() + getY()  : float
    - squaredDistance() + squaredDistance()  : float
    @@ -345,6 +346,7 @@ based on count. + protected float @@ -380,6 +382,7 @@ based on count. + protected float @@ -415,6 +418,7 @@ based on count. + protected float @@ -450,6 +454,7 @@ based on count. + private int @@ -497,6 +502,7 @@ based on count.
    +
    Parameters
    @@ -563,6 +569,7 @@ position and size -- meaning, it is at nearly the same center with nearly the sa
    +
    Parameters
    @@ -627,6 +634,7 @@ based on count.

    +
    Parameters
    @@ -688,6 +696,7 @@ based on count.

    +
    Parameters
    @@ -758,6 +767,7 @@ based on count.

    + @@ -793,6 +803,7 @@ based on count.

    +
    Parameters
    @@ -848,6 +859,7 @@ based on count.

    + @@ -884,6 +896,7 @@ based on count.

    +
    Parameters
    @@ -933,6 +946,7 @@ based on count.

    + @@ -970,6 +984,7 @@ based on count.

    + @@ -1005,6 +1020,7 @@ based on count.

    +
    Parameters
    @@ -1160,27 +1176,27 @@ based on count.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Detector-FinderPatternFinder.html b/classes/chillerlan-QRCode-Detector-FinderPatternFinder.html index 7b1f358ae..70049cc89 100644 --- a/classes/chillerlan-QRCode-Detector-FinderPatternFinder.html +++ b/classes/chillerlan-QRCode-Detector-FinderPatternFinder.html @@ -159,6 +159,7 @@

    This class attempts to find finder patterns in a QR Code. Finder patterns are the square markers at three corners of a QR Code.

    +

    This class is thread-safe but not reentrant. Each thread must allocate its own object.

    @@ -203,19 +204,19 @@ markers at three corners of a QR Code.

    - CENTER_QUORUM + CENTER_QUORUM  = 2
    - MAX_MODULES + MAX_MODULES  = 177
    - MIN_SKIP + MIN_SKIP  = 2
    @@ -230,19 +231,19 @@ markers at three corners of a QR Code.

    - $hasSkipped + $hasSkipped  : bool
    - $matrix + $matrix  : BitMatrix
    - $possibleCenters + $possibleCenters  : array<string|int, FinderPattern>
    @@ -256,20 +257,20 @@ markers at three corners of a QR Code.

    - __construct() + __construct()  : mixed
    Creates a finder that will search the image for three finder patterns.
    - find() + find()  : array<string|int, FinderPattern>
    - centerFromEnd() + centerFromEnd()  : float
    @@ -277,7 +278,7 @@ markers at three corners of a QR Code.

    figures the location of the center of this run.
    - crossCheckDiagonal() + crossCheckDiagonal()  : bool
    @@ -286,7 +287,7 @@ figures the location of the center of this run. finder pattern to see if the same proportion is detected.
    - crossCheckHorizontal() + crossCheckHorizontal()  : float|null
    @@ -295,7 +296,7 @@ except it reads horizontally instead of vertically. This is used to cross-cross check a vertical cross-check and locate the real center of the alignment pattern.
    - crossCheckVertical() + crossCheckVertical()  : float|null
    @@ -304,50 +305,50 @@ check a vertical cross-check and locate the real center of the alignment pattern finder pattern to see if the same proportion is detected.
    - crossProductZ() + crossProductZ()  : float
    Returns the z component of the cross product between vectors BC and BA.
    - doShiftCounts2() + doShiftCounts2()  : array<string|int, int>
    - findRowSkip() + findRowSkip()  : int
    - foundPatternCross() + foundPatternCross()  : bool
    - foundPatternDiagonal() + foundPatternDiagonal()  : bool
    - foundPatternVariance() + foundPatternVariance()  : bool
    - getCrossCheckStateCount() + getCrossCheckStateCount()  : array<string|int, int>
    - handlePossibleCenter() + handlePossibleCenter()  : bool
    @@ -357,13 +358,13 @@ with another horizontal scan. This is needed primarily to locate the real horizo center of the pattern in cases of extreme skew.
    - haveMultiplyConfirmedCenters() + haveMultiplyConfirmedCenters()  : bool
    - orderBestPatterns() + orderBestPatterns()  : array<string|int, FinderPattern>
    @@ -371,7 +372,7 @@ center of the pattern in cases of extreme skew. and BC is less than AC, and the angle between BC and BA is less than 180 degrees.
    - selectBestPatterns() + selectBestPatterns()  : array<string|int, FinderPattern>
    @@ -402,6 +403,7 @@ and BC is less than AC, and the angle between BC and BA is less than 180 degrees + private mixed @@ -432,6 +434,7 @@ and BC is less than AC, and the angle between BC and BA is less than 180 degrees + private mixed @@ -462,6 +465,7 @@ and BC is less than AC, and the angle between BC and BA is less than 180 degrees + private mixed @@ -508,6 +512,7 @@ and BC is less than AC, and the angle between BC and BA is less than 180 degrees + private bool @@ -543,6 +548,7 @@ and BC is less than AC, and the angle between BC and BA is less than 180 degrees + private BitMatrix @@ -578,6 +584,7 @@ and BC is less than AC, and the angle between BC and BA is less than 180 degrees + private array<string|int, FinderPattern> @@ -626,6 +633,7 @@ and BC is less than AC, and the angle between BC and BA is less than 180 degrees
    +
    Parameters
    @@ -673,6 +681,7 @@ and BC is less than AC, and the angle between BC and BA is less than 180 degrees + @@ -710,6 +719,7 @@ figures the location of the center of this run.

    +
    Parameters
    @@ -767,6 +777,7 @@ finder pattern to see if the same proportion is detected.

    +
    Parameters
    @@ -832,6 +843,7 @@ check a vertical cross-check and locate the real center of the alignment pattern
    +
    Parameters
    @@ -919,6 +931,7 @@ finder pattern to see if the same proportion is detected.

    +
    Parameters
    @@ -1015,6 +1028,7 @@ observed in any reading state, based on the results of the horizontal scan

    +
    Parameters
    @@ -1076,6 +1090,7 @@ observed in any reading state, based on the results of the horizontal scan

    +
    Parameters
    @@ -1125,6 +1140,7 @@ observed in any reading state, based on the results of the horizontal scan

    + @@ -1167,6 +1183,7 @@ down in the image.

    +
    Parameters
    @@ -1214,6 +1231,7 @@ down in the image.

    +
    Parameters
    @@ -1261,6 +1279,7 @@ down in the image.

    +
    Parameters
    @@ -1324,6 +1343,7 @@ used by finder patterns to be considered a match

    + @@ -1362,6 +1382,7 @@ center of the pattern in cases of extreme skew.

    +

    And then we cross-cross-cross check with another diagonal scan.

    If that succeeds the finder pattern location is added to a list that tracks the number of times each location has been nearly-matched as a finder pattern. @@ -1442,6 +1463,7 @@ pattern center

    + @@ -1485,6 +1507,7 @@ and BC is less than AC, and the angle between BC and BA is less than 180 degrees
    +
    Parameters
    @@ -1536,6 +1559,7 @@ and BC is less than AC, and the angle between BC and BA is less than 180 degrees +
    Tags @@ -1681,41 +1705,41 @@ size differs from the average among those patterns the least

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Detector-GridSampler.html b/classes/chillerlan-QRCode-Detector-GridSampler.html index d7655850e..e4aef5da0 100644 --- a/classes/chillerlan-QRCode-Detector-GridSampler.html +++ b/classes/chillerlan-QRCode-Detector-GridSampler.html @@ -163,6 +163,7 @@ to take advantage of platform-specific optimized implementations, like Sun' Imaging library, but which may not be available in other environments such as J2ME, and vice versa.

    +

    The implementation used can be controlled by calling #setGridSampler(GridSampler) with an instance of a class which implements this interface.

    @@ -210,7 +211,7 @@ with an instance of a class which implements this interface.

    - $points + $points  : array<string|int, mixed>
    @@ -224,7 +225,7 @@ with an instance of a class which implements this interface.

    - sampleGrid() + sampleGrid()  : BitMatrix
    @@ -233,7 +234,7 @@ transformation is determined by the coordinates of 4 points, in the original and image space.
    - checkAndNudgePoints() + checkAndNudgePoints()  : void
    @@ -275,6 +276,7 @@ the image's dimensions to see if the point are even within the image. + private array<string|int, mixed> @@ -325,6 +327,7 @@ image space.

    +
    Parameters
    @@ -410,6 +413,7 @@ the image's dimensions to see if the point are even within the image.

    +

    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 patterns in an image where the QR Code runs all the way to the image border.

    @@ -566,15 +570,15 @@ to be within the image. Because the set of points are assumed to be linear, this
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Detector-PerspectiveTransform.html b/classes/chillerlan-QRCode-Detector-PerspectiveTransform.html index a260d2a98..3fd8b28db 100644 --- a/classes/chillerlan-QRCode-Detector-PerspectiveTransform.html +++ b/classes/chillerlan-QRCode-Detector-PerspectiveTransform.html @@ -162,6 +162,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping +
    Tags @@ -204,55 +205,55 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping
    - $a11 + $a11  : float
    - $a12 + $a12  : float
    - $a13 + $a13  : float
    - $a21 + $a21  : float
    - $a22 + $a22  : float
    - $a23 + $a23  : float
    - $a31 + $a31  : float
    - $a32 + $a32  : float
    - $a33 + $a33  : float
    @@ -266,43 +267,43 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping
    - quadrilateralToQuadrilateral() + quadrilateralToQuadrilateral()  : self
    - transformPoints() + transformPoints()  : array<string|int, array<string|int, mixed>>
    - buildAdjoint() + buildAdjoint()  : self
    - quadrilateralToSquare() + quadrilateralToSquare()  : self
    - set() + set()  : self
    - squareToQuadrilateral() + squareToQuadrilateral()  : self
    - times() + times()  : self
    @@ -342,6 +343,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping + private float @@ -377,6 +379,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping + private float @@ -412,6 +415,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping + private float @@ -447,6 +451,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping + private float @@ -482,6 +487,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping + private float @@ -517,6 +523,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping + private float @@ -552,6 +559,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping + private float @@ -587,6 +595,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping + private float @@ -622,6 +631,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping + private float @@ -669,6 +679,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping
    +
    Parameters
    @@ -837,6 +848,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping
    +
    Parameters
    @@ -897,6 +909,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping + @@ -932,6 +945,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping
    +
    Parameters
    @@ -1028,6 +1042,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping
    +
    Parameters
    @@ -1131,6 +1146,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping
    +
    Parameters
    @@ -1227,6 +1243,7 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping
    +
    Parameters
    @@ -1361,28 +1378,28 @@ directly upon section 3.4.2 of George Wolberg's "Digital Image Warping
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Detector-QRCodeDetectorException.html b/classes/chillerlan-QRCode-Detector-QRCodeDetectorException.html index 95b10cb77..7d7babd5e 100644 --- a/classes/chillerlan-QRCode-Detector-QRCodeDetectorException.html +++ b/classes/chillerlan-QRCode-Detector-QRCodeDetectorException.html @@ -168,6 +168,7 @@ +

    Table of Contents diff --git a/classes/chillerlan-QRCode-Detector-ResultPoint.html b/classes/chillerlan-QRCode-Detector-ResultPoint.html index 0ff36570d..a9a1f759d 100644 --- a/classes/chillerlan-QRCode-Detector-ResultPoint.html +++ b/classes/chillerlan-QRCode-Detector-ResultPoint.html @@ -161,6 +161,7 @@ would be the location of a finder pattern or the corner of the barcode, for exam +

    Tags @@ -203,19 +204,19 @@ would be the location of a finder pattern or the corner of the barcode, for exam
    - $estimatedModuleSize + $estimatedModuleSize  : float
    - $x + $x  : float
    - $y + $y  : float
    @@ -229,13 +230,13 @@ would be the location of a finder pattern or the corner of the barcode, for exam
    - __construct() + __construct()  : mixed
    - aboutEquals() + aboutEquals()  : bool
    @@ -243,19 +244,19 @@ would be the location of a finder pattern or the corner of the barcode, for exam position and size -- meaning, it is at nearly the same center with nearly the same size.
    - getEstimatedModuleSize() + getEstimatedModuleSize()  : float
    - getX() + getX()  : float
    - getY() + getY()  : float
    @@ -295,6 +296,7 @@ position and size -- meaning, it is at nearly the same center with nearly the sa + protected float @@ -330,6 +332,7 @@ position and size -- meaning, it is at nearly the same center with nearly the sa + protected float @@ -365,6 +368,7 @@ position and size -- meaning, it is at nearly the same center with nearly the sa + protected float @@ -412,6 +416,7 @@ position and size -- meaning, it is at nearly the same center with nearly the sa
    +
    Parameters
    @@ -471,6 +476,7 @@ position and size -- meaning, it is at nearly the same center with nearly the sa
    +
    Parameters
    @@ -534,6 +540,7 @@ position and size -- meaning, it is at nearly the same center with nearly the sa + @@ -571,6 +578,7 @@ position and size -- meaning, it is at nearly the same center with nearly the sa + @@ -608,6 +616,7 @@ position and size -- meaning, it is at nearly the same center with nearly the sa + @@ -730,20 +739,20 @@ position and size -- meaning, it is at nearly the same center with nearly the sa
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html b/classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html index 8eda369e4..e2ba04969 100644 --- a/classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html +++ b/classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html @@ -148,6 +148,7 @@ +

    Table of Contents @@ -170,7 +171,7 @@

    - moduleValueIsValid() + moduleValueIsValid()  : bool
    @@ -178,13 +179,13 @@ note: css4 colors are not included
    - getDefaultModuleValue() + getDefaultModuleValue()  : string
    - prepareModuleValue() + prepareModuleValue()  : string
    @@ -232,6 +233,7 @@ note: css4 colors are not included

    +
    Parameters
    @@ -319,6 +321,7 @@ note: css4 colors are not included

    +
    Parameters
    @@ -389,6 +392,7 @@ note: css4 colors are not included

    +
    Parameters
    @@ -544,9 +548,9 @@ note: css4 colors are not included

  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRCodeOutputException.html b/classes/chillerlan-QRCode-Output-QRCodeOutputException.html index 4765a0398..75cd5eb5d 100644 --- a/classes/chillerlan-QRCode-Output-QRCodeOutputException.html +++ b/classes/chillerlan-QRCode-Output-QRCodeOutputException.html @@ -168,6 +168,7 @@ +

    Table of Contents diff --git a/classes/chillerlan-QRCode-Output-QREps.html b/classes/chillerlan-QRCode-Output-QREps.html index 74b2b6bc4..6077dc5ab 100644 --- a/classes/chillerlan-QRCode-Output-QREps.html +++ b/classes/chillerlan-QRCode-Output-QREps.html @@ -161,6 +161,7 @@ +

    Tags @@ -224,7 +225,7 @@
    - MIME_TYPE + MIME_TYPE  = 'application/postscript'
    @@ -239,90 +240,90 @@
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    @@ -336,28 +337,28 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    Determines whether the given value is valid
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -365,7 +366,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -373,77 +374,77 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - formatColor() + formatColor()  : string
    Set the color format string
    - getDefaultModuleValue() + getDefaultModuleValue()  : string
    Returns a default value for either dark or light modules (return value depends on the output class)
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - module() + module()  : string
    Returns a path segment for a single module
    - prepareModuleValue() + prepareModuleValue()  : string
    Prepares the value for the given input (return value depends on the output class)
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -475,6 +476,7 @@ in long loops for a significant performance increase. + public final mixed @@ -521,6 +523,7 @@ in long loops for a significant performance increase. + protected float @@ -556,6 +559,7 @@ in long loops for a significant performance increase. + protected float @@ -606,6 +610,7 @@ in long loops for a significant performance increase. + protected bool @@ -656,6 +661,7 @@ in long loops for a significant performance increase. + protected bool @@ -706,6 +712,7 @@ in long loops for a significant performance increase. + protected bool @@ -756,6 +763,7 @@ in long loops for a significant performance increase. + protected string @@ -806,6 +814,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -856,6 +865,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -907,6 +917,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -943,6 +954,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -979,6 +991,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1030,6 +1043,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1066,6 +1080,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1101,6 +1116,7 @@ in long loops for a significant performance increase. + protected int @@ -1164,6 +1180,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1215,6 +1232,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1277,6 +1295,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1339,6 +1358,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1394,6 +1414,7 @@ in long loops for a significant performance increase.

    +

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

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

    +

    4 values in the color array will be interpreted as CMYK, 3 as RGB

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

    +
    Parameters
    @@ -1558,6 +1581,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1619,6 +1643,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1669,6 +1694,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1710,6 +1736,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1772,6 +1799,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1834,6 +1862,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1915,6 +1944,7 @@ in long loops for a significant performance increase.

    +

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

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

    + @@ -1986,6 +2017,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2127,49 +2159,49 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRFpdf.html b/classes/chillerlan-QRCode-Output-QRFpdf.html index 16c9d7004..bf0798015 100644 --- a/classes/chillerlan-QRCode-Output-QRFpdf.html +++ b/classes/chillerlan-QRCode-Output-QRFpdf.html @@ -164,6 +164,7 @@ +
    Tags @@ -211,7 +212,7 @@
    - MIME_TYPE + MIME_TYPE  = 'application/pdf'
    @@ -226,102 +227,102 @@
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $fpdf + $fpdf  : FPDF
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $prevColor + $prevColor  : array<string|int, mixed>|null
    - $scale + $scale  : int
    @@ -335,27 +336,27 @@
    - __construct() + __construct()  : mixed
    QRFpdf constructor.
    - dump() + dump()  : string|FPDF
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -363,7 +364,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -371,75 +372,75 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - getDefaultModuleValue() + getDefaultModuleValue()  : array<string|int, mixed>
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - initFPDF() + initFPDF()  : FPDF
    Initializes an FPDF instance
    - module() + module()  : void
    Renders a single module
    - prepareModuleValue() + prepareModuleValue()  : array<string|int, mixed>
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -471,6 +472,7 @@ in long loops for a significant performance increase. + public final mixed @@ -517,6 +519,7 @@ in long loops for a significant performance increase. + protected float @@ -552,6 +555,7 @@ in long loops for a significant performance increase. + protected float @@ -602,6 +606,7 @@ in long loops for a significant performance increase. + protected bool @@ -652,6 +657,7 @@ in long loops for a significant performance increase. + protected bool @@ -702,6 +708,7 @@ in long loops for a significant performance increase. + protected bool @@ -752,6 +759,7 @@ in long loops for a significant performance increase. + protected string @@ -802,6 +810,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -852,6 +861,7 @@ in long loops for a significant performance increase. + protected FPDF @@ -887,6 +897,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -938,6 +949,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -974,6 +986,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -1010,6 +1023,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1061,6 +1075,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1097,6 +1112,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1132,6 +1148,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed>|null @@ -1167,6 +1184,7 @@ in long loops for a significant performance increase. + protected int @@ -1230,6 +1248,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1296,6 +1315,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1364,6 +1384,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1435,6 +1456,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1490,6 +1512,7 @@ in long loops for a significant performance increase.

    +

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

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

    +
    Parameters
    @@ -1597,6 +1621,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1658,6 +1683,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1708,6 +1734,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1751,6 +1778,7 @@ in long loops for a significant performance increase.

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

    +
    Parameters
    @@ -1844,6 +1873,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1923,6 +1953,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2004,6 +2035,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2043,6 +2075,7 @@ in long loops for a significant performance increase.

    + @@ -2075,6 +2108,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2216,51 +2250,51 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRGdImage.html b/classes/chillerlan-QRCode-Output-QRGdImage.html index 1596c3d21..d547bb7dc 100644 --- a/classes/chillerlan-QRCode-Output-QRGdImage.html +++ b/classes/chillerlan-QRCode-Output-QRGdImage.html @@ -166,6 +166,7 @@ +
    Tags @@ -215,110 +216,110 @@
    - $background + $background  : int
    The allocated background color
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $image + $image  : GdImage
    The GD image resource
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    - $upscaled + $upscaled  : bool
    @@ -333,34 +334,34 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string|GdImage
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    - checkGD() + checkGD()  : void
    Checks whether GD is installed and if the given mode is supported
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -368,7 +369,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -376,112 +377,112 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - createImage() + createImage()  : GdImage
    Creates a new GdImage resource and scales it if necessary
    - drawImage() + drawImage()  : void
    Draws the QR image
    - dumpImage() + dumpImage()  : string
    Creates the final image by calling the desired GD output function
    - getDefaultModuleValue() + getDefaultModuleValue()  : int
    Returns a default value for either dark or light modules (return value depends on the output class)
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - module() + module()  : void
    Creates a single QR pixel with the given settings
    - prepareModuleValue() + prepareModuleValue()  : int
    Prepares the value for the given input (return value depends on the output class)
    - renderImage() + renderImage()  : void
    Renders the image with the gdimage function for the desired output
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setBgColor() + setBgColor()  : void
    Sets the background color
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - setTransparencyColor() + setTransparencyColor()  : void
    Sets the transparency color
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -523,6 +524,7 @@ in long loops for a significant performance increase.

    The allocated background color

    + protected int @@ -573,6 +575,7 @@ in long loops for a significant performance increase. + protected float @@ -608,6 +611,7 @@ in long loops for a significant performance increase. + protected float @@ -658,6 +662,7 @@ in long loops for a significant performance increase. + protected bool @@ -708,6 +713,7 @@ in long loops for a significant performance increase. + protected bool @@ -758,6 +764,7 @@ in long loops for a significant performance increase. + protected bool @@ -808,6 +815,7 @@ in long loops for a significant performance increase. + protected string @@ -858,6 +866,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -909,6 +918,7 @@ in long loops for a significant performance increase.

    The GD image resource

    + protected GdImage @@ -959,6 +969,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -1010,6 +1021,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -1046,6 +1058,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -1082,6 +1095,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1133,6 +1147,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1169,6 +1184,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1204,6 +1220,7 @@ in long loops for a significant performance increase. + protected int @@ -1255,6 +1272,7 @@ in long loops for a significant performance increase.

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

    + protected bool @@ -1318,6 +1336,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1400,6 +1419,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1469,6 +1489,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1542,6 +1563,7 @@ in long loops for a significant performance increase. +
    Tags @@ -1596,6 +1618,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1651,6 +1674,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1675,7 +1699,7 @@ in long loops for a significant performance increase.

    @@ -1687,6 +1711,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1730,7 +1755,7 @@ in long loops for a significant performance increase.

    @@ -1745,6 +1770,7 @@ in long loops for a significant performance increase.

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

    @@ -1779,6 +1805,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -1830,6 +1857,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1892,6 +1920,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1953,6 +1982,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2003,6 +2033,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2031,7 +2062,7 @@ in long loops for a significant performance increase.

    @@ -2044,6 +2075,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2102,6 +2134,7 @@ in long loops for a significant performance increase.

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

    @@ -2174,6 +2207,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -2221,6 +2255,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2290,7 +2325,7 @@ in long loops for a significant performance increase.

    @@ -2305,6 +2340,7 @@ in long loops for a significant performance increase.

    + @@ -2336,6 +2372,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2375,6 +2412,7 @@ in long loops for a significant performance increase.

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

    @@ -2409,6 +2447,7 @@ in long loops for a significant performance increase.

    + @@ -2441,6 +2480,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2582,51 +2622,51 @@ in long loops for a significant performance increase.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRGdImageAVIF.html b/classes/chillerlan-QRCode-Output-QRGdImageAVIF.html index 37dfff848..79ed663bc 100644 --- a/classes/chillerlan-QRCode-Output-QRGdImageAVIF.html +++ b/classes/chillerlan-QRCode-Output-QRGdImageAVIF.html @@ -161,6 +161,7 @@ +
    Tags @@ -200,7 +201,7 @@
    - MIME_TYPE + MIME_TYPE  = 'image/avif'
    @@ -215,110 +216,110 @@
    - $background + $background  : int
    The allocated background color
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $image + $image  : GdImage
    The GD image resource
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    - $upscaled + $upscaled  : bool
    @@ -333,34 +334,34 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string|GdImage
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    - checkGD() + checkGD()  : void
    Checks whether GD is installed and if the given mode is supported
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -368,7 +369,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -376,112 +377,112 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - createImage() + createImage()  : GdImage
    Creates a new GdImage resource and scales it if necessary
    - drawImage() + drawImage()  : void
    Draws the QR image
    - dumpImage() + dumpImage()  : string
    Creates the final image by calling the desired GD output function
    - getDefaultModuleValue() + getDefaultModuleValue()  : int
    Returns a default value for either dark or light modules (return value depends on the output class)
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - module() + module()  : void
    Creates a single QR pixel with the given settings
    - prepareModuleValue() + prepareModuleValue()  : int
    Prepares the value for the given input (return value depends on the output class)
    - renderImage() + renderImage()  : void
    Renders the image with the gdimage function for the desired output
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setBgColor() + setBgColor()  : void
    Sets the background color
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - setTransparencyColor() + setTransparencyColor()  : void
    Sets the transparency color
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -513,6 +514,7 @@ in long loops for a significant performance increase. + public final mixed @@ -560,6 +562,7 @@ in long loops for a significant performance increase.

    The allocated background color

    + protected int @@ -610,6 +613,7 @@ in long loops for a significant performance increase. + protected float @@ -645,6 +649,7 @@ in long loops for a significant performance increase. + protected float @@ -695,6 +700,7 @@ in long loops for a significant performance increase. + protected bool @@ -745,6 +751,7 @@ in long loops for a significant performance increase. + protected bool @@ -795,6 +802,7 @@ in long loops for a significant performance increase. + protected bool @@ -845,6 +853,7 @@ in long loops for a significant performance increase. + protected string @@ -895,6 +904,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -946,6 +956,7 @@ in long loops for a significant performance increase.

    The GD image resource

    + protected GdImage @@ -996,6 +1007,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -1047,6 +1059,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -1083,6 +1096,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -1119,6 +1133,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1170,6 +1185,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1206,6 +1222,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1241,6 +1258,7 @@ in long loops for a significant performance increase. + protected int @@ -1292,6 +1310,7 @@ in long loops for a significant performance increase.

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

    + protected bool @@ -1355,6 +1374,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1437,6 +1457,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1506,6 +1527,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1579,6 +1601,7 @@ in long loops for a significant performance increase. +
    Tags @@ -1633,6 +1656,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1688,6 +1712,7 @@ in long loops for a significant performance increase.

    +

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

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

    @@ -1724,6 +1749,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1767,7 +1793,7 @@ in long loops for a significant performance increase.

    @@ -1782,6 +1808,7 @@ in long loops for a significant performance increase.

    + @@ -1801,7 +1828,7 @@ in long loops for a significant performance increase.

    @@ -1816,6 +1843,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -1867,6 +1895,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1929,6 +1958,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1990,6 +2020,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2040,6 +2071,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2068,7 +2100,7 @@ in long loops for a significant performance increase.

    @@ -2081,6 +2113,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2139,6 +2172,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2211,6 +2245,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -2257,6 +2292,7 @@ in long loops for a significant performance increase.

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

    @@ -2341,6 +2377,7 @@ in long loops for a significant performance increase.

    + @@ -2372,6 +2409,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2411,6 +2449,7 @@ in long loops for a significant performance increase.

    + @@ -2430,7 +2469,7 @@ in long loops for a significant performance increase.

    @@ -2445,6 +2484,7 @@ in long loops for a significant performance increase.

    + @@ -2477,6 +2517,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2618,58 +2659,58 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRGdImageBMP.html b/classes/chillerlan-QRCode-Output-QRGdImageBMP.html index 7a9162b04..b5a7069a3 100644 --- a/classes/chillerlan-QRCode-Output-QRGdImageBMP.html +++ b/classes/chillerlan-QRCode-Output-QRGdImageBMP.html @@ -161,6 +161,7 @@ +
    Tags @@ -200,7 +201,7 @@
    - MIME_TYPE + MIME_TYPE  = 'image/bmp'
    @@ -215,110 +216,110 @@
    - $background + $background  : int
    The allocated background color
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $image + $image  : GdImage
    The GD image resource
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    - $upscaled + $upscaled  : bool
    @@ -333,34 +334,34 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string|GdImage
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    - checkGD() + checkGD()  : void
    Checks whether GD is installed and if the given mode is supported
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -368,7 +369,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -376,112 +377,112 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - createImage() + createImage()  : GdImage
    Creates a new GdImage resource and scales it if necessary
    - drawImage() + drawImage()  : void
    Draws the QR image
    - dumpImage() + dumpImage()  : string
    Creates the final image by calling the desired GD output function
    - getDefaultModuleValue() + getDefaultModuleValue()  : int
    Returns a default value for either dark or light modules (return value depends on the output class)
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - module() + module()  : void
    Creates a single QR pixel with the given settings
    - prepareModuleValue() + prepareModuleValue()  : int
    Prepares the value for the given input (return value depends on the output class)
    - renderImage() + renderImage()  : void
    Renders the image with the gdimage function for the desired output
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setBgColor() + setBgColor()  : void
    Sets the background color
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - setTransparencyColor() + setTransparencyColor()  : void
    Sets the transparency color
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -513,6 +514,7 @@ in long loops for a significant performance increase. + public final mixed @@ -560,6 +562,7 @@ in long loops for a significant performance increase.

    The allocated background color

    + protected int @@ -610,6 +613,7 @@ in long loops for a significant performance increase. + protected float @@ -645,6 +649,7 @@ in long loops for a significant performance increase. + protected float @@ -695,6 +700,7 @@ in long loops for a significant performance increase. + protected bool @@ -745,6 +751,7 @@ in long loops for a significant performance increase. + protected bool @@ -795,6 +802,7 @@ in long loops for a significant performance increase. + protected bool @@ -845,6 +853,7 @@ in long loops for a significant performance increase. + protected string @@ -895,6 +904,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -946,6 +956,7 @@ in long loops for a significant performance increase.

    The GD image resource

    + protected GdImage @@ -996,6 +1007,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -1047,6 +1059,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -1083,6 +1096,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -1119,6 +1133,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1170,6 +1185,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1206,6 +1222,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1241,6 +1258,7 @@ in long loops for a significant performance increase. + protected int @@ -1292,6 +1310,7 @@ in long loops for a significant performance increase.

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

    + protected bool @@ -1355,6 +1374,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1437,6 +1457,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1506,6 +1527,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1579,6 +1601,7 @@ in long loops for a significant performance increase. +
    Tags @@ -1633,6 +1656,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1688,6 +1712,7 @@ in long loops for a significant performance increase.

    +

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

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

    @@ -1724,6 +1749,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1767,7 +1793,7 @@ in long loops for a significant performance increase.

    @@ -1782,6 +1808,7 @@ in long loops for a significant performance increase.

    + @@ -1801,7 +1828,7 @@ in long loops for a significant performance increase.

    @@ -1816,6 +1843,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -1867,6 +1895,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1929,6 +1958,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1990,6 +2020,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2040,6 +2071,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2068,7 +2100,7 @@ in long loops for a significant performance increase.

    @@ -2081,6 +2113,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2139,6 +2172,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2211,6 +2245,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -2257,6 +2292,7 @@ in long loops for a significant performance increase.

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

    @@ -2341,6 +2377,7 @@ in long loops for a significant performance increase.

    + @@ -2372,6 +2409,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2411,6 +2449,7 @@ in long loops for a significant performance increase.

    + @@ -2430,7 +2469,7 @@ in long loops for a significant performance increase.

    @@ -2445,6 +2484,7 @@ in long loops for a significant performance increase.

    + @@ -2477,6 +2517,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2618,58 +2659,58 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRGdImageGIF.html b/classes/chillerlan-QRCode-Output-QRGdImageGIF.html index e266f7ff1..0a633dff5 100644 --- a/classes/chillerlan-QRCode-Output-QRGdImageGIF.html +++ b/classes/chillerlan-QRCode-Output-QRGdImageGIF.html @@ -161,6 +161,7 @@ +
    Tags @@ -200,7 +201,7 @@
    - MIME_TYPE + MIME_TYPE  = 'image/gif'
    @@ -215,110 +216,110 @@
    - $background + $background  : int
    The allocated background color
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $image + $image  : GdImage
    The GD image resource
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    - $upscaled + $upscaled  : bool
    @@ -333,34 +334,34 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string|GdImage
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    - checkGD() + checkGD()  : void
    Checks whether GD is installed and if the given mode is supported
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -368,7 +369,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -376,112 +377,112 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - createImage() + createImage()  : GdImage
    Creates a new GdImage resource and scales it if necessary
    - drawImage() + drawImage()  : void
    Draws the QR image
    - dumpImage() + dumpImage()  : string
    Creates the final image by calling the desired GD output function
    - getDefaultModuleValue() + getDefaultModuleValue()  : int
    Returns a default value for either dark or light modules (return value depends on the output class)
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - module() + module()  : void
    Creates a single QR pixel with the given settings
    - prepareModuleValue() + prepareModuleValue()  : int
    Prepares the value for the given input (return value depends on the output class)
    - renderImage() + renderImage()  : void
    Renders the image with the gdimage function for the desired output
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setBgColor() + setBgColor()  : void
    Sets the background color
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - setTransparencyColor() + setTransparencyColor()  : void
    Sets the transparency color
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -513,6 +514,7 @@ in long loops for a significant performance increase. + public final mixed @@ -560,6 +562,7 @@ in long loops for a significant performance increase.

    The allocated background color

    + protected int @@ -610,6 +613,7 @@ in long loops for a significant performance increase. + protected float @@ -645,6 +649,7 @@ in long loops for a significant performance increase. + protected float @@ -695,6 +700,7 @@ in long loops for a significant performance increase. + protected bool @@ -745,6 +751,7 @@ in long loops for a significant performance increase. + protected bool @@ -795,6 +802,7 @@ in long loops for a significant performance increase. + protected bool @@ -845,6 +853,7 @@ in long loops for a significant performance increase. + protected string @@ -895,6 +904,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -946,6 +956,7 @@ in long loops for a significant performance increase.

    The GD image resource

    + protected GdImage @@ -996,6 +1007,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -1047,6 +1059,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -1083,6 +1096,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -1119,6 +1133,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1170,6 +1185,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1206,6 +1222,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1241,6 +1258,7 @@ in long loops for a significant performance increase. + protected int @@ -1292,6 +1310,7 @@ in long loops for a significant performance increase.

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

    + protected bool @@ -1355,6 +1374,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1437,6 +1457,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1506,6 +1527,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1579,6 +1601,7 @@ in long loops for a significant performance increase. +
    Tags @@ -1633,6 +1656,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1688,6 +1712,7 @@ in long loops for a significant performance increase.

    +

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

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

    @@ -1724,6 +1749,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1767,7 +1793,7 @@ in long loops for a significant performance increase.

    @@ -1782,6 +1808,7 @@ in long loops for a significant performance increase.

    + @@ -1801,7 +1828,7 @@ in long loops for a significant performance increase.

    @@ -1816,6 +1843,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -1867,6 +1895,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1929,6 +1958,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1990,6 +2020,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2040,6 +2071,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2068,7 +2100,7 @@ in long loops for a significant performance increase.

    @@ -2081,6 +2113,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2139,6 +2172,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2211,6 +2245,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -2257,6 +2292,7 @@ in long loops for a significant performance increase.

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

    @@ -2341,6 +2377,7 @@ in long loops for a significant performance increase.

    + @@ -2372,6 +2409,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2411,6 +2449,7 @@ in long loops for a significant performance increase.

    + @@ -2430,7 +2469,7 @@ in long loops for a significant performance increase.

    @@ -2445,6 +2484,7 @@ in long loops for a significant performance increase.

    + @@ -2477,6 +2517,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2618,58 +2659,58 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRGdImageJPEG.html b/classes/chillerlan-QRCode-Output-QRGdImageJPEG.html index e163ecc4c..0c0486f03 100644 --- a/classes/chillerlan-QRCode-Output-QRGdImageJPEG.html +++ b/classes/chillerlan-QRCode-Output-QRGdImageJPEG.html @@ -161,6 +161,7 @@ +
    Tags @@ -200,7 +201,7 @@
    - MIME_TYPE + MIME_TYPE  = 'image/jpg'
    @@ -215,110 +216,110 @@
    - $background + $background  : int
    The allocated background color
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $image + $image  : GdImage
    The GD image resource
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    - $upscaled + $upscaled  : bool
    @@ -333,34 +334,34 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string|GdImage
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    - checkGD() + checkGD()  : void
    Checks whether GD is installed and if the given mode is supported
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -368,7 +369,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -376,112 +377,112 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - createImage() + createImage()  : GdImage
    Creates a new GdImage resource and scales it if necessary
    - drawImage() + drawImage()  : void
    Draws the QR image
    - dumpImage() + dumpImage()  : string
    Creates the final image by calling the desired GD output function
    - getDefaultModuleValue() + getDefaultModuleValue()  : int
    Returns a default value for either dark or light modules (return value depends on the output class)
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - module() + module()  : void
    Creates a single QR pixel with the given settings
    - prepareModuleValue() + prepareModuleValue()  : int
    Prepares the value for the given input (return value depends on the output class)
    - renderImage() + renderImage()  : void
    Renders the image with the gdimage function for the desired output
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setBgColor() + setBgColor()  : void
    Sets the background color
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - setTransparencyColor() + setTransparencyColor()  : void
    Sets the transparency color
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -513,6 +514,7 @@ in long loops for a significant performance increase. + public final mixed @@ -560,6 +562,7 @@ in long loops for a significant performance increase.

    The allocated background color

    + protected int @@ -610,6 +613,7 @@ in long loops for a significant performance increase. + protected float @@ -645,6 +649,7 @@ in long loops for a significant performance increase. + protected float @@ -695,6 +700,7 @@ in long loops for a significant performance increase. + protected bool @@ -745,6 +751,7 @@ in long loops for a significant performance increase. + protected bool @@ -795,6 +802,7 @@ in long loops for a significant performance increase. + protected bool @@ -845,6 +853,7 @@ in long loops for a significant performance increase. + protected string @@ -895,6 +904,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -946,6 +956,7 @@ in long loops for a significant performance increase.

    The GD image resource

    + protected GdImage @@ -996,6 +1007,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -1047,6 +1059,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -1083,6 +1096,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -1119,6 +1133,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1170,6 +1185,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1206,6 +1222,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1241,6 +1258,7 @@ in long loops for a significant performance increase. + protected int @@ -1292,6 +1310,7 @@ in long loops for a significant performance increase.

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

    + protected bool @@ -1355,6 +1374,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1437,6 +1457,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1506,6 +1527,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1579,6 +1601,7 @@ in long loops for a significant performance increase. +
    Tags @@ -1633,6 +1656,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1688,6 +1712,7 @@ in long loops for a significant performance increase.

    +

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

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

    @@ -1724,6 +1749,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1767,7 +1793,7 @@ in long loops for a significant performance increase.

    @@ -1782,6 +1808,7 @@ in long loops for a significant performance increase.

    + @@ -1801,7 +1828,7 @@ in long loops for a significant performance increase.

    @@ -1816,6 +1843,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -1867,6 +1895,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1929,6 +1958,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1990,6 +2020,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2040,6 +2071,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2068,7 +2100,7 @@ in long loops for a significant performance increase.

    @@ -2081,6 +2113,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2139,6 +2172,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2211,6 +2245,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -2257,6 +2292,7 @@ in long loops for a significant performance increase.

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

    @@ -2341,6 +2377,7 @@ in long loops for a significant performance increase.

    + @@ -2372,6 +2409,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2411,6 +2449,7 @@ in long loops for a significant performance increase.

    + @@ -2445,6 +2484,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -2491,6 +2531,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2632,58 +2673,58 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRGdImagePNG.html b/classes/chillerlan-QRCode-Output-QRGdImagePNG.html index 5e1f4baa2..704aa44f1 100644 --- a/classes/chillerlan-QRCode-Output-QRGdImagePNG.html +++ b/classes/chillerlan-QRCode-Output-QRGdImagePNG.html @@ -161,6 +161,7 @@ +
    Tags @@ -200,7 +201,7 @@
    - MIME_TYPE + MIME_TYPE  = 'image/png'
    @@ -215,110 +216,110 @@
    - $background + $background  : int
    The allocated background color
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $image + $image  : GdImage
    The GD image resource
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    - $upscaled + $upscaled  : bool
    @@ -333,34 +334,34 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string|GdImage
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    - checkGD() + checkGD()  : void
    Checks whether GD is installed and if the given mode is supported
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -368,7 +369,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -376,112 +377,112 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - createImage() + createImage()  : GdImage
    Creates a new GdImage resource and scales it if necessary
    - drawImage() + drawImage()  : void
    Draws the QR image
    - dumpImage() + dumpImage()  : string
    Creates the final image by calling the desired GD output function
    - getDefaultModuleValue() + getDefaultModuleValue()  : int
    Returns a default value for either dark or light modules (return value depends on the output class)
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - module() + module()  : void
    Creates a single QR pixel with the given settings
    - prepareModuleValue() + prepareModuleValue()  : int
    Prepares the value for the given input (return value depends on the output class)
    - renderImage() + renderImage()  : void
    Renders the image with the gdimage function for the desired output
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setBgColor() + setBgColor()  : void
    Sets the background color
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - setTransparencyColor() + setTransparencyColor()  : void
    Sets the transparency color
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -513,6 +514,7 @@ in long loops for a significant performance increase. + public final mixed @@ -560,6 +562,7 @@ in long loops for a significant performance increase.

    The allocated background color

    + protected int @@ -610,6 +613,7 @@ in long loops for a significant performance increase. + protected float @@ -645,6 +649,7 @@ in long loops for a significant performance increase. + protected float @@ -695,6 +700,7 @@ in long loops for a significant performance increase. + protected bool @@ -745,6 +751,7 @@ in long loops for a significant performance increase. + protected bool @@ -795,6 +802,7 @@ in long loops for a significant performance increase. + protected bool @@ -845,6 +853,7 @@ in long loops for a significant performance increase. + protected string @@ -895,6 +904,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -946,6 +956,7 @@ in long loops for a significant performance increase.

    The GD image resource

    + protected GdImage @@ -996,6 +1007,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -1047,6 +1059,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -1083,6 +1096,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -1119,6 +1133,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1170,6 +1185,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1206,6 +1222,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1241,6 +1258,7 @@ in long loops for a significant performance increase. + protected int @@ -1292,6 +1310,7 @@ in long loops for a significant performance increase.

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

    + protected bool @@ -1355,6 +1374,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1437,6 +1457,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1506,6 +1527,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1579,6 +1601,7 @@ in long loops for a significant performance increase. +
    Tags @@ -1633,6 +1656,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1688,6 +1712,7 @@ in long loops for a significant performance increase.

    +

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

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

    @@ -1724,6 +1749,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1767,7 +1793,7 @@ in long loops for a significant performance increase.

    @@ -1782,6 +1808,7 @@ in long loops for a significant performance increase.

    + @@ -1801,7 +1828,7 @@ in long loops for a significant performance increase.

    @@ -1816,6 +1843,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -1867,6 +1895,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1929,6 +1958,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1990,6 +2020,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2040,6 +2071,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2068,7 +2100,7 @@ in long loops for a significant performance increase.

    @@ -2081,6 +2113,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2139,6 +2172,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2211,6 +2245,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -2257,6 +2292,7 @@ in long loops for a significant performance increase.

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

    @@ -2341,6 +2377,7 @@ in long loops for a significant performance increase.

    + @@ -2372,6 +2409,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2411,6 +2449,7 @@ in long loops for a significant performance increase.

    + @@ -2430,7 +2469,7 @@ in long loops for a significant performance increase.

    @@ -2445,6 +2484,7 @@ in long loops for a significant performance increase.

    + @@ -2477,6 +2517,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2618,58 +2659,58 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRGdImageWEBP.html b/classes/chillerlan-QRCode-Output-QRGdImageWEBP.html index daeb6073b..aeaa9a3fc 100644 --- a/classes/chillerlan-QRCode-Output-QRGdImageWEBP.html +++ b/classes/chillerlan-QRCode-Output-QRGdImageWEBP.html @@ -161,6 +161,7 @@ +
    Tags @@ -200,7 +201,7 @@
    - MIME_TYPE + MIME_TYPE  = 'image/webp'
    @@ -215,110 +216,110 @@
    - $background + $background  : int
    The allocated background color
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $image + $image  : GdImage
    The GD image resource
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    - $upscaled + $upscaled  : bool
    @@ -333,34 +334,34 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string|GdImage
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    - checkGD() + checkGD()  : void
    Checks whether GD is installed and if the given mode is supported
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -368,7 +369,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -376,112 +377,112 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - createImage() + createImage()  : GdImage
    Creates a new GdImage resource and scales it if necessary
    - drawImage() + drawImage()  : void
    Draws the QR image
    - dumpImage() + dumpImage()  : string
    Creates the final image by calling the desired GD output function
    - getDefaultModuleValue() + getDefaultModuleValue()  : int
    Returns a default value for either dark or light modules (return value depends on the output class)
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - module() + module()  : void
    Creates a single QR pixel with the given settings
    - prepareModuleValue() + prepareModuleValue()  : int
    Prepares the value for the given input (return value depends on the output class)
    - renderImage() + renderImage()  : void
    Renders the image with the gdimage function for the desired output
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setBgColor() + setBgColor()  : void
    Sets the background color
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - setTransparencyColor() + setTransparencyColor()  : void
    Sets the transparency color
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -513,6 +514,7 @@ in long loops for a significant performance increase. + public final mixed @@ -560,6 +562,7 @@ in long loops for a significant performance increase.

    The allocated background color

    + protected int @@ -610,6 +613,7 @@ in long loops for a significant performance increase. + protected float @@ -645,6 +649,7 @@ in long loops for a significant performance increase. + protected float @@ -695,6 +700,7 @@ in long loops for a significant performance increase. + protected bool @@ -745,6 +751,7 @@ in long loops for a significant performance increase. + protected bool @@ -795,6 +802,7 @@ in long loops for a significant performance increase. + protected bool @@ -845,6 +853,7 @@ in long loops for a significant performance increase. + protected string @@ -895,6 +904,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -946,6 +956,7 @@ in long loops for a significant performance increase.

    The GD image resource

    + protected GdImage @@ -996,6 +1007,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -1047,6 +1059,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -1083,6 +1096,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -1119,6 +1133,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1170,6 +1185,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1206,6 +1222,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1241,6 +1258,7 @@ in long loops for a significant performance increase. + protected int @@ -1292,6 +1310,7 @@ in long loops for a significant performance increase.

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

    + protected bool @@ -1355,6 +1374,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1437,6 +1457,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1506,6 +1527,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1579,6 +1601,7 @@ in long loops for a significant performance increase. +
    Tags @@ -1633,6 +1656,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1688,6 +1712,7 @@ in long loops for a significant performance increase.

    +

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

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

    @@ -1724,6 +1749,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1767,7 +1793,7 @@ in long loops for a significant performance increase.

    @@ -1782,6 +1808,7 @@ in long loops for a significant performance increase.

    + @@ -1801,7 +1828,7 @@ in long loops for a significant performance increase.

    @@ -1816,6 +1843,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -1867,6 +1895,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1929,6 +1958,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1990,6 +2020,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2040,6 +2071,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2068,7 +2100,7 @@ in long loops for a significant performance increase.

    @@ -2081,6 +2113,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2139,6 +2172,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2211,6 +2245,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -2257,6 +2292,7 @@ in long loops for a significant performance increase.

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

    @@ -2341,6 +2377,7 @@ in long loops for a significant performance increase.

    + @@ -2372,6 +2409,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2411,6 +2449,7 @@ in long loops for a significant performance increase.

    + @@ -2430,7 +2469,7 @@ in long loops for a significant performance increase.

    @@ -2445,6 +2484,7 @@ in long loops for a significant performance increase.

    + @@ -2477,6 +2517,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2618,58 +2659,58 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRImagick.html b/classes/chillerlan-QRCode-Output-QRImagick.html index 25dc2a0a8..459fe23b5 100644 --- a/classes/chillerlan-QRCode-Output-QRImagick.html +++ b/classes/chillerlan-QRCode-Output-QRImagick.html @@ -161,6 +161,7 @@ +
    Tags @@ -210,111 +211,111 @@
    - $backgroundColor + $backgroundColor  : ImagickPixel
    The allocated background color
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $imagick + $imagick  : Imagick
    The main image instance
    - $imagickDraw + $imagickDraw  : ImagickDraw
    The main draw instance
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    @@ -328,28 +329,28 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string|Imagick
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    note: we're not necessarily validating the several values, just checking the general syntax
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -357,7 +358,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -365,98 +366,98 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - createImage() + createImage()  : Imagick
    Creates a new Imagick instance
    - drawImage() + drawImage()  : void
    Creates the QR image via ImagickDraw
    - getDefaultModuleValue() + getDefaultModuleValue()  : ImagickPixel
    Returns a default value for either dark or light modules (return value depends on the output class)
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - module() + module()  : void
    draws a single pixel at the given position
    - prepareModuleValue() + prepareModuleValue()  : ImagickPixel
    Prepares the value for the given input (return value depends on the output class)
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setBgColor() + setBgColor()  : void
    Sets the background color
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - setTransparencyColor() + setTransparencyColor()  : void
    Sets the transparency color
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -498,6 +499,7 @@ in long loops for a significant performance increase.

    The allocated background color

    + protected ImagickPixel @@ -533,6 +535,7 @@ in long loops for a significant performance increase. + protected float @@ -568,6 +571,7 @@ in long loops for a significant performance increase. + protected float @@ -618,6 +622,7 @@ in long loops for a significant performance increase. + protected bool @@ -668,6 +673,7 @@ in long loops for a significant performance increase. + protected bool @@ -718,6 +724,7 @@ in long loops for a significant performance increase. + protected bool @@ -768,6 +775,7 @@ in long loops for a significant performance increase. + protected string @@ -818,6 +826,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -869,6 +878,7 @@ in long loops for a significant performance increase.

    The main image instance

    + protected Imagick @@ -905,6 +915,7 @@ in long loops for a significant performance increase.

    The main draw instance

    + protected ImagickDraw @@ -940,6 +951,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -991,6 +1003,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -1027,6 +1040,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -1063,6 +1077,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1114,6 +1129,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1150,6 +1166,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1185,6 +1202,7 @@ in long loops for a significant performance increase. + protected int @@ -1248,6 +1266,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1321,6 +1340,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1383,6 +1403,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1453,6 +1474,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1508,6 +1530,7 @@ in long loops for a significant performance increase.

    +

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

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

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

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

    +
    Parameters
    @@ -1679,6 +1705,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1740,6 +1767,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1790,6 +1818,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1831,6 +1860,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1889,6 +1919,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1951,6 +1982,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2035,6 +2067,7 @@ in long loops for a significant performance increase.

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

    +

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

    @@ -2105,6 +2139,7 @@ in long loops for a significant performance increase.

    + @@ -2139,6 +2174,7 @@ in long loops for a significant performance increase.

    + @@ -2171,6 +2207,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2312,48 +2349,48 @@ in long loops for a significant performance increase.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRInterventionImage.html b/classes/chillerlan-QRCode-Output-QRInterventionImage.html index 72920ed38..e6d01933b 100644 --- a/classes/chillerlan-QRCode-Output-QRInterventionImage.html +++ b/classes/chillerlan-QRCode-Output-QRInterventionImage.html @@ -162,6 +162,7 @@

    intervention/image (GD/ImageMagick) output

    +

    note: this output class works very slow compared to the native GD/Imagick output classes for obvious reasons. use only if you must.

    @@ -216,108 +217,108 @@ use only if you must.

    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $driver + $driver  : DriverInterface
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $image + $image  : ImageInterface
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $manager + $manager  : ImageManagerInterface
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    @@ -331,21 +332,21 @@ use only if you must.

    - __construct() + __construct()  : mixed
    QRInterventionImage constructor.
    - dump() + dump()  : string|ImageInterface
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    @@ -353,14 +354,14 @@ use only if you must.

    note: css4 colors are not included
    - setDriver() + setDriver()  : static
    Sets a DriverInterface
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -368,7 +369,7 @@ note: css4 colors are not included returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -376,68 +377,68 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - getDefaultModuleValue() + getDefaultModuleValue()  : string
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - module() + module()  : void
    draws a single pixel at the given position
    - prepareModuleValue() + prepareModuleValue()  : string
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -478,6 +479,7 @@ in long loops for a significant performance increase. + protected float @@ -513,6 +515,7 @@ in long loops for a significant performance increase. + protected float @@ -563,6 +566,7 @@ in long loops for a significant performance increase. + protected bool @@ -613,6 +617,7 @@ in long loops for a significant performance increase. + protected bool @@ -663,6 +668,7 @@ in long loops for a significant performance increase. + protected bool @@ -713,6 +719,7 @@ in long loops for a significant performance increase. + protected DriverInterface @@ -748,6 +755,7 @@ in long loops for a significant performance increase. + protected string @@ -798,6 +806,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -848,6 +857,7 @@ in long loops for a significant performance increase. + protected ImageInterface @@ -883,6 +893,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -934,6 +945,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -969,6 +981,7 @@ in long loops for a significant performance increase. + protected ImageManagerInterface @@ -1005,6 +1018,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -1041,6 +1055,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1092,6 +1107,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1128,6 +1144,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1163,6 +1180,7 @@ in long loops for a significant performance increase. + protected int @@ -1226,6 +1244,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1292,6 +1311,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1355,6 +1375,7 @@ note: css4 colors are not included

    +
    Parameters
    @@ -1443,6 +1464,7 @@ note: css4 colors are not included

    +
    Parameters
    @@ -1491,6 +1513,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1546,6 +1569,7 @@ in long loops for a significant performance increase.

    +

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

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

    +
    Parameters
    @@ -1653,6 +1678,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1714,6 +1740,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1764,6 +1791,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1805,6 +1833,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1862,6 +1891,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1933,6 +1963,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2014,6 +2045,7 @@ in long loops for a significant performance increase.

    +

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

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

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

    +
    Parameters
    @@ -2226,45 +2260,45 @@ in long loops for a significant performance increase.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRMarkup.html b/classes/chillerlan-QRCode-Output-QRMarkup.html index 9dfce0605..87b2d93e6 100644 --- a/classes/chillerlan-QRCode-Output-QRMarkup.html +++ b/classes/chillerlan-QRCode-Output-QRMarkup.html @@ -171,6 +171,7 @@ +

    Table of Contents @@ -192,90 +193,90 @@

    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    @@ -289,21 +290,21 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    @@ -311,7 +312,7 @@ note: css4 colors are not included
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -319,7 +320,7 @@ note: css4 colors are not included returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -327,75 +328,75 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - createMarkup() + createMarkup()  : string
    returns the fully parsed and rendered markup string for the given input
    - getCssClass() + getCssClass()  : string
    returns a string with all css classes for the current element
    - getDefaultModuleValue() + getDefaultModuleValue()  : string
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - prepareModuleValue() + prepareModuleValue()  : string
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -436,6 +437,7 @@ in long loops for a significant performance increase. + protected float @@ -471,6 +473,7 @@ in long loops for a significant performance increase. + protected float @@ -521,6 +524,7 @@ in long loops for a significant performance increase. + protected bool @@ -571,6 +575,7 @@ in long loops for a significant performance increase. + protected bool @@ -621,6 +626,7 @@ in long loops for a significant performance increase. + protected bool @@ -671,6 +677,7 @@ in long loops for a significant performance increase. + protected string @@ -721,6 +728,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -771,6 +779,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -822,6 +831,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -858,6 +868,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -894,6 +905,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -945,6 +957,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -981,6 +994,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1016,6 +1030,7 @@ in long loops for a significant performance increase. + protected int @@ -1079,6 +1094,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1130,6 +1146,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1193,6 +1210,7 @@ note: css4 colors are not included

    +
    Parameters
    @@ -1281,6 +1299,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1336,6 +1355,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1373,6 +1393,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1421,6 +1442,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1468,6 +1490,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1539,6 +1562,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1600,6 +1624,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1650,6 +1675,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1690,6 +1716,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1761,6 +1788,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1842,6 +1870,7 @@ in long loops for a significant performance increase.

    +

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

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

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

    +
    Parameters
    @@ -2054,42 +2085,42 @@ in long loops for a significant performance increase.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRMarkupHTML.html b/classes/chillerlan-QRCode-Output-QRMarkupHTML.html index 6f21c3e4d..bda46416c 100644 --- a/classes/chillerlan-QRCode-Output-QRMarkupHTML.html +++ b/classes/chillerlan-QRCode-Output-QRMarkupHTML.html @@ -166,6 +166,7 @@ +

    Table of Contents @@ -185,7 +186,7 @@

    - MIME_TYPE + MIME_TYPE  = 'text/html'
    @@ -200,90 +201,90 @@
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    @@ -297,21 +298,21 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    @@ -319,7 +320,7 @@ note: css4 colors are not included
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -327,7 +328,7 @@ note: css4 colors are not included returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -335,75 +336,75 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - createMarkup() + createMarkup()  : string
    returns the fully parsed and rendered markup string for the given input
    - getCssClass() + getCssClass()  : string
    returns a string with all css classes for the current element
    - getDefaultModuleValue() + getDefaultModuleValue()  : string
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - prepareModuleValue() + prepareModuleValue()  : string
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -435,6 +436,7 @@ in long loops for a significant performance increase. + public final mixed @@ -481,6 +483,7 @@ in long loops for a significant performance increase. + protected float @@ -516,6 +519,7 @@ in long loops for a significant performance increase. + protected float @@ -566,6 +570,7 @@ in long loops for a significant performance increase. + protected bool @@ -616,6 +621,7 @@ in long loops for a significant performance increase. + protected bool @@ -666,6 +672,7 @@ in long loops for a significant performance increase. + protected bool @@ -716,6 +723,7 @@ in long loops for a significant performance increase. + protected string @@ -766,6 +774,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -816,6 +825,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -867,6 +877,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -903,6 +914,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -939,6 +951,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -990,6 +1003,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1026,6 +1040,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1061,6 +1076,7 @@ in long loops for a significant performance increase. + protected int @@ -1124,6 +1140,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1175,6 +1192,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1238,6 +1256,7 @@ note: css4 colors are not included

    +
    Parameters
    @@ -1326,6 +1345,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1381,6 +1401,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1418,6 +1439,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1480,6 +1502,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1527,6 +1550,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1598,6 +1622,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1659,6 +1684,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1709,6 +1735,7 @@ in long loops for a significant performance increase.

    +

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

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

    +
    Parameters
    @@ -1820,6 +1848,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1901,6 +1930,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1940,6 +1970,7 @@ in long loops for a significant performance increase.

    + @@ -1972,6 +2003,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2113,49 +2145,49 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRMarkupSVG.html b/classes/chillerlan-QRCode-Output-QRMarkupSVG.html index de3eccca1..ced9e21d3 100644 --- a/classes/chillerlan-QRCode-Output-QRMarkupSVG.html +++ b/classes/chillerlan-QRCode-Output-QRMarkupSVG.html @@ -161,6 +161,7 @@ +
    Tags @@ -248,7 +249,7 @@
    - MIME_TYPE + MIME_TYPE  = 'image/svg+xml'
    @@ -263,90 +264,90 @@
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    @@ -360,28 +361,28 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    Determines whether the given value is valid
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -389,7 +390,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -397,110 +398,110 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - createMarkup() + createMarkup()  : string
    returns the fully parsed and rendered markup string for the given input
    - getCssClass() + getCssClass()  : string
    returns a string with all css classes for the current element
    - getDefaultModuleValue() + getDefaultModuleValue()  : string
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - getViewBox() + getViewBox()  : string
    returns the value for the SVG viewBox attribute
    - header() + header()  : string
    returns the <svg> header with the given options parsed
    - module() + module()  : string
    returns a path segment for a single module
    - path() + path()  : string
    renders and returns a single <path> element
    - paths() + paths()  : string
    returns one or more SVG <path> elements
    - prepareModuleValue() + prepareModuleValue()  : string
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -532,6 +533,7 @@ in long loops for a significant performance increase. + public final mixed @@ -578,6 +580,7 @@ in long loops for a significant performance increase. + protected float @@ -613,6 +616,7 @@ in long loops for a significant performance increase. + protected float @@ -663,6 +667,7 @@ in long loops for a significant performance increase. + protected bool @@ -713,6 +718,7 @@ in long loops for a significant performance increase. + protected bool @@ -763,6 +769,7 @@ in long loops for a significant performance increase. + protected bool @@ -813,6 +820,7 @@ in long loops for a significant performance increase. + protected string @@ -863,6 +871,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -913,6 +922,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -964,6 +974,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -1000,6 +1011,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -1036,6 +1048,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1087,6 +1100,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1123,6 +1137,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1158,6 +1173,7 @@ in long loops for a significant performance increase. + protected int @@ -1221,6 +1237,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1272,6 +1289,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1334,6 +1352,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1413,6 +1432,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1468,6 +1488,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1505,6 +1526,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1567,6 +1589,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1628,6 +1651,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1699,6 +1723,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1760,6 +1785,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1813,6 +1839,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -1865,6 +1892,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -1926,6 +1954,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -1977,6 +2006,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2054,6 +2084,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2126,6 +2157,7 @@ in long loops for a significant performance increase.

    + @@ -2161,6 +2193,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2232,6 +2265,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2313,6 +2347,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2352,6 +2387,7 @@ in long loops for a significant performance increase.

    + @@ -2384,6 +2420,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2525,54 +2562,54 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRMarkupXML.html b/classes/chillerlan-QRCode-Output-QRMarkupXML.html index 1895ca5f4..8b2f297a9 100644 --- a/classes/chillerlan-QRCode-Output-QRMarkupXML.html +++ b/classes/chillerlan-QRCode-Output-QRMarkupXML.html @@ -166,6 +166,7 @@ +

    Table of Contents @@ -185,13 +186,13 @@

    - MIME_TYPE + MIME_TYPE  = 'application/xml'
    - SCHEMA + SCHEMA  = 'https://raw.githubusercontent.com/chillerlan/php-qrcode/main/src/Output/qrcode.schema.xsd'
    @@ -206,96 +207,96 @@
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $dom + $dom  : DOMDocument
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    @@ -309,21 +310,21 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    @@ -331,7 +332,7 @@ note: css4 colors are not included
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -339,7 +340,7 @@ note: css4 colors are not included returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -347,96 +348,96 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - createMarkup() + createMarkup()  : string
    returns the fully parsed and rendered markup string for the given input
    - createMatrix() + createMatrix()  : DOMElement
    Creates the matrix element
    - getCssClass() + getCssClass()  : string
    returns a string with all css classes for the current element
    - getDefaultModuleValue() + getDefaultModuleValue()  : string
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - module() + module()  : DOMElement|null
    Creates a DOM element for a single module
    - prepareModuleValue() + prepareModuleValue()  : string
    - row() + row()  : DOMElement|null
    Creates a DOM element for a matrix row
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -468,6 +469,7 @@ in long loops for a significant performance increase. + public final mixed @@ -498,6 +500,7 @@ in long loops for a significant performance increase. + public final mixed @@ -544,6 +547,7 @@ in long loops for a significant performance increase. + protected float @@ -579,6 +583,7 @@ in long loops for a significant performance increase. + protected float @@ -629,6 +634,7 @@ in long loops for a significant performance increase. + protected bool @@ -679,6 +685,7 @@ in long loops for a significant performance increase. + protected DOMDocument @@ -714,6 +721,7 @@ in long loops for a significant performance increase. + protected bool @@ -764,6 +772,7 @@ in long loops for a significant performance increase. + protected bool @@ -814,6 +823,7 @@ in long loops for a significant performance increase. + protected string @@ -864,6 +874,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -914,6 +925,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -965,6 +977,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -1001,6 +1014,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -1037,6 +1051,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1088,6 +1103,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1124,6 +1140,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1159,6 +1176,7 @@ in long loops for a significant performance increase. + protected int @@ -1222,6 +1240,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1273,6 +1292,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1336,6 +1356,7 @@ note: css4 colors are not included

    +
    Parameters
    @@ -1424,6 +1445,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1479,6 +1501,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1516,6 +1539,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1580,6 +1604,7 @@ in long loops for a significant performance increase.

    + @@ -1616,6 +1641,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1663,6 +1689,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1734,6 +1761,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1795,6 +1823,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1848,6 +1877,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -1898,6 +1928,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1959,6 +1990,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2030,6 +2062,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2085,6 +2118,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2166,6 +2200,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -2205,6 +2240,7 @@ in long loops for a significant performance increase.

    + @@ -2237,6 +2273,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2378,54 +2415,54 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QROutputAbstract.html b/classes/chillerlan-QRCode-Output-QROutputAbstract.html index ac8f2d240..52876d35a 100644 --- a/classes/chillerlan-QRCode-Output-QROutputAbstract.html +++ b/classes/chillerlan-QRCode-Output-QROutputAbstract.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -196,90 +197,90 @@

    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    @@ -293,14 +294,14 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -308,7 +309,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -316,63 +317,63 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - getDefaultModuleValue() + getDefaultModuleValue()  : mixed
    Returns a default value for either dark or light modules (return value depends on the output class)
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - prepareModuleValue() + prepareModuleValue()  : mixed
    Prepares the value for the given input (return value depends on the output class)
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -413,6 +414,7 @@ in long loops for a significant performance increase. + protected float @@ -448,6 +450,7 @@ in long loops for a significant performance increase. + protected float @@ -498,6 +501,7 @@ in long loops for a significant performance increase. + protected bool @@ -548,6 +552,7 @@ in long loops for a significant performance increase. + protected bool @@ -598,6 +603,7 @@ in long loops for a significant performance increase. + protected bool @@ -648,6 +654,7 @@ in long loops for a significant performance increase. + protected string @@ -698,6 +705,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -748,6 +756,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -799,6 +808,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -835,6 +845,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -871,6 +882,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -922,6 +934,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -958,6 +971,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -993,6 +1007,7 @@ in long loops for a significant performance increase. + protected int @@ -1056,6 +1071,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1107,6 +1123,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1162,6 +1179,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1199,6 +1217,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1243,6 +1262,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1304,6 +1324,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1354,6 +1375,7 @@ in long loops for a significant performance increase.

    +

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

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

    +
    Parameters
    @@ -1439,6 +1462,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1520,6 +1544,7 @@ in long loops for a significant performance increase.

    +

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

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

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

    +
    Parameters
    @@ -1732,38 +1759,38 @@ in long loops for a significant performance increase.

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QROutputInterface.html b/classes/chillerlan-QRCode-Output-QROutputInterface.html index 804bef4e4..82e4424d0 100644 --- a/classes/chillerlan-QRCode-Output-QROutputInterface.html +++ b/classes/chillerlan-QRCode-Output-QROutputInterface.html @@ -154,6 +154,7 @@ +

    Table of Contents @@ -173,7 +174,7 @@

    - DEFAULT_MODULE_VALUES + DEFAULT_MODULE_VALUES  = [ // light @@ -206,7 +207,7 @@
    Map of module type => default value
    - LAYERNAMES + LAYERNAMES  = [ // light @@ -239,14 +240,14 @@
    Map of module type => readable name (for CSS etc.)
    - MIME_TYPE + MIME_TYPE  = ''
    Note: do not call this constant from the interface, but rather from one of the child classes
    - MODES + MODES  = [\chillerlan\QRCode\Output\QREps::class, \chillerlan\QRCode\Output\QRFpdf::class, \chillerlan\QRCode\Output\QRGdImageAVIF::class, \chillerlan\QRCode\Output\QRGdImageBMP::class, \chillerlan\QRCode\Output\QRGdImageGIF::class, \chillerlan\QRCode\Output\QRGdImageJPEG::class, \chillerlan\QRCode\Output\QRGdImagePNG::class, \chillerlan\QRCode\Output\QRGdImageWEBP::class, \chillerlan\QRCode\Output\QRImagick::class, \chillerlan\QRCode\Output\QRInterventionImage::class, \chillerlan\QRCode\Output\QRMarkupHTML::class, \chillerlan\QRCode\Output\QRMarkupSVG::class, \chillerlan\QRCode\Output\QRMarkupXML::class, \chillerlan\QRCode\Output\QRStringJSON::class, \chillerlan\QRCode\Output\QRStringText::class]
    @@ -263,14 +264,14 @@
    - dump() + dump()  : mixed
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    @@ -304,6 +305,7 @@

    Map of module type => default value

    + public array<string|int, bool> @@ -361,6 +363,7 @@

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

    + public array<string|int, string> @@ -418,6 +421,7 @@

    Note: do not call this constant from the interface, but rather from one of the child classes

    + public string @@ -464,6 +468,7 @@

    Map of built-in output class FQN

    + public array<string|int, string> @@ -528,6 +533,7 @@
    +

    please note that the value of QROptions::$cachefile is already evaluated at this point. if the output module is invoked manually, it has no effect at all. you need to supply the $file parameter here in that case (or handle the option value in your custom output module).

    @@ -592,6 +598,7 @@ you need to supply the $file parameter here in that case (or handle the option v
    +
    Parameters
    @@ -725,18 +732,18 @@ you need to supply the $file parameter here in that case (or handle the option v
  • Methods
  • Constants
    • diff --git a/classes/chillerlan-QRCode-Output-QRStringJSON.html b/classes/chillerlan-QRCode-Output-QRStringJSON.html index 5be2cb8df..89ff516b6 100644 --- a/classes/chillerlan-QRCode-Output-QRStringJSON.html +++ b/classes/chillerlan-QRCode-Output-QRStringJSON.html @@ -169,6 +169,7 @@ +

    Table of Contents @@ -188,13 +189,13 @@

    - MIME_TYPE + MIME_TYPE  = 'application/json'
    - SCHEMA + SCHEMA  = 'https://raw.githubusercontent.com/chillerlan/php-qrcode/main/src/Output/qrcode.schema.json'
    @@ -209,90 +210,90 @@
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    @@ -306,21 +307,21 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - dump() + dump()  : string
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    @@ -328,7 +329,7 @@ note: css4 colors are not included
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -336,7 +337,7 @@ note: css4 colors are not included returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -344,75 +345,75 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - getDefaultModuleValue() + getDefaultModuleValue()  : string
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - module() + module()  : array<string|int, mixed>|null
    Creates an array element for a single module
    - prepareModuleValue() + prepareModuleValue()  : string
    - row() + row()  : array<string|int, mixed>|null
    Creates an array element for a matrix row
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -444,6 +445,7 @@ in long loops for a significant performance increase. + public final mixed @@ -474,6 +476,7 @@ in long loops for a significant performance increase. + public final mixed @@ -520,6 +523,7 @@ in long loops for a significant performance increase. + protected float @@ -555,6 +559,7 @@ in long loops for a significant performance increase. + protected float @@ -605,6 +610,7 @@ in long loops for a significant performance increase. + protected bool @@ -655,6 +661,7 @@ in long loops for a significant performance increase. + protected bool @@ -705,6 +712,7 @@ in long loops for a significant performance increase. + protected bool @@ -755,6 +763,7 @@ in long loops for a significant performance increase. + protected string @@ -805,6 +814,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -855,6 +865,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -906,6 +917,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -942,6 +954,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -978,6 +991,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -1029,6 +1043,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1065,6 +1080,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1100,6 +1116,7 @@ in long loops for a significant performance increase. + protected int @@ -1163,6 +1180,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1214,6 +1232,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1285,6 +1304,7 @@ note: css4 colors are not included

    +
    Parameters
    @@ -1373,6 +1393,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1428,6 +1449,7 @@ in long loops for a significant performance increase.

    +

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

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

    +
    Parameters
    @@ -1535,6 +1558,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1596,6 +1620,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1649,6 +1674,7 @@ in long loops for a significant performance increase.

    +
    Tags @@ -1699,6 +1725,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1760,6 +1787,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1831,6 +1859,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1886,6 +1915,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1967,6 +1997,7 @@ in long loops for a significant performance increase.

    +

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

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

    + @@ -2038,6 +2070,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -2179,50 +2212,50 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-QRStringText.html b/classes/chillerlan-QRCode-Output-QRStringText.html index f2a9aea54..ceb09333d 100644 --- a/classes/chillerlan-QRCode-Output-QRStringText.html +++ b/classes/chillerlan-QRCode-Output-QRStringText.html @@ -166,6 +166,7 @@ +

    Table of Contents @@ -185,7 +186,7 @@

    - MIME_TYPE + MIME_TYPE  = 'text/plain'
    @@ -200,90 +201,90 @@
    - $circleDiameter + $circleDiameter  : float
    - $circleRadius + $circleRadius  : float
    - $connectPaths + $connectPaths  : bool
    - $drawCircularModules + $drawCircularModules  : bool
    - $drawLightModules + $drawLightModules  : bool
    - $eol + $eol  : string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    - $length + $length  : int
    the side length of the QR image (modules * scale)
    - $matrix + $matrix  : QRMatrix
    the (filled) data matrix object
    - $moduleCount + $moduleCount  : int
    the current size of the QR matrix
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    an (optional) array of color values for the several QR matrix parts
    - $options + $options  : SettingsContainerInterface|QROptions
    the options instance
    - $scale + $scale  : int
    @@ -297,35 +298,35 @@
    - __construct() + __construct()  : mixed
    QROutputAbstract constructor.
    - ansi8() + ansi8()  : string
    a little helper to create a proper ANSI 8-bit color escape sequence
    - dump() + dump()  : string
    Generates the output, optionally dumps it to a file, and returns it
    - moduleValueIsValid() + moduleValueIsValid()  : bool
    Determines whether the given value is valid
    - collectModules() + collectModules()  : array<string|int, mixed>
    @@ -333,7 +334,7 @@ returns an array with the transformed modules
    - copyVars() + copyVars()  : void
    @@ -341,63 +342,63 @@ returns an array with the transformed modules in long loops for a significant performance increase.
    - getDefaultModuleValue() + getDefaultModuleValue()  : string
    Returns a default value for either dark or light modules (return value depends on the output class)
    - getModuleValue() + getModuleValue()  : mixed
    Returns the prepared value for the given $M_TYPE
    - getModuleValueAt() + getModuleValueAt()  : mixed
    Returns the prepared module value at the given coordinate [$x, $y] (convenience)
    - getOutputDimensions() + getOutputDimensions()  : array<string|int, mixed>
    Returns a 2 element array with the current output width and height
    - prepareModuleValue() + prepareModuleValue()  : string
    Prepares the value for the given input (return value depends on the output class)
    - saveToFile() + saveToFile()  : void
    Saves the qr $data to a $file. If $file is null, nothing happens.
    - setMatrixDimensions() + setMatrixDimensions()  : void
    Sets/updates the matrix dimensions
    - setModuleValues() + setModuleValues()  : void
    Sets the initial module values
    - toBase64DataURI() + toBase64DataURI()  : string
    @@ -429,6 +430,7 @@ in long loops for a significant performance increase. + public final mixed @@ -475,6 +477,7 @@ in long loops for a significant performance increase. + protected float @@ -510,6 +513,7 @@ in long loops for a significant performance increase. + protected float @@ -560,6 +564,7 @@ in long loops for a significant performance increase. + protected bool @@ -610,6 +615,7 @@ in long loops for a significant performance increase. + protected bool @@ -660,6 +666,7 @@ in long loops for a significant performance increase. + protected bool @@ -710,6 +717,7 @@ in long loops for a significant performance increase. + protected string @@ -760,6 +768,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -810,6 +819,7 @@ in long loops for a significant performance increase. + protected array<string|int, mixed> @@ -861,6 +871,7 @@ in long loops for a significant performance increase.

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

    + protected int @@ -897,6 +908,7 @@ in long loops for a significant performance increase.

    the (filled) data matrix object

    + protected QRMatrix @@ -933,6 +945,7 @@ in long loops for a significant performance increase.

    the current size of the QR matrix

    + protected int @@ -984,6 +997,7 @@ in long loops for a significant performance increase.

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

    + protected array<string|int, mixed> @@ -1020,6 +1034,7 @@ in long loops for a significant performance increase.

    the options instance

    + protected SettingsContainerInterface|QROptions @@ -1055,6 +1070,7 @@ in long loops for a significant performance increase. + protected int @@ -1118,6 +1134,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1169,6 +1186,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1261,6 +1279,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1323,6 +1342,7 @@ in long loops for a significant performance increase.
    +
    Parameters
    @@ -1385,6 +1405,7 @@ returns an array with the transformed modules

    +

    The transform callback is called with the following parameters:

    $x - current column $y - current row @@ -1440,6 +1461,7 @@ in long loops for a significant performance increase.

    +

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

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

    +
    Parameters
    @@ -1539,6 +1562,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1600,6 +1624,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1650,6 +1675,7 @@ in long loops for a significant performance increase.

    +

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

    @@ -1691,6 +1717,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1753,6 +1780,7 @@ in long loops for a significant performance increase.

    +
    Parameters
    @@ -1834,6 +1862,7 @@ in long loops for a significant performance increase.

    +

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

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

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

    +
    Parameters
    @@ -2046,48 +2077,48 @@ in long loops for a significant performance increase.

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-Output-RGBArrayModuleValueTrait.html b/classes/chillerlan-QRCode-Output-RGBArrayModuleValueTrait.html index f8c3103a3..9356c3d57 100644 --- a/classes/chillerlan-QRCode-Output-RGBArrayModuleValueTrait.html +++ b/classes/chillerlan-QRCode-Output-RGBArrayModuleValueTrait.html @@ -148,6 +148,7 @@ +

    Table of Contents @@ -170,19 +171,19 @@

    - moduleValueIsValid() + moduleValueIsValid()  : bool
    - getDefaultModuleValue() + getDefaultModuleValue()  : array<string|int, mixed>
    - prepareModuleValue() + prepareModuleValue()  : array<string|int, mixed>
    @@ -228,6 +229,7 @@
    +
    Parameters
    @@ -298,6 +300,7 @@
    +
    Parameters
    @@ -368,6 +371,7 @@
    +
    Parameters
    @@ -531,9 +535,9 @@
  • Methods
    • diff --git a/classes/chillerlan-QRCode-QRCode.html b/classes/chillerlan-QRCode-QRCode.html index c2fe7b7cf..a4cd2c021 100644 --- a/classes/chillerlan-QRCode-QRCode.html +++ b/classes/chillerlan-QRCode-QRCode.html @@ -157,6 +157,7 @@ +
    Tags @@ -230,21 +231,21 @@
    - $dataSegments + $dataSegments  : array<string|int, QRDataModeInterface>
    A collection of one or more data segments of QRDataModeInterface instances to write
    - $luminanceSourceFQN + $luminanceSourceFQN  : string
    The luminance source for the reader
    - $options + $options  : SettingsContainerInterface|QROptions
    @@ -259,133 +260,133 @@
    - __construct() + __construct()  : mixed
    QRCode constructor.
    - addAlphaNumSegment() + addAlphaNumSegment()  : static
    Adds an alphanumeric data segment
    - addByteSegment() + addByteSegment()  : static
    Adds an 8-bit byte data segment
    - addEciDesignator() + addEciDesignator()  : static
    Adds a standalone ECI designator
    - addEciSegment() + addEciSegment()  : static
    Adds an ECI data segment (including designator)
    - addHanziSegment() + addHanziSegment()  : static
    Adds a Hanzi data segment (simplified Chinese 13-bit double-byte characters, GB2312/GB18030)
    - addKanjiSegment() + addKanjiSegment()  : static
    Adds a Kanji data segment (Japanese 13-bit double-byte characters, Shift-JIS)
    - addNumericSegment() + addNumericSegment()  : static
    Adds a numeric data segment
    - addSegment() + addSegment()  : static
    Adds a data segment
    - clearSegments() + clearSegments()  : static
    Clears the data segments array
    - getQRMatrix() + getQRMatrix()  : QRMatrix
    Returns a QRMatrix object for the given $data and current QROptions
    - readFromBlob() + readFromBlob()  : DecoderResult
    Reads a QR Code from the given data blob
    - readFromFile() + readFromFile()  : DecoderResult
    Reads a QR Code from a given file
    - readFromSource() + readFromSource()  : DecoderResult
    Reads a QR Code from the given luminance source
    - render() + render()  : mixed
    Renders a QR Code for the given $data and QROptions, saves $file optionally
    - renderMatrix() + renderMatrix()  : mixed
    Renders a QR Code for the given QRMatrix and QROptions, saves $file optionally
    - setOptions() + setOptions()  : static
    Sets an options instance
    - addMatrixModifications() + addMatrixModifications()  : QRMatrix
    add matrix modifications after mask pattern evaluation and before handing over to output
    - initOutputInterface() + initOutputInterface()  : QROutputInterface
    @@ -427,6 +428,7 @@

    A collection of one or more data segments of QRDataModeInterface instances to write

    + protected array<string|int, QRDataModeInterface> @@ -463,6 +465,7 @@

    The luminance source for the reader

    + protected string @@ -499,6 +502,7 @@

    The settings container

    + protected SettingsContainerInterface|QROptions @@ -547,6 +551,7 @@
    +
    Parameters
    @@ -590,6 +595,7 @@
    +

    ISO/IEC 18004:2000 8.3.3 - Alphanumeric Mode

    @@ -640,6 +646,7 @@
    +

    ISO/IEC 18004:2000 8.3.4 - 8-bit Byte Mode

    @@ -690,6 +697,7 @@
    +

    The ECI designator must be followed by a Byte segment that contains the string encoded according to the given ECI charset

    ISO/IEC 18004:2000 8.3.1 - Extended Channel Interpretation (ECI) Mode

    @@ -741,6 +749,7 @@
    +

    The given string will be encoded from mb_internal_encoding() to the given ECI character set

    I hate this somehow, but I'll leave it for now

    @@ -814,6 +823,7 @@
    +

    GBT18284-2000 Hanzi Mode

    @@ -864,6 +874,7 @@
    +

    ISO/IEC 18004:2000 8.3.5 - Kanji Mode

    @@ -914,6 +925,7 @@
    +

    ISO/IEC 18004:2000 8.3.2 - Numeric Mode

    @@ -964,6 +976,7 @@
    +

    ISO/IEC 18004:2000 8.3.6 - Mixing modes ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

    @@ -1018,6 +1031,7 @@ ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

    +
    Tags @@ -1070,6 +1084,7 @@ ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

    + @@ -1106,6 +1121,7 @@ ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

    +
    Parameters
    @@ -1154,6 +1170,7 @@ ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

    +
    Parameters
    @@ -1202,6 +1219,7 @@ ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

    +
    Parameters
    @@ -1250,6 +1268,7 @@ ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

    +
    Parameters
    @@ -1301,6 +1320,7 @@ ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

    +
    Parameters
    @@ -1352,6 +1372,7 @@ ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

    +
    Parameters
    @@ -1400,6 +1421,7 @@ ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

    +
    Parameters
    @@ -1448,6 +1470,7 @@ ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

    +
    Parameters
    @@ -1597,34 +1620,34 @@ ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length

  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-QRCodeException.html b/classes/chillerlan-QRCode-QRCodeException.html index ea5bd4a00..96e42382c 100644 --- a/classes/chillerlan-QRCode-QRCodeException.html +++ b/classes/chillerlan-QRCode-QRCodeException.html @@ -165,6 +165,7 @@ +

    Table of Contents diff --git a/classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html b/classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html index 177da526a..91deebd3c 100644 --- a/classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html +++ b/classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html @@ -147,6 +147,7 @@ +

    Table of Contents @@ -168,28 +169,28 @@

    - $readerGrayscale + $readerGrayscale  : bool
    Grayscale the image before reading
    - $readerIncreaseContrast + $readerIncreaseContrast  : bool
    Increase the contrast before reading
    - $readerInvertColors + $readerInvertColors  : bool
    Invert the colors of the image
    - $readerUseImagickIfAvailable + $readerUseImagickIfAvailable  : bool
    @@ -204,7 +205,7 @@
    - set_readerUseImagickIfAvailable() + set_readerUseImagickIfAvailable()  : void
    @@ -247,6 +248,7 @@

    Grayscale the image before reading

    + protected bool @@ -283,6 +285,7 @@

    Increase the contrast before reading

    + protected bool @@ -321,6 +324,7 @@

    Invert the colors of the image

    + protected bool @@ -357,6 +361,7 @@

    Use Imagick (if available) when reading QR Codes

    + protected bool @@ -405,6 +410,7 @@
    +
    Parameters
    @@ -534,16 +540,16 @@
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-QROptions.html b/classes/chillerlan-QRCode-QROptions.html index 37c3b8694..b88ebcb0b 100644 --- a/classes/chillerlan-QRCode-QROptions.html +++ b/classes/chillerlan-QRCode-QROptions.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -189,98 +190,98 @@

    - $addLogoSpace + $addLogoSpace  : bool
    Toggles logo space creation
    - $addQuietzone + $addQuietzone  : bool
    Add a "quiet zone" (margin) according to the QR code spec
    - $bgColor + $bgColor  : mixed
    Sets the image background color (if applicable)
    - $cachefile + $cachefile  : string|null
    Optional cache file path `/path/to/cache.file`
    - $circleRadius + $circleRadius  : float
    Specifies the radius of the modules when `QROptions::$drawCircularModules` is set to `true`
    - $connectPaths + $connectPaths  : bool
    Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.
    - $cssClass + $cssClass  : string
    A common css class
    - $drawCircularModules + $drawCircularModules  : bool
    Specify whether to draw the modules as filled circles
    - $drawLightModules + $drawLightModules  : bool
    Whether to draw the light (false) modules
    - $eccLevel + $eccLevel  : int
    Error correct level
    - $eol + $eol  : string
    Newline string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    Specify which paths/patterns to exclude from connecting if `QROptions::$connectPaths` is set to `true`
    - $fpdfMeasureUnit + $fpdfMeasureUnit  : string
    Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)
    - $gdImageUseUpscale + $gdImageUseUpscale  : bool
    @@ -288,217 +289,217 @@ `QROptions::$scale` is less than 20
    - $imageTransparent + $imageTransparent  : bool
    Toggle transparency
    - $imagickFormat + $imagickFormat  : string
    Imagick output format
    - $invertMatrix + $invertMatrix  : bool
    Whether to invert the matrix (reflectance reversal)
    - $jsonFlags + $jsonFlags  : int
    Sets the flags to use for the `json_encode()` call
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    Specifies which module types to exclude when `QROptions::$drawCircularModules` is set to `true`
    - $logoSpaceHeight + $logoSpaceHeight  : int|null
    Height of the logo space
    - $logoSpaceStartX + $logoSpaceStartX  : int|null
    Optional horizontal start position of the logo space (top left corner)
    - $logoSpaceStartY + $logoSpaceStartY  : int|null
    Optional vertical start position of the logo space (top left corner)
    - $logoSpaceWidth + $logoSpaceWidth  : int|null
    Width of the logo space
    - $maskPattern + $maskPattern  : int
    Mask Pattern to use (no value in using, mostly for unit testing purposes)
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    Module values map
    - $outputBase64 + $outputBase64  : bool
    Toggle base64 data URI or raw data output (if applicable)
    - $outputInterface + $outputInterface  : string
    The FQCN of the `QROutputInterface` to use
    - $quality + $quality  : int
    Compression quality
    - $quietzoneSize + $quietzoneSize  : int
    Size of the quiet zone
    - $readerGrayscale + $readerGrayscale  : bool
    Grayscale the image before reading
    - $readerIncreaseContrast + $readerIncreaseContrast  : bool
    Increase the contrast before reading
    - $readerInvertColors + $readerInvertColors  : bool
    Invert the colors of the image
    - $readerUseImagickIfAvailable + $readerUseImagickIfAvailable  : bool
    Use Imagick (if available) when reading QR Codes
    - $returnResource + $returnResource  : bool
    Return the image resource instead of a render if applicable.
    - $scale + $scale  : int
    Pixel size of a QR code module
    - $svgAddXmlHeader + $svgAddXmlHeader  : bool
    Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML
    - $svgDefs + $svgDefs  : string
    Anything in the SVG `<defs>` tag
    - $svgPreserveAspectRatio + $svgPreserveAspectRatio  : string
    Sets the value for the "preserveAspectRatio" on the `<svg>` element
    - $svgUseFillAttributes + $svgUseFillAttributes  : bool
    Whether to use the SVG `fill` attributes
    - $textLineStart + $textLineStart  : string
    An optional line prefix, e.g. empty space to align the QR Code in a console
    - $transparencyColor + $transparencyColor  : mixed|null
    Sets a transparency color for when `QROptions::$imageTransparent` is set to `true`.
    - $version + $version  : int
    QR Code version number
    - $versionMax + $versionMax  : int
    Maximum QR version
    - $versionMin + $versionMin  : int
    Minimum QR version
    - $xmlStylesheet + $xmlStylesheet  : string|null
    @@ -513,98 +514,98 @@
    - clampLogoSpaceValue() + clampLogoSpaceValue()  : int|null
    clamp the logo space values between 0 and maximum length (177 modules at version 40)
    - set_circleRadius() + set_circleRadius()  : void
    clamp/set SVG circle radius
    - set_eccLevel() + set_eccLevel()  : void
    sets the ECC level
    - set_fpdfMeasureUnit() + set_fpdfMeasureUnit()  : void
    sets the FPDF measurement unit
    - set_logoSpaceHeight() + set_logoSpaceHeight()  : void
    clamp/set logo space height
    - set_logoSpaceStartX() + set_logoSpaceStartX()  : void
    clamp/set horizontal logo space start
    - set_logoSpaceStartY() + set_logoSpaceStartY()  : void
    clamp/set vertical logo space start
    - set_logoSpaceWidth() + set_logoSpaceWidth()  : void
    clamp/set logo space width
    - set_quietzoneSize() + set_quietzoneSize()  : void
    sets/clamps the quiet zone size
    - set_readerUseImagickIfAvailable() + set_readerUseImagickIfAvailable()  : void
    enables Imagick for the QR Code reader if the extension is available
    - set_version() + set_version()  : void
    sets/clamps the version number
    - set_versionMax() + set_versionMax()  : void
    sets the maximum version number
    - set_versionMin() + set_versionMin()  : void
    sets the minimum version number
    - setMinMaxVersion() + setMinMaxVersion()  : void
    @@ -646,6 +647,7 @@

    Toggles logo space creation

    + protected bool @@ -705,6 +707,7 @@

    Add a "quiet zone" (margin) according to the QR code spec

    + protected bool @@ -756,6 +759,7 @@

    Sets the image background color (if applicable)

    + protected mixed @@ -803,6 +807,7 @@

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

    + protected string|null @@ -865,6 +870,7 @@ takes precedence over the QROptions::$cachefile

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

    + protected float @@ -903,6 +909,7 @@ takes precedence over the QROptions::$cachefile

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

    + protected bool @@ -975,6 +982,7 @@ which converts the $M_TYPE of all modules to A common css class

    + protected string @@ -1011,6 +1019,7 @@ which converts the $M_TYPE of all modules to Specify whether to draw the modules as filled circles

    + protected bool @@ -1083,6 +1092,7 @@ using imagefilledellipse() and then scaled back

    Whether to draw the light (false) modules

    + protected bool @@ -1121,6 +1131,7 @@ using imagefilledellipse() and then scaled back

    Error correct level

    + protected int @@ -1193,6 +1204,7 @@ using imagefilledellipse() and then scaled back

    Newline string

    + protected string @@ -1231,6 +1243,7 @@ using imagefilledellipse() and then scaled back

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

    + protected array<string|int, mixed> @@ -1282,6 +1295,7 @@ using imagefilledellipse() and then scaled back

    Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)

    + protected string @@ -1334,6 +1348,7 @@ using imagefilledellipse() and then scaled back

    Toggles the usage of internal upscaling when `QROptions::$drawCircularModules` is set to `true` and `QROptions::$scale` is less than 20

    + protected bool @@ -1393,6 +1408,7 @@ using imagefilledellipse() and then scaled back

    Toggle transparency

    + protected bool @@ -1449,6 +1465,7 @@ using imagefilledellipse() and then scaled back

    Imagick output format

    + protected string @@ -1508,6 +1525,7 @@ using imagefilledellipse() and then scaled back

    Whether to invert the matrix (reflectance reversal)

    + protected bool @@ -1561,6 +1579,7 @@ using imagefilledellipse() and then scaled back

    Sets the flags to use for the `json_encode()` call

    + protected int @@ -1612,6 +1631,7 @@ using imagefilledellipse() and then scaled back

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

    + protected array<string|int, mixed> @@ -1650,6 +1670,7 @@ using imagefilledellipse() and then scaled back

    Height of the logo space

    + protected int|null @@ -1688,6 +1709,7 @@ using imagefilledellipse() and then scaled back

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

    + protected int|null @@ -1724,6 +1746,7 @@ using imagefilledellipse() and then scaled back

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

    + protected int|null @@ -1760,6 +1783,7 @@ using imagefilledellipse() and then scaled back

    Width of the logo space

    + protected int|null @@ -1798,6 +1822,7 @@ using imagefilledellipse() and then scaled back

    Mask Pattern to use (no value in using, mostly for unit testing purposes)

    + protected int @@ -1851,6 +1876,7 @@ using imagefilledellipse() and then scaled back

    Module values map

    + protected array<string|int, mixed> @@ -1911,6 +1937,7 @@ using imagefilledellipse() and then scaled back

    Toggle base64 data URI or raw data output (if applicable)

    + protected bool @@ -1964,6 +1991,7 @@ using imagefilledellipse() and then scaled back

    The FQCN of the `QROutputInterface` to use

    + protected string @@ -2000,6 +2028,7 @@ using imagefilledellipse() and then scaled back

    Compression quality

    + protected int @@ -2102,6 +2131,7 @@ using imagefilledellipse() and then scaled back

    Size of the quiet zone

    + protected int @@ -2140,6 +2170,7 @@ using imagefilledellipse() and then scaled back

    Grayscale the image before reading

    + protected bool @@ -2176,6 +2207,7 @@ using imagefilledellipse() and then scaled back

    Increase the contrast before reading

    + protected bool @@ -2214,6 +2246,7 @@ using imagefilledellipse() and then scaled back

    Invert the colors of the image

    + protected bool @@ -2250,6 +2283,7 @@ using imagefilledellipse() and then scaled back

    Use Imagick (if available) when reading QR Codes

    + protected bool @@ -2286,6 +2320,7 @@ using imagefilledellipse() and then scaled back

    Return the image resource instead of a render if applicable.

    + protected bool @@ -2351,6 +2386,7 @@ and QROptions::$outputBase64. (default: Pixel size of a QR code module

    + protected int @@ -2387,6 +2423,7 @@ and QROptions::$outputBase64. (default: Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML

    + protected bool @@ -2425,6 +2462,7 @@ and QROptions::$outputBase64. (default: Anything in the SVG `<defs>` tag

    + protected string @@ -2476,6 +2514,7 @@ and QROptions::$outputBase64. (default: Sets the value for the "preserveAspectRatio" on the `<svg>` element

    + protected string @@ -2527,6 +2566,7 @@ and QROptions::$outputBase64. (default: Whether to use the SVG `fill` attributes

    + protected bool @@ -2581,6 +2621,7 @@ When set to false, the module values map will b

    An optional line prefix, e.g. empty space to align the QR Code in a console

    + protected string @@ -2617,6 +2658,7 @@ When set to false, the module values map will b

    Sets a transparency color for when `QROptions::$imageTransparent` is set to `true`.

    + protected mixed|null @@ -2686,6 +2728,7 @@ When set to false, the module values map will b

    QR Code version number

    + protected int @@ -2739,6 +2782,7 @@ When set to false, the module values map will b

    Maximum QR version

    + protected int @@ -2777,6 +2821,7 @@ When set to false, the module values map will b

    Minimum QR version

    + protected int @@ -2815,6 +2860,7 @@ When set to false, the module values map will b

    Sets an optional XSLT stylesheet in the XML output

    + protected string|null @@ -2878,6 +2924,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -2926,6 +2973,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -2970,6 +3018,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3029,6 +3078,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3087,6 +3137,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3131,6 +3182,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3175,6 +3227,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3219,6 +3272,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3263,6 +3317,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3307,6 +3362,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3351,6 +3407,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3395,6 +3452,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3439,6 +3497,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3483,6 +3542,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3620,71 +3680,71 @@ When set to false, the module values map will b
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCode-QROptionsTrait.html b/classes/chillerlan-QRCode-QROptionsTrait.html index d01dd7b2e..3cec9c921 100644 --- a/classes/chillerlan-QRCode-QROptionsTrait.html +++ b/classes/chillerlan-QRCode-QROptionsTrait.html @@ -147,6 +147,7 @@ +

    Table of Contents @@ -168,98 +169,98 @@

    - $addLogoSpace + $addLogoSpace  : bool
    Toggles logo space creation
    - $addQuietzone + $addQuietzone  : bool
    Add a "quiet zone" (margin) according to the QR code spec
    - $bgColor + $bgColor  : mixed
    Sets the image background color (if applicable)
    - $cachefile + $cachefile  : string|null
    Optional cache file path `/path/to/cache.file`
    - $circleRadius + $circleRadius  : float
    Specifies the radius of the modules when `QROptions::$drawCircularModules` is set to `true`
    - $connectPaths + $connectPaths  : bool
    Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.
    - $cssClass + $cssClass  : string
    A common css class
    - $drawCircularModules + $drawCircularModules  : bool
    Specify whether to draw the modules as filled circles
    - $drawLightModules + $drawLightModules  : bool
    Whether to draw the light (false) modules
    - $eccLevel + $eccLevel  : int
    Error correct level
    - $eol + $eol  : string
    Newline string
    - $excludeFromConnect + $excludeFromConnect  : array<string|int, mixed>
    Specify which paths/patterns to exclude from connecting if `QROptions::$connectPaths` is set to `true`
    - $fpdfMeasureUnit + $fpdfMeasureUnit  : string
    Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)
    - $gdImageUseUpscale + $gdImageUseUpscale  : bool
    @@ -267,189 +268,189 @@ `QROptions::$scale` is less than 20
    - $imageTransparent + $imageTransparent  : bool
    Toggle transparency
    - $imagickFormat + $imagickFormat  : string
    Imagick output format
    - $invertMatrix + $invertMatrix  : bool
    Whether to invert the matrix (reflectance reversal)
    - $jsonFlags + $jsonFlags  : int
    Sets the flags to use for the `json_encode()` call
    - $keepAsSquare + $keepAsSquare  : array<string|int, mixed>
    Specifies which module types to exclude when `QROptions::$drawCircularModules` is set to `true`
    - $logoSpaceHeight + $logoSpaceHeight  : int|null
    Height of the logo space
    - $logoSpaceStartX + $logoSpaceStartX  : int|null
    Optional horizontal start position of the logo space (top left corner)
    - $logoSpaceStartY + $logoSpaceStartY  : int|null
    Optional vertical start position of the logo space (top left corner)
    - $logoSpaceWidth + $logoSpaceWidth  : int|null
    Width of the logo space
    - $maskPattern + $maskPattern  : int
    Mask Pattern to use (no value in using, mostly for unit testing purposes)
    - $moduleValues + $moduleValues  : array<string|int, mixed>
    Module values map
    - $outputBase64 + $outputBase64  : bool
    Toggle base64 data URI or raw data output (if applicable)
    - $outputInterface + $outputInterface  : string
    The FQCN of the `QROutputInterface` to use
    - $quality + $quality  : int
    Compression quality
    - $quietzoneSize + $quietzoneSize  : int
    Size of the quiet zone
    - $returnResource + $returnResource  : bool
    Return the image resource instead of a render if applicable.
    - $scale + $scale  : int
    Pixel size of a QR code module
    - $svgAddXmlHeader + $svgAddXmlHeader  : bool
    Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML
    - $svgDefs + $svgDefs  : string
    Anything in the SVG `<defs>` tag
    - $svgPreserveAspectRatio + $svgPreserveAspectRatio  : string
    Sets the value for the "preserveAspectRatio" on the `<svg>` element
    - $svgUseFillAttributes + $svgUseFillAttributes  : bool
    Whether to use the SVG `fill` attributes
    - $textLineStart + $textLineStart  : string
    An optional line prefix, e.g. empty space to align the QR Code in a console
    - $transparencyColor + $transparencyColor  : mixed|null
    Sets a transparency color for when `QROptions::$imageTransparent` is set to `true`.
    - $version + $version  : int
    QR Code version number
    - $versionMax + $versionMax  : int
    Maximum QR version
    - $versionMin + $versionMin  : int
    Minimum QR version
    - $xmlStylesheet + $xmlStylesheet  : string|null
    @@ -464,91 +465,91 @@
    - clampLogoSpaceValue() + clampLogoSpaceValue()  : int|null
    clamp the logo space values between 0 and maximum length (177 modules at version 40)
    - set_circleRadius() + set_circleRadius()  : void
    clamp/set SVG circle radius
    - set_eccLevel() + set_eccLevel()  : void
    sets the ECC level
    - set_fpdfMeasureUnit() + set_fpdfMeasureUnit()  : void
    sets the FPDF measurement unit
    - set_logoSpaceHeight() + set_logoSpaceHeight()  : void
    clamp/set logo space height
    - set_logoSpaceStartX() + set_logoSpaceStartX()  : void
    clamp/set horizontal logo space start
    - set_logoSpaceStartY() + set_logoSpaceStartY()  : void
    clamp/set vertical logo space start
    - set_logoSpaceWidth() + set_logoSpaceWidth()  : void
    clamp/set logo space width
    - set_quietzoneSize() + set_quietzoneSize()  : void
    sets/clamps the quiet zone size
    - set_version() + set_version()  : void
    sets/clamps the version number
    - set_versionMax() + set_versionMax()  : void
    sets the maximum version number
    - set_versionMin() + set_versionMin()  : void
    sets the minimum version number
    - setMinMaxVersion() + setMinMaxVersion()  : void
    @@ -591,6 +592,7 @@

    Toggles logo space creation

    + protected bool @@ -650,6 +652,7 @@

    Add a "quiet zone" (margin) according to the QR code spec

    + protected bool @@ -701,6 +704,7 @@

    Sets the image background color (if applicable)

    + protected mixed @@ -748,6 +752,7 @@

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

    + protected string|null @@ -810,6 +815,7 @@ takes precedence over the QROptions::$cachefile

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

    + protected float @@ -848,6 +854,7 @@ takes precedence over the QROptions::$cachefile

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

    + protected bool @@ -920,6 +927,7 @@ which converts the $M_TYPE of all modules to A common css class

    + protected string @@ -956,6 +964,7 @@ which converts the $M_TYPE of all modules to Specify whether to draw the modules as filled circles

    + protected bool @@ -1028,6 +1037,7 @@ using imagefilledellipse() and then scaled back

    Whether to draw the light (false) modules

    + protected bool @@ -1066,6 +1076,7 @@ using imagefilledellipse() and then scaled back

    Error correct level

    + protected int @@ -1138,6 +1149,7 @@ using imagefilledellipse() and then scaled back

    Newline string

    + protected string @@ -1176,6 +1188,7 @@ using imagefilledellipse() and then scaled back

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

    + protected array<string|int, mixed> @@ -1227,6 +1240,7 @@ using imagefilledellipse() and then scaled back

    Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)

    + protected string @@ -1279,6 +1293,7 @@ using imagefilledellipse() and then scaled back

    Toggles the usage of internal upscaling when `QROptions::$drawCircularModules` is set to `true` and `QROptions::$scale` is less than 20

    + protected bool @@ -1338,6 +1353,7 @@ using imagefilledellipse() and then scaled back

    Toggle transparency

    + protected bool @@ -1394,6 +1410,7 @@ using imagefilledellipse() and then scaled back

    Imagick output format

    + protected string @@ -1453,6 +1470,7 @@ using imagefilledellipse() and then scaled back

    Whether to invert the matrix (reflectance reversal)

    + protected bool @@ -1506,6 +1524,7 @@ using imagefilledellipse() and then scaled back

    Sets the flags to use for the `json_encode()` call

    + protected int @@ -1557,6 +1576,7 @@ using imagefilledellipse() and then scaled back

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

    + protected array<string|int, mixed> @@ -1595,6 +1615,7 @@ using imagefilledellipse() and then scaled back

    Height of the logo space

    + protected int|null @@ -1633,6 +1654,7 @@ using imagefilledellipse() and then scaled back

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

    + protected int|null @@ -1669,6 +1691,7 @@ using imagefilledellipse() and then scaled back

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

    + protected int|null @@ -1705,6 +1728,7 @@ using imagefilledellipse() and then scaled back

    Width of the logo space

    + protected int|null @@ -1743,6 +1767,7 @@ using imagefilledellipse() and then scaled back

    Mask Pattern to use (no value in using, mostly for unit testing purposes)

    + protected int @@ -1796,6 +1821,7 @@ using imagefilledellipse() and then scaled back

    Module values map

    + protected array<string|int, mixed> @@ -1856,6 +1882,7 @@ using imagefilledellipse() and then scaled back

    Toggle base64 data URI or raw data output (if applicable)

    + protected bool @@ -1909,6 +1936,7 @@ using imagefilledellipse() and then scaled back

    The FQCN of the `QROutputInterface` to use

    + protected string @@ -1945,6 +1973,7 @@ using imagefilledellipse() and then scaled back

    Compression quality

    + protected int @@ -2047,6 +2076,7 @@ using imagefilledellipse() and then scaled back

    Size of the quiet zone

    + protected int @@ -2085,6 +2115,7 @@ using imagefilledellipse() and then scaled back

    Return the image resource instead of a render if applicable.

    + protected bool @@ -2150,6 +2181,7 @@ and QROptions::$outputBase64. (default: Pixel size of a QR code module

    + protected int @@ -2186,6 +2218,7 @@ and QROptions::$outputBase64. (default: Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML

    + protected bool @@ -2224,6 +2257,7 @@ and QROptions::$outputBase64. (default: Anything in the SVG `<defs>` tag

    + protected string @@ -2275,6 +2309,7 @@ and QROptions::$outputBase64. (default: Sets the value for the "preserveAspectRatio" on the `<svg>` element

    + protected string @@ -2326,6 +2361,7 @@ and QROptions::$outputBase64. (default: Whether to use the SVG `fill` attributes

    + protected bool @@ -2380,6 +2416,7 @@ When set to false, the module values map will b

    An optional line prefix, e.g. empty space to align the QR Code in a console

    + protected string @@ -2416,6 +2453,7 @@ When set to false, the module values map will b

    Sets a transparency color for when `QROptions::$imageTransparent` is set to `true`.

    + protected mixed|null @@ -2485,6 +2523,7 @@ When set to false, the module values map will b

    QR Code version number

    + protected int @@ -2538,6 +2577,7 @@ When set to false, the module values map will b

    Maximum QR version

    + protected int @@ -2576,6 +2616,7 @@ When set to false, the module values map will b

    Minimum QR version

    + protected int @@ -2614,6 +2655,7 @@ When set to false, the module values map will b

    Sets an optional XSLT stylesheet in the XML output

    + protected string|null @@ -2677,6 +2719,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -2725,6 +2768,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -2769,6 +2813,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -2828,6 +2873,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -2886,6 +2932,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -2930,6 +2977,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -2974,6 +3022,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3018,6 +3067,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3062,6 +3112,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3106,6 +3157,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3150,6 +3202,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3194,6 +3247,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3238,6 +3292,7 @@ When set to false, the module values map will b
    +
    Parameters
    @@ -3374,65 +3429,65 @@ When set to false, the module values map will b
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-BuildDirTrait.html b/classes/chillerlan-QRCodeTest-BuildDirTrait.html index 8f533d476..1b4a2db8d 100644 --- a/classes/chillerlan-QRCodeTest-BuildDirTrait.html +++ b/classes/chillerlan-QRCodeTest-BuildDirTrait.html @@ -147,6 +147,7 @@ +

    Table of Contents @@ -166,7 +167,7 @@

    - _buildDir + _buildDir  = __DIR__ . '/../.build/'
    @@ -182,35 +183,35 @@
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    @@ -243,6 +244,7 @@ + private mixed @@ -295,6 +297,7 @@
    +
    Parameters
    @@ -354,6 +357,7 @@
    +
    Parameters
    @@ -417,6 +421,7 @@
    +
    Parameters
    @@ -465,6 +470,7 @@
    +
    Parameters
    @@ -528,6 +534,7 @@
    +
    Parameters
    @@ -661,17 +668,17 @@
  • Constants
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Common-BitBufferTest.html b/classes/chillerlan-QRCodeTest-Common-BitBufferTest.html index ac108b8ba..a49f1e358 100644 --- a/classes/chillerlan-QRCodeTest-Common-BitBufferTest.html +++ b/classes/chillerlan-QRCodeTest-Common-BitBufferTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -189,7 +190,7 @@

    - $bitBuffer + $bitBuffer  : BitBuffer
    @@ -203,25 +204,25 @@
    - bitProvider() + bitProvider()  : array<string|int, mixed>
    - testPut() + testPut()  : void
    - testReadException() + testReadException()  : void
    - setUp() + setUp()  : void
    @@ -261,6 +262,7 @@ + private BitBuffer @@ -310,6 +312,7 @@ + @@ -345,6 +348,7 @@
    +
    Parameters
    @@ -411,6 +415,7 @@ + @@ -444,6 +449,7 @@ + @@ -562,17 +568,17 @@
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Common-ECICharsetTest.html b/classes/chillerlan-QRCodeTest-Common-ECICharsetTest.html index d807ad7e7..1eb4c4048 100644 --- a/classes/chillerlan-QRCodeTest-Common-ECICharsetTest.html +++ b/classes/chillerlan-QRCodeTest-Common-ECICharsetTest.html @@ -167,6 +167,7 @@ +

    Table of Contents @@ -189,25 +190,25 @@

    - encodingProvider() + encodingProvider()  : array<string|int, mixed>
    - invalidIdProvider() + invalidIdProvider()  : array<string|int, mixed>
    - testGetName() + testGetName()  : void
    - testInvalidDataException() + testInvalidDataException()  : void
    @@ -254,6 +255,7 @@ + @@ -291,6 +293,7 @@ + @@ -326,6 +329,7 @@
    +
    Parameters
    @@ -390,6 +394,7 @@
    +
    Parameters
    @@ -534,10 +539,10 @@
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Common-EccLevelTest.html b/classes/chillerlan-QRCodeTest-Common-EccLevelTest.html index 6224dfe74..b45a20d61 100644 --- a/classes/chillerlan-QRCodeTest-Common-EccLevelTest.html +++ b/classes/chillerlan-QRCodeTest-Common-EccLevelTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -190,37 +191,37 @@

    - getMaxBits() + getMaxBits()  : void
    - testConstructInvalidEccException() + testConstructInvalidEccException()  : void
    - testGetformatPattern() + testGetformatPattern()  : void
    - testGetLevel() + testGetLevel()  : void
    - testGetOrdinal() + testGetOrdinal()  : void
    - testToString() + testToString()  : void
    @@ -267,6 +268,7 @@ + @@ -300,6 +302,7 @@ + @@ -333,6 +336,7 @@ + @@ -366,6 +370,7 @@ + @@ -399,6 +404,7 @@ + @@ -432,6 +438,7 @@ + @@ -550,12 +557,12 @@
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Common-MaskPatternTest.html b/classes/chillerlan-QRCodeTest-Common-MaskPatternTest.html index 2fc4584fe..ca77a4bbd 100644 --- a/classes/chillerlan-QRCodeTest-Common-MaskPatternTest.html +++ b/classes/chillerlan-QRCodeTest-Common-MaskPatternTest.html @@ -162,6 +162,7 @@ +
    Tags @@ -204,51 +205,51 @@
    - maskPatternProvider() + maskPatternProvider()  : array<string|int, mixed>
    - testInvalidMaskPatternException() + testInvalidMaskPatternException()  : void
    Tests if an exception is thrown on an incorrect mask pattern
    - testMask() + testMask()  : void
    Tests if the mask function generates the correct pattern
    - testPenaltyRule1() + testPenaltyRule1()  : void
    - testPenaltyRule2() + testPenaltyRule2()  : void
    - testPenaltyRule3() + testPenaltyRule3()  : void
    - testPenaltyRule4() + testPenaltyRule4()  : void
    - assertMask() + assertMask()  : bool
    @@ -295,6 +296,7 @@ + @@ -333,6 +335,7 @@ + @@ -365,6 +368,7 @@
    +
    Parameters
    @@ -431,6 +435,7 @@ + @@ -464,6 +469,7 @@ + @@ -497,6 +503,7 @@ + @@ -530,6 +537,7 @@ + @@ -561,6 +569,7 @@
    +
    Parameters
    @@ -702,14 +711,14 @@
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Common-ModeTest.html b/classes/chillerlan-QRCodeTest-Common-ModeTest.html index 5198d15e3..4c4c67f74 100644 --- a/classes/chillerlan-QRCodeTest-Common-ModeTest.html +++ b/classes/chillerlan-QRCodeTest-Common-ModeTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -190,25 +191,25 @@

    - testGetLengthBitsForVersionBreakpoints() + testGetLengthBitsForVersionBreakpoints()  : void
    - testGetLengthBitsForVersionInvalidModeException() + testGetLengthBitsForVersionInvalidModeException()  : void
    - testGetLengthBitsForVersionInvalidVersionException() + testGetLengthBitsForVersionInvalidVersionException()  : void
    - versionProvider() + versionProvider()  : array<string|int, mixed>
    @@ -254,6 +255,7 @@
    +
    Parameters
    @@ -320,6 +322,7 @@ + @@ -353,6 +356,7 @@ + @@ -387,6 +391,7 @@ + @@ -509,10 +514,10 @@
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Common-VersionTest.html b/classes/chillerlan-QRCodeTest-Common-VersionTest.html index 00ceda3b7..108a92d45 100644 --- a/classes/chillerlan-QRCodeTest-Common-VersionTest.html +++ b/classes/chillerlan-QRCodeTest-Common-VersionTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -189,7 +190,7 @@

    - $version + $version  : Version
    @@ -203,55 +204,55 @@
    - testConstructInvalidVersion() + testConstructInvalidVersion()  : void
    - testGetAlignmentPattern() + testGetAlignmentPattern()  : void
    - testGetDimension() + testGetDimension()  : void
    - testGetRSBlocks() + testGetRSBlocks()  : void
    - testGetTotalCodewords() + testGetTotalCodewords()  : void
    - testGetVersionNumber() + testGetVersionNumber()  : void
    - testGetVersionPattern() + testGetVersionPattern()  : void
    - testToString() + testToString()  : void
    - setUp() + setUp()  : void
    @@ -291,6 +292,7 @@ + private Version @@ -340,6 +342,7 @@ + @@ -373,6 +376,7 @@ + @@ -406,6 +410,7 @@ + @@ -439,6 +444,7 @@ + @@ -472,6 +478,7 @@ + @@ -505,6 +512,7 @@ + @@ -538,6 +546,7 @@ + @@ -571,6 +580,7 @@ + @@ -604,6 +614,7 @@ + @@ -722,22 +733,22 @@
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Data-AlphaNumTest.html b/classes/chillerlan-QRCodeTest-Data-AlphaNumTest.html index 417328a54..d09dcd2e2 100644 --- a/classes/chillerlan-QRCodeTest-Data-AlphaNumTest.html +++ b/classes/chillerlan-QRCodeTest-Data-AlphaNumTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - testData + testData  = '0 $%*+-./:'
    @@ -202,13 +203,13 @@
    - $dataMode + $dataMode  : QRDataModeInterface
    - $QRData + $QRData  : QRData
    @@ -222,116 +223,116 @@
    - getMaxLengthForMode() + getMaxLengthForMode()  : int
    the maximum character count for the given $mode and $eccLevel
    - maskPatternProvider() + maskPatternProvider()  : array<string|int, array<string|int, int>>
    - maxLengthProvider() + maxLengthProvider()  : Generator
    Generates test data for each data mode:
    - stringValidateProvider() + stringValidateProvider()  : array<string|int, mixed>
    isAlphaNum() should pass on the 45 defined characters and fail on anything else (e.g. lowercase)
    - testBinaryStringInvalid() + testBinaryStringInvalid()  : void
    Tests if a random binary string is properly validated as false
    - testDecodeSegment() + testDecodeSegment()  : void
    Tests decoding a data segment from a given BitBuffer
    - testGetMinimumVersion() + testGetMinimumVersion()  : void
    Tests getting the minimum QR version for the given data
    - testGetMinimumVersionException() + testGetMinimumVersionException()  : void
    Tests if an exception is thrown when the data exceeds the maximum version while auto-detecting
    - testInitMatrix() + testInitMatrix()  : void
    Tests initializing the data matrix
    - testInvalidDataException() + testInvalidDataException()  : void
    Tests if an exception is thrown when an invalid character is encountered
    - testInvalidDataOnEmptyException() + testInvalidDataOnEmptyException()  : void
    Tests if an exception is thrown if the given string is empty
    - testMaxLength() + testMaxLength()  : void
    - testMaxLengthOverflowException() + testMaxLengthOverflowException()  : void
    Tests if an exception is thrown on data overflow
    - testValidateString() + testValidateString()  : void
    Tests if a string is properly validated for the respective data mode
    - versionBreakpointProvider() + versionBreakpointProvider()  : array<string|int, mixed>
    returns versions within the version breakpoints 1-9, 10-26 and 27-40
    - getDataModeInterface() + getDataModeInterface()  : QRDataModeInterface
    - setUp() + setUp()  : void
    @@ -362,6 +363,7 @@ + protected mixed @@ -408,6 +410,7 @@ + protected QRDataModeInterface @@ -443,6 +446,7 @@ + protected QRData @@ -491,6 +495,7 @@
    +
    Parameters
    @@ -576,6 +581,7 @@ + @@ -611,6 +617,7 @@
    +
    diff --git a/classes/chillerlan-QRCodeTest-Data-ByteTest.html b/classes/chillerlan-QRCodeTest-Data-ByteTest.html index a1cde3046..53b444e1f 100644 --- a/classes/chillerlan-QRCodeTest-Data-ByteTest.html +++ b/classes/chillerlan-QRCodeTest-Data-ByteTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - testData + testData  = '[¯\_(ツ)_/¯]'
    @@ -202,13 +203,13 @@
    - $dataMode + $dataMode  : QRDataModeInterface
    - $QRData + $QRData  : QRData
    @@ -222,116 +223,116 @@
    - getMaxLengthForMode() + getMaxLengthForMode()  : int
    the maximum character count for the given $mode and $eccLevel
    - maskPatternProvider() + maskPatternProvider()  : array<string|int, array<string|int, int>>
    - maxLengthProvider() + maxLengthProvider()  : Generator
    Generates test data for each data mode:
    - stringValidateProvider() + stringValidateProvider()  : array<string|int, mixed>
    isByte() passses any binary string and only fails on empty strings
    - testBinaryStringInvalid() + testBinaryStringInvalid()  : void
    Tests if a random binary string is properly validated as false
    - testDecodeSegment() + testDecodeSegment()  : void
    Tests decoding a data segment from a given BitBuffer
    - testGetMinimumVersion() + testGetMinimumVersion()  : void
    Tests getting the minimum QR version for the given data
    - testGetMinimumVersionException() + testGetMinimumVersionException()  : void
    Tests if an exception is thrown when the data exceeds the maximum version while auto-detecting
    - testInitMatrix() + testInitMatrix()  : void
    Tests initializing the data matrix
    - testInvalidDataException() + testInvalidDataException()  : void
    Tests if an exception is thrown when an invalid character is encountered
    - testInvalidDataOnEmptyException() + testInvalidDataOnEmptyException()  : void
    Tests if an exception is thrown if the given string is empty
    - testMaxLength() + testMaxLength()  : void
    - testMaxLengthOverflowException() + testMaxLengthOverflowException()  : void
    Tests if an exception is thrown on data overflow
    - testValidateString() + testValidateString()  : void
    Tests if a string is properly validated for the respective data mode
    - versionBreakpointProvider() + versionBreakpointProvider()  : array<string|int, mixed>
    returns versions within the version breakpoints 1-9, 10-26 and 27-40
    - getDataModeInterface() + getDataModeInterface()  : QRDataModeInterface
    - setUp() + setUp()  : void
    @@ -362,6 +363,7 @@ + protected mixed @@ -408,6 +410,7 @@ + protected QRDataModeInterface @@ -443,6 +446,7 @@ + protected QRData @@ -491,6 +495,7 @@
    +
    Parameters
    @@ -576,6 +581,7 @@ + @@ -611,6 +617,7 @@
    +
    diff --git a/classes/chillerlan-QRCodeTest-Data-DataInterfaceTestAbstract.html b/classes/chillerlan-QRCodeTest-Data-DataInterfaceTestAbstract.html index 115c275e0..d33805ba3 100644 --- a/classes/chillerlan-QRCodeTest-Data-DataInterfaceTestAbstract.html +++ b/classes/chillerlan-QRCodeTest-Data-DataInterfaceTestAbstract.html @@ -171,6 +171,7 @@ +

    Table of Contents @@ -190,7 +191,7 @@

    - testData + testData  = ''
    @@ -205,13 +206,13 @@
    - $dataMode + $dataMode  : QRDataModeInterface
    - $QRData + $QRData  : QRData
    @@ -225,115 +226,115 @@
    - getMaxLengthForMode() + getMaxLengthForMode()  : int
    the maximum character count for the given $mode and $eccLevel
    - maskPatternProvider() + maskPatternProvider()  : array<string|int, array<string|int, int>>
    - maxLengthProvider() + maxLengthProvider()  : Generator
    Generates test data for each data mode:
    - stringValidateProvider() + stringValidateProvider()  : array<string|int, mixed>
    - testBinaryStringInvalid() + testBinaryStringInvalid()  : void
    Tests if a random binary string is properly validated as false
    - testDecodeSegment() + testDecodeSegment()  : void
    Tests decoding a data segment from a given BitBuffer
    - testGetMinimumVersion() + testGetMinimumVersion()  : void
    Tests getting the minimum QR version for the given data
    - testGetMinimumVersionException() + testGetMinimumVersionException()  : void
    Tests if an exception is thrown when the data exceeds the maximum version while auto-detecting
    - testInitMatrix() + testInitMatrix()  : void
    Tests initializing the data matrix
    - testInvalidDataException() + testInvalidDataException()  : void
    Tests if an exception is thrown when an invalid character is encountered
    - testInvalidDataOnEmptyException() + testInvalidDataOnEmptyException()  : void
    Tests if an exception is thrown if the given string is empty
    - testMaxLength() + testMaxLength()  : void
    - testMaxLengthOverflowException() + testMaxLengthOverflowException()  : void
    Tests if an exception is thrown on data overflow
    - testValidateString() + testValidateString()  : void
    Tests if a string is properly validated for the respective data mode
    - versionBreakpointProvider() + versionBreakpointProvider()  : array<string|int, mixed>
    returns versions within the version breakpoints 1-9, 10-26 and 27-40
    - getDataModeInterface() + getDataModeInterface()  : QRDataModeInterface
    - setUp() + setUp()  : void
    @@ -364,6 +365,7 @@ + protected mixed @@ -410,6 +412,7 @@ + protected QRDataModeInterface @@ -445,6 +448,7 @@ + protected QRData @@ -493,6 +497,7 @@
    +
    Parameters
    @@ -578,6 +583,7 @@ + @@ -613,6 +619,7 @@
    +
    diff --git a/classes/chillerlan-QRCodeTest-Data-ECITest.html b/classes/chillerlan-QRCodeTest-Data-ECITest.html index ef4dab46b..42a7e28f2 100644 --- a/classes/chillerlan-QRCodeTest-Data-ECITest.html +++ b/classes/chillerlan-QRCodeTest-Data-ECITest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - testData + testData  = '无可奈何燃花作香'
    @@ -202,13 +203,13 @@
    - $QRData + $QRData  : QRData
    - $testCharset + $testCharset  : int
    @@ -222,45 +223,45 @@
    - eciCharsetIdProvider() + eciCharsetIdProvider()  : array<string|int, mixed>
    - testConvertUnknownEncoding() + testConvertUnknownEncoding()  : void
    Tests detection of an unknown character set
    - testDataModeInstance() + testDataModeInstance()  : void
    - testDecodeECISegmentFollowedByInvalidModeException() + testDecodeECISegmentFollowedByInvalidModeException()  : void
    Tests if and exception is thrown when the ECI segment is followed by a mode that is not 8-bit byte
    - testDecodeSegment() + testDecodeSegment()  : void
    - testInvalidDataException() + testInvalidDataException()  : void
    - testInvalidDataOnEmptyException() + testInvalidDataOnEmptyException()  : void
    @@ -268,32 +269,32 @@ we'll use this test to check for the upper end of the accepted input range
    - testReadWrite() + testReadWrite()  : void
    - unknownEncodingDataProvider() + unknownEncodingDataProvider()  : array<string|int, mixed>
    - versionBreakpointProvider() + versionBreakpointProvider()  : array<string|int, mixed>
    returns versions within the version breakpoints 1-9, 10-26 and 27-40
    - setUp() + setUp()  : void
    - getDataSegments() + getDataSegments()  : array<string|int, mixed>
    @@ -324,6 +325,7 @@ we'll use this test to check for the upper end of the accepted input range< + private mixed @@ -370,6 +372,7 @@ we'll use this test to check for the upper end of the accepted input range< + private QRData @@ -405,6 +408,7 @@ we'll use this test to check for the upper end of the accepted input range< + private int @@ -454,6 +458,7 @@ we'll use this test to check for the upper end of the accepted input range< + @@ -490,6 +495,7 @@ we'll use this test to check for the upper end of the accepted input range<
    +
    Parameters
    @@ -556,6 +562,7 @@ we'll use this test to check for the upper end of the accepted input range< + @@ -590,6 +597,7 @@ we'll use this test to check for the upper end of the accepted input range< + @@ -621,6 +629,7 @@ we'll use this test to check for the upper end of the accepted input range<
    +
    Parameters
    @@ -680,6 +689,7 @@ we'll use this test to check for the upper end of the accepted input range< + @@ -715,6 +725,7 @@ we'll use this test to check for the upper end of the accepted input range< + @@ -746,6 +757,7 @@ we'll use this test to check for the upper end of the accepted input range<
    +
    Parameters
    @@ -812,6 +824,7 @@ we'll use this test to check for the upper end of the accepted input range< + @@ -850,6 +863,7 @@ we'll use this test to check for the upper end of the accepted input range< + @@ -887,6 +901,7 @@ we'll use this test to check for the upper end of the accepted input range< + @@ -920,6 +935,7 @@ we'll use this test to check for the upper end of the accepted input range< + @@ -1042,33 +1058,33 @@ we'll use this test to check for the upper end of the accepted input range<
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Data-HanziTest.html b/classes/chillerlan-QRCodeTest-Data-HanziTest.html index 3d59bf28c..869f7eeb5 100644 --- a/classes/chillerlan-QRCodeTest-Data-HanziTest.html +++ b/classes/chillerlan-QRCodeTest-Data-HanziTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - testData + testData  = '无可奈何燃花作香'
    @@ -202,13 +203,13 @@
    - $dataMode + $dataMode  : QRDataModeInterface
    - $QRData + $QRData  : QRData
    @@ -222,129 +223,129 @@
    - getMaxLengthForMode() + getMaxLengthForMode()  : int
    the maximum character count for the given $mode and $eccLevel
    - hanziProvider() + hanziProvider()  : Generator
    lists all characters in the valid GB2312 range
    - maskPatternProvider() + maskPatternProvider()  : array<string|int, array<string|int, int>>
    - maxLengthProvider() + maxLengthProvider()  : Generator
    Generates test data for each data mode:
    - stringValidateProvider() + stringValidateProvider()  : array<string|int, mixed>
    isGB2312() should pass on Hanzi/GB2312 characters and fail on everything else
    - testBinaryStringInvalid() + testBinaryStringInvalid()  : void
    Tests if a random binary string is properly validated as false
    - testDecodeSegment() + testDecodeSegment()  : void
    Tests decoding a data segment from a given BitBuffer
    - testGetMinimumVersion() + testGetMinimumVersion()  : void
    Tests getting the minimum QR version for the given data
    - testGetMinimumVersionException() + testGetMinimumVersionException()  : void
    Tests if an exception is thrown when the data exceeds the maximum version while auto-detecting
    - testInitMatrix() + testInitMatrix()  : void
    Tests initializing the data matrix
    - testInvalidDataException() + testInvalidDataException()  : void
    Tests if an exception is thrown when an invalid character is encountered
    - testInvalidDataOnEmptyException() + testInvalidDataOnEmptyException()  : void
    Tests if an exception is thrown if the given string is empty
    - testMaxLength() + testMaxLength()  : void
    - testMaxLengthOverflowException() + testMaxLengthOverflowException()  : void
    Tests if an exception is thrown on data overflow
    - testValidateGB2312() + testValidateGB2312()  : void
    - testValidateString() + testValidateString()  : void
    Tests if a string is properly validated for the respective data mode
    - versionBreakpointProvider() + versionBreakpointProvider()  : array<string|int, mixed>
    returns versions within the version breakpoints 1-9, 10-26 and 27-40
    - getDataModeInterface() + getDataModeInterface()  : QRDataModeInterface
    - setUp() + setUp()  : void
    @@ -375,6 +376,7 @@ + protected mixed @@ -421,6 +423,7 @@ + protected QRDataModeInterface @@ -456,6 +459,7 @@ + protected QRData @@ -504,6 +508,7 @@
    +
    Parameters
    @@ -590,6 +595,7 @@ + @@ -627,6 +633,7 @@ + @@ -662,6 +669,7 @@
    +
    diff --git a/classes/chillerlan-QRCodeTest-Data-KanjiTest.html b/classes/chillerlan-QRCodeTest-Data-KanjiTest.html index 5fd6be764..59cec9147 100644 --- a/classes/chillerlan-QRCodeTest-Data-KanjiTest.html +++ b/classes/chillerlan-QRCodeTest-Data-KanjiTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - testData + testData  = '漂う花の香り'
    @@ -202,13 +203,13 @@
    - $dataMode + $dataMode  : QRDataModeInterface
    - $QRData + $QRData  : QRData
    @@ -222,129 +223,129 @@
    - getMaxLengthForMode() + getMaxLengthForMode()  : int
    the maximum character count for the given $mode and $eccLevel
    - kanjiProvider() + kanjiProvider()  : Generator
    lists the valid SJIS kanji
    - maskPatternProvider() + maskPatternProvider()  : array<string|int, array<string|int, int>>
    - maxLengthProvider() + maxLengthProvider()  : Generator
    Generates test data for each data mode:
    - stringValidateProvider() + stringValidateProvider()  : array<string|int, mixed>
    isKanji() should pass on Kanji/SJIS characters and fail on everything else
    - testBinaryStringInvalid() + testBinaryStringInvalid()  : void
    Tests if a random binary string is properly validated as false
    - testDecodeSegment() + testDecodeSegment()  : void
    Tests decoding a data segment from a given BitBuffer
    - testGetMinimumVersion() + testGetMinimumVersion()  : void
    Tests getting the minimum QR version for the given data
    - testGetMinimumVersionException() + testGetMinimumVersionException()  : void
    Tests if an exception is thrown when the data exceeds the maximum version while auto-detecting
    - testInitMatrix() + testInitMatrix()  : void
    Tests initializing the data matrix
    - testInvalidDataException() + testInvalidDataException()  : void
    Tests if an exception is thrown when an invalid character is encountered
    - testInvalidDataOnEmptyException() + testInvalidDataOnEmptyException()  : void
    Tests if an exception is thrown if the given string is empty
    - testMaxLength() + testMaxLength()  : void
    - testMaxLengthOverflowException() + testMaxLengthOverflowException()  : void
    Tests if an exception is thrown on data overflow
    - testValidateSJIS() + testValidateSJIS()  : void
    - testValidateString() + testValidateString()  : void
    Tests if a string is properly validated for the respective data mode
    - versionBreakpointProvider() + versionBreakpointProvider()  : array<string|int, mixed>
    returns versions within the version breakpoints 1-9, 10-26 and 27-40
    - getDataModeInterface() + getDataModeInterface()  : QRDataModeInterface
    - setUp() + setUp()  : void
    @@ -375,6 +376,7 @@ + protected mixed @@ -421,6 +423,7 @@ + protected QRDataModeInterface @@ -456,6 +459,7 @@ + protected QRData @@ -504,6 +508,7 @@
    +
    Parameters
    @@ -590,6 +595,7 @@ + @@ -627,6 +633,7 @@ + @@ -662,6 +669,7 @@
    +
    diff --git a/classes/chillerlan-QRCodeTest-Data-NumberTest.html b/classes/chillerlan-QRCodeTest-Data-NumberTest.html index ce1a09214..4be325f70 100644 --- a/classes/chillerlan-QRCodeTest-Data-NumberTest.html +++ b/classes/chillerlan-QRCodeTest-Data-NumberTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - testData + testData  = '0123456789'
    @@ -202,13 +203,13 @@
    - $dataMode + $dataMode  : QRDataModeInterface
    - $QRData + $QRData  : QRData
    @@ -222,116 +223,116 @@
    - getMaxLengthForMode() + getMaxLengthForMode()  : int
    the maximum character count for the given $mode and $eccLevel
    - maskPatternProvider() + maskPatternProvider()  : array<string|int, array<string|int, int>>
    - maxLengthProvider() + maxLengthProvider()  : Generator
    Generates test data for each data mode:
    - stringValidateProvider() + stringValidateProvider()  : array<string|int, mixed>
    isNumber() should pass on any number and fail on anything else
    - testBinaryStringInvalid() + testBinaryStringInvalid()  : void
    Tests if a random binary string is properly validated as false
    - testDecodeSegment() + testDecodeSegment()  : void
    Tests decoding a data segment from a given BitBuffer
    - testGetMinimumVersion() + testGetMinimumVersion()  : void
    Tests getting the minimum QR version for the given data
    - testGetMinimumVersionException() + testGetMinimumVersionException()  : void
    Tests if an exception is thrown when the data exceeds the maximum version while auto-detecting
    - testInitMatrix() + testInitMatrix()  : void
    Tests initializing the data matrix
    - testInvalidDataException() + testInvalidDataException()  : void
    Tests if an exception is thrown when an invalid character is encountered
    - testInvalidDataOnEmptyException() + testInvalidDataOnEmptyException()  : void
    Tests if an exception is thrown if the given string is empty
    - testMaxLength() + testMaxLength()  : void
    - testMaxLengthOverflowException() + testMaxLengthOverflowException()  : void
    Tests if an exception is thrown on data overflow
    - testValidateString() + testValidateString()  : void
    Tests if a string is properly validated for the respective data mode
    - versionBreakpointProvider() + versionBreakpointProvider()  : array<string|int, mixed>
    returns versions within the version breakpoints 1-9, 10-26 and 27-40
    - getDataModeInterface() + getDataModeInterface()  : QRDataModeInterface
    - setUp() + setUp()  : void
    @@ -362,6 +363,7 @@ + protected mixed @@ -408,6 +410,7 @@ + protected QRDataModeInterface @@ -443,6 +446,7 @@ + protected QRData @@ -491,6 +495,7 @@
    +
    Parameters
    @@ -576,6 +581,7 @@ + @@ -611,6 +617,7 @@
    +
    diff --git a/classes/chillerlan-QRCodeTest-Data-QRDataTest.html b/classes/chillerlan-QRCodeTest-Data-QRDataTest.html index c4fbaedba..7f575db15 100644 --- a/classes/chillerlan-QRCodeTest-Data-QRDataTest.html +++ b/classes/chillerlan-QRCodeTest-Data-QRDataTest.html @@ -170,6 +170,7 @@ +

    Table of Contents @@ -192,27 +193,27 @@

    - testEstimateTotalBitLength() + testEstimateTotalBitLength()  : void
    - testSetBitBuffer() + testSetBitBuffer()  : void
    tests setting the BitBuffer object directly
    - debugMatrix() + debugMatrix()  : void
    Matrix debugging console output
    - dm() + dm()  : void
    @@ -260,6 +261,7 @@ + @@ -294,6 +296,7 @@ + @@ -326,6 +329,7 @@
    +
    Parameters
    @@ -370,6 +374,7 @@
    +
    Parameters
    @@ -515,10 +520,10 @@
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Data-QRMatrixTest.html b/classes/chillerlan-QRCodeTest-Data-QRMatrixTest.html index d159d88b0..cb1064937 100644 --- a/classes/chillerlan-QRCodeTest-Data-QRMatrixTest.html +++ b/classes/chillerlan-QRCodeTest-Data-QRMatrixTest.html @@ -171,6 +171,7 @@ +

    Table of Contents @@ -190,7 +191,7 @@

    - version + version  = 40
    @@ -205,7 +206,7 @@
    - $matrix + $matrix  : QRMatrix
    @@ -219,196 +220,196 @@
    - matrixProvider() + matrixProvider()  : Generator
    Version data provider for several pattern tests
    - testCheckNeighbours() + testCheckNeighbours()  : void
    Tests checking the adjacent modules
    - testCheckTypeIn() + testCheckTypeIn()  : void
    Tests checking whether the M_TYPE of a module is not one of an array of M_TYPES
    - testFlip() + testFlip()  : void
    Tests flipping the value of a module
    - testGetECC() + testGetECC()  : void
    Tests if eccLevel() returns the current (given) ECC level
    - testGetMaskPattern() + testGetMaskPattern()  : void
    Tests if maskPattern() returns the current (or default) mask pattern
    - testGetSetCheck() + testGetSetCheck()  : void
    Tests the set(), get() and check() methods
    - testGetSize() + testGetSize()  : void
    Tests if size() returns the actual matrix size/count
    - testGetVersion() + testGetVersion()  : void
    Tests if version() returns the current (given) version
    - testRotate90() + testRotate90()  : void
    Tests rotating the matrix by 90 degrees CW
    - testSetAlignmentPattern() + testSetAlignmentPattern()  : void
    Tests the alignment patterns and verifies their positions - version 1 (no pattern) skipped
    - testSetDarkModule() + testSetDarkModule()  : void
    Tests setting the dark module and verifies its position
    - testSetFinderPattern() + testSetFinderPattern()  : void
    Tests setting the finder patterns and verifies their positions
    - testSetFormatInfo() + testSetFormatInfo()  : void
    Tests the format patterns and verifies their positions
    - testSetLogoSpaceExceedsException() + testSetLogoSpaceExceedsException()  : void
    Tests whether an exception is thrown when width or height exceed the matrix size
    - testSetLogoSpaceInvalidEccException() + testSetLogoSpaceInvalidEccException()  : void
    Tests whether an exception is thrown when an ECC level other than "H" is set when attempting to add logo space
    - testSetLogoSpaceMaxSizeException() + testSetLogoSpaceMaxSizeException()  : void
    Tests whether an exception is thrown when the logo space size exceeds the maximum ECC capacity
    - testSetLogoSpaceOmitDimension() + testSetLogoSpaceOmitDimension()  : void
    Tests if the logo space is drawn square if one of the dimensions is omitted
    - testSetLogoSpaceOrientation() + testSetLogoSpaceOrientation()  : void
    Tests the auto orientation of the logo space
    - testSetLogoSpacePosition() + testSetLogoSpacePosition()  : void
    Tests the manual positioning of the logo space
    - testSetQuietZone() + testSetQuietZone()  : void
    Tests the quiet zone pattern and verifies its position
    - testSetQuietZoneException() + testSetQuietZoneException()  : void
    Tests if an exception is thrown in an attempt to create the quiet zone before data was written
    - testSetSeparators() + testSetSeparators()  : void
    Tests the separator patterns and verifies their positions
    - testSetTimingPattern() + testSetTimingPattern()  : void
    Tests the timing patterns and verifies their positions
    - testSetVersionNumber() + testSetVersionNumber()  : void
    Tests the version patterns and verifies their positions - version < 7 skipped
    - debugMatrix() + debugMatrix()  : void
    Matrix debugging console output
    - dm() + dm()  : void
    debugging shortcut - limit to a single version when using with matrixProvider
    - setUp() + setUp()  : void
    @@ -440,6 +441,7 @@ + private mixed @@ -486,6 +488,7 @@ + private QRMatrix @@ -536,6 +539,7 @@ + @@ -574,6 +578,7 @@ + @@ -608,6 +613,7 @@ + @@ -642,6 +648,7 @@ + @@ -676,6 +683,7 @@ + @@ -710,6 +718,7 @@ + @@ -744,6 +753,7 @@ + @@ -778,6 +788,7 @@ + @@ -812,6 +823,7 @@ + @@ -844,6 +856,7 @@
    +
    Parameters
    @@ -902,6 +915,7 @@
    +
    Parameters
    @@ -960,6 +974,7 @@
    +
    Parameters
    @@ -1018,6 +1033,7 @@
    +
    Parameters
    @@ -1076,6 +1092,7 @@
    +
    Parameters
    @@ -1136,6 +1153,7 @@ + @@ -1170,6 +1188,7 @@ + @@ -1204,6 +1223,7 @@ + @@ -1238,6 +1258,7 @@ + @@ -1272,6 +1293,7 @@ + @@ -1306,6 +1328,7 @@ + @@ -1338,6 +1361,7 @@
    +
    Parameters
    @@ -1398,6 +1422,7 @@ + @@ -1430,6 +1455,7 @@
    +
    Parameters
    @@ -1488,6 +1514,7 @@
    +
    Parameters
    @@ -1546,6 +1573,7 @@
    +
    Parameters
    @@ -1604,6 +1632,7 @@
    +
    Parameters
    @@ -1648,6 +1677,7 @@
    +
    Parameters
    @@ -1709,6 +1739,7 @@ + @@ -1827,48 +1858,48 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-CssColorModuleValueProviderTrait.html b/classes/chillerlan-QRCodeTest-Output-CssColorModuleValueProviderTrait.html index dbb620dfd..2b92b2f22 100644 --- a/classes/chillerlan-QRCodeTest-Output-CssColorModuleValueProviderTrait.html +++ b/classes/chillerlan-QRCodeTest-Output-CssColorModuleValueProviderTrait.html @@ -143,6 +143,7 @@ +
    Tags @@ -185,7 +186,7 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    @@ -233,6 +234,7 @@ +
    Tags @@ -369,7 +371,7 @@
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QREpsTest.html b/classes/chillerlan-QRCodeTest-Output-QREpsTest.html index 44375aafb..56dd3cce4 100644 --- a/classes/chillerlan-QRCodeTest-Output-QREpsTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QREpsTest.html @@ -167,6 +167,7 @@ should also be used to test custom output modules

    +

    Table of Contents @@ -186,7 +187,7 @@ should also be used to test custom output modules

    - buildDir + buildDir  = 'output-test'
    @@ -201,19 +202,19 @@ should also be used to test custom output modules

    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -227,81 +228,81 @@ should also be used to test custom output modules

    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -333,6 +334,7 @@ should also be used to test custom output modules

    + protected mixed @@ -379,6 +381,7 @@ should also be used to test custom output modules

    + protected QRMatrix @@ -414,6 +417,7 @@ should also be used to test custom output modules

    + protected SettingsContainerInterface|QROptions @@ -449,6 +453,7 @@ should also be used to test custom output modules

    + protected QROutputInterface @@ -498,6 +503,7 @@ should also be used to test custom output modules

    + @@ -536,6 +542,7 @@ should also be used to test custom output modules

    + @@ -570,6 +577,7 @@ should also be used to test custom output modules

    + @@ -604,6 +612,7 @@ should also be used to test custom output modules

    +
    Tags @@ -649,6 +658,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -714,6 +724,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -773,6 +784,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -836,6 +848,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -884,6 +897,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -947,6 +961,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -994,6 +1009,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -1051,6 +1067,7 @@ should also be used to test custom output modules

    + @@ -1169,34 +1186,34 @@ should also be used to test custom output modules

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRFpdfTest.html b/classes/chillerlan-QRCodeTest-Output-QRFpdfTest.html index 8b5373ade..06854396d 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRFpdfTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRFpdfTest.html @@ -171,6 +171,7 @@ +

    Table of Contents @@ -190,7 +191,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -205,19 +206,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -231,87 +232,87 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testOutputGetResource() + testOutputGetResource()  : void
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -343,6 +344,7 @@ + protected mixed @@ -389,6 +391,7 @@ + protected QRMatrix @@ -424,6 +427,7 @@ + protected SettingsContainerInterface|QROptions @@ -459,6 +463,7 @@ + protected QROutputInterface @@ -508,6 +513,7 @@ + @@ -545,6 +551,7 @@ + @@ -579,6 +586,7 @@ + @@ -613,6 +621,7 @@ + @@ -647,6 +656,7 @@ +
    Tags @@ -692,6 +702,7 @@
    +
    Parameters
    @@ -757,6 +768,7 @@
    +
    Parameters
    @@ -816,6 +828,7 @@
    +
    Parameters
    @@ -879,6 +892,7 @@
    +
    Parameters
    @@ -927,6 +941,7 @@
    +
    Parameters
    @@ -990,6 +1005,7 @@
    +
    Parameters
    @@ -1037,6 +1053,7 @@
    +
    Parameters
    @@ -1094,6 +1111,7 @@ +
    Tags @@ -1226,35 +1244,35 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRGdImageBMPTest.html b/classes/chillerlan-QRCodeTest-Output-QRGdImageBMPTest.html index 5736233d2..36511bc4b 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRGdImageBMPTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRGdImageBMPTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -202,19 +203,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -228,93 +229,93 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testBase64MimeType() + testBase64MimeType()  : void
    - testOutputGetResource() + testOutputGetResource()  : void
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -346,6 +347,7 @@ + protected mixed @@ -392,6 +394,7 @@ + protected QRMatrix @@ -427,6 +430,7 @@ + protected SettingsContainerInterface|QROptions @@ -462,6 +466,7 @@ + protected QROutputInterface @@ -511,6 +516,7 @@ + @@ -548,6 +554,7 @@ + @@ -581,6 +588,7 @@ + @@ -615,6 +623,7 @@ + @@ -649,6 +658,7 @@ + @@ -683,6 +693,7 @@ +
    Tags @@ -728,6 +739,7 @@
    +
    Parameters
    @@ -793,6 +805,7 @@
    +
    Parameters
    @@ -852,6 +865,7 @@
    +
    Parameters
    @@ -915,6 +929,7 @@
    +
    Parameters
    @@ -963,6 +978,7 @@
    +
    Parameters
    @@ -1026,6 +1042,7 @@
    +
    Parameters
    @@ -1073,6 +1090,7 @@
    +
    Parameters
    @@ -1130,6 +1148,7 @@ +
    Tags @@ -1262,36 +1281,36 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRGdImageGIFTest.html b/classes/chillerlan-QRCodeTest-Output-QRGdImageGIFTest.html index 15ba41d56..443411628 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRGdImageGIFTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRGdImageGIFTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -202,19 +203,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -228,93 +229,93 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testBase64MimeType() + testBase64MimeType()  : void
    - testOutputGetResource() + testOutputGetResource()  : void
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -346,6 +347,7 @@ + protected mixed @@ -392,6 +394,7 @@ + protected QRMatrix @@ -427,6 +430,7 @@ + protected SettingsContainerInterface|QROptions @@ -462,6 +466,7 @@ + protected QROutputInterface @@ -511,6 +516,7 @@ + @@ -548,6 +554,7 @@ + @@ -581,6 +588,7 @@ + @@ -615,6 +623,7 @@ + @@ -649,6 +658,7 @@ + @@ -683,6 +693,7 @@ +
    Tags @@ -728,6 +739,7 @@
    +
    Parameters
    @@ -793,6 +805,7 @@
    +
    Parameters
    @@ -852,6 +865,7 @@
    +
    Parameters
    @@ -915,6 +929,7 @@
    +
    Parameters
    @@ -963,6 +978,7 @@
    +
    Parameters
    @@ -1026,6 +1042,7 @@
    +
    Parameters
    @@ -1073,6 +1090,7 @@
    +
    Parameters
    @@ -1130,6 +1148,7 @@ +
    Tags @@ -1262,36 +1281,36 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRGdImageJPGTest.html b/classes/chillerlan-QRCodeTest-Output-QRGdImageJPGTest.html index aa63c51c2..9978af50a 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRGdImageJPGTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRGdImageJPGTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -202,19 +203,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -228,93 +229,93 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testBase64MimeType() + testBase64MimeType()  : void
    - testOutputGetResource() + testOutputGetResource()  : void
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -346,6 +347,7 @@ + protected mixed @@ -392,6 +394,7 @@ + protected QRMatrix @@ -427,6 +430,7 @@ + protected SettingsContainerInterface|QROptions @@ -462,6 +466,7 @@ + protected QROutputInterface @@ -511,6 +516,7 @@ + @@ -548,6 +554,7 @@ + @@ -581,6 +588,7 @@ + @@ -615,6 +623,7 @@ + @@ -649,6 +658,7 @@ + @@ -683,6 +693,7 @@ +
    Tags @@ -728,6 +739,7 @@
    +
    Parameters
    @@ -793,6 +805,7 @@
    +
    Parameters
    @@ -852,6 +865,7 @@
    +
    Parameters
    @@ -915,6 +929,7 @@
    +
    Parameters
    @@ -963,6 +978,7 @@
    +
    Parameters
    @@ -1026,6 +1042,7 @@
    +
    Parameters
    @@ -1073,6 +1090,7 @@
    +
    Parameters
    @@ -1130,6 +1148,7 @@ +
    Tags @@ -1262,36 +1281,36 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRGdImagePNGTest.html b/classes/chillerlan-QRCodeTest-Output-QRGdImagePNGTest.html index d827f74f5..e05299b33 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRGdImagePNGTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRGdImagePNGTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -202,19 +203,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -228,93 +229,93 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testBase64MimeType() + testBase64MimeType()  : void
    - testOutputGetResource() + testOutputGetResource()  : void
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -346,6 +347,7 @@ + protected mixed @@ -392,6 +394,7 @@ + protected QRMatrix @@ -427,6 +430,7 @@ + protected SettingsContainerInterface|QROptions @@ -462,6 +466,7 @@ + protected QROutputInterface @@ -511,6 +516,7 @@ + @@ -548,6 +554,7 @@ + @@ -581,6 +588,7 @@ + @@ -615,6 +623,7 @@ + @@ -649,6 +658,7 @@ + @@ -683,6 +693,7 @@ +
    Tags @@ -728,6 +739,7 @@
    +
    Parameters
    @@ -793,6 +805,7 @@
    +
    Parameters
    @@ -852,6 +865,7 @@
    +
    Parameters
    @@ -915,6 +929,7 @@
    +
    Parameters
    @@ -963,6 +978,7 @@
    +
    Parameters
    @@ -1026,6 +1042,7 @@
    +
    Parameters
    @@ -1073,6 +1090,7 @@
    +
    Parameters
    @@ -1130,6 +1148,7 @@ +
    Tags @@ -1262,36 +1281,36 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRGdImageTestAbstract.html b/classes/chillerlan-QRCodeTest-Output-QRGdImageTestAbstract.html index 4efa96bb8..628a8313d 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRGdImageTestAbstract.html +++ b/classes/chillerlan-QRCodeTest-Output-QRGdImageTestAbstract.html @@ -171,6 +171,7 @@ +

    Table of Contents @@ -190,7 +191,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -205,19 +206,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -231,93 +232,93 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testBase64MimeType() + testBase64MimeType()  : void
    - testOutputGetResource() + testOutputGetResource()  : void
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -349,6 +350,7 @@ + protected mixed @@ -395,6 +397,7 @@ + protected QRMatrix @@ -430,6 +433,7 @@ + protected SettingsContainerInterface|QROptions @@ -465,6 +469,7 @@ + protected QROutputInterface @@ -514,6 +519,7 @@ + @@ -551,6 +557,7 @@ + @@ -584,6 +591,7 @@ + @@ -618,6 +626,7 @@ + @@ -652,6 +661,7 @@ + @@ -686,6 +696,7 @@ +
    Tags @@ -731,6 +742,7 @@
    +
    Parameters
    @@ -796,6 +808,7 @@
    +
    Parameters
    @@ -855,6 +868,7 @@
    +
    Parameters
    @@ -918,6 +932,7 @@
    +
    Parameters
    @@ -966,6 +981,7 @@
    +
    Parameters
    @@ -1029,6 +1045,7 @@
    +
    Parameters
    @@ -1076,6 +1093,7 @@
    +
    Parameters
    @@ -1133,6 +1151,7 @@ +
    Tags @@ -1265,36 +1284,36 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRGdImageWEBPTest.html b/classes/chillerlan-QRCodeTest-Output-QRGdImageWEBPTest.html index a777847b9..34d39912a 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRGdImageWEBPTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRGdImageWEBPTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -202,19 +203,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -228,93 +229,93 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testBase64MimeType() + testBase64MimeType()  : void
    - testOutputGetResource() + testOutputGetResource()  : void
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -346,6 +347,7 @@ + protected mixed @@ -392,6 +394,7 @@ + protected QRMatrix @@ -427,6 +430,7 @@ + protected SettingsContainerInterface|QROptions @@ -462,6 +466,7 @@ + protected QROutputInterface @@ -511,6 +516,7 @@ + @@ -548,6 +554,7 @@ + @@ -581,6 +588,7 @@ + @@ -615,6 +623,7 @@ + @@ -649,6 +658,7 @@ + @@ -683,6 +693,7 @@ +
    Tags @@ -728,6 +739,7 @@
    +
    Parameters
    @@ -793,6 +805,7 @@
    +
    Parameters
    @@ -852,6 +865,7 @@
    +
    Parameters
    @@ -915,6 +929,7 @@
    +
    Parameters
    @@ -963,6 +978,7 @@
    +
    Parameters
    @@ -1026,6 +1042,7 @@
    +
    Parameters
    @@ -1073,6 +1090,7 @@
    +
    Parameters
    @@ -1130,6 +1148,7 @@ +
    Tags @@ -1262,36 +1281,36 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRImagickTest.html b/classes/chillerlan-QRCodeTest-Output-QRImagickTest.html index 9ae5ca45c..eeaec9d72 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRImagickTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRImagickTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -202,19 +203,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -228,87 +229,87 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testOutputGetResource() + testOutputGetResource()  : void
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -340,6 +341,7 @@ + protected mixed @@ -386,6 +388,7 @@ + protected QRMatrix @@ -421,6 +424,7 @@ + protected SettingsContainerInterface|QROptions @@ -456,6 +460,7 @@ + protected QROutputInterface @@ -505,6 +510,7 @@ + @@ -542,6 +548,7 @@ + @@ -576,6 +583,7 @@ + @@ -610,6 +618,7 @@ + @@ -644,6 +653,7 @@ +
    Tags @@ -689,6 +699,7 @@
    +
    Parameters
    @@ -754,6 +765,7 @@
    +
    Parameters
    @@ -813,6 +825,7 @@
    +
    Parameters
    @@ -876,6 +889,7 @@
    +
    Parameters
    @@ -924,6 +938,7 @@
    +
    Parameters
    @@ -987,6 +1002,7 @@
    +
    Parameters
    @@ -1034,6 +1050,7 @@
    +
    Parameters
    @@ -1091,6 +1108,7 @@ +
    Tags @@ -1223,35 +1241,35 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRInterventionImageTest.html b/classes/chillerlan-QRCodeTest-Output-QRInterventionImageTest.html index ba403e1a2..582df9d08 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRInterventionImageTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRInterventionImageTest.html @@ -169,6 +169,7 @@ +

    Table of Contents @@ -188,7 +189,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -203,19 +204,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -229,87 +230,87 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testOutputGetResource() + testOutputGetResource()  : void
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -341,6 +342,7 @@ + protected mixed @@ -387,6 +389,7 @@ + protected QRMatrix @@ -422,6 +425,7 @@ + protected SettingsContainerInterface|QROptions @@ -457,6 +461,7 @@ + protected QROutputInterface @@ -506,6 +511,7 @@ +
    Tags @@ -559,6 +565,7 @@ + @@ -593,6 +600,7 @@ + @@ -627,6 +635,7 @@ + @@ -661,6 +670,7 @@ +
    Tags @@ -706,6 +716,7 @@
    +
    Parameters
    @@ -771,6 +782,7 @@
    +
    Parameters
    @@ -830,6 +842,7 @@
    +
    Parameters
    @@ -893,6 +906,7 @@
    +
    Parameters
    @@ -941,6 +955,7 @@
    +
    Parameters
    @@ -1004,6 +1019,7 @@
    +
    Parameters
    @@ -1051,6 +1067,7 @@
    +
    Parameters
    @@ -1108,6 +1125,7 @@ +
    Tags @@ -1240,35 +1258,35 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRMarkupHTMLTest.html b/classes/chillerlan-QRCodeTest-Output-QRMarkupHTMLTest.html index 60fd8e288..81a1387a9 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRMarkupHTMLTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRMarkupHTMLTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -202,19 +203,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -228,81 +229,81 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -334,6 +335,7 @@ + protected mixed @@ -380,6 +382,7 @@ + protected QRMatrix @@ -415,6 +418,7 @@ + protected SettingsContainerInterface|QROptions @@ -450,6 +454,7 @@ + protected QROutputInterface @@ -499,6 +504,7 @@ +
    Tags @@ -553,6 +559,7 @@ + @@ -587,6 +594,7 @@ + @@ -621,6 +629,7 @@ +
    Tags @@ -666,6 +675,7 @@
    +
    Parameters
    @@ -731,6 +741,7 @@
    +
    Parameters
    @@ -790,6 +801,7 @@
    +
    Parameters
    @@ -853,6 +865,7 @@
    +
    Parameters
    @@ -901,6 +914,7 @@
    +
    Parameters
    @@ -964,6 +978,7 @@
    +
    Parameters
    @@ -1011,6 +1026,7 @@
    +
    Parameters
    @@ -1068,6 +1084,7 @@ + @@ -1186,34 +1203,34 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRMarkupSVGTest.html b/classes/chillerlan-QRCodeTest-Output-QRMarkupSVGTest.html index 1fde60e2d..aa58dc027 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRMarkupSVGTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRMarkupSVGTest.html @@ -168,6 +168,7 @@ +

    Table of Contents @@ -187,7 +188,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -202,19 +203,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -228,81 +229,81 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -334,6 +335,7 @@ + protected mixed @@ -380,6 +382,7 @@ + protected QRMatrix @@ -415,6 +418,7 @@ + protected SettingsContainerInterface|QROptions @@ -450,6 +454,7 @@ + protected QROutputInterface @@ -499,6 +504,7 @@ + @@ -537,6 +543,7 @@ + @@ -571,6 +578,7 @@ + @@ -605,6 +613,7 @@ +
    Tags @@ -650,6 +659,7 @@
    +
    Parameters
    @@ -715,6 +725,7 @@
    +
    Parameters
    @@ -774,6 +785,7 @@
    +
    Parameters
    @@ -837,6 +849,7 @@
    +
    Parameters
    @@ -885,6 +898,7 @@
    +
    Parameters
    @@ -948,6 +962,7 @@
    +
    Parameters
    @@ -995,6 +1010,7 @@
    +
    Parameters
    @@ -1052,6 +1068,7 @@ + @@ -1170,34 +1187,34 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRMarkupTestAbstract.html b/classes/chillerlan-QRCodeTest-Output-QRMarkupTestAbstract.html index c0935e82a..94b4aedd9 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRMarkupTestAbstract.html +++ b/classes/chillerlan-QRCodeTest-Output-QRMarkupTestAbstract.html @@ -171,6 +171,7 @@ +

    Table of Contents @@ -190,7 +191,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -205,19 +206,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -231,81 +232,81 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -337,6 +338,7 @@ + protected mixed @@ -383,6 +385,7 @@ + protected QRMatrix @@ -418,6 +421,7 @@ + protected SettingsContainerInterface|QROptions @@ -453,6 +457,7 @@ + protected QROutputInterface @@ -502,6 +507,7 @@ +
    Tags @@ -556,6 +562,7 @@ + @@ -590,6 +597,7 @@ + @@ -624,6 +632,7 @@ +
    Tags @@ -669,6 +678,7 @@
    +
    Parameters
    @@ -734,6 +744,7 @@
    +
    Parameters
    @@ -793,6 +804,7 @@
    +
    Parameters
    @@ -856,6 +868,7 @@
    +
    Parameters
    @@ -904,6 +917,7 @@
    +
    Parameters
    @@ -967,6 +981,7 @@
    +
    Parameters
    @@ -1014,6 +1029,7 @@
    +
    Parameters
    @@ -1071,6 +1087,7 @@ + @@ -1189,34 +1206,34 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRMarkupXMLTest.html b/classes/chillerlan-QRCodeTest-Output-QRMarkupXMLTest.html index 32693f632..4375c2231 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRMarkupXMLTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRMarkupXMLTest.html @@ -166,6 +166,7 @@ +

    Table of Contents @@ -185,7 +186,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -200,19 +201,19 @@
    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -226,81 +227,81 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -332,6 +333,7 @@ + protected mixed @@ -378,6 +380,7 @@ + protected QRMatrix @@ -413,6 +416,7 @@ + protected SettingsContainerInterface|QROptions @@ -448,6 +452,7 @@ + protected QROutputInterface @@ -497,6 +502,7 @@ +
    Tags @@ -551,6 +557,7 @@ + @@ -585,6 +592,7 @@ + @@ -619,6 +627,7 @@ +
    Tags @@ -664,6 +673,7 @@
    +
    Parameters
    @@ -729,6 +739,7 @@
    +
    Parameters
    @@ -788,6 +799,7 @@
    +
    Parameters
    @@ -851,6 +863,7 @@
    +
    Parameters
    @@ -899,6 +912,7 @@
    +
    Parameters
    @@ -962,6 +976,7 @@
    +
    Parameters
    @@ -1009,6 +1024,7 @@
    +
    Parameters
    @@ -1066,6 +1082,7 @@ + @@ -1184,34 +1201,34 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html b/classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html index b75e5e43c..fb29efb45 100644 --- a/classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html +++ b/classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html @@ -172,6 +172,7 @@ should also be used to test custom output modules

    +

    Table of Contents @@ -191,7 +192,7 @@ should also be used to test custom output modules

    - buildDir + buildDir  = 'output-test'
    @@ -206,19 +207,19 @@ should also be used to test custom output modules

    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -232,81 +233,81 @@ should also be used to test custom output modules

    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -338,6 +339,7 @@ should also be used to test custom output modules

    + protected mixed @@ -384,6 +386,7 @@ should also be used to test custom output modules

    + protected QRMatrix @@ -419,6 +422,7 @@ should also be used to test custom output modules

    + protected SettingsContainerInterface|QROptions @@ -454,6 +458,7 @@ should also be used to test custom output modules

    + protected QROutputInterface @@ -503,6 +508,7 @@ should also be used to test custom output modules

    + @@ -541,6 +547,7 @@ should also be used to test custom output modules

    + @@ -575,6 +582,7 @@ should also be used to test custom output modules

    + @@ -609,6 +617,7 @@ should also be used to test custom output modules

    + @@ -640,6 +649,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -705,6 +715,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -764,6 +775,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -827,6 +839,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -875,6 +888,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -938,6 +952,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -985,6 +1000,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -1042,6 +1058,7 @@ should also be used to test custom output modules

    + @@ -1160,34 +1177,34 @@ should also be used to test custom output modules

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html b/classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html index 31e218b3f..ce753a3fd 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html @@ -172,6 +172,7 @@ should also be used to test custom output modules

    +

    Table of Contents @@ -191,7 +192,7 @@ should also be used to test custom output modules

    - buildDir + buildDir  = 'output-test'
    @@ -206,19 +207,19 @@ should also be used to test custom output modules

    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -232,81 +233,81 @@ should also be used to test custom output modules

    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -338,6 +339,7 @@ should also be used to test custom output modules

    + protected mixed @@ -384,6 +386,7 @@ should also be used to test custom output modules

    + protected QRMatrix @@ -419,6 +422,7 @@ should also be used to test custom output modules

    + protected SettingsContainerInterface|QROptions @@ -454,6 +458,7 @@ should also be used to test custom output modules

    + protected QROutputInterface @@ -503,6 +508,7 @@ should also be used to test custom output modules

    +
    Tags @@ -557,6 +563,7 @@ should also be used to test custom output modules

    + @@ -591,6 +598,7 @@ should also be used to test custom output modules

    + @@ -625,6 +633,7 @@ should also be used to test custom output modules

    +
    Tags @@ -670,6 +679,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -735,6 +745,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -794,6 +805,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -857,6 +869,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -905,6 +918,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -968,6 +982,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -1015,6 +1030,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -1072,6 +1088,7 @@ should also be used to test custom output modules

    + @@ -1190,34 +1207,34 @@ should also be used to test custom output modules

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-QRStringTextTest.html b/classes/chillerlan-QRCodeTest-Output-QRStringTextTest.html index e6f8809c3..7b2d9333a 100644 --- a/classes/chillerlan-QRCodeTest-Output-QRStringTextTest.html +++ b/classes/chillerlan-QRCodeTest-Output-QRStringTextTest.html @@ -169,6 +169,7 @@ should also be used to test custom output modules

    +

    Table of Contents @@ -188,7 +189,7 @@ should also be used to test custom output modules

    - buildDir + buildDir  = 'output-test'
    @@ -203,19 +204,19 @@ should also be used to test custom output modules

    - $matrix + $matrix  : QRMatrix
    - $options + $options  : SettingsContainerInterface|QROptions
    - $outputInterface + $outputInterface  : QROutputInterface
    @@ -229,81 +230,81 @@ should also be used to test custom output modules

    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    coverage of the built-in output modules
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - testSetModuleValues() + testSetModuleValues()  : void
    covers the module values settings
    - testValidateModuleValues() + testValidateModuleValues()  : void
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - getOutputInterface() + getOutputInterface()  : QROutputInterface
    - setUp() + setUp()  : void
    @@ -335,6 +336,7 @@ should also be used to test custom output modules

    + protected mixed @@ -381,6 +383,7 @@ should also be used to test custom output modules

    + protected QRMatrix @@ -416,6 +419,7 @@ should also be used to test custom output modules

    + protected SettingsContainerInterface|QROptions @@ -451,6 +455,7 @@ should also be used to test custom output modules

    + protected QROutputInterface @@ -500,6 +505,7 @@ should also be used to test custom output modules

    + @@ -538,6 +544,7 @@ should also be used to test custom output modules

    + @@ -572,6 +579,7 @@ should also be used to test custom output modules

    + @@ -606,6 +614,7 @@ should also be used to test custom output modules

    +
    Tags @@ -651,6 +660,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -716,6 +726,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -775,6 +786,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -838,6 +850,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -886,6 +899,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -949,6 +963,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -996,6 +1011,7 @@ should also be used to test custom output modules

    +
    Parameters
    @@ -1053,6 +1069,7 @@ should also be used to test custom output modules

    + @@ -1171,34 +1188,34 @@ should also be used to test custom output modules

  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-Output-RGBArrayModuleValueProviderTrait.html b/classes/chillerlan-QRCodeTest-Output-RGBArrayModuleValueProviderTrait.html index 409b399c5..eef3b6f3f 100644 --- a/classes/chillerlan-QRCodeTest-Output-RGBArrayModuleValueProviderTrait.html +++ b/classes/chillerlan-QRCodeTest-Output-RGBArrayModuleValueProviderTrait.html @@ -143,6 +143,7 @@ +
    Tags @@ -185,7 +186,7 @@
    - moduleValueProvider() + moduleValueProvider()  : array<string|int, mixed>
    @@ -233,6 +234,7 @@ + @@ -353,7 +355,7 @@
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-QRCodeReaderGDTest.html b/classes/chillerlan-QRCodeTest-QRCodeReaderGDTest.html index ba564d65d..cdf7a5f93 100644 --- a/classes/chillerlan-QRCodeTest-QRCodeReaderGDTest.html +++ b/classes/chillerlan-QRCodeTest-QRCodeReaderGDTest.html @@ -167,6 +167,7 @@ +

    Table of Contents @@ -186,13 +187,13 @@

    - loremipsum + loremipsum  = 'Just let this happen. We just let this flow right out of our minds. ' . 'Anyone can paint. We touch the canvas, the canvas takes what it wants. From all of us here, ' . 'I want to wish you happy painting and God bless, my friends. A tree cannot be straight if it has a crooked trunk. ' . 'You have to make almighty decisions when you\'re the creator. I guess that would be considered a UFO. ' . 'A big cotton ball in the sky. I\'m gonna add just a tiny little amount of Prussian Blue. ' . 'They say everything looks better with odd numbers of things. But sometimes I put even numbers—just ' . 'to upset the critics. We\'ll lay all these little funky little things in there. '
    - samplesDir + samplesDir  = __DIR__ . '/samples/'
    @@ -207,7 +208,7 @@
    - $options + $options  : SettingsContainerInterface|QROptions
    @@ -221,64 +222,64 @@
    - dataTestProvider() + dataTestProvider()  : Generator
    - getMaxLengthForMode() + getMaxLengthForMode()  : int
    the maximum character count for the given $mode and $eccLevel
    - qrCodeProvider() + qrCodeProvider()  : array<string|int, mixed>
    - testReadData() + testReadData()  : void
    - testReader() + testReader()  : void
    - testReaderMultiMode() + testReaderMultiMode()  : void
    - debugMatrix() + debugMatrix()  : void
    Matrix debugging console output
    - dm() + dm()  : void
    debugging shortcut - limit to a single version when using with matrixProvider
    - getLuminanceSourceFromFile() + getLuminanceSourceFromFile()  : LuminanceSourceInterface
    - setUp() + setUp()  : void
    @@ -309,6 +310,7 @@ + protected mixed @@ -354,6 +356,7 @@ + protected mixed @@ -400,6 +403,7 @@ + protected SettingsContainerInterface|QROptions @@ -449,6 +453,7 @@ + @@ -485,6 +490,7 @@
    +
    Parameters
    @@ -570,6 +576,7 @@ + @@ -605,6 +612,7 @@
    +
    Parameters
    @@ -684,6 +692,7 @@
    +
    Parameters
    @@ -765,6 +774,7 @@ + @@ -797,6 +807,7 @@
    +
    Parameters
    @@ -841,6 +852,7 @@
    +
    Parameters
    @@ -899,6 +911,7 @@
    +
    Parameters
    @@ -955,6 +968,7 @@ + @@ -1073,31 +1087,31 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-QRCodeReaderImagickTest.html b/classes/chillerlan-QRCodeTest-QRCodeReaderImagickTest.html index 5d4e65f00..2d8bd5ba0 100644 --- a/classes/chillerlan-QRCodeTest-QRCodeReaderImagickTest.html +++ b/classes/chillerlan-QRCodeTest-QRCodeReaderImagickTest.html @@ -167,6 +167,7 @@ +

    Table of Contents @@ -186,13 +187,13 @@

    - loremipsum + loremipsum  = 'Just let this happen. We just let this flow right out of our minds. ' . 'Anyone can paint. We touch the canvas, the canvas takes what it wants. From all of us here, ' . 'I want to wish you happy painting and God bless, my friends. A tree cannot be straight if it has a crooked trunk. ' . 'You have to make almighty decisions when you\'re the creator. I guess that would be considered a UFO. ' . 'A big cotton ball in the sky. I\'m gonna add just a tiny little amount of Prussian Blue. ' . 'They say everything looks better with odd numbers of things. But sometimes I put even numbers—just ' . 'to upset the critics. We\'ll lay all these little funky little things in there. '
    - samplesDir + samplesDir  = __DIR__ . '/samples/'
    @@ -207,7 +208,7 @@
    - $options + $options  : SettingsContainerInterface|QROptions
    @@ -221,76 +222,76 @@
    - dataTestProvider() + dataTestProvider()  : Generator
    - getMaxLengthForMode() + getMaxLengthForMode()  : int
    the maximum character count for the given $mode and $eccLevel
    - qrCodeProvider() + qrCodeProvider()  : array<string|int, mixed>
    - testReadData() + testReadData()  : void
    - testReader() + testReader()  : void
    - testReaderMultiMode() + testReaderMultiMode()  : void
    - testReadVectorFormats() + testReadVectorFormats()  : void
    - vectorQRCodeProvider() + vectorQRCodeProvider()  : array<string|int, mixed>
    - debugMatrix() + debugMatrix()  : void
    Matrix debugging console output
    - dm() + dm()  : void
    debugging shortcut - limit to a single version when using with matrixProvider
    - getLuminanceSourceFromFile() + getLuminanceSourceFromFile()  : LuminanceSourceInterface
    - setUp() + setUp()  : void
    @@ -321,6 +322,7 @@ + protected mixed @@ -366,6 +368,7 @@ + protected mixed @@ -412,6 +415,7 @@ + protected SettingsContainerInterface|QROptions @@ -461,6 +465,7 @@ + @@ -497,6 +502,7 @@
    +
    Parameters
    @@ -582,6 +588,7 @@ + @@ -617,6 +624,7 @@
    +
    Parameters
    @@ -696,6 +704,7 @@
    +
    Parameters
    @@ -777,6 +786,7 @@ + @@ -808,6 +818,7 @@
    +
    Parameters
    @@ -874,6 +885,7 @@ + @@ -910,6 +922,7 @@
    +
    Parameters
    @@ -954,6 +967,7 @@
    +
    Parameters
    @@ -1012,6 +1026,7 @@
    +
    Parameters
    @@ -1068,6 +1083,7 @@ + @@ -1186,33 +1202,33 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-QRCodeReaderTestAbstract.html b/classes/chillerlan-QRCodeTest-QRCodeReaderTestAbstract.html index bb8ed46bb..557a90f33 100644 --- a/classes/chillerlan-QRCodeTest-QRCodeReaderTestAbstract.html +++ b/classes/chillerlan-QRCodeTest-QRCodeReaderTestAbstract.html @@ -170,6 +170,7 @@ +

    Table of Contents @@ -189,13 +190,13 @@

    - loremipsum + loremipsum  = 'Just let this happen. We just let this flow right out of our minds. ' . 'Anyone can paint. We touch the canvas, the canvas takes what it wants. From all of us here, ' . 'I want to wish you happy painting and God bless, my friends. A tree cannot be straight if it has a crooked trunk. ' . 'You have to make almighty decisions when you\'re the creator. I guess that would be considered a UFO. ' . 'A big cotton ball in the sky. I\'m gonna add just a tiny little amount of Prussian Blue. ' . 'They say everything looks better with odd numbers of things. But sometimes I put even numbers—just ' . 'to upset the critics. We\'ll lay all these little funky little things in there. '
    - samplesDir + samplesDir  = __DIR__ . '/samples/'
    @@ -210,7 +211,7 @@
    - $options + $options  : SettingsContainerInterface|QROptions
    @@ -224,64 +225,64 @@
    - dataTestProvider() + dataTestProvider()  : Generator
    - getMaxLengthForMode() + getMaxLengthForMode()  : int
    the maximum character count for the given $mode and $eccLevel
    - qrCodeProvider() + qrCodeProvider()  : array<string|int, mixed>
    - testReadData() + testReadData()  : void
    - testReader() + testReader()  : void
    - testReaderMultiMode() + testReaderMultiMode()  : void
    - debugMatrix() + debugMatrix()  : void
    Matrix debugging console output
    - dm() + dm()  : void
    debugging shortcut - limit to a single version when using with matrixProvider
    - getLuminanceSourceFromFile() + getLuminanceSourceFromFile()  : LuminanceSourceInterface
    - setUp() + setUp()  : void
    @@ -312,6 +313,7 @@ + protected mixed @@ -357,6 +359,7 @@ + protected mixed @@ -403,6 +406,7 @@ + protected SettingsContainerInterface|QROptions @@ -452,6 +456,7 @@ + @@ -488,6 +493,7 @@
    +
    Parameters
    @@ -573,6 +579,7 @@ + @@ -608,6 +615,7 @@
    +
    Parameters
    @@ -687,6 +695,7 @@
    +
    Parameters
    @@ -768,6 +777,7 @@ + @@ -800,6 +810,7 @@
    +
    Parameters
    @@ -844,6 +855,7 @@
    +
    Parameters
    @@ -902,6 +914,7 @@
    +
    Parameters
    @@ -958,6 +971,7 @@ + @@ -1076,31 +1090,31 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-QRCodeTest.html b/classes/chillerlan-QRCodeTest-QRCodeTest.html index c2fa28d05..d3844baf1 100644 --- a/classes/chillerlan-QRCodeTest-QRCodeTest.html +++ b/classes/chillerlan-QRCodeTest-QRCodeTest.html @@ -170,6 +170,7 @@ +

    Table of Contents @@ -189,7 +190,7 @@

    - buildDir + buildDir  = 'output-test'
    @@ -204,13 +205,13 @@
    - $options + $options  : QROptions
    - $qrcode + $qrcode  : QRCode
    @@ -224,70 +225,70 @@
    - testInitCustomOutputInterfaceNotExistsException() + testInitCustomOutputInterfaceNotExistsException()  : void
    tests if an exception is thrown if the given output class does not exist
    - testInitCustomOutputInterfaceNotImplementsException() + testInitCustomOutputInterfaceNotImplementsException()  : void
    tests if an exception is thrown if the given output class does not implement QROutputInterface
    - testRenderToCacheFile() + testRenderToCacheFile()  : void
    Tests if a cache file is properly saved in the given path
    - testSaveException() + testSaveException()  : void
    Tests if an exception is thrown when trying to write a cache file to an invalid destination
    - createBuildDir() + createBuildDir()  : void
    attempts to create the build dir
    - getBuildDir() + getBuildDir()  : string
    returns the full (real) path to the given build path
    - getBuildFileContent() + getBuildFileContent()  : string
    returns the contents of the given build file
    - getBuildFilePath() + getBuildFilePath()  : string
    returns the full (real) path to the given build file
    - getBuildPath() + getBuildPath()  : string
    returns the full raw path to the build dir
    - setUp() + setUp()  : void
    @@ -319,6 +320,7 @@ + private mixed @@ -365,6 +367,7 @@ + private QROptions @@ -400,6 +403,7 @@ + private QRCode @@ -450,6 +454,7 @@ + @@ -484,6 +489,7 @@ + @@ -518,6 +524,7 @@ + @@ -552,6 +559,7 @@ + @@ -584,6 +592,7 @@
    +
    Parameters
    @@ -643,6 +652,7 @@
    +
    Parameters
    @@ -706,6 +716,7 @@
    +
    Parameters
    @@ -754,6 +765,7 @@
    +
    Parameters
    @@ -817,6 +829,7 @@
    +
    Parameters
    @@ -867,6 +880,7 @@ + @@ -985,31 +999,31 @@
  • Constants
  • Properties
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html b/classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html index 3d087f551..367071331 100644 --- a/classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html +++ b/classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html @@ -147,6 +147,7 @@ +

    Table of Contents @@ -169,14 +170,14 @@

    - debugMatrix() + debugMatrix()  : void
    Matrix debugging console output
    - dm() + dm()  : void
    @@ -224,6 +225,7 @@
    +
    Parameters
    @@ -268,6 +270,7 @@
    +
    Parameters
    @@ -411,8 +414,8 @@
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-QRMaxLengthTrait.html b/classes/chillerlan-QRCodeTest-QRMaxLengthTrait.html index 5632d875b..40ac66b68 100644 --- a/classes/chillerlan-QRCodeTest-QRMaxLengthTrait.html +++ b/classes/chillerlan-QRCodeTest-QRMaxLengthTrait.html @@ -147,6 +147,7 @@ +

    Table of Contents @@ -166,7 +167,7 @@

    - MAX_LENGTH + MAX_LENGTH  = [ // v => [NUMERIC => [L, M, Q, H ], ALPHANUM => [L, M, Q, H], BINARY => [L, M, Q, H ], KANJI => [L, M, Q, H ]] @@ -225,7 +226,7 @@
    - getMaxLengthForMode() + getMaxLengthForMode()  : int
    @@ -259,6 +260,7 @@

    ISO/IEC 18004:2000 Tables 7-11 - Number of symbol characters and input data capacity for versions 1 to 40

    + protected array<string|int, array<string|int, array<string|int, int>>> @@ -368,6 +370,7 @@
    +
    Parameters
    @@ -537,13 +540,13 @@
  • Constants
  • Methods
    • diff --git a/classes/chillerlan-QRCodeTest-QROptionsTest.html b/classes/chillerlan-QRCodeTest-QROptionsTest.html index edd38afce..24cb6f162 100644 --- a/classes/chillerlan-QRCodeTest-QROptionsTest.html +++ b/classes/chillerlan-QRCodeTest-QROptionsTest.html @@ -167,6 +167,7 @@ +

    Table of Contents @@ -189,87 +190,87 @@

    - circleRadiusProvider() + circleRadiusProvider()  : array<string|int, array<string|int, float>>
    - logoSpaceValueProvider() + logoSpaceValueProvider()  : array<string|int, array<string|int, int>>
    - RGBProvider() + RGBProvider()  : array<string|int, array<string|int, array<string|int, int>>>
    - testClampCircleRadius() + testClampCircleRadius()  : void
    Tests clamping of the circle radius
    - testClampLogoSpaceValue() + testClampLogoSpaceValue()  : void
    Tests the clamping (between 0 and 177) of the logo space values
    - testLogoSpaceStartNullable() + testLogoSpaceStartNullable()  : void
    Tests if the optional logo space start values are nullable
    - testSetEccLevel() + testSetEccLevel()  : void
    Tests setting the ECC level from string or int
    - testSetEccLevelFromIntException() + testSetEccLevelFromIntException()  : void
    Tests if an exception is thrown when attempting to set an invalid ECC level integer
    - testSetEccLevelFromStringException() + testSetEccLevelFromStringException()  : void
    Tests if an exception is thrown when attempting to set an invalid ECC level string
    - testVersionClamp() + testVersionClamp()  : void
    Tests the $version clamping
    - testVersionMinMaxClamp() + testVersionMinMaxClamp()  : void
    Tests the $versionMin/$versionMax clamping
    - VersionMinMaxProvider() + VersionMinMaxProvider()  : array<string|int, array<string|int, int>>
    - VersionProvider() + VersionProvider()  : array<string|int, array<string|int, int>>
    @@ -316,6 +317,7 @@ + @@ -353,6 +355,7 @@ + @@ -390,6 +393,7 @@ + @@ -426,6 +430,7 @@
    +
    Parameters
    @@ -491,6 +496,7 @@
    +
    Parameters
    @@ -558,6 +564,7 @@ + @@ -592,6 +599,7 @@ + @@ -626,6 +634,7 @@ + @@ -660,6 +669,7 @@ + @@ -692,6 +702,7 @@
    +
    Parameters
    @@ -757,6 +768,7 @@
    +
    Parameters
    @@ -837,6 +849,7 @@ + @@ -874,6 +887,7 @@ + @@ -996,19 +1010,19 @@
  • Methods
    • diff --git a/css/base.css b/css/base.css index 08e77bdae..3b525072f 100644 --- a/css/base.css +++ b/css/base.css @@ -1216,6 +1216,10 @@ is too big a fix and needs to be done in a new design iteration. word-break: break-all; line-height: normal; } + + .phpdocumentor-on-this-page__content li.-deprecated { + text-decoration: line-through; + } } /* Used for screen readers and such */ diff --git a/css/template.css b/css/template.css index cafd680dd..ee2e68d4d 100644 --- a/css/template.css +++ b/css/template.css @@ -126,6 +126,10 @@ flex: 0 1 auto; } +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a.-deprecated { + text-decoration: line-through; +} + .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span { flex: 1; white-space: nowrap; diff --git a/files/src-common-bitbuffer.html b/files/src-common-bitbuffer.html index e21b8d6d0..2b138cd40 100644 --- a/files/src-common-bitbuffer.html +++ b/files/src-common-bitbuffer.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-common-ecclevel.html b/files/src-common-ecclevel.html index 0481c3f6c..52b9ed30c 100644 --- a/files/src-common-ecclevel.html +++ b/files/src-common-ecclevel.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-common-ecicharset.html b/files/src-common-ecicharset.html index 37c3b1df5..935491d60 100644 --- a/files/src-common-ecicharset.html +++ b/files/src-common-ecicharset.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-common-gdluminancesource.html b/files/src-common-gdluminancesource.html index 0ed562824..1d5d46821 100644 --- a/files/src-common-gdluminancesource.html +++ b/files/src-common-gdluminancesource.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-common-genericgfpoly.html b/files/src-common-genericgfpoly.html index ae5461629..58d19d368 100644 --- a/files/src-common-genericgfpoly.html +++ b/files/src-common-genericgfpoly.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-common-gf256.html b/files/src-common-gf256.html index 97047ff94..62d8ffedb 100644 --- a/files/src-common-gf256.html +++ b/files/src-common-gf256.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-common-imagickluminancesource.html b/files/src-common-imagickluminancesource.html index fae82bae6..38656b887 100644 --- a/files/src-common-imagickluminancesource.html +++ b/files/src-common-imagickluminancesource.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-common-luminancesourceabstract.html b/files/src-common-luminancesourceabstract.html index 4dbad844b..8a35f9d89 100644 --- a/files/src-common-luminancesourceabstract.html +++ b/files/src-common-luminancesourceabstract.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-common-luminancesourceinterface.html b/files/src-common-luminancesourceinterface.html index 1678f115e..5d8cebb2e 100644 --- a/files/src-common-luminancesourceinterface.html +++ b/files/src-common-luminancesourceinterface.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-common-maskpattern.html b/files/src-common-maskpattern.html index e52858695..6268a0ef0 100644 --- a/files/src-common-maskpattern.html +++ b/files/src-common-maskpattern.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-common-mode.html b/files/src-common-mode.html index b87d95037..fe5f2058d 100644 --- a/files/src-common-mode.html +++ b/files/src-common-mode.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-common-version.html b/files/src-common-version.html index 4b39b5eb8..9945cecba 100644 --- a/files/src-common-version.html +++ b/files/src-common-version.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-data-alphanum.html b/files/src-data-alphanum.html index 6c3bdc1ed..789479632 100644 --- a/files/src-data-alphanum.html +++ b/files/src-data-alphanum.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-data-byte.html b/files/src-data-byte.html index b90660804..ebf19ca49 100644 --- a/files/src-data-byte.html +++ b/files/src-data-byte.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-data-eci.html b/files/src-data-eci.html index 05f1de7a4..4d32dcbab 100644 --- a/files/src-data-eci.html +++ b/files/src-data-eci.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-data-hanzi.html b/files/src-data-hanzi.html index 14cd488b4..d4eb0d9e4 100644 --- a/files/src-data-hanzi.html +++ b/files/src-data-hanzi.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-data-kanji.html b/files/src-data-kanji.html index 14377110c..9ed481ee9 100644 --- a/files/src-data-kanji.html +++ b/files/src-data-kanji.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-data-number.html b/files/src-data-number.html index 823d65386..e6d6e4f85 100644 --- a/files/src-data-number.html +++ b/files/src-data-number.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-data-qrcodedataexception.html b/files/src-data-qrcodedataexception.html index feb8c75bc..b411d941f 100644 --- a/files/src-data-qrcodedataexception.html +++ b/files/src-data-qrcodedataexception.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-data-qrdata.html b/files/src-data-qrdata.html index ec7913210..520170a8d 100644 --- a/files/src-data-qrdata.html +++ b/files/src-data-qrdata.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-data-qrdatamodeabstract.html b/files/src-data-qrdatamodeabstract.html index 309a00474..917fa5795 100644 --- a/files/src-data-qrdatamodeabstract.html +++ b/files/src-data-qrdatamodeabstract.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-data-qrdatamodeinterface.html b/files/src-data-qrdatamodeinterface.html index 2165d7237..cc9c30dff 100644 --- a/files/src-data-qrdatamodeinterface.html +++ b/files/src-data-qrdatamodeinterface.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-data-qrmatrix.html b/files/src-data-qrmatrix.html index 852a3bd60..7b2eb445a 100644 --- a/files/src-data-qrmatrix.html +++ b/files/src-data-qrmatrix.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-data-reedsolomonencoder.html b/files/src-data-reedsolomonencoder.html index 85de6d45a..e03b30091 100644 --- a/files/src-data-reedsolomonencoder.html +++ b/files/src-data-reedsolomonencoder.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-decoder-binarizer.html b/files/src-decoder-binarizer.html index 982852201..111728e76 100644 --- a/files/src-decoder-binarizer.html +++ b/files/src-decoder-binarizer.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-decoder-bitmatrix.html b/files/src-decoder-bitmatrix.html index 1fee76d34..8f444f576 100644 --- a/files/src-decoder-bitmatrix.html +++ b/files/src-decoder-bitmatrix.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-decoder-decoder.html b/files/src-decoder-decoder.html index 1256ddbaf..7d7aa21c8 100644 --- a/files/src-decoder-decoder.html +++ b/files/src-decoder-decoder.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-decoder-decoderresult.html b/files/src-decoder-decoderresult.html index bb558608a..ea867b7de 100644 --- a/files/src-decoder-decoderresult.html +++ b/files/src-decoder-decoderresult.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-decoder-qrcodedecoderexception.html b/files/src-decoder-qrcodedecoderexception.html index b4b309996..d0f470477 100644 --- a/files/src-decoder-qrcodedecoderexception.html +++ b/files/src-decoder-qrcodedecoderexception.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-decoder-reedsolomondecoder.html b/files/src-decoder-reedsolomondecoder.html index 3cc90b76c..19e06a36b 100644 --- a/files/src-decoder-reedsolomondecoder.html +++ b/files/src-decoder-reedsolomondecoder.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-detector-alignmentpattern.html b/files/src-detector-alignmentpattern.html index af65b4583..38acd8587 100644 --- a/files/src-detector-alignmentpattern.html +++ b/files/src-detector-alignmentpattern.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-detector-alignmentpatternfinder.html b/files/src-detector-alignmentpatternfinder.html index 043ac1f1a..a0fb8deb0 100644 --- a/files/src-detector-alignmentpatternfinder.html +++ b/files/src-detector-alignmentpatternfinder.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-detector-detector.html b/files/src-detector-detector.html index 16bcebada..e895f788e 100644 --- a/files/src-detector-detector.html +++ b/files/src-detector-detector.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-detector-finderpattern.html b/files/src-detector-finderpattern.html index da6483ecc..4b93694b9 100644 --- a/files/src-detector-finderpattern.html +++ b/files/src-detector-finderpattern.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-detector-finderpatternfinder.html b/files/src-detector-finderpatternfinder.html index 75a1d2056..566c4c57e 100644 --- a/files/src-detector-finderpatternfinder.html +++ b/files/src-detector-finderpatternfinder.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-detector-gridsampler.html b/files/src-detector-gridsampler.html index 2b8d89cec..a42c76dcb 100644 --- a/files/src-detector-gridsampler.html +++ b/files/src-detector-gridsampler.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-detector-perspectivetransform.html b/files/src-detector-perspectivetransform.html index 112a3b2a3..6db977e48 100644 --- a/files/src-detector-perspectivetransform.html +++ b/files/src-detector-perspectivetransform.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-detector-qrcodedetectorexception.html b/files/src-detector-qrcodedetectorexception.html index 91811f0cb..da10edb4d 100644 --- a/files/src-detector-qrcodedetectorexception.html +++ b/files/src-detector-qrcodedetectorexception.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-detector-resultpoint.html b/files/src-detector-resultpoint.html index eadbf31e4..e1418c018 100644 --- a/files/src-detector-resultpoint.html +++ b/files/src-detector-resultpoint.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-csscolormodulevaluetrait.html b/files/src-output-csscolormodulevaluetrait.html index 62ed6bc20..e0871603a 100644 --- a/files/src-output-csscolormodulevaluetrait.html +++ b/files/src-output-csscolormodulevaluetrait.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrcodeoutputexception.html b/files/src-output-qrcodeoutputexception.html index dd1a429c1..5c30f7834 100644 --- a/files/src-output-qrcodeoutputexception.html +++ b/files/src-output-qrcodeoutputexception.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qreps.html b/files/src-output-qreps.html index 1b599fd35..8d31149c4 100644 --- a/files/src-output-qreps.html +++ b/files/src-output-qreps.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrfpdf.html b/files/src-output-qrfpdf.html index 7047976f2..66755e720 100644 --- a/files/src-output-qrfpdf.html +++ b/files/src-output-qrfpdf.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrgdimage.html b/files/src-output-qrgdimage.html index a3b06a9f8..3b93753c5 100644 --- a/files/src-output-qrgdimage.html +++ b/files/src-output-qrgdimage.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrgdimageavif.html b/files/src-output-qrgdimageavif.html index 15a5757f7..dbc828ee1 100644 --- a/files/src-output-qrgdimageavif.html +++ b/files/src-output-qrgdimageavif.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrgdimagebmp.html b/files/src-output-qrgdimagebmp.html index c3ed24f9c..2020ebf8b 100644 --- a/files/src-output-qrgdimagebmp.html +++ b/files/src-output-qrgdimagebmp.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrgdimagegif.html b/files/src-output-qrgdimagegif.html index 219e4b026..44f0c0360 100644 --- a/files/src-output-qrgdimagegif.html +++ b/files/src-output-qrgdimagegif.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrgdimagejpeg.html b/files/src-output-qrgdimagejpeg.html index 576d0360e..8abeed641 100644 --- a/files/src-output-qrgdimagejpeg.html +++ b/files/src-output-qrgdimagejpeg.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrgdimagepng.html b/files/src-output-qrgdimagepng.html index ac184eaf2..389512e48 100644 --- a/files/src-output-qrgdimagepng.html +++ b/files/src-output-qrgdimagepng.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrgdimagewebp.html b/files/src-output-qrgdimagewebp.html index 838cfacbb..2c7b5fd5a 100644 --- a/files/src-output-qrgdimagewebp.html +++ b/files/src-output-qrgdimagewebp.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrimagick.html b/files/src-output-qrimagick.html index 1d076ab23..7af5f796b 100644 --- a/files/src-output-qrimagick.html +++ b/files/src-output-qrimagick.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrinterventionimage.html b/files/src-output-qrinterventionimage.html index 0f5616b28..879384d08 100644 --- a/files/src-output-qrinterventionimage.html +++ b/files/src-output-qrinterventionimage.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrmarkup.html b/files/src-output-qrmarkup.html index 7c5589a8f..165f6bf7e 100644 --- a/files/src-output-qrmarkup.html +++ b/files/src-output-qrmarkup.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrmarkuphtml.html b/files/src-output-qrmarkuphtml.html index 0de8b1d4a..dc8e8f8cf 100644 --- a/files/src-output-qrmarkuphtml.html +++ b/files/src-output-qrmarkuphtml.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrmarkupsvg.html b/files/src-output-qrmarkupsvg.html index 292d846cb..d25c4a6c8 100644 --- a/files/src-output-qrmarkupsvg.html +++ b/files/src-output-qrmarkupsvg.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrmarkupxml.html b/files/src-output-qrmarkupxml.html index c2800d159..35ec08725 100644 --- a/files/src-output-qrmarkupxml.html +++ b/files/src-output-qrmarkupxml.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qroutputabstract.html b/files/src-output-qroutputabstract.html index 236b7e55f..5392a1ddf 100644 --- a/files/src-output-qroutputabstract.html +++ b/files/src-output-qroutputabstract.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qroutputinterface.html b/files/src-output-qroutputinterface.html index 1192997d6..e38c53cbf 100644 --- a/files/src-output-qroutputinterface.html +++ b/files/src-output-qroutputinterface.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrstringjson.html b/files/src-output-qrstringjson.html index 85b1bae41..e8090a29a 100644 --- a/files/src-output-qrstringjson.html +++ b/files/src-output-qrstringjson.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-qrstringtext.html b/files/src-output-qrstringtext.html index 25b94183b..14d2951a9 100644 --- a/files/src-output-qrstringtext.html +++ b/files/src-output-qrstringtext.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-output-rgbarraymodulevaluetrait.html b/files/src-output-rgbarraymodulevaluetrait.html index 7e7ff7016..557803524 100644 --- a/files/src-output-rgbarraymodulevaluetrait.html +++ b/files/src-output-rgbarraymodulevaluetrait.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-qrcode.html b/files/src-qrcode.html index 378753f2f..98bd99ba9 100644 --- a/files/src-qrcode.html +++ b/files/src-qrcode.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-qrcodeexception.html b/files/src-qrcodeexception.html index d8a2fffbd..2e5368e0d 100644 --- a/files/src-qrcodeexception.html +++ b/files/src-qrcodeexception.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-qrcodereaderoptionstrait.html b/files/src-qrcodereaderoptionstrait.html index ebb1f688b..2fbb99d72 100644 --- a/files/src-qrcodereaderoptionstrait.html +++ b/files/src-qrcodereaderoptionstrait.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-qroptions.html b/files/src-qroptions.html index d62fed20f..e87e904d1 100644 --- a/files/src-qroptions.html +++ b/files/src-qroptions.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/src-qroptionstrait.html b/files/src-qroptionstrait.html index 6d59e36ae..3171254db 100644 --- a/files/src-qroptionstrait.html +++ b/files/src-qroptionstrait.html @@ -129,6 +129,7 @@

    Trait QROptionsTrait

    +

    Note: the docblocks in this file are optimized for readability in PhpStorm ond on readthedocs.io

    diff --git a/files/tests-builddirtrait.html b/files/tests-builddirtrait.html index ecef24d07..6b1f88af2 100644 --- a/files/tests-builddirtrait.html +++ b/files/tests-builddirtrait.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-common-bitbuffertest.html b/files/tests-common-bitbuffertest.html index 0105efb98..47ef59bfe 100644 --- a/files/tests-common-bitbuffertest.html +++ b/files/tests-common-bitbuffertest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-common-eccleveltest.html b/files/tests-common-eccleveltest.html index 754283dfc..900d8f829 100644 --- a/files/tests-common-eccleveltest.html +++ b/files/tests-common-eccleveltest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-common-ecicharsettest.html b/files/tests-common-ecicharsettest.html index ce81f4d61..9a36d571a 100644 --- a/files/tests-common-ecicharsettest.html +++ b/files/tests-common-ecicharsettest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-common-maskpatterntest.html b/files/tests-common-maskpatterntest.html index f52faf737..a2b511b7c 100644 --- a/files/tests-common-maskpatterntest.html +++ b/files/tests-common-maskpatterntest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-common-modetest.html b/files/tests-common-modetest.html index b36b43dd2..159384d3b 100644 --- a/files/tests-common-modetest.html +++ b/files/tests-common-modetest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-common-versiontest.html b/files/tests-common-versiontest.html index 67d62db52..d423a8b49 100644 --- a/files/tests-common-versiontest.html +++ b/files/tests-common-versiontest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-data-alphanumtest.html b/files/tests-data-alphanumtest.html index 6ad5e204b..db8394899 100644 --- a/files/tests-data-alphanumtest.html +++ b/files/tests-data-alphanumtest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-data-bytetest.html b/files/tests-data-bytetest.html index bf06523b4..a4f8b43b8 100644 --- a/files/tests-data-bytetest.html +++ b/files/tests-data-bytetest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-data-datainterfacetestabstract.html b/files/tests-data-datainterfacetestabstract.html index 84837d745..b1ccbc6af 100644 --- a/files/tests-data-datainterfacetestabstract.html +++ b/files/tests-data-datainterfacetestabstract.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-data-ecitest.html b/files/tests-data-ecitest.html index 05e4365ad..ddef3bf44 100644 --- a/files/tests-data-ecitest.html +++ b/files/tests-data-ecitest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-data-hanzitest.html b/files/tests-data-hanzitest.html index 5ec59cad9..af3191163 100644 --- a/files/tests-data-hanzitest.html +++ b/files/tests-data-hanzitest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-data-kanjitest.html b/files/tests-data-kanjitest.html index b577f4ef1..810c3361a 100644 --- a/files/tests-data-kanjitest.html +++ b/files/tests-data-kanjitest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-data-numbertest.html b/files/tests-data-numbertest.html index ffdccd935..cf08baf9e 100644 --- a/files/tests-data-numbertest.html +++ b/files/tests-data-numbertest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-data-qrdatatest.html b/files/tests-data-qrdatatest.html index 33a135b4b..5db5fefa1 100644 --- a/files/tests-data-qrdatatest.html +++ b/files/tests-data-qrdatatest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-data-qrmatrixtest.html b/files/tests-data-qrmatrixtest.html index 186d81223..d1ce17ab3 100644 --- a/files/tests-data-qrmatrixtest.html +++ b/files/tests-data-qrmatrixtest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-csscolormodulevalueprovidertrait.html b/files/tests-output-csscolormodulevalueprovidertrait.html index fd667d89c..48f7650ab 100644 --- a/files/tests-output-csscolormodulevalueprovidertrait.html +++ b/files/tests-output-csscolormodulevalueprovidertrait.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrepstest.html b/files/tests-output-qrepstest.html index cf047cf12..613060adc 100644 --- a/files/tests-output-qrepstest.html +++ b/files/tests-output-qrepstest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrfpdftest.html b/files/tests-output-qrfpdftest.html index 3cf3358e4..9cc6cf23d 100644 --- a/files/tests-output-qrfpdftest.html +++ b/files/tests-output-qrfpdftest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrgdimageaviftest.html b/files/tests-output-qrgdimageaviftest.html index fca878799..0d8f357b9 100644 --- a/files/tests-output-qrgdimageaviftest.html +++ b/files/tests-output-qrgdimageaviftest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrgdimagebmptest.html b/files/tests-output-qrgdimagebmptest.html index 7c6867fdb..de88cbbbb 100644 --- a/files/tests-output-qrgdimagebmptest.html +++ b/files/tests-output-qrgdimagebmptest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrgdimagegiftest.html b/files/tests-output-qrgdimagegiftest.html index 52aa0e27f..dcef67e3a 100644 --- a/files/tests-output-qrgdimagegiftest.html +++ b/files/tests-output-qrgdimagegiftest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrgdimagejpgtest.html b/files/tests-output-qrgdimagejpgtest.html index b9487cab4..b9b1bf7a0 100644 --- a/files/tests-output-qrgdimagejpgtest.html +++ b/files/tests-output-qrgdimagejpgtest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrgdimagepngtest.html b/files/tests-output-qrgdimagepngtest.html index bb0827371..a11c68042 100644 --- a/files/tests-output-qrgdimagepngtest.html +++ b/files/tests-output-qrgdimagepngtest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrgdimagetestabstract.html b/files/tests-output-qrgdimagetestabstract.html index cf914d51c..80dcc65c7 100644 --- a/files/tests-output-qrgdimagetestabstract.html +++ b/files/tests-output-qrgdimagetestabstract.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrgdimagewebptest.html b/files/tests-output-qrgdimagewebptest.html index 6723a1acd..fb0da2903 100644 --- a/files/tests-output-qrgdimagewebptest.html +++ b/files/tests-output-qrgdimagewebptest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrimagicktest.html b/files/tests-output-qrimagicktest.html index 4fb2e5afc..31389a5a0 100644 --- a/files/tests-output-qrimagicktest.html +++ b/files/tests-output-qrimagicktest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrinterventionimagetest.html b/files/tests-output-qrinterventionimagetest.html index 1b5061d47..d935c93bb 100644 --- a/files/tests-output-qrinterventionimagetest.html +++ b/files/tests-output-qrinterventionimagetest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrmarkuphtmltest.html b/files/tests-output-qrmarkuphtmltest.html index 628dd7fc2..1e6015736 100644 --- a/files/tests-output-qrmarkuphtmltest.html +++ b/files/tests-output-qrmarkuphtmltest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrmarkupsvgtest.html b/files/tests-output-qrmarkupsvgtest.html index b01c062f8..4c51871ae 100644 --- a/files/tests-output-qrmarkupsvgtest.html +++ b/files/tests-output-qrmarkupsvgtest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrmarkuptestabstract.html b/files/tests-output-qrmarkuptestabstract.html index 35167bab6..ffac3e289 100644 --- a/files/tests-output-qrmarkuptestabstract.html +++ b/files/tests-output-qrmarkuptestabstract.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrmarkupxmltest.html b/files/tests-output-qrmarkupxmltest.html index 8846ff04a..dd1280b66 100644 --- a/files/tests-output-qrmarkupxmltest.html +++ b/files/tests-output-qrmarkupxmltest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qroutputtestabstract.html b/files/tests-output-qroutputtestabstract.html index 99f7941c7..cb01ec825 100644 --- a/files/tests-output-qroutputtestabstract.html +++ b/files/tests-output-qroutputtestabstract.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrstringjsontest.html b/files/tests-output-qrstringjsontest.html index 3392308c6..a8c1ca66f 100644 --- a/files/tests-output-qrstringjsontest.html +++ b/files/tests-output-qrstringjsontest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-qrstringtexttest.html b/files/tests-output-qrstringtexttest.html index 50575c160..383e08bed 100644 --- a/files/tests-output-qrstringtexttest.html +++ b/files/tests-output-qrstringtexttest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-output-rgbarraymodulevalueprovidertrait.html b/files/tests-output-rgbarraymodulevalueprovidertrait.html index 8fa2fc443..f3c0ea440 100644 --- a/files/tests-output-rgbarraymodulevalueprovidertrait.html +++ b/files/tests-output-rgbarraymodulevalueprovidertrait.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-qrcodereadergdtest.html b/files/tests-qrcodereadergdtest.html index 6ef7b18d9..073d887e8 100644 --- a/files/tests-qrcodereadergdtest.html +++ b/files/tests-qrcodereadergdtest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-qrcodereaderimagicktest.html b/files/tests-qrcodereaderimagicktest.html index 1457c64e3..a62d610b8 100644 --- a/files/tests-qrcodereaderimagicktest.html +++ b/files/tests-qrcodereaderimagicktest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-qrcodereadertestabstract.html b/files/tests-qrcodereadertestabstract.html index e4244e43b..7a36ca350 100644 --- a/files/tests-qrcodereadertestabstract.html +++ b/files/tests-qrcodereadertestabstract.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-qrcodetest.html b/files/tests-qrcodetest.html index 667f92519..c2795646b 100644 --- a/files/tests-qrcodetest.html +++ b/files/tests-qrcodetest.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-qrmatrixdebugtrait.html b/files/tests-qrmatrixdebugtrait.html index a7da974f1..02ddfe499 100644 --- a/files/tests-qrmatrixdebugtrait.html +++ b/files/tests-qrmatrixdebugtrait.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-qrmaxlengthtrait.html b/files/tests-qrmaxlengthtrait.html index ed7671ec5..0fd9866b6 100644 --- a/files/tests-qrmaxlengthtrait.html +++ b/files/tests-qrmaxlengthtrait.html @@ -131,6 +131,7 @@ +
    Tags diff --git a/files/tests-qroptionstest.html b/files/tests-qroptionstest.html index 121ac980b..a571315d0 100644 --- a/files/tests-qroptionstest.html +++ b/files/tests-qroptionstest.html @@ -131,6 +131,7 @@ +
    Tags