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

http://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

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

Table of Contents

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  = -1

OUTPUT_CUSTOM  = 'custom'

OUTPUT_FPDF  = 'fpdf'

OUTPUT_IMAGE_GIF  = 'gif'

OUTPUT_IMAGE_JPG  = 'jpg'

OUTPUT_IMAGE_PNG  = 'png'

OUTPUT_IMAGICK  = 'imagick'

OUTPUT_MARKUP_HTML  = 'html'

OUTPUT_MARKUP_SVG  = 'svg'

OUTPUT_MODES  = [self::OUTPUT_MARKUP_SVG => \chillerlan\QRCode\Output\QRMarkup::class, self::OUTPUT_MARKUP_HTML => \chillerlan\QRCode\Output\QRMarkup::class, self::OUTPUT_IMAGE_PNG => \chillerlan\QRCode\Output\QRGdImage::class, self::OUTPUT_IMAGE_GIF => \chillerlan\QRCode\Output\QRGdImage::class, self::OUTPUT_IMAGE_JPG => \chillerlan\QRCode\Output\QRGdImage::class, self::OUTPUT_STRING_JSON => \chillerlan\QRCode\Output\QRString::class, self::OUTPUT_STRING_TEXT => \chillerlan\QRCode\Output\QRString::class, self::OUTPUT_IMAGICK => \chillerlan\QRCode\Output\QRImagick::class, self::OUTPUT_FPDF => \chillerlan\QRCode\Output\QRFpdf::class]

Map of built-in output modes => modules

OUTPUT_STRING_JSON  = 'json'

OUTPUT_STRING_TEXT  = 'text'

VERSION_AUTO  = -1

$dataSegments  : array<string|int, mixed>

A collection of one or more data segments of [classname, data] to write

$options  : SettingsContainerInterface

The settings container

__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)

addKanjiSegment()  : self

Adds a Kanji data segment

addNumericSegment()  : self

Adds a numeric data segment

clearSegments()  : self

Clears the data segments array

getMatrix()  : 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

addSegment()  : void

Adds a data segment

initCustomOutputInterface()  : QROutputInterface

initializes a custom output module after checking the existence of the class and if it implemnts the required interface

initOutputInterface()  : QROutputInterface

returns a fresh (built-in) QROutputInterface