ISO/IEC 18004:2000 Section 8.8.1
+ISO/IEC 18004:2000 Section 8.8.1 +ISO/IEC 18004:2000 Section 8.8.2 - Evaluation of masking results
+Evaluates the matrix of the given data interface and returns a new mask pattern instance for the best result
+ +
+ public
+ static getBestPattern(QRData $dataInterface) : self
+
+
+ Apply mask penalty rule 1 and return the penalty. Find repetitive cells with the same color and +give penalty to them. Example: 00000 or 11111.
+ +
+ public
+ static testRule1(array<string|int, mixed> $matrix, int $height, int $width) : int
+
+
+ Apply mask penalty rule 2 and return the penalty. Find 2x2 blocks with the same color and give +penalty to them. This is actually equivalent to the spec's rule, which is to find MxN blocks and give a +penalty proportional to (M-1)x(N-1), because this is the number of 2x2 blocks inside such a block.
+ +
+ public
+ static testRule2(array<string|int, mixed> $matrix, int $height, int $width) : int
+
+
+ Apply mask penalty rule 3 and return the penalty. Find consecutive runs of 1:1:3:1:1:4 +starting with black, or 4:1:1:3:1:1 starting with white, and give penalty to them. If we +find patterns like 000010111010000, we give penalty once.
+ +
+ public
+ static testRule3(array<string|int, mixed> $matrix, int $height, int $width) : int
+
+
+ Apply mask penalty rule 4 and return the penalty. Calculate the ratio of dark cells and give +penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.
+ +
+ public
+ static testRule4(array<string|int, mixed> $matrix, int $height, int $width) : int
+
+
+
+ private
+ static applyRule1(array<string|int, mixed> $matrix, int $height, int $width, bool $isHorizontal) : int
+
+
+
+
+ private
+ static isWhiteHorizontal(array<string|int, mixed> $row, int $width, int $from, int $to) : bool
+
+
+
+
+ private
+ static isWhiteVertical(array<string|int, mixed> $matrix, int $height, int $x, int $from, int $to) : bool
+
+
+
+ Receives a QRData object and runs the mask pattern tests on it.
- -ISO/IEC 18004:2000 Section 8.8.2 - Evaluation of masking results
-The data interface that contains the data matrix to test
- -
- private
- QRData
- $qrData
-
-
-
-
-
-
-
-Receives the QRData object
- -
- public
- __construct(QRData $qrData) : mixed
-
-
- shoves a QRMatrix through the MaskPatternTester to find the lowest penalty mask pattern
- -
- public
- getBestMaskPattern() : MaskPattern
-
-
-
-
- Returns the penalty for the given mask pattern
- -
- public
- testPattern(MaskPattern $pattern) : int
-
-
- Apply mask penalty rule 1 and return the penalty. Find repetitive cells with the same color and -give penalty to them. Example: 00000 or 11111.
- -
- private
- testLevel1(array<string|int, mixed> $m, int $size) : int
-
-
- Apply mask penalty rule 2 and return the penalty. Find 2x2 blocks with the same color and give -penalty to them. This is actually equivalent to the spec's rule, which is to find MxN blocks and give a -penalty proportional to (M-1)x(N-1), because this is the number of 2x2 blocks inside such a block.
- -
- private
- testLevel2(array<string|int, mixed> $m, int $size) : int
-
-
- Apply mask penalty rule 3 and return the penalty. Find consecutive runs of 1:1:3:1:1:4 -starting with black, or 4:1:1:3:1:1 starting with white, and give penalty to them. If we -find patterns like 000010111010000, we give penalty once.
- -
- private
- testLevel3(array<string|int, mixed> $m, int $size) : int
-
-
- Apply mask penalty rule 4 and return the penalty. Calculate the ratio of dark cells and give -penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.
- -
- private
- testLevel4(array<string|int, mixed> $m, int $size) : float
-
-
-
public
- writeMatrix(MaskPattern $maskPattern[, bool $test = null ]) : QRMatrix
+ writeMatrix(MaskPattern $maskPattern) : QRMatrix
shortcut to initialize the matrix
+shortcut to set format and version info
public
- init(MaskPattern $maskPattern[, bool $test = null ]) : self
+ initFormatInfo(MaskPattern $maskPattern) : self
shortcut to initialize the functional patterns
+ +
+ public
+ initFunctionalPatterns() : self
+
+
+
+
+
4 * version + 9 or moduleCount - 8
+
public
- setFormatInfo(MaskPattern $maskPattern[, bool $test = null ]) : self
+ setFormatInfo(MaskPattern $maskPattern) : self
ISO/IEC 18004:2000 Section 8.9
public
- setVersionNumber([bool $test = null ]) : self
+ setVersionNumber() : self
ISO/IEC 18004:2000 Section 8.10
- public
- getHistogramBlackMatrix(int $width, int $height) : BitMatrix
-
-
-
+ private
+ getHistogramBlackMatrix(int $width, int $height) : BitMatrix
+
+
+
+ private
+ FormatInformation|null
+ $formatInfo
+ = null
+
+
+
+
+
+
+
+
+ private
+ bool
+ $mirror
+ = false
+
+
+
+
+
+
+
+ private
+ Version|null
+ $version
+ = null
+
+
+
+
+
+
+
See ISO 18004:2006 Annex E
- -
- public
- buildFunctionPattern(Version $version) : BitMatrix
-
-
-
public
- flip(int $x, int $y) : void
+ flip(int $x, int $y) : self
+ public
+ getFormatInfo() : FormatInformation|null
+
+
+
+
+
+
+ public
+ getVersion() : Version|null
+
+
+
+
+
+
public
- mirror() : void
+ mirror() : self
<p>Reads the bits in the {@link BitMatrix} representing the finder pattern in the +correct order in order to reconstruct the codewords bytes contained within the +QR Code.</p>
+ +
+ public
+ readCodewords() : array<string|int, mixed>
+
+
+
+
+ bytes encoded within the QR Code
+
public
- set(int $x, int $y) : void
+ set(int $x, int $y) : self
Prepare the parser for a mirrored operation.
+ +
+ public
+ setMirror(bool $mirror) : self
+
+ This flag has effect only on the and the +. Before proceeding with the + method should be called.
+Whether to read version and format information mirrored.
+
public
- setRegion(int $left, int $top, int $width, int $height) : void
+ setRegion(int $left, int $top, int $width, int $height) : self
Implementations of this method reverse the data masking process applied to a QR Code and -make its bits ready to read.
+See ISO 18004:2006 Annex E
- public
- unmask(int $dimension, MaskPattern $maskPattern) : void
+ private
+ buildFunctionPattern() : self
+
+
+
+
+
+
+ private
+ copyBit(int $i, int $j, int $versionBits) : int
+ private
+ decodeVersionInformation(int $versionBits) : Version|null
+
+
+
+ private
+ doDecodeFormatInformation(int $maskedFormatInfo1, int $maskedFormatInfo2) : FormatInformation|null
+
+
+ format info indicator, with mask still applied
+second copy of same info; both are checked at the same time +to establish best match
+information about the format it specifies, or null +if doesn't seem to match any known pattern
+
+ private
+ numBitsDiffering(int $a, int $b) : int
+
+
+ <p>Reads format information from one of its two locations within the QR Code.</p>
+ +
+ private
+ readFormatInformation() : FormatInformation
+
+
+
+
+ encapsulating the QR Code's format info
+<p>Reads version information from one of its two locations within the QR Code.</p>
+ +
+ private
+ readVersion() : Version
+
+
+
+
+ encapsulating the QR Code's version
+Implementations of this method reverse the data masking process applied to a QR Code and +make its bits ready to read.
+ +
+ private
+ unmask() : void
+
+
+
+
+
+ private
+ uRShift(int $a, int $b) : int
+
+
+
- private
- BitMatrix
- $bitMatrix
-
-
-
-
-
-
-
-
-
- private
- bool
- $mirror
- = false
-
-
-
-
-
-
-
-
- private
- FormatInformation|null
- $parsedFormatInfo
- = null
-
-
-
-
-
-
-
-
- private
- Version|null
- $parsedVersion
- = null
-
-
-
-
-
-
-
-
- public
- __construct(BitMatrix $bitMatrix) : mixed
-
-
- Mirror the bit matrix in order to attempt a second reading.
- -
- public
- mirror() : void
-
-
-
-
-
- <p>Reads the bits in the {@link BitMatrix} representing the finder pattern in the -correct order in order to reconstruct the codewords bytes contained within the -QR Code.</p>
- -
- public
- readCodewords() : array<string|int, mixed>
-
-
-
-
- bytes encoded within the QR Code
-<p>Reads format information from one of its two locations within the QR Code.</p>
- -
- public
- readFormatInformation() : FormatInformation
-
-
-
-
- encapsulating the QR Code's format info
-<p>Reads version information from one of its two locations within the QR Code.</p>
- -
- public
- readVersion() : Version
-
-
-
-
- encapsulating the QR Code's version
-Prepare the parser for a mirrored operation.
- -
- public
- setMirror(bool $mirror) : void
-
- This flag has effect only on the and the -. Before proceeding with the - method should be called.
-Whether to read version and format information mirrored.
-
- public
- static uRShift(int $a, int $b) : int
-
-
-
- private
- copyBit(int $i, int $j, int $versionBits) : int
-
-
-
- private
- decodeVersionInformation(int $versionBits) : Version|null
-
-
-
- private
- doDecodeFormatInformation(int $maskedFormatInfo1, int $maskedFormatInfo2) : FormatInformation|null
-
-
- format info indicator, with mask still applied
-second copy of same info; both are checked at the same time -to establish best match
-information about the format it specifies, or null -if doesn't seem to match any known pattern
-
- private
- static numBitsDiffering(int $a, int $b) : int
-
-
- if the QR Code cannot be decoded
private
- decodeParser(BitMatrixParser $parser) : DecoderResult
+ decodeMatrix(BitMatrix $bitMatrix) : DecoderResult
<p>Encapsulates the result of decoding a matrix of bits. This typically +
Encapsulates the result of decoding a matrix of bits. This typically applies to 2D barcode formats. For now it contains the raw bytes obtained, -as well as a String interpretation of those bytes, if applicable.</p>
+as well as a String interpretation of those bytes, if applicable. -
- private
+ public
+ EccLevel
+ $eccLevel
+
+
+
+
+
+
+
+
+
+ public
+ array<string|int, int>
+ $rawBytes
+
+
+
+
+
+
+
+
+ public
+ int
+ $structuredAppendParity
+
+
+
+
+
+
+
+
+ public
+ int
+ $structuredAppendSequence
+
+
+
+
+
+
+
+
+ public
+ string
+ $text
+
+
+
+
+
+
+
+
+ public
+ Version
+ $version
+
+
+
+
+
+
+
+
+ protected
EccLevel
$eccLevel
@@ -303,7 +496,7 @@ as well as a String interpretation of those bytes, if applicable.</p>
class="
phpdocumentor-element
-property
- -private
+ -protected
"
>
- private
+ protected
array<string|int, mixed>
$rawBytes
@@ -337,7 +530,7 @@ as well as a String interpretation of those bytes, if applicable.</p>
class="
phpdocumentor-element
-property
- -private
+ -protected
"
>
- private
+ protected
int
$structuredAppendParity
-
+ = -1
@@ -371,28 +564,28 @@ as well as a String interpretation of those bytes, if applicable.</p>
class="
phpdocumentor-element
-property
- -private
+ -protected
"
>
-
- private
+ protected
int
- $structuredAppendSequenceNumber
-
+ $structuredAppendSequence
+ = -1
@@ -405,7 +598,7 @@ as well as a String interpretation of those bytes, if applicable.</p>
class="
phpdocumentor-element
-property
- -private
+ -protected
"
>
- private
+ protected
string
$text
@@ -439,7 +632,7 @@ as well as a String interpretation of those bytes, if applicable.</p>
class="
phpdocumentor-element
-property
- -private
+ -protected
"
>
- private
+ protected
Version
$version
@@ -482,79 +675,60 @@ as well as a String interpretation of those bytes, if applicable.</p>
-public
"
>
-
public
- __construct(array<string|int, mixed> $rawBytes, string $text, Version $version, EccLevel $eccLevel[, int $saSequence = -1 ][, int $saParity = -1 ]) : mixed
+ __set(mixed $property, mixed $value) : void
public
- getEccLevel() : EccLevel
+ fromIterable(iteratable<string|int, mixed> $properties) : self
+
- public
- getRawBytes() : array<string|int, int>
-
-
-
-
-
- raw bytes encoded by the barcode, if applicable, otherwise null
-
- public
- getStructuredAppendParity() : int
-
-
-
-
-
-
- public
- getStructuredAppendSequenceNumber() : int
-
-
-
-
-
-
- public
- getText() : string
-
-
-
-
-
- raw text encoded by the barcode
-
- public
- getVersion() : Version
-
-
-
-
-
-
public
- __construct(BitMatrix $image) : mixed
+ __construct(LuminanceSourceInterface $source) : mixed
The selected data interface (Number, AlphaNum, Kanji, Byte)
- -
- protected
- QRData
- $dataInterface
-
-
-
-
-
-
-
-The FQCN of the luminance sporce class to use in the reader (GD or Imagick)
- -
- private
- string
- $luminanceSourceClass
-
-
-
-
-
-
- returns the FQCN of the luminance source class to use in the reader (GD or Imagick)
+ +
+ public
+ getLuminanceSourceFQCN() : string
+
+
+
+
+ returns the FQCN of the luminance source class to use in the reader (GD or Imagick)
+ +
+ public
+ getLuminanceSourceFQCN() : string
+
+
+
+
+
+ public
+ testPenaltyRule1() : void
+
+
+
+
+
+
+
+ public
+ testPenaltyRule2() : void
+
+
+
+
+
+
+
+ public
+ testPenaltyRule3() : void
+
+
+
+
+
+
+
+ public
+ testPenaltyRule4() : void
+
+
+
+
+
+
+ MaskPatternTester coverage test
- - - - - - - - - -Tests getting the best mask pattern
- -
- public
- testMaskpattern() : void
-
-
-
-
-
- Tests getting the penalty value for a given mask pattern
- -
- public
- testMaskpatternID() : void
-
-
-
-
-
-