setMargin()
getMargin()
setWidth()
getWidth()
setHeight()
getHeight()
setRoundDimensions()
shouldRoundDimensions()
setBackgroundColor()
getBackgroundColor()
setForegroundColor()
getForegroundColor()
addDecorator()
render()
init()
addColor()
drawBackground()
drawBlock()
getByteStream()

No public properties found

No constants found

setColor()

$margin
$width
$height
$roundDimensions
$finalWidth
$finalHeight
$blockSize
$backgroundColor
$floorToClosestDimension
$foregroundColor
$decorators
$eps
$colors
$currentColor

N/A

No private methods found

No private properties found

N/A

Properties

$margin

$margin : integer

Margin around the QR code, also known as quiet zone.

Type

integer

$width

$width : integer

Requested width of the rendered image.

Type

integer

$height

$height : integer

Requested height of the rendered image.

Type

integer

$roundDimensions

$roundDimensions : boolean

Whether dimensions should be rounded down.

Type

boolean

$finalWidth

$finalWidth : integer

Final width of the image.

Type

integer

$finalHeight

$finalHeight : integer

Final height of the image.

Type

integer

$blockSize

$blockSize : integer

Size of each individual block.

Type

integer

$backgroundColor

$backgroundColor : \BaconQrCode\Renderer\Color\ColorInterface

Background color.

Type

\BaconQrCode\Renderer\Color\ColorInterface

$floorToClosestDimension

$floorToClosestDimension : boolean

Whether dimensions should be rounded down

Type

boolean

$foregroundColor

$foregroundColor : \BaconQrCode\Renderer\Color\ColorInterface

Foreground color.

Type

\BaconQrCode\Renderer\Color\ColorInterface

$decorators

$decorators : array

Decorators used on QR codes.

Type

array

$eps

$eps : string

EPS string.

Type

string

$colors

$colors : array

Colors used for drawing.

Type

array

$currentColor

$currentColor : string

Current color.

Type

string

Methods

setMargin()

setMargin(integer  $margin) : \BaconQrCode\Renderer\Image\AbstractRenderer

Sets the margin around the QR code.

Parameters

integer

$margin

Throws

\BaconQrCode\Exception\InvalidArgumentException

Returns

\BaconQrCode\Renderer\Image\AbstractRenderer

getMargin()

getMargin() : integer

Gets the margin around the QR code.

Returns

integer

setWidth()

setWidth(integer  $width) : \BaconQrCode\Renderer\Image\AbstractRenderer

Sets the height around the renderd image.

If the width is smaller than the matrix width plus padding, the renderer will automatically use that as the width instead of the specified one.

Parameters

integer

$width

Returns

\BaconQrCode\Renderer\Image\AbstractRenderer

getWidth()

getWidth() : integer

Gets the width of the rendered image.

Returns

integer

setHeight()

setHeight(integer  $height) : \BaconQrCode\Renderer\Image\AbstractRenderer

Sets the height around the renderd image.

If the height is smaller than the matrix height plus padding, the renderer will automatically use that as the height instead of the specified one.

Parameters

integer

$height

Returns

\BaconQrCode\Renderer\Image\AbstractRenderer

getHeight()

getHeight() : integer

Gets the height around the rendered image.

Returns

integer

setRoundDimensions()

setRoundDimensions(boolean  $flag) : \BaconQrCode\Renderer\Image\AbstractRenderer

Sets whether dimensions should be rounded down.

Parameters

boolean

$flag

Returns

\BaconQrCode\Renderer\Image\AbstractRenderer

shouldRoundDimensions()

shouldRoundDimensions() : boolean

Gets whether dimensions should be rounded down.

Returns

boolean

setBackgroundColor()

setBackgroundColor(\BaconQrCode\Renderer\Color\ColorInterface  $color) : \BaconQrCode\Renderer\Image\AbstractRenderer

Sets background color.

Parameters

\BaconQrCode\Renderer\Color\ColorInterface

$color

Returns

\BaconQrCode\Renderer\Image\AbstractRenderer

getBackgroundColor()

getBackgroundColor() : \BaconQrCode\Renderer\Color\ColorInterface

Gets background color.

Returns

\BaconQrCode\Renderer\Color\ColorInterface

setForegroundColor()

setForegroundColor(\BaconQrCode\Renderer\Color\ColorInterface  $color) : \BaconQrCode\Renderer\Image\AbstractRenderer

Sets foreground color.

Parameters

\BaconQrCode\Renderer\Color\ColorInterface

$color

Returns

\BaconQrCode\Renderer\Image\AbstractRenderer

getForegroundColor()

getForegroundColor() : \BaconQrCode\Renderer\Color\ColorInterface

Gets foreground color.

Returns

\BaconQrCode\Renderer\Color\ColorInterface

addDecorator()

addDecorator(\BaconQrCode\Renderer\Image\Decorator\DecoratorInterface  $decorator) : \BaconQrCode\Renderer\Image\AbstractRenderer

Adds a decorator to the renderer.

Parameters

\BaconQrCode\Renderer\Image\Decorator\DecoratorInterface

$decorator

Returns

\BaconQrCode\Renderer\Image\AbstractRenderer

render()

render(\BaconQrCode\Encoder\QrCode  $qrCode) : string

render(): defined by RendererInterface.

Parameters

\BaconQrCode\Encoder\QrCode

$qrCode

Returns

string

init()

init() : void

init(): defined by RendererInterface.

addColor()

addColor(string  $id, \BaconQrCode\Renderer\Color\ColorInterface  $color) : void

addColor(): defined by RendererInterface.

Parameters

string	$id
\BaconQrCode\Renderer\Color\ColorInterface	$color

drawBackground()

drawBackground(string  $colorId) : void

drawBackground(): defined by RendererInterface.

Parameters

string

$colorId

drawBlock()

drawBlock(integer  $x, integer  $y, string  $colorId) : void

drawBlock(): defined by RendererInterface.

Parameters

integer	$x
integer	$y
string	$colorId

getByteStream()

getByteStream() : string

getByteStream(): defined by RendererInterface.

Returns

string

setColor()

setColor(string  $colorId) : void

Sets color to use.

Parameters

string

$colorId