DecoderResultThe full phpDocumentor API documentation can be found at chillerlan.github.io/php-qrcode.
+method |
+return |
+description |
+
|---|---|---|
|
+- |
+used internally by |
+
|
+
|
+returns the data contained in the QR symbol |
+
|
+
|
++ |
|
+
|
++ |
property |
+type |
+description |
+
|---|---|---|
|
+
|
++ |
|
+
|
++ |
|
+
|
++ |
|
+
|
++ |
|
+
|
+defaults to |
+
|
+
|
+defaults to |
+
|
+
|
+defaults to |
+
QRCodeThe full phpDocumentor API documentation can be found at chillerlan.github.io/php-qrcode.
+method |
+return |
+description |
+
|---|---|---|
|
+- |
+see |
+
|
+
|
+Sets an options instance, internally called via the constructor |
+
|
+
|
+renders a QR Code for the given |
+
|
+
|
+renders a QR Code for the given |
+
|
+
|
+returns a |
+
|
+
|
+Adds a |
+
|
+
|
+Clears the data segments array |
+
|
+
|
+Adds a numeric data segment |
+
|
+
|
+Adds an alphanumeric data segment |
+
|
+
|
+Adds a Kanji data segment (Japanese 13-bit double-byte characters, Shift-JIS) |
+
|
+
|
+Adds a Hanzi data segment (simplified Chinese 13-bit double-byte characters, GB2312/GB18030) |
+
|
+
|
+Adds an 8-bit byte data segment |
+
|
+
|
+Adds a standalone ECI designator |
+
|
+
|
+Adds an ECI data segment (including designator) |
+
|
+
|
+Reads a QR Code from a given file |
+
|
+
|
+Reads a QR Code from the given data blob |
+
|
+
|
+Reads a QR Code from the given luminance source |
+
method |
+since |
+replacement |
+
|---|---|---|
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
name |
+since |
+replacement |
+
|---|---|---|
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
QRMatrixThe full phpDocumentor API documentation can be found at chillerlan.github.io/php-qrcode.
+method |
+return |
+description |
+
|---|---|---|
|
+- |
++ |
|
+
|
+shortcut to initialize the functional patterns |
+
|
+
|
+the internal matrix representation as a 2 dimensional array |
+
|
+
|
+the current QR Code version instance |
+
|
+
|
+the current ECC level instance |
+
|
+
|
+the used mask pattern instance |
+
|
+
|
+the absoulute size of the matrix, including quiet zone (if set). |
+
|
+
|
+returns the value of the module |
+
|
+
|
+sets the |
+
|
+
|
+Fills an area of $width * $height, from the given starting point $startX, $startY (top left) with $value for $M_TYPE |
+
|
+
|
+Checks whether a module is of the given $M_TYPE |
+
|
+
|
+Checks whether the module at ($x, $y) is in the given array of $M_TYPES, returns true if a match is found, otherwise false |
+
|
+
|
+checks whether a module is true (dark) or false (light) |
+
|
+
|
+Checks the status neighbouring modules of the given module at ($x, $y) and returns a bitmask with the results. |
+
|
+
|
++ |
|
+
|
++ |
|
+
|
++ |
|
+
|
++ |
|
+
|
++ |
|
+
|
++ |
|
+
|
++ |
|
+
|
+Draws the “quiet zone” of $quietZoneSize around the matrix |
+
|
+
|
+Rotates the matrix by 90 degrees clock wise |
+
|
+
|
+Clears a space of $width * $height in order to add a logo or text. |
+
|
+
|
+Maps the interleaved binary data on the matrix |
+
|
+
|
+Applies/reverses the mask pattern |
+
method |
+since |
+replacement |
+
|---|---|---|
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
The _DARK prefixed constans exist purely for convenience - their value is the same as QRMatrix::M_XXX\|QRMatrix::IS_DARK, see QROutputInterface.
name |
+description |
+
|---|---|
|
+sets the “dark” flag for the given value: |
+
|
+module not set |
+
|
+once per matrix at |
+
|
+the actual encoded data |
+
|
+convenience |
+
|
+the 7x7 finder patterns |
+
|
+convenience |
+
|
+the inner 3x3 block of the finder pattern |
+
|
+separator lines along the finder patterns |
+
|
+convenience |
+
|
+the 5x5 alignment patterns |
+
|
+convenience |
+
|
+the timing pattern lines |
+
|
+convenience |
+
|
+format information pattern |
+
|
+convenience |
+
|
+version information pattern |
+
|
+convenience |
+
|
+margin around the QR Code |
+
|
+convenience |
+
|
+space for a logo image (not used yet) |
+
|
+convenience |
+
|
+test value |
+
|
+convenience |
+
QROptions(via QROptionsTrait)
The full phpDocumentor API documentation can be found at chillerlan.github.io/php-qrcode.
+Inherited from SettingsContainerAbstract
method |
+return |
+info |
+
|---|---|---|
|
+- |
+calls |
+
(protected) |
+
|
+calls a method with trait name as replacement constructor for each used trait (similar to PHP4 constructors) |
+
|
+
|
+calls |
+
|
+
|
+calls |
+
|
+
|
++ |
|
+
|
++ |
|
+
|
+a JSON string |
+
|
+
|
++ |
|
+
|
++ |
|
+
|
+accepts JSON options constants |
+
|
+
|
++ |
|
+
|
+implements the |
+
property |
+type |
+default |
+allowed |
+description |
+
|---|---|---|---|---|
|
+
|
+
|
+
|
++ |
|
+
|
+
|
+
|
+Minimum QR version (if |
+
|
+
|
+
|
+
|
+Maximum QR version (if |
+
|
+
|
+
|
+
|
+Error correct level, where X = L (7%), M (15%), Q (25%), H (30%) |
+
|
+
|
+
|
+
|
+Mask Pattern to use |
+
|
+
|
+
|
+* |
+Add a “quiet zone” (margin) according to the QR code spec |
+
|
+
|
+
|
+clamped to |
+Size of the quiet zone |
+
|
+
|
+
|
+
|
+The built-in output type, XXX can be one of: |
+
|
+
|
+
|
+* |
+The FQCN of the custom |
+
|
+
|
+
|
+* |
+Return the image resource instead of a render if applicable. |
+
|
+
|
+
|
+* |
+Optional cache file path |
+
|
+
|
+
|
+* |
+Toggle base64 or raw image data (if applicable) |
+
|
+
|
+
|
+* |
+Newline string (HTML, SVG, TEXT) |
+
|
+
|
+
|
+a valid FPDF, GD or Imagick color value |
+Sets the image background color (if applicable). QRImagick: defaults to “white”, QRGdImage: defaults to [255, 255, 255], QRFpdf: defaults to blank internally (white page) |
+
|
+
|
+
|
+* |
+Whether to draw the light (false) modules |
+
|
+
|
+
|
+* |
+Specify whether to draw the modules as filled circles |
+
|
+
|
+
|
+
|
+Specifies the radius of the modules when $svgDrawCircularModules is set to true |
+
|
+
|
+
|
+
|
+Specifies which module types to exclude when $svgDrawCircularModules is set to true |
+
|
+
|
+
|
+* |
+Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc. |
+
|
+
|
+
|
+
|
+Specify which paths/patterns to exclude from connecting if $svgConnectPaths is set to true |
+
|
+
|
+
|
+* |
+Module values map, see [[Custom module values]] |
+
|
+
|
+
|
+* |
+Toggles logo space creation |
+
|
+
|
+
|
+* |
+Width of the logo space |
+
|
+
|
+
|
+* |
+Height of the logo space |
+
|
+
|
+
|
+* |
+Optional horizontal start position of the logo space (top left corner) |
+
|
+
|
+
|
+* |
+Optional vertical start position of the logo space (top left corner) |
+
|
+
|
+
|
+* |
+Pixel size of a QR code module |
+
|
+
|
+
|
+* |
+Toggle transparency (no jpeg support), QRGdImage and QRImagick only. The given |
+
|
+
|
+
|
+a valid GD or Imagick color value |
+Sets a transparency color for when |
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+* |
+ImageMagick output type, see |
+
|
+
|
+
|
+* |
+A common css class |
+
|
+
|
+
|
+* |
+Markup substitute for dark (CSS value) |
+
|
+
|
+
|
+* |
+Markup substitute for light (CSS value) |
+
|
+
|
+
|
+* |
+Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML |
+
|
+
|
+
|
+
|
+SVG opacity |
+
|
+
|
+
|
+* |
+Anything in the |
+
|
+
|
+
|
+* |
+SVG viewBox size. A single integer number which defines width/height of the viewBox attribute |
+
|
+
|
+
|
+* |
++ |
|
+
|
+
|
+* |
+Optional “width” attribute with the specified value (note that the value is not checked!) |
+
|
+
|
+
|
+* |
+Optional “height” attribute with the specified value (note that the value is not checked!) |
+
|
+
|
+
|
+* |
+String substitute for dark |
+
|
+
|
+
|
+* |
+String substitute for light |
+
|
+
|
+
|
+* |
+Measurement unit for FPDF output: pt, mm, cm, in |
+
|
+
|
+
|
+* |
+Use Imagick (if available) when reading QR Codes |
+
|
+
|
+
|
+* |
+Grayscale the image before reading |
+
|
+
|
+
|
+* |
+Increase the contrast before reading |
+
QROutputInterfaceThe full phpDocumentor API documentation can be found at chillerlan.github.io/php-qrcode.
+method |
+return |
+description |
+
|---|---|---|
(static) |
+
|
+Determines whether the given value is valid |
+
|
+
|
+Generates the output, optionally dumps it to a file, and returns it |
+
name |
+description |
+
|---|---|
|
++ |
|
++ |
|
++ |
|
++ |
|
++ |
|
++ |
|
++ |
|
++ |
|
++ |
|
++ |
|
++ |
|
+Map of built-in output modes => class FQN |
+
|
+Map of module type => default value |
+
|
+Map of module type => readable name (for CSS etc.) |
+
A QR code (quick-response code) is a type of two-dimensional matrix barcode, invented +in 1994 by Japanese company Denso Wave for labelling automobile parts. +The QR labelling system was applied beyond the automobile industry due to its fast readability and greater storage capacity +compared to standard UPC barcodes. +QR Codes, more specifically, the popular Model 2, are internationally standardized in the ISO/IEC 18004.
+A QR symbol is arranged in a matrix consisting of an array of nominally square modules arranged in an overall square pattern.
+For ease of reference, module positions are defined by their row and column coordinates in the symbol, in the form (x, y)
+where x designates the column (counting from left to right) and y the row (counting from the top downwards) in which
+the module is located, with counting commencing at 0. Module (0, 0) is therefore located in the upper left corner of the symbol.
A module represents a single square “pixel” (not to confuse with pixels in a raster image or screen) in the matrix. +A dark module is a binary one and a light module is a binary zero.
+The version of a QR symbol determines the side length of the matrix (and therefore the maximum capacity of code words),
+ranging from 21×21 modules at version 1 to 177×177 modules at version 40; the module count increases in steps of 4 and can
+be calculated by 4 * version + 17.
The maximum capacity for each version, mode and ECC level can be found in this table (qrcode.com).
+The Finder Pattern shall consist of three identical Position Detection Patterns located at the upper left, upper right +and lower left corners of the symbol.
+Each Position Detection Pattern may be viewed as three superimposed concentric squares and is constructed of dark 7×7 modules, +light 5×5 modules and dark 3×3 modules.
+The symbol is preferentially encoded so that similar patterns have a low probability of being encountered elsewhere in the symbol, +enabling rapid identification of a possible QR Code symbol in the field of view. Identification of the three Position Detection +Patterns comprising the finder pattern then unambiguously defines the location and orientation of the symbol in the field of view.
+
+ 
+
The Alignment Pattern is a fixed reference pattern in defined positions, which enables the decode software to +resynchronise the coordinate mapping of the modules in the event of moderate amounts of distortion of the image.
+Each Alignment Pattern may be viewed as three superimposed concentric squares and is constructed of dark 5×5 +modules, light 3×3 modules and a single central dark module.
+The number of Alignment Patterns depends on the symbol version, and they shall be placed in all Model 2 symbols of +version 2 or larger in positions defined in the specification.
+
+ 
+
The horizontal and vertical Timing Patterns respectively consist of a one module wide row or column of alternating +dark and light modules, commencing and ending with a dark module. The horizontal Timing Pattern runs across +row 6 of the symbol between the separators for the upper Position Detection Patterns; the vertical Timing Pattern +similarly runs down column 6 of the symbol between the separators for the left-hand Position Detection Patterns. +They enable the symbol density and version to be determined and provide datum positions for determining module +coordinates.
+
+ 
+
A pattern of all light modules, one module wide, separating the Position Detection Patterns from the rest of the symbol.
+
+ 
+
This is a region 4 modules wide which shall be free of all other markings, surrounding the symbol on all four sides. +Its nominal reflectance value shall be equal to that of the light modules.
+
+ 
+
This region shall contain the symbol characters representing data, those representing error correction codewords, +the Version Information and Format Information.
+This region contains the encoded data and error correction code blocks. Data bits are placed starting at the bottom-right of +the matrix and proceeding upward in a column that is 2 modules wide. When the column reaches the top, the next 2-module column +starts immediately to the left of the previous column and continues downward. Whenever the current column reaches the edge of +the matrix, move on to the next 2-module column and change direction. If a function pattern or reserved area is encountered, +the data bit is placed in the next unused module. +(see wikipedia QR code - Encoding and thonky.com - QR Code Tutorial)
+
+ 
+
The Version Information is an 18 bit sequence containing 6 data bits, with 12 error correction bits calculated using the (18, 6) +BCH code which contains the version number.
+
+ 
+
The Format Information is a 15 bit sequence containing 5 data bits, with 10 error correction bits calculated using the (15, 5) BCH code. +It contains information on the error correction level applied to the symbol and on the masking pattern used, +essential to enable the remainder of the encoding region to be decoded.
+
+ 
+
The module in position (4 * version + 9, 8) shall always be dark and does not form part of the Format Information.
+ 
+
The mode is the method of representing a defined character set as a bit string, with a mode indicator, a four-bit identifier indicating in which mode the next data sequence is encoded.
+Mode |
+Indicator |
+Description |
+
|---|---|---|
Numeric |
+
|
+Numeric encoding, 10 bits per 3 digits |
+
Alphanumeric |
+
|
+Alphanumeric encoding, 11 bits per 2 characters |
+
Byte |
+
|
+Byte encoding, 8 bits per character |
+
Kanji |
+
|
++ |
Hanzi* |
+
|
+Hanzi encoding (simplified Chinese, GB2312/GB18030), 13 bits per character |
+
Structured append |
+
|
+used to split a message across multiple (up to 16) QR symbols |
+
ECI |
+
|
+Extended Channel Interpretation (select alternate character set or encoding) |
+
FNC1 in first position |
+
|
+see Code 128, also zxing/issues/1373 |
+
FNC1 in second position |
+
|
++ |
Terminator |
+
|
+End of message |
+
* Hanzi mode is not part of the ISO specification, but the Chinese standard GB/T 18284
+Each segment consists of the 4 bit mode indicator followed by the data bit stream, where the content of the bit stream can vary depending on the mode:
+Mode |
+Bit stream contents |
+
|---|---|
Numeric |
+[ |
+
Alphanumeric |
+[ |
+
Byte |
+[ |
+
Kanji |
+[ |
+
Hanzi |
+[ |
+
Structured append |
+[ |
+
ECI |
+[ |
+
FNC1 in first position |
+[ |
+
FNC1 in second position |
+[ |
+
Terminator |
+[ |
+
The lenght of the Character Count Indicator for Numeric/Alphanumeric/Byte/Kanji/Hanzi varies, depending on the version:
+Mode |
+Version 1-9 |
+Version 10-26 |
+Version 27-40 |
+
|---|---|---|---|
Numeric |
+10 |
+12 |
+14 |
+
Alphanumeric |
+9 |
+11 |
+13 |
+
Byte |
+8 |
+16 |
+16 |
+
Kanji/Hanzi |
+8 |
+10 |
+12 |
+
Extended Channel Interpretation can be used to indicate an +alternate character encoding for the following Byte segment (by default, ISO-8859-1 “Latin-1”).
+An ECI segment starts with the 4 bit indicator 0111 followed by the ECI Assignment number (8, 16 or 24 bits),
+followed by a Byte segment (0100 …) where the contents are encoded according to the preceding ECI ID.
The lenght of the ECI Assignment number depends on the given encoding ID:
+ID |
+length (bits) |
+
|---|---|
0 - 127 |
+8 |
+
128 - 16383 |
+16 |
+
16384 - 999999 |
+24 |
+
Encoding modes can be mixed as needed within a QR symbol in order to optimize data usage. +Each segment of data is encoded in the appropriate mode, with the basic structure +Mode Indicator / Character Count Indicator / Data and followed immediately by the Mode Indicator commencing the next segment.
+[ Mode Indicator 1 ][ Mode bitstream 1 ]
+…
+[ Mode Indicator n ][ Mode bitstream n ]
+…
+[ 0000 End of message (Terminator) ]
QR codes use Reed–Solomon error correction that allow QR code readers to detect and correct errors. +A detailed breakdown of the process can be found at thonky.com - QR Code Tutorial.
+The number of data versus error correction bytes within each block depends on the version of the QR symbol and the error +correction level. The higher the error correction level, the less storage capacity. The following table lists the approximate +error correction capability at each of the four levels:
+Level |
+Short |
+Capacity |
+Indicator |
+
|---|---|---|---|
Low |
+L |
+7% |
+
|
+
Medium |
+M |
+15% |
+
|
+
Quartile |
+Q |
+25% |
+
|
+
High |
+H |
+30% |
+
|
+
The maximum data capacity of a QR Code at version 40 for each ECC level and mode is shown in the following table:
+ECC |
+max. bits |
+Numeric |
+Alphanumeric |
+Binary |
+Kanji/Hanzi * |
+
|---|---|---|---|---|---|
L |
+23648 |
+7089 |
+4296 |
+2953 |
+1817 |
+
M |
+18672 |
+5596 |
+3391 |
+2331 |
+1435 |
+
Q |
+13328 |
+3993 |
+2420 |
+1663 |
+1024 |
+
H |
+10208 |
+3057 |
+1852 |
+1273 |
+784 |
+
* Hanzi mode stores one character less than Kanji as it uses an additional subset indicator of 4 bits length.
+Masking is the process of XORing the bit pattern in the encoding region with a masking pattern to provide a symbol with more +evenly balanced numbers of dark and light modules and reduced occurrence of patterns which would interfere with fast processing of the image.
+The mask pattern evaluation is done for each of the 8 mask patterns, the pattern with the lowest penalty score shall be used for the final output. +During the evaluation, 4 rules are applied to get the penalty score:
+find repetitive cells with the same color Example: 00000 or 11111 (horizontal and vertical).
find 2×2 blocks with the same color
find consecutive runs of 1:1:3:1:1:4 starting with black, or 4:1:1:3:1:1 starting with white
calculate the ratio of dark cells and give increasing penalty if the ratio is far from 50%
Pattern |
+Mask* |
+Example |
+
|---|---|---|
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
* where x = column (width) and y = row (height), with x,y = 0,0 for the top left module
Symbols are intended to be read when either dark on light or light on dark. +The International Standard (ISO/IEC 18004) is based on dark images on a light background (example on the left), +reflectance reversal therefore means a light image on dark background (example on the right).
+
+ 
+ 
+
Public API
+
QRCode
+QROptionsQROutputInterface
+QRMatrix
+DecoderResult
+Appendix