Documentation

DecoderResult
in package

<p>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>

Tags
author

Sean Owen

Table of Contents

$eccLevel  : EccLevel
$rawBytes  : array<string|int, mixed>
$structuredAppendParity  : int
$structuredAppendSequenceNumber  : int
$text  : string
$version  : Version
__construct()  : mixed
__toString()  : string
getEccLevel()  : EccLevel
getRawBytes()  : array<string|int, int>
getStructuredAppendParity()  : int
getStructuredAppendSequenceNumber()  : int
getText()  : string
getVersion()  : Version
hasStructuredAppend()  : bool

Properties

$structuredAppendSequenceNumber

private int $structuredAppendSequenceNumber

Methods

__construct()

public __construct(array<string|int, mixed> $rawBytes, string $text, Version $version, EccLevel $eccLevel[, int $saSequence = -1 ][, int $saParity = -1 ]) : mixed
Parameters
$rawBytes : array<string|int, mixed>
$text : string
$version : Version
$eccLevel : EccLevel
$saSequence : int = -1
$saParity : int = -1
Return values
mixed

__toString()

public __toString() : string
Return values
string

getRawBytes()

public getRawBytes() : array<string|int, int>
Return values
array<string|int, int>

raw bytes encoded by the barcode, if applicable, otherwise null

getStructuredAppendParity()

public getStructuredAppendParity() : int
Return values
int

getStructuredAppendSequenceNumber()

public getStructuredAppendSequenceNumber() : int
Return values
int

getText()

public getText() : string
Return values
string

raw text encoded by the barcode

hasStructuredAppend()

public hasStructuredAppend() : bool
Return values
bool

Search results