Spec extends SpecRs
in package
Com\Tecnick\Barcode\Type\Square\QrCode\Spec
Tags
Table of Contents
Methods
- createFrame() : array<int, string>
- Return a copy of initialized frame.
- getDataLength() : int
- Return maximum data code length (bytes) for the version.
- getECCLength() : int
- Return maximum error correction code length (bytes) for the version.
- getEccSpec() : EccSpec
- Return an array of ECC specification.
- getFormatInfo() : int
- Return BCH encoded format information pattern.
- getRemainder() : int
- Return the numer of remainder bits.
- getVersionPattern() : int
- Return BCH encoded version information pattern that is used for the symbol of version 7 or greater.
- getWidth() : int
- Return the width of the symbol for the version.
- maximumWords() : int
- Return the maximum length for the mode and version.
- putAlignmentMarker() : array<int, string>
- Put an alignment marker.
- putAlignmentPattern() : array<int, string>
- Put an alignment pattern.
- putFinderPattern() : array<int, string>
- Put a finder pattern.
- qrstrset() : array<int, string>
- Replace a value on the array at the specified position
- rsBlockNum() : int
- Return block number 0
- rsBlockNum1() : int
- Return block number 1
- rsBlockNum2() : int
- Return block number 2
- rsDataCodes1() : int
- Return data codes 1
- rsDataCodes2() : int
- Return data codes 2
- rsDataLength() : int
- Return data length
- rsEccCodes1() : int
- Return ecc codes 1
- rsEccCodes2() : int
- Return ecc codes 2
- rsEccLength() : int
- Return ecc length
Methods
createFrame()
Return a copy of initialized frame.
public createFrame(int $version)
: array<int,
string>
Parameters
- $version : int
-
Version
Return values
array<int, string> —of unsigned char.
getDataLength()
Return maximum data code length (bytes) for the version.
public getDataLength(int $version,
int $level)
: int
Parameters
- $version : int
-
Version
- $level : int
-
Error correction level
Return values
int —maximum size (bytes)
getECCLength()
Return maximum error correction code length (bytes) for the version.
public getECCLength(int $version,
int $level)
: int
Parameters
- $version : int
-
Version
- $level : int
-
Error correction level
Return values
int —ECC size (bytes)
getEccSpec()
Return an array of ECC specification.
public getEccSpec(int $version,
int $level,
EccSpec $spec)
: EccSpec
Parameters
- $version : int
-
Version
- $level : int
-
Error correction level
- $spec : EccSpec
-
Array of ECC specification
Return values
EccSpec —spec: 0 = # of type1 blocks 1 = # of data code 2 = # of ecc code 3 = # of type2 blocks 4 = # of data code
getFormatInfo()
Return BCH encoded format information pattern.
public getFormatInfo(int $maskNo,
int $level)
: int
Parameters
- $maskNo : int
-
Mask number
- $level : int
-
Error correction level
Return values
intgetRemainder()
Return the numer of remainder bits.
public getRemainder(int $version)
: int
Parameters
- $version : int
-
Version
Return values
int —number of remainder bits
getVersionPattern()
Return BCH encoded version information pattern that is used for the symbol of version 7 or greater.
public getVersionPattern(int $version)
: int
Use lower 18 bits.
Parameters
- $version : int
-
Version
Return values
intgetWidth()
Return the width of the symbol for the version.
public getWidth(int $version)
: int
Parameters
- $version : int
-
Version
Return values
int —width
maximumWords()
Return the maximum length for the mode and version.
public maximumWords(int $mode,
int $version)
: int
Parameters
- $mode : int
-
Encoding mode
- $version : int
-
Version
Return values
int —the maximum length (bytes)
putAlignmentMarker()
Put an alignment marker.
public putAlignmentMarker(array<int,
string> $frame,
int $pox,
int $poy)
: array<int,
string>
Parameters
- $frame : array<int, string>
-
Frame
- $pox : int
-
X center coordinate of the pattern
- $poy : int
-
Y center coordinate of the pattern
Return values
array<int, string> —frame
putAlignmentPattern()
Put an alignment pattern.
public putAlignmentPattern(int $version,
array<int,
string> $frame,
int $width)
: array<int,
string>
Parameters
- $version : int
-
Version
- $frame : array<int, string>
-
Frame
- $width : int
-
Width
Return values
array<int, string> —frame
putFinderPattern()
Put a finder pattern.
public putFinderPattern(array<int,
string> $frame,
int $pox,
int $poy)
: array<int,
string>
Parameters
- $frame : array<int, string>
-
Frame
- $pox : int
-
X center coordinate of the pattern
- $poy : int
-
Y center coordinate of the pattern
Return values
array<int, string> —frame
qrstrset()
Replace a value on the array at the specified position
public qrstrset(array<int,
string> $srctab,
int $xpos,
int $ypos,
string $repl[,
int $replLen
= null
]) : array<int,
string>
Parameters
- $srctab : array<int, string>
-
Source table
- $xpos : int
-
X position
- $ypos : int
-
Y position
- $repl : string
-
Value to replace
- $replLen : int = null
-
Length of the repl string
Return values
array<int, string> —srctab
rsBlockNum()
Return block number 0
public rsBlockNum(array<int,
int> $spec)
: int
Parameters
- $spec : array<int, int>
-
Spec
Return values
int —value
rsBlockNum1()
Return block number 1
public rsBlockNum1(array<int,
int> $spec)
: int
Parameters
- $spec : array<int, int>
-
Spec
Return values
int —value
rsBlockNum2()
Return block number 2
public rsBlockNum2(array<int,
int> $spec)
: int
Parameters
- $spec : array<int, int>
-
Spec
Return values
int —value
rsDataCodes1()
Return data codes 1
public rsDataCodes1(array<int,
int> $spec)
: int
Parameters
- $spec : array<int, int>
-
Spec
Return values
int —value
rsDataCodes2()
Return data codes 2
public rsDataCodes2(array<int,
int> $spec)
: int
Parameters
- $spec : array<int, int>
-
Spec
Return values
int —value
rsDataLength()
Return data length
public rsDataLength(array<int,
int> $spec)
: int
Parameters
- $spec : array<int, int>
-
Spec
Return values
int —value
rsEccCodes1()
Return ecc codes 1
public rsEccCodes1(array<int,
int> $spec)
: int
Parameters
- $spec : array<int, int>
-
Spec
Return values
int —value
rsEccCodes2()
Return ecc codes 2
public rsEccCodes2(array<int,
int> $spec)
: int
Parameters
- $spec : array<int, int>
-
Spec
Return values
int —value
rsEccLength()
Return ecc length
public rsEccLength(array<int,
int> $spec)
: int
Parameters
- $spec : array<int, int>
-
Spec
Return values
int —value