Menu

## QROutputInterface
in

QROutputInterface.php : 18

Converts the data matrix into readable output

### Table of Contents

CUSTOM = 'custom'
DEFAULT_MODULE_VALUES = [ // light \chillerlan\QRCode\Data\QRMatrix::M_NULL => false, \chillerlan\QRCode\Data\QRMatrix::M_DATA => false, \chillerlan\QRCode\Data\QRMatrix::M_FINDER => false, \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR => false, \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT => false, \chillerlan\QRCode\Data\QRMatrix::M_TIMING => false, \chillerlan\QRCode\Data\QRMatrix::M_FORMAT => false, \chillerlan\QRCode\Data\QRMatrix::M_VERSION => false, \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE => false, \chillerlan\QRCode\Data\QRMatrix::M_LOGO => false, \chillerlan\QRCode\Data\QRMatrix::M_TEST => false, // dark \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_DATA | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_FINDER | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_TIMING | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_FORMAT | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_VERSION | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_TEST | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, ]
EPS = 'eps'
FPDF = 'fpdf'
GDIMAGE_GIF = 'gif'
GDIMAGE_JPG = 'jpg'
GDIMAGE_PNG = 'png'
IMAGICK = 'imagick'
MARKUP_HTML = 'html'
MARKUP_SVG = 'svg'
MODES = [self::MARKUP_SVG => \chillerlan\QRCode\Output\QRMarkupSVG::class, self::MARKUP_HTML => \chillerlan\QRCode\Output\QRMarkupHTML::class, self::GDIMAGE_PNG => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_GIF => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_JPG => \chillerlan\QRCode\Output\QRGdImage::class, self::STRING_JSON => \chillerlan\QRCode\Output\QRString::class, self::STRING_TEXT => \chillerlan\QRCode\Output\QRString::class, self::IMAGICK => \chillerlan\QRCode\Output\QRImagick::class, self::FPDF => \chillerlan\QRCode\Output\QRFpdf::class, self::EPS => \chillerlan\QRCode\Output\QREps::class]
  Map of built-in output modes => modules
STRING_JSON = 'json'
STRING_TEXT = 'text'
dump() : mixed
  generates the output, optionally dumps it to a file, and returns it

### Constants

#### CUSTOM

QROutputInterface.php : 41
`public string CUSTOM = 'custom'`

#### DEFAULT_MODULE_VALUES

QROutputInterface.php : 64
`public array<string|int, bool> DEFAULT_MODULE_VALUES = [ // light \chillerlan\QRCode\Data\QRMatrix::M_NULL => false, \chillerlan\QRCode\Data\QRMatrix::M_DATA => false, \chillerlan\QRCode\Data\QRMatrix::M_FINDER => false, \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR => false, \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT => false, \chillerlan\QRCode\Data\QRMatrix::M_TIMING => false, \chillerlan\QRCode\Data\QRMatrix::M_FORMAT => false, \chillerlan\QRCode\Data\QRMatrix::M_VERSION => false, \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE => false, \chillerlan\QRCode\Data\QRMatrix::M_LOGO => false, \chillerlan\QRCode\Data\QRMatrix::M_TEST => false, // dark \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_DATA | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_FINDER | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_TIMING | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_FORMAT | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_VERSION | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, \chillerlan\QRCode\Data\QRMatrix::M_TEST | \chillerlan\QRCode\Data\QRMatrix::IS_DARK => true, ]`

#### EPS

QROutputInterface.php : 39
`public string EPS = 'eps'`

#### FPDF

QROutputInterface.php : 37
`public string FPDF = 'fpdf'`

#### GDIMAGE_GIF

QROutputInterface.php : 29
`public string GDIMAGE_GIF = 'gif'`

#### GDIMAGE_JPG

QROutputInterface.php : 27
`public string GDIMAGE_JPG = 'jpg'`

#### GDIMAGE_PNG

QROutputInterface.php : 25
`public string GDIMAGE_PNG = 'png'`

#### IMAGICK

QROutputInterface.php : 35
`public string IMAGICK = 'imagick'`

#### MARKUP_HTML

QROutputInterface.php : 21
`public string MARKUP_HTML = 'html'`

#### MARKUP_SVG

QROutputInterface.php : 23
`public string MARKUP_SVG = 'svg'`

#### MODES

QROutputInterface.php : 48

Map of built-in output modes => modules

`public array<string|int, string> MODES = [self::MARKUP_SVG => \chillerlan\QRCode\Output\QRMarkupSVG::class, self::MARKUP_HTML => \chillerlan\QRCode\Output\QRMarkupHTML::class, self::GDIMAGE_PNG => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_GIF => \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_JPG => \chillerlan\QRCode\Output\QRGdImage::class, self::STRING_JSON => \chillerlan\QRCode\Output\QRString::class, self::STRING_TEXT => \chillerlan\QRCode\Output\QRString::class, self::IMAGICK => \chillerlan\QRCode\Output\QRImagick::class, self::FPDF => \chillerlan\QRCode\Output\QRFpdf::class, self::EPS => \chillerlan\QRCode\Output\QREps::class]`

#### STRING_JSON

QROutputInterface.php : 31
`public string STRING_JSON = 'json'`

#### STRING_TEXT

QROutputInterface.php : 33
`public string STRING_TEXT = 'text'`

### Methods

#### dump()

QROutputInterface.php : 100

generates the output, optionally dumps it to a file, and returns it

`public dump([string $file = null ]) : mixed`

please note that the value of QROptions::$cachefile is already evaluated at this point. if the output module is invoked manually, it has no effect at all. you need to supply the $file parameter here in that case (or handle the option value in your custom output module).

##### Parameters

$file : string = null

##### Tags

see
  QRCode::renderMatrix()

##### Return values

mixed —

## Search results