Documentation

QRCode

in package

• Application

Turns a text string into a Model 2 QR Code

Tags

see

https://github.com/kazuhikoarase/qrcode-generator/tree/master/php

see

https://www.qrcode.com/en/codes/model12.html

see

https://www.swisseduc.ch/informatik/theoretische_informatik/qr_codes/docs/qr_standard.pdf

see

https://en.wikipedia.org/wiki/QR_code

see

https://www.thonky.com/qr-code-tutorial/

Table of Contents

Constants

ECC_H  = \chillerlan\QRCode\Common\EccLevel::H

ECC_L  = \chillerlan\QRCode\Common\EccLevel::L

ECC_M  = \chillerlan\QRCode\Common\EccLevel::M

ECC_Q  = \chillerlan\QRCode\Common\EccLevel::Q

MASK_PATTERN_AUTO  = \chillerlan\QRCode\Common\MaskPattern::AUTO

OUTPUT_CUSTOM  = \chillerlan\QRCode\Output\QROutputInterface::CUSTOM

OUTPUT_EPS  = \chillerlan\QRCode\Output\QROutputInterface::EPS

OUTPUT_FPDF  = \chillerlan\QRCode\Output\QROutputInterface::FPDF

OUTPUT_IMAGE_GIF  = \chillerlan\QRCode\Output\QROutputInterface::GDIMAGE_GIF

OUTPUT_IMAGE_JPG  = \chillerlan\QRCode\Output\QROutputInterface::GDIMAGE_JPG

OUTPUT_IMAGE_PNG  = \chillerlan\QRCode\Output\QROutputInterface::GDIMAGE_PNG

OUTPUT_IMAGICK  = \chillerlan\QRCode\Output\QROutputInterface::IMAGICK

OUTPUT_MARKUP_HTML  = \chillerlan\QRCode\Output\QROutputInterface::MARKUP_HTML

OUTPUT_MARKUP_SVG  = \chillerlan\QRCode\Output\QROutputInterface::MARKUP_SVG

OUTPUT_MODES  = \chillerlan\QRCode\Output\QROutputInterface::MODES

OUTPUT_STRING_JSON  = \chillerlan\QRCode\Output\QROutputInterface::STRING_JSON

OUTPUT_STRING_TEXT  = \chillerlan\QRCode\Output\QROutputInterface::STRING_TEXT

VERSION_AUTO  = \chillerlan\QRCode\Common\Version::AUTO

Properties

$dataSegments  : array<string|int, QRDataModeInterface>

A collection of one or more data segments of QRDataModeInterface instances to write

$luminanceSourceFQN  : string

The luminance source for the reader

$options  : QROptions|SettingsContainerInterface

The settings container

Methods

__construct()  : mixed

QRCode constructor.

addAlphaNumSegment()  : self

Adds an alphanumeric data segment

addByteSegment()  : self

Adds an 8-bit byte data segment

addEciDesignator()  : self

Adds a standalone ECI designator

addEciSegment()  : self

Adds an ECI data segment (including designator)

addHanziSegment()  : self

Adds a Hanzi data segment (simplified Chinese 13-bit double-byte characters, GB2312/GB18030)

addKanjiSegment()  : self

Adds a Kanji data segment (Japanese 13-bit double-byte characters, Shift-JIS)

addNumericSegment()  : self

Adds a numeric data segment

addSegment()  : self

Adds a data segment

clearSegments()  : self

Clears the data segments array

getMatrix()  : QRMatrix

getQRMatrix()  : QRMatrix

Returns a QRMatrix object for the given $data and current QROptions

isAlphaNum()  : bool

checks if a string qualifies as alphanumeric (convenience method)

isByte()  : bool

a dummy (convenience method)

isKanji()  : bool

checks if a string qualifies as Kanji (convenience method)

isNumber()  : bool

checks if a string qualifies as numeric (convenience method)

readFromBlob()  : DecoderResult

Reads a QR Code from the given data blob

readFromFile()  : DecoderResult

Reads a QR Code from a given file

readFromSource()  : DecoderResult

Reads a QR Code from the given luminance source

render()  : mixed

Renders a QR Code for the given $data and QROptions, saves $file optionally

renderMatrix()  : mixed

Renders a QR Code for the given QRMatrix and QROptions, saves $file optionally

setOptions()  : self

Sets an options instance

addMatrixModifications()  : QRMatrix

add matrix modifications after mask pattern evaluation and before handing over to output

initOutputInterface()  : QROutputInterface

initializes a fresh built-in or custom QROutputInterface