Documentation

QROutputAbstract
in package
implements QROutputInterface

common output abstract

Interfaces, Classes, Traits and Enums

QROutputInterface
Converts the data matrix into readable output

Table of Contents

$length  : int
the side length of the QR image (modules * scale)
$matrix  : QRMatrix
the (filled) data matrix object
$moduleCount  : int
the current size of the QR matrix
$moduleValues  : array<string|int, mixed>
an (optional) array of color values for the several QR matrix parts
$options  : SettingsContainerInterface
$scale  : int
the current scaling for a QR pixel
__construct()  : mixed
QROutputAbstract constructor.
collectModules()  : array<string|int, mixed>
collects the modules per QRMatrix::M_* type and runs a $transform function on each module and returns an array with the transformed modules
getDefaultModuleValue()  : mixed
Returns a default value for either dark or light modules (return value depends on the output module)
getModuleValue()  : mixed
Returns the final value for the given input (return value depends on the output module)
saveToFile()  : void
Saves the qr $data to a $file. If $file is null, nothing happens.
setMatrixDimensions()  : void
Sets/updates the matrix dimensions
setModuleValues()  : void
Sets the initial module values
toBase64DataURI()  : string
Returns a base64 data URI for the given string and mime type

Properties

$length

the side length of the QR image (modules * scale)

protected int $length

$moduleValues

an (optional) array of color values for the several QR matrix parts

protected array<string|int, mixed> $moduleValues

$scale

the current scaling for a QR pixel

protected int $scale
Tags
see
QROptions::$scale

Methods

__construct()

QROutputAbstract constructor.

public __construct(SettingsContainerInterface $options, QRMatrix $matrix) : mixed
Parameters
$options : SettingsContainerInterface
$matrix : QRMatrix
Return values
mixed —

collectModules()

collects the modules per QRMatrix::M_* type and runs a $transform function on each module and returns an array with the transformed modules

protected collectModules(Closure $transform) : array<string|int, mixed>

The transform callback is called with the following parameters:

$x - current column $y - current row $M_TYPE - field value $M_TYPE_LAYER - (possibly modified) field value that acts as layer id

Parameters
$transform : Closure
Return values
array<string|int, mixed> —

getDefaultModuleValue()

Returns a default value for either dark or light modules (return value depends on the output module)

protected abstract getDefaultModuleValue(bool $isDark) : mixed
Parameters
$isDark : bool
Return values
mixed —

getModuleValue()

Returns the final value for the given input (return value depends on the output module)

protected abstract getModuleValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

saveToFile()

Saves the qr $data to a $file. If $file is null, nothing happens.

protected saveToFile(string $data[, string $file = null ]) : void
Parameters
$data : string
$file : string = null
Tags
see
file_put_contents()
see
QROptions::$cachefile
throws
QRCodeOutputException
Return values
void —

setMatrixDimensions()

Sets/updates the matrix dimensions

protected setMatrixDimensions() : void

Call this method if you modify the matrix from within your custom module in case the dimensions have been changed

Return values
void —

setModuleValues()

Sets the initial module values

protected setModuleValues() : void
Return values
void —

toBase64DataURI()

Returns a base64 data URI for the given string and mime type

protected toBase64DataURI(string $data, string $mime) : string
Parameters
$data : string
$mime : string
Return values
string —

Search results