classes-Com-Tecnick-Barcode-Type-Square-QrCode-Spec

It appears that you are using AdBlocking software. The cost of running this website is covered by advertisements. If you like it please feel free to a small amount of money to secure the future of this website.

Spec extends SpecRs

Com\Tecnick\Barcode\Type\Square\QrCode\Spec

Tags
since
2015-02-21
category

Library

author

Nicola Asuni info@tecnick.com

copyright

2010-2016 Nicola Asuni - Tecnick.com LTD

license

http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)

link
https://github.com/tecnickcom/tc-lib-barcode

Table of Contents

createFrame()  : array<string|int, mixed>
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()  : array<string|int, mixed>
Return an array of ECC specification.
getFormatInfo()  : BCH
Return BCH encoded format information pattern.
getRemainder()  : int
Return the numer of remainder bits.
getVersionPattern()  : BCH
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<string|int, mixed>
Put an alignment marker.
putAlignmentPattern()  : array<string|int, mixed>
Put an alignment pattern.
putFinderPattern()  : array<string|int, mixed>
Put a finder pattern.
qrstrset()  : array<string|int, mixed>
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<string|int, mixed>
Parameters
$version : int

Version

Return values
array<string|int, mixed>

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, array<string|int, mixed> $spec) : array<string|int, mixed>
Parameters
$version : int

Version

$level : int

Error correction level

$spec : array<string|int, mixed>

Array of ECC specification contains as following: {# of type1 blocks, # of data code, # of ecc code, # of type2 blocks, # of data code}

Return values
array<string|int, mixed>

spec

getFormatInfo()

Return BCH encoded format information pattern.

public getFormatInfo(array<string|int, mixed> $maskNo, int $level) : BCH
Parameters
$maskNo : array<string|int, mixed>

Mask number

$level : int

Error correction level

Return values
BCH

encoded format information pattern

getRemainder()

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) : BCH

Use lower 18 bits.

Parameters
$version : int

Version

Return values
BCH

encoded version information pattern

getWidth()

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<string|int, mixed> $frame, int $pox, int $poy) : array<string|int, mixed>
Parameters
$frame : array<string|int, mixed>

Frame

$pox : int

X center coordinate of the pattern

$poy : int

Y center coordinate of the pattern

Return values
array<string|int, mixed>

frame

putAlignmentPattern()

Put an alignment pattern.

public putAlignmentPattern(int $version, array<string|int, mixed> $frame, int $width) : array<string|int, mixed>
Parameters
$version : int

Version

$frame : array<string|int, mixed>

Frame

$width : int

Width

Return values
array<string|int, mixed>

frame

putFinderPattern()

Put a finder pattern.

public putFinderPattern(array<string|int, mixed> $frame, int $pox, int $poy) : array<string|int, mixed>
Parameters
$frame : array<string|int, mixed>

Frame

$pox : int

X center coordinate of the pattern

$poy : int

Y center coordinate of the pattern

Return values
array<string|int, mixed>

frame

qrstrset()

Replace a value on the array at the specified position

public qrstrset(array<string|int, mixed> $srctab, int $xpos, int $ypos, string $repl[, int $replLen = false ]) : array<string|int, mixed>
Parameters
$srctab : array<string|int, mixed>
$xpos : int

X position

$ypos : int

Y position

$repl : string

Value to replace

$replLen : int = false

Length of the repl string

Return values
array<string|int, mixed>

srctab

rsBlockNum()

Return block number 0

public rsBlockNum(array<string|int, mixed> $spec) : int
Parameters
$spec : array<string|int, mixed>
Return values
int

value

rsBlockNum1()

Return block number 1

public rsBlockNum1(array<string|int, mixed> $spec) : int
Parameters
$spec : array<string|int, mixed>
Return values
int

value

rsBlockNum2()

Return block number 2

public rsBlockNum2(array<string|int, mixed> $spec) : int
Parameters
$spec : array<string|int, mixed>
Return values
int

value

rsDataCodes1()

Return data codes 1

public rsDataCodes1(array<string|int, mixed> $spec) : int
Parameters
$spec : array<string|int, mixed>
Return values
int

value

rsDataCodes2()

Return data codes 2

public rsDataCodes2(array<string|int, mixed> $spec) : int
Parameters
$spec : array<string|int, mixed>
Return values
int

value

rsDataLength()

Return data length

public rsDataLength(array<string|int, mixed> $spec) : int
Parameters
$spec : array<string|int, mixed>
Return values
int

value

rsEccCodes1()

Return ecc codes 1

public rsEccCodes1(array<string|int, mixed> $spec) : int
Parameters
$spec : array<string|int, mixed>
Return values
int

value

rsEccCodes2()

Return ecc codes 2

public rsEccCodes2(array<string|int, mixed> $spec) : int
Parameters
$spec : array<string|int, mixed>
Return values
int

value

rsEccLength()

Return ecc length

public rsEccLength(array<string|int, mixed> $spec) : int
Parameters
$spec : array<string|int, mixed>
Return values
int

value

 

© 2004-2021 – Nicola Asuni - Tecnick.com - All rights reserved.
about - disclaimer - privacy