\Endroid\QrCodeQrCode

Generate QR Code.

Summary

Methods
Properties
Constants
__construct()
setStructureAppend()
setVersion()
getVersion()
setErrorCorrection()
getErrorCorrection()
setModuleSize()
getModuleSize()
setImageType()
getImageType()
setExtension()
setImagePath()
getImagePath()
setPath()
getPath()
setLogo()
setLogoSize()
setText()
getText()
setSize()
getSize()
setPadding()
getPadding()
setDrawQuietZone()
getDrawQuietZone()
setDrawBorder()
getDrawBorder()
setLabel()
getLabel()
setLabelFontSize()
getLabelFontSize()
setLabelFontPath()
getLabelFontPath()
setLabelHalign()
getLabelHalign()
setLabelValign()
getLabelValign()
setForegroundColor()
getForegroundColor()
setBackgroundColor()
getBackgroundColor()
getImage()
getDataUri()
save()
render()
getContentType()
get()
create()
No public properties found
LEVEL_LOW
LEVEL_MEDIUM
LEVEL_QUARTILE
LEVEL_HIGH
IMAGE_TYPE_PNG
IMAGE_TYPE_GIF
IMAGE_TYPE_JPEG
IMAGE_TYPE_WBMP
LABEL_HALIGN_CENTER
LABEL_HALIGN_LEFT
LABEL_HALIGN_LEFT_BORDER
LABEL_HALIGN_LEFT_CODE
LABEL_HALIGN_RIGHT
LABEL_HALIGN_RIGHT_BORDER
LABEL_HALIGN_RIGHT_CODE
LABEL_VALIGN_TOP
LABEL_VALIGN_TOP_NO_BORDER
LABEL_VALIGN_MIDDLE
LABEL_VALIGN_BOTTOM
No protected methods found
$logo
$logo_size
$text
$size
$padding
$draw_quiet_zone
$draw_border
$color_foreground
$color_background
$label
$label_font_size
$label_font_path
$label_halign
$label_valign
$image
$version
$error_correction
$error_corrections_available
$module_size
$image_type
$image_types_available
$image_path
$path
$structure_append_n
$structure_append_m
$structure_append_parity
$structure_append_original_data
N/A
No private methods found
No private properties found
N/A

Constants

LEVEL_LOW

LEVEL_LOW = 1

LEVEL_MEDIUM

LEVEL_MEDIUM = 0

LEVEL_QUARTILE

LEVEL_QUARTILE = 3

LEVEL_HIGH

LEVEL_HIGH = 2

IMAGE_TYPE_PNG

IMAGE_TYPE_PNG = 'png'

IMAGE_TYPE_GIF

IMAGE_TYPE_GIF = 'gif'

IMAGE_TYPE_JPEG

IMAGE_TYPE_JPEG = 'jpeg'

IMAGE_TYPE_WBMP

IMAGE_TYPE_WBMP = 'wbmp'

LABEL_HALIGN_CENTER

LABEL_HALIGN_CENTER = 0

LABEL_HALIGN_LEFT

LABEL_HALIGN_LEFT = 1

LABEL_HALIGN_LEFT_BORDER

LABEL_HALIGN_LEFT_BORDER = 2

LABEL_HALIGN_LEFT_CODE

LABEL_HALIGN_LEFT_CODE = 3

LABEL_HALIGN_RIGHT

LABEL_HALIGN_RIGHT = 4

LABEL_HALIGN_RIGHT_BORDER

LABEL_HALIGN_RIGHT_BORDER = 5

LABEL_HALIGN_RIGHT_CODE

LABEL_HALIGN_RIGHT_CODE = 6

LABEL_VALIGN_TOP

LABEL_VALIGN_TOP = 1

LABEL_VALIGN_TOP_NO_BORDER

LABEL_VALIGN_TOP_NO_BORDER = 2

LABEL_VALIGN_MIDDLE

LABEL_VALIGN_MIDDLE = 3

LABEL_VALIGN_BOTTOM

LABEL_VALIGN_BOTTOM = 4

Properties

$logo

$logo : string

Type

string

$logo_size

$logo_size : 

Type

$text

$text : string

Type

string

$size

$size : integer

Type

integer

$padding

$padding : integer

Type

integer

$draw_quiet_zone

$draw_quiet_zone : boolean

Type

boolean

$draw_border

$draw_border : boolean

Type

boolean

$color_foreground

$color_foreground : array

Type

array

$color_background

$color_background : array

Type

array

$label

$label : string

Type

string

$label_font_size

$label_font_size : integer

Type

integer

$label_font_path

$label_font_path : string

Type

string

$label_halign

$label_halign : integer

Type

integer

$label_valign

$label_valign : integer

Type

integer

$image

$image : resource

Type

resource

$version

$version : integer

Type

integer

$error_correction

$error_correction : integer

Type

integer

$error_corrections_available

$error_corrections_available : array

Type

array

$module_size

$module_size : integer

Type

integer

$image_type

$image_type : string

Type

string

$image_types_available

$image_types_available : array

Type

array

$image_path

$image_path : string

Type

string

$path

$path : string

Type

string

$structure_append_n

$structure_append_n : integer

Type

integer

$structure_append_m

$structure_append_m : integer

Type

integer

$structure_append_parity

$structure_append_parity : integer

Type

integer

$structure_append_original_data

$structure_append_original_data : string

Type

string

Methods

__construct()

__construct(string  $text = '') 

Class constructor.

Parameters

string $text

setStructureAppend()

setStructureAppend(integer  $n, integer  $m, integer  $parity, string  $original_data) : \Endroid\QrCode\QrCode

Set structure append.

Parameters

integer $n
integer $m
integer $parity

Parity

string $original_data

Original data

Returns

\Endroid\QrCode\QrCode

setVersion()

setVersion(integer  $version) : \Endroid\QrCode\QrCode

Set QR Code version.

Parameters

integer $version

QR Code version

Returns

\Endroid\QrCode\QrCode

getVersion()

getVersion() : integer

Return QR Code version.

Returns

integer

setErrorCorrection()

setErrorCorrection(mixed  $error_correction) : \Endroid\QrCode\QrCode

Set QR Code error correction level.

Parameters

mixed $error_correction

Error Correction Level

Returns

\Endroid\QrCode\QrCode

getErrorCorrection()

getErrorCorrection() : integer

Return QR Code error correction level.

Returns

integer

setModuleSize()

setModuleSize(integer  $module_size) : \Endroid\QrCode\QrCode

Set QR Code module size.

Parameters

integer $module_size

Module size

Returns

\Endroid\QrCode\QrCode

getModuleSize()

getModuleSize() : integer

Return QR Code module size.

Returns

integer

setImageType()

setImageType(string  $image_type) : \Endroid\QrCode\QrCode

Set image type for rendering.

Parameters

string $image_type

Image type

Throws

\Endroid\QrCode\Exceptions\ImageTypeInvalidException

Returns

\Endroid\QrCode\QrCode

getImageType()

getImageType() : string

Return image type for rendering.

Returns

string

setExtension()

setExtension(string  $extension) : \Endroid\QrCode\QrCode

Set image type for rendering via extension.

Parameters

string $extension

Image extension

Returns

\Endroid\QrCode\QrCode

setImagePath()

setImagePath(string  $image_path) : \Endroid\QrCode\QrCode

Set path to the images directory.

Parameters

string $image_path

Image directory

Returns

\Endroid\QrCode\QrCode

getImagePath()

getImagePath() : string

Return path to the images directory.

Returns

string

setPath()

setPath(string  $path) : \Endroid\QrCode\QrCode

Set path to the data directory.

Parameters

string $path

Data directory

Returns

\Endroid\QrCode\QrCode

getPath()

getPath() : string

Return path to the data directory.

Returns

string

setLogo()

setLogo(string  $logo) : \Endroid\QrCode\QrCode

Set logo in QR Code.

Parameters

string $logo

Logo Path

Throws

\Endroid\QrCode\Exceptions\DataDoesntExistsException

Returns

\Endroid\QrCode\QrCode

setLogoSize()

setLogoSize(integer  $logo_size) : \Endroid\QrCode\QrCode

Set logo size in QR Code(default 48).

Parameters

integer $logo_size

Logo Size

Returns

\Endroid\QrCode\QrCode

setText()

setText(string  $text) : \Endroid\QrCode\QrCode

Set text to hide in QR Code.

Parameters

string $text

Text to hide

Returns

\Endroid\QrCode\QrCode

getText()

getText() : string

Return text that will be hid in QR Code.

Returns

string

setSize()

setSize(integer  $size) : \Endroid\QrCode\QrCode

Set QR Code size (width).

Parameters

integer $size

Width of the QR Code

Returns

\Endroid\QrCode\QrCode

getSize()

getSize() : integer

Return QR Code size (width).

Returns

integer

setPadding()

setPadding(integer  $padding) : \Endroid\QrCode\QrCode

Set padding around the QR Code.

Parameters

integer $padding

Padding around QR Code

Returns

\Endroid\QrCode\QrCode

getPadding()

getPadding() : integer

Return padding around the QR Code.

Returns

integer

setDrawQuietZone()

setDrawQuietZone(boolean  $draw_quiet_zone) : \Endroid\QrCode\QrCode

Set draw required four-module wide margin.

Parameters

boolean $draw_quiet_zone

State of required four-module wide margin drawing

Returns

\Endroid\QrCode\QrCode

getDrawQuietZone()

getDrawQuietZone() : boolean

Return draw required four-module wide margin.

Returns

boolean

setDrawBorder()

setDrawBorder(boolean  $draw_border) : \Endroid\QrCode\QrCode

Set draw border around QR Code.

Parameters

boolean $draw_border

State of border drawing

Returns

\Endroid\QrCode\QrCode

getDrawBorder()

getDrawBorder() : boolean

Return draw border around QR Code.

Returns

boolean

setLabel()

setLabel(integer|string  $label) : \Endroid\QrCode\QrCode

Set QR Code label (text).

Parameters

integer|string $label

Label to print under QR code

Returns

\Endroid\QrCode\QrCode

getLabel()

getLabel() : string

Return QR Code label (text).

Returns

string

setLabelFontSize()

setLabelFontSize(integer  $label_font_size) : \Endroid\QrCode\QrCode

Set QR Code label font size.

Parameters

integer $label_font_size

Font size of the QR code label

Returns

\Endroid\QrCode\QrCode

getLabelFontSize()

getLabelFontSize() : integer

Return QR Code label font size.

Returns

integer

setLabelFontPath()

setLabelFontPath(integer  $label_font_path) : \Endroid\QrCode\QrCode

Set QR Code label font path.

Parameters

integer $label_font_path

Path to the QR Code label's TTF font file

Returns

\Endroid\QrCode\QrCode

getLabelFontPath()

getLabelFontPath() : string

Return path to the QR Code label's TTF font file.

Returns

string

setLabelHalign()

setLabelHalign(integer  $label_halign) : \Endroid\QrCode\QrCode

Set label horizontal alignment.

Parameters

integer $label_halign

Label horizontal alignment

Returns

\Endroid\QrCode\QrCode

getLabelHalign()

getLabelHalign() : integer

Return label horizontal alignment.

Returns

integer

setLabelValign()

setLabelValign(integer  $label_valign) : \Endroid\QrCode\QrCode

Set label vertical alignment.

Parameters

integer $label_valign

Label vertical alignment

Returns

\Endroid\QrCode\QrCode

getLabelValign()

getLabelValign() : integer

Return label vertical alignment.

Returns

integer

setForegroundColor()

setForegroundColor(array  $color_foreground) : \Endroid\QrCode\QrCode

Set foreground color of the QR Code.

Parameters

array $color_foreground

RGB color

Returns

\Endroid\QrCode\QrCode

getForegroundColor()

getForegroundColor() : array

Return foreground color of the QR Code.

Returns

array

setBackgroundColor()

setBackgroundColor(array  $color_background) : \Endroid\QrCode\QrCode

Set background color of the QR Code.

Parameters

array $color_background

RGB color

Returns

\Endroid\QrCode\QrCode

getBackgroundColor()

getBackgroundColor() : array

Return background color of the QR Code.

Returns

array

getImage()

getImage() : resource

Return the image resource.

Returns

resource

getDataUri()

getDataUri() : string

Return the data URI.

Returns

string

save()

save(string  $filename) : \Endroid\QrCode\QrCode

Render the QR Code then save it to given file name.

Parameters

string $filename

File name of the QR Code

Returns

\Endroid\QrCode\QrCode

render()

render(null|string  $filename = null, null|string  $format = 'png') : \Endroid\QrCode\QrCode

Render the QR Code then save it to given file name or output it to the browser when file name omitted.

Parameters

null|string $filename

File name of the QR Code

null|string $format

Format of the file (png, jpeg, jpg, gif, wbmp)

Throws

\Endroid\QrCode\Exceptions\ImageFunctionUnknownException
\Endroid\QrCode\Exceptions\ImageFunctionFailedException

Returns

\Endroid\QrCode\QrCode

getContentType()

getContentType() : string

Returns the content type corresponding to the image type.

Returns

string

get()

get(string|null  $format = null) : string

Create QR Code and return its content.

Parameters

string|null $format

Image type (gif, png, wbmp, jpeg)

Throws

\Endroid\QrCode\Exceptions\ImageFunctionUnknownException
\Endroid\QrCode\Exceptions\ImageFunctionFailedException

Returns

string

create()

create() 

Create the image.

Throws

\Endroid\QrCode\Exceptions\DataDoesntExistsException
\Endroid\QrCode\Exceptions\VersionTooLargeException
\Endroid\QrCode\Exceptions\ImageSizeTooLargeException
\OverflowException