Barcode/Renderer/RendererAbstract.php

Show:

inherited

Classes
- \Zend_Barcode_Renderer_RendererAbstract

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Barcode
Subpackage: Renderer
Version: $Id: RendererAbstract.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Barcode_Renderer_RendererAbstract
jump to top

Package: Zend\Barcode

Class for rendering the barcode

Children: \Zend_Barcode_Renderer_Pdf; \Zend_Barcode_Renderer_Image; \Zend_Barcode_Renderer_Svg
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

boolean $_automaticRenderError = false

Activate/Deactivate the automatic rendering of exception

Default valuefalseDetails

Type: boolean

\Zend_Barcode_Object_ObjectAbstract $_barcode

Barcode object

Details

Type: \Zend_Barcode_Object_ObjectAbstract

integer $_horizontalPosition = 'left'

Horizontal position of the barcode in the rendering resource

Default value'left'Details

Type: integer

integer $_leftOffset = 0

Offset of the barcode from the left of the rendering resource

Default value0Details

Type: integer

float $_moduleSize = 1

Module size rendering

Default value1Details

Type: float

string $_rendererNamespace = 'Zend_Barcode_Renderer'

Namespace of the renderer for autoloading

Default value'Zend_Barcode_Renderer'Details

Type: string

$_resource

Drawing resource

Details

Type: n/a

integer $_topOffset = 0

Offset of the barcode from the top of the rendering resource

Default value0Details

Type: integer

string $_type = null

Renderer type

Default valuenullDetails

Type: string

integer $_verticalPosition = 'top'

Vertical position of the barcode in the rendering resource

Default value'top'Details

Type: integer

Methods

__construct(array | \Zend_Config $options = null) : void

Constructor

Parameters

Name	Type	Description
$options	array \| \Zend_Config

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

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

Parameters

Name	Type	Description
$supportHeight	float
$supportWidth	float

_checkBarcodeObject() : void

Check if a barcode object is correctly provided

Details

Throw

_checkParams() : void

abstract

Checking of parameters after all settings

_drawInstructionList() : void

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

_drawPolygon(array $points, integer $color, boolean $filled = true) : void

abstract

Draw a polygon in the rendering resource

Parameters

Name	Type	Description
$points	array
$color	integer
$filled	boolean

_drawText(string $text, float $size, array $position, string $font, integer $color, string $alignment = 'center', float $orientation = 0) : void

abstract

Draw a polygon in the rendering resource

Parameters

Name	Type	Description
$text	string
$size	float
$position	array
$font	string
$color	integer
$alignment	string
$orientation	float

_initRenderer() : void

abstract

Initialize the rendering resource

checkParams() : boolean

Checking of parameters after all settings

Returns

Type	Description
boolean

draw() : mixed

Draw the barcode in the rendering resource

Returns

Type	Description
mixed

getAutomaticRenderError() : boolean

Retrieve the automatic rendering of exception

Returns

Type	Description
boolean

getBarcode() : \Zend_Barcode_Object

Retrieve the barcode object

Returns

Type	Description
\Zend_Barcode_Object

getHorizontalPosition() : string

Horizontal position of the barcode in the rendering resource

Returns

Type	Description
string

getLeftOffset() : integer

Retrieve vertical adjustment

Returns

Type	Description
integer

getModuleSize() : float

Set the size of a module

Returns

Type	Description
float

getRendererNamespace() : string

Retrieve renderer namespace

Returns

Type	Description
string

getTopOffset() : integer

Retrieve vertical adjustment

Returns

Type	Description
integer

getType() : string

Retrieve renderer type

Returns

Type	Description
string

getVerticalPosition() : string

Vertical position of the barcode in the rendering resource

Returns

Type	Description
string

render() : mixed

abstract

Render the resource by sending headers and drawed resource

Returns

Type	Description
mixed

setAutomaticRenderError(boolean $value) : void

Activate/Deactivate the automatic rendering of exception

Parameters

Name	Type	Description
$value	boolean

setBarcode(\Zend_Barcode_Object $barcode) : \Zend_Barcode_Renderer

Set the barcode object

Parameters

Name	Type	Description
$barcode	\Zend_Barcode_Object

Returns

Type	Description
\Zend_Barcode_Renderer

setConfig(\Zend_Config $config) : \Zend_Renderer_Object

Set renderer state from config object

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_Renderer_Object

setHorizontalPosition(string $value) : \Zend_Barcode_Renderer

Horizontal position of the barcode in the rendering resource

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Barcode_Renderer

Details

Throw

setLeftOffset(integer $value) : \Zend_Barcode_Renderer

Manually adjust left position

Parameters

Name	Type	Description
$value	integer

Returns

Type	Description
\Zend_Barcode_Renderer

Details

Throw

setModuleSize(float $value) : \Zend_Barcode_Renderer

Set the size of a module

Parameters

Name	Type	Description
$value	float

Returns

Type	Description
\Zend_Barcode_Renderer

Details

Throw

setOptions(array $options) : \Zend_Renderer_Object

Set renderer state from options array

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Renderer_Object

setRendererNamespace(string $namespace) : \Zend_Renderer_Object

Set renderer namespace for autoloading

Parameters

Name	Type	Description
$namespace	string

Returns

Type	Description
\Zend_Renderer_Object

setTopOffset(integer $value) : \Zend_Barcode_Renderer

Manually adjust top position

Parameters

Name	Type	Description
$value	integer

Returns

Type	Description
\Zend_Barcode_Renderer

Details

Throw

setVerticalPosition(string $value) : \Zend_Barcode_Renderer

Vertical position of the barcode in the rendering resource

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Barcode_Renderer

Details

Throw

Barcode/Renderer/RendererAbstract.php

\Zend_Barcode_Renderer_RendererAbstractjump to top

Properties

Methods

\Zend_Barcode_Renderer_RendererAbstract
jump to top