QRMarkupHTML
extends QRMarkup
in package
HTML 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.
- dump() : string
- moduleValueIsValid() : bool
- note: we're not necessarily validating the several values, just checking the general syntax note: css4 colors are not included
- 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
- createMarkup() : string
- getCssClass() : string
- returns a string with all css classes for the current element
- getDefaultModuleValue() : mixed|null
- Returns a default value for either dark or light modules
- getModuleValue() : mixed|null
- Returns the prepared value for the given $M_TYPE
- getModuleValueAt() : mixed|null
- Returns the prepared module value at the given coordinate [$x, $y] (convenience)
- prepareModuleValue() : mixed|null
- Prepares the value for the given input ()
- 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
$matrix
the (filled) data matrix object
protected
QRMatrix
$matrix
$moduleCount
the current size of the QR matrix
protected
int
$moduleCount
Tags
$moduleValues
an (optional) array of color values for the several QR matrix parts
protected
array<string|int, mixed>
$moduleValues
$options
protected
SettingsContainerInterface
$options
$scale
the current scaling for a QR pixel
protected
int
$scale
Tags
Methods
__construct()
QROutputAbstract constructor.
public
__construct(SettingsContainerInterface $options, QRMatrix $matrix) : mixed
Parameters
- $options : SettingsContainerInterface
- $matrix : QRMatrix
Return values
mixed —dump()
public
dump([string $file = null ]) : string
Parameters
- $file : string = null
Tags
Return values
string —moduleValueIsValid()
note: we're not necessarily validating the several values, just checking the general syntax note: css4 colors are not included
public
static moduleValueIsValid(mixed $value) : bool
Parameters
- $value : mixed
Tags
Return values
bool —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> —createMarkup()
protected
createMarkup(bool $saveToFile) : string
Parameters
- $saveToFile : bool
Tags
Return values
string —getCssClass()
returns a string with all css classes for the current element
protected
getCssClass(int $M_TYPE) : string
Parameters
- $M_TYPE : int
Return values
string —getDefaultModuleValue()
Returns a default value for either dark or light modules
protected
abstract getDefaultModuleValue(bool $isDark) : mixed|null
Parameters
- $isDark : bool
Return values
mixed|null —return value depends on the output class
getModuleValue()
Returns the prepared value for the given $M_TYPE
protected
getModuleValue(int $M_TYPE) : mixed|null
Parameters
- $M_TYPE : int
Tags
Return values
mixed|null —return value depends on the output class, null if $moduleValues[$M_TYPE] doesn't exist
getModuleValueAt()
Returns the prepared module value at the given coordinate [$x, $y] (convenience)
protected
getModuleValueAt(int $x, int $y) : mixed|null
Parameters
- $x : int
- $y : int
Return values
mixed|null —prepareModuleValue()
Prepares the value for the given input ()
protected
abstract prepareModuleValue(mixed $value) : mixed|null
Parameters
- $value : mixed
Return values
mixed|null —return value depends on the output class
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
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