Zend Framework
Back to top  

Class for rendering the barcode

 Methods

Constructor

__construct(array | \Traversable $options) 

Parameters

$options

array\Traversable

Checking of parameters after all settings

checkParams() : bool

Returns

bool

Draw the barcode in the rendering resource

draw() : mixed

Exceptions

\Zend\Barcode\Exception\ExceptionInterface

Returns

mixed

Retrieve the automatic rendering of exception

getAutomaticRenderError() : bool

Returns

bool

Retrieve the barcode object

getBarcode() : \Zend\Barcode\Object\ObjectInterface

Returns

\Zend\Barcode\Object\ObjectInterface

Horizontal position of the barcode in the rendering resource

getHorizontalPosition() : string

Returns

string

Retrieve vertical adjustment

getLeftOffset() : int

Returns

int

Set the size of a module

getModuleSize() : float

Returns

float

Retrieve renderer namespace

getRendererNamespace() : string

Returns

string

Retrieve vertical adjustment

getTopOffset() : int

Returns

int

getTransparentBackground() 

getTransparentBackground() : bool

Returns

bool

Retrieve renderer type

getType() : string

Returns

string

Vertical position of the barcode in the rendering resource

getVerticalPosition() : string

Returns

string

Render the resource by sending headers and drawed resource

render() : mixed
Inherited

inherited_from \Zend\Barcode\Renderer\RendererInterface::render()

Returns

mixed

Activate/Deactivate the automatic rendering of exception

setAutomaticRenderError(bool $value) : \Zend\Barcode\Renderer\AbstractRenderer

Parameters

$value

bool

Returns

\Zend\Barcode\Renderer\AbstractRenderer

Set the barcode object

setBarcode(\Zend\Barcode\Object\ObjectInterface $barcode) : \Zend\Barcode\Renderer\AbstractRenderer

Parameters

$barcode

\Zend\Barcode\Object\ObjectInterface

Returns

\Zend\Barcode\Renderer\AbstractRenderer

Horizontal position of the barcode in the rendering resource

setHorizontalPosition(string $value) : \Zend\Barcode\Renderer\AbstractRenderer

Parameters

$value

string

Exceptions

\Zend\Barcode\Renderer\Exception\UnexpectedValueException

Returns

\Zend\Barcode\Renderer\AbstractRenderer

Manually adjust left position

setLeftOffset(int $value) : \Zend\Barcode\Renderer\AbstractRenderer

Parameters

$value

int

Exceptions

\Zend\Barcode\Renderer\Exception\OutOfRangeException

Returns

\Zend\Barcode\Renderer\AbstractRenderer

Set the size of a module

setModuleSize(float $value) : \Zend\Barcode\Renderer\AbstractRenderer

Parameters

$value

float

Exceptions

\Zend\Barcode\Renderer\Exception\OutOfRangeException

Returns

\Zend\Barcode\Renderer\AbstractRenderer

Set renderer state from options array

setOptions(array $options) : \Zend\Barcode\Renderer\AbstractRenderer

Parameters

$options

array

Returns

\Zend\Barcode\Renderer\AbstractRenderer

Set renderer namespace for autoloading

setRendererNamespace(string $namespace) : \Zend\Barcode\Renderer\AbstractRenderer

Parameters

$namespace

string

Returns

\Zend\Barcode\Renderer\AbstractRenderer

Manually adjust top position

setTopOffset(int $value) : \Zend\Barcode\Renderer\AbstractRenderer

Parameters

$value

int

Exceptions

\Zend\Barcode\Renderer\Exception\OutOfRangeException

Returns

\Zend\Barcode\Renderer\AbstractRenderer

Set whether background should be transparent Will work for SVG and Image (png and gif only)

setTransparentBackground($bool) : \Zend\Barcode\Renderer\$this

Parameters

$bool

Returns

\Zend\Barcode\Renderer\$this

Vertical position of the barcode in the rendering resource

setVerticalPosition(string $value) : \Zend\Barcode\Renderer\AbstractRenderer

Parameters

$value

string

Exceptions

\Zend\Barcode\Renderer\Exception\UnexpectedValueException

Returns

\Zend\Barcode\Renderer\AbstractRenderer

Calculate the left and top offset of the barcode in the rendering support

adjustPosition(float $supportHeight, float $supportWidth) : void

Parameters

$supportHeight

float

$supportWidth

float

Check if a barcode object is correctly provided

checkBarcodeObject() : void

Exceptions

\Zend\Barcode\Renderer\Exception\RuntimeException

Checking of parameters after all settings

checkSpecificParams() : void

Draw a polygon in the rendering resource

drawPolygon(array $points, int $color, bool $filled) 

Parameters

$points

array

$color

int

$filled

bool

Draw a polygon in the rendering resource

drawText(string $text, float $size, array $position, string $font, int $color, string $alignment, float | int $orientation) 

Parameters

$text

string

$size

float

$position

array

$font

string

$color

int

$alignment

string

$orientation

floatint

Initialize the rendering resource

initRenderer() : void

Sub process to draw the barcode instructions Needed by the automatic error rendering

drawInstructionList() 

 Properties

 

Activate/Deactivate the automatic rendering of exception

$automaticRenderError : bool

 

Barcode object

$barcode : \Zend\Barcode\Object\ObjectInterface

 

Horizontal position of the barcode in the rendering resource

$horizontalPosition : string

 

Offset of the barcode from the left of the rendering resource

$leftOffset : int

 

Module size rendering

$moduleSize : float

 

Namespace of the renderer for autoloading

$rendererNamespace : string

 

Drawing resource

$resource 

 

Offset of the barcode from the top of the rendering resource

$topOffset : int

 

Show a transparent background

$transparentBackground : Boolean

 

Renderer type

$type : string

 

Vertical position of the barcode in the rendering resource

$verticalPosition : string