\BaconQrCode\Renderer\TextPlain

Plaintext renderer.

Summary

Methods
Properties
Constants
setFullBlock()
getFullBlock()
setEmptyBlock()
getEmptyBlock()
setMargin()
getMargin()
render()
No public properties found
No constants found
No protected methods found
$margin
$fullBlock
$emptyBlock
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

$fullBlock

$fullBlock : string

Char used for full block.

UTF-8 FULL BLOCK (U+2588)

Type

string

$emptyBlock

$emptyBlock : string

Char used for empty space

Type

string

Methods

setFullBlock()

setFullBlock(string  $fullBlock) 

Set char used as full block (occupied space, "black").

Parameters

string $fullBlock

getFullBlock()

getFullBlock() : string

Get char used as full block (occupied space, "black").

Returns

string

setEmptyBlock()

setEmptyBlock(string  $emptyBlock) 

Set char used as empty block (empty space, "white").

Parameters

string $emptyBlock

getEmptyBlock()

getEmptyBlock() : string

Get char used as empty block (empty space, "white").

Returns

string

setMargin()

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

Sets the margin around the QR code.

Parameters

integer $margin

Throws

\BaconQrCode\Exception\InvalidArgumentException

Returns

\BaconQrCode\Renderer\Text\AbstractRenderer

getMargin()

getMargin() : integer

Gets the margin around the QR code.

Returns

integer

render()

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

render(): defined by RendererInterface.

Parameters

\BaconQrCode\Encoder\QrCode $qrCode

Returns

string