Class for rendering the barcode in PDF resource

category Zend
package Zend_Barcode

 Methods

Constructor

__construct(array | \Traversable $options) 
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::__construct()

Parameters

$options

array\Traversable

Checking of parameters after all settings

checkParams() : bool
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::checkParams()

Returns

bool

Draw the barcode in the rendering resource

draw() : mixed
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::draw()

Exceptions

\Zend\Barcode\Exception\ExceptionInterface

Returns

mixed

Retrieve the automatic rendering of exception

getAutomaticRenderError() : bool
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::getAutomaticRenderError()

Returns

bool

Retrieve the barcode object

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

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::getBarcode()

Returns

Horizontal position of the barcode in the rendering resource

getHorizontalPosition() : string
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::getHorizontalPosition()

Returns

string

Retrieve vertical adjustment

getLeftOffset() : integer
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::getLeftOffset()

Returns

integer

Set the size of a module

getModuleSize() : float
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::getModuleSize()

Returns

float

Retrieve renderer namespace

getRendererNamespace() : string
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::getRendererNamespace()

Returns

string

Retrieve vertical adjustment

getTopOffset() : integer
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::getTopOffset()

Returns

integer

Retrieve renderer type

getType() : string
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::getType()

Returns

string

Vertical position of the barcode in the rendering resource

getVerticalPosition() : string
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::getVerticalPosition()

Returns

string

Draw the barcode in the PDF, send headers and the PDF

render() : mixed

Returns

mixed

Activate/Deactivate the automatic rendering of exception

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

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::setAutomaticRenderError()

Parameters

$value

bool

Returns

Set the barcode object

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

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::setBarcode()

Parameters

Returns

Horizontal position of the barcode in the rendering resource

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

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::setHorizontalPosition()

Parameters

$value

string

Exceptions

\Zend\Barcode\Renderer\Exception\UnexpectedValueException

Returns

Manually adjust left position

setLeftOffset(integer $value) : \Zend\Barcode\Renderer\AbstractRenderer
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::setLeftOffset()

Parameters

$value

integer

Exceptions

\Zend\Barcode\Renderer\Exception\OutOfRangeException

Returns

Set the size of a module

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

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::setModuleSize()

Parameters

$value

float

Exceptions

\Zend\Barcode\Renderer\Exception\OutOfRangeException

Returns

Set renderer state from options array

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

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::setOptions()

Parameters

$options

array

Returns

Set renderer namespace for autoloading

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

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::setRendererNamespace()

Parameters

$namespace

string

Returns

Set a PDF resource to draw the barcode inside

setResource(\ZendPdf\PdfDocument $pdf, integer $page) : \Zend\Barcode\Renderer\Pdf

Parameters

$pdf

\ZendPdf\PdfDocument

$page

integer

Returns

Manually adjust top position

setTopOffset(integer $value) : \Zend\Barcode\Renderer\AbstractRenderer
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::setTopOffset()

Parameters

$value

integer

Exceptions

\Zend\Barcode\Renderer\Exception\OutOfRangeException

Returns

Vertical position of the barcode in the rendering resource

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

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::setVerticalPosition()

Parameters

$value

string

Exceptions

\Zend\Barcode\Renderer\Exception\UnexpectedValueException

Returns

Calculate the width of a string: in case of using alignment parameter in drawText

widthForStringUsingFontSize(string $text, \ZendPdf\Font $font, float $fontSize) : float

Parameters

$text

string

$font

\ZendPdf\Font

$fontSize

float

Returns

float

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

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

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::adjustPosition()

Parameters

$supportHeight

float

$supportWidth

float

Check if a barcode object is correctly provided

checkBarcodeObject() : void
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::checkBarcodeObject()

Exceptions

\Zend\Barcode\Renderer\Exception\RuntimeException

Check renderer parameters

checkSpecificParams() : void

Draw a polygon in the rendering resource

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

Parameters

$points

array

$color

integer

$filled

bool

Draw a polygon in the rendering resource

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

Parameters

$text

string

$size

float

$position

array

$font

string

$color

integer

$alignment

string

$orientation

float

Initialize the PDF resource

initRenderer() : void

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

drawInstructionList() 
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::drawInstructionList()

 Properties

 

Activate/Deactivate the automatic rendering of exception

$automaticRenderError : bool
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::$$automaticRenderError
 

Barcode object

$barcode : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::$$barcode
 

Horizontal position of the barcode in the rendering resource

$horizontalPosition : integer
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::$$horizontalPosition
 

Offset of the barcode from the left of the rendering resource

$leftOffset : integer
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::$$leftOffset
 

Module size rendering

$moduleSize : float

 

Page number in PDF resource

$page : integer

 

Namespace of the renderer for autoloading

$rendererNamespace : string
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::$$rendererNamespace
 

PDF resource

$resource : \ZendPdf\PdfDocument

 

Offset of the barcode from the top of the rendering resource

$topOffset : integer
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::$$topOffset
 

Renderer type

$type : string
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::$$type
 

Vertical position of the barcode in the rendering resource

$verticalPosition : integer
Inherited

inherited_from \Zend\Barcode\Renderer\AbstractRenderer::$$verticalPosition