Class Image

Summary

Fully Qualified Name: Laminas\Barcode\Renderer\Image
Extends: AbstractRenderer

Description

Class for rendering the barcode as image

Methods

Name Description Defined By
__construct() Constructor Image
checkParams() Checking of parameters after all settings AbstractRenderer
draw() Draw the barcode in the rendering resource AbstractRenderer
getAutomaticRenderError() Retrieve the automatic rendering of exception AbstractRenderer
getBarcode() Retrieve the barcode object AbstractRenderer
getHeight() Get barcode height Image
getHorizontalPosition() Horizontal position of the barcode in the rendering resource AbstractRenderer
getImageType() Retrieve the image type to produce Image
getLeftOffset() Retrieve vertical adjustment AbstractRenderer
getModuleSize() Set the size of a module AbstractRenderer
getRendererNamespace() Retrieve renderer namespace AbstractRenderer
getTopOffset() Retrieve vertical adjustment AbstractRenderer
getTransparentBackground() AbstractRenderer
getType() Retrieve renderer type AbstractRenderer
getVerticalPosition() Vertical position of the barcode in the rendering resource AbstractRenderer
getWidth() Get barcode width Image
render() Draw and render the barcode with correct headers Image
setAutomaticRenderError() Activate/Deactivate the automatic rendering of exception AbstractRenderer
setBarcode() Set the barcode object AbstractRenderer
setHeight() Set height of the result image Image
setHorizontalPosition() Horizontal position of the barcode in the rendering resource AbstractRenderer
setImageType() Set the image type to produce (png, jpeg, gif) Image
setLeftOffset() Manually adjust left position AbstractRenderer
setModuleSize() Set the size of a module AbstractRenderer
setOptions() Set renderer state from options array AbstractRenderer
setRendererNamespace() Set renderer namespace for autoloading AbstractRenderer
setResource() Set an image resource to draw the barcode inside Image
setTopOffset() Manually adjust top position AbstractRenderer
setTransparentBackground() Set whether background should be transparent Will work for SVG and Image (png and gif only) AbstractRenderer
setVerticalPosition() Vertical position of the barcode in the rendering resource AbstractRenderer
setWidth() Set barcode width Image

Method Details

__construct()

Constructor

Parameter Name Type Description
$options array|\Traversable

Returns:

checkParams()

Checking of parameters after all settings

Returns: bool

draw()

Draw the barcode in the rendering resource

Returns: mixed

getAutomaticRenderError()

Retrieve the automatic rendering of exception

Returns: bool

getBarcode()

Retrieve the barcode object

Returns: \Object\ObjectInterface

getHeight()

Get barcode height

Returns: int

getHorizontalPosition()

Horizontal position of the barcode in the rendering resource

Returns: string

getImageType()

Retrieve the image type to produce

Returns: string

getLeftOffset()

Retrieve vertical adjustment

Returns: int

getModuleSize()

Set the size of a module

Returns: float

getRendererNamespace()

Retrieve renderer namespace

Returns: string

getTopOffset()

Retrieve vertical adjustment

Returns: int

getTransparentBackground()

Returns: bool

getType()

Retrieve renderer type

Returns: string

getVerticalPosition()

Vertical position of the barcode in the rendering resource

Returns: string

getWidth()

Get barcode width

Returns: int

render()

Draw and render the barcode with correct headers

Returns: mixed

setAutomaticRenderError()

Activate/Deactivate the automatic rendering of exception

Parameter Name Type Description
$value bool

Returns: self Provides a fluent interface

setBarcode()

Set the barcode object

Parameter Name Type Description
$barcode \Object\ObjectInterface

Returns: self Provides a fluent interface

setHeight()

Set height of the result image

Parameter Name Type Description
$value null|int

Returns: self Provides a fluent interface

setHorizontalPosition()

Horizontal position of the barcode in the rendering resource

Parameter Name Type Description
$value string

Returns: self Provides a fluent interface

setImageType()

Set the image type to produce (png, jpeg, gif)

Parameter Name Type Description
$value string

Returns: self Provides a fluent interface

setLeftOffset()

Manually adjust left position

Parameter Name Type Description
$value int

Returns: self Provides a fluent interface

setModuleSize()

Set the size of a module

Parameter Name Type Description
$value float

Returns: self Provides a fluent interface

setOptions()

Set renderer state from options array

Parameter Name Type Description
$options array

Returns: self Provides a fluent interface

setRendererNamespace()

Set renderer namespace for autoloading

Parameter Name Type Description
$namespace string

Returns: self Provides a fluent interface

setResource()

Set an image resource to draw the barcode inside

Parameter Name Type Description
$image resource

Returns: self Provides a fluent interface

setTopOffset()

Manually adjust top position

Parameter Name Type Description
$value int

Returns: self Provides a fluent interface

setTransparentBackground()

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

Parameter Name Type Description
$bool
$bool

Returns: self Provides a fluent interface

setVerticalPosition()

Vertical position of the barcode in the rendering resource

Parameter Name Type Description
$value string

Returns: self Provides a fluent interface

setWidth()

Set barcode width

Parameter Name Type Description
$value mixed

Returns: self Provides a fluent interface

Top