Barcode/Renderer/RendererAbstract.php
inherited
Classes
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 [email protected] 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
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 = falseActivate/Deactivate the automatic rendering of exception
falseDetails- Type
- boolean
\Zend_Barcode_Object_ObjectAbstract $_barcode = Barcode object
integer $_horizontalPosition = 'left'Horizontal position of the barcode in the rendering resource
'left'Details- Type
- integer
integer $_leftOffset = 0Offset of the barcode from the left of the rendering resource
0Details- Type
- integer
float $_moduleSize = 1Module size rendering
1Details- Type
- float
string $_rendererNamespace = 'Zend_Barcode_Renderer'Namespace of the renderer for autoloading
'Zend_Barcode_Renderer'Details- Type
- string
$_resource = Drawing resource
- Type
- n/a
integer $_topOffset = 0Offset of the barcode from the top of the rendering resource
0Details- Type
- integer
string $_type = nullRenderer type
nullDetails- Type
- string
integer $_verticalPosition = 'top'Vertical position of the barcode in the rendering resource
'top'Details- Type
- integer
Methods
__construct(array | \Zend_Config $options = null) : voidConstructor
| Name | Type | Description |
|---|---|---|
| $options | array | \Zend_Config |
_adjustPosition(float $supportHeight, float $supportWidth) : voidCalculate the left and top offset of the barcode in the rendering support
| Name | Type | Description |
|---|---|---|
| $supportHeight | float | |
| $supportWidth | float |
_checkBarcodeObject() : voidCheck if a barcode object is correctly provided
| Exception | Description |
|---|---|
| \Zend_Barcode_Renderer_Exception |
_checkParams() : voidChecking of parameters after all settings
_drawInstructionList() : voidSub process to draw the barcode instructions Needed by the automatic error rendering
_drawPolygon(array $points, integer $color, boolean $filled = true) : voidDraw a polygon in the rendering resource
| 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) : voidDraw a polygon in the rendering resource
| Name | Type | Description |
|---|---|---|
| $text | string | |
| $size | float | |
| $position | array | |
| $font | string | |
| $color | integer | |
| $alignment | string | |
| $orientation | float |
_initRenderer() : voidInitialize the rendering resource
checkParams() : booleanChecking of parameters after all settings
| Type | Description |
|---|---|
| boolean |
draw() : mixedDraw the barcode in the rendering resource
| Type | Description |
|---|---|
| mixed |
getAutomaticRenderError() : booleanRetrieve the automatic rendering of exception
| Type | Description |
|---|---|
| boolean |
getBarcode() : \Zend_Barcode_ObjectRetrieve the barcode object
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
getHorizontalPosition() : stringHorizontal position of the barcode in the rendering resource
| Type | Description |
|---|---|
| string |
getLeftOffset() : integerRetrieve vertical adjustment
| Type | Description |
|---|---|
| integer |
getModuleSize() : floatSet the size of a module
| Type | Description |
|---|---|
| float |
getRendererNamespace() : stringRetrieve renderer namespace
| Type | Description |
|---|---|
| string |
getTopOffset() : integerRetrieve vertical adjustment
| Type | Description |
|---|---|
| integer |
getType() : stringRetrieve renderer type
| Type | Description |
|---|---|
| string |
getVerticalPosition() : stringVertical position of the barcode in the rendering resource
| Type | Description |
|---|---|
| string |
render() : mixedRender the resource by sending headers and drawed resource
| Type | Description |
|---|---|
| mixed |
setAutomaticRenderError(boolean $value) : voidActivate/Deactivate the automatic rendering of exception
| Name | Type | Description |
|---|---|---|
| $value | boolean |
setBarcode(\Zend_Barcode_Object $barcode) : \Zend_Barcode_RendererSet the barcode object
| Name | Type | Description |
|---|---|---|
| $barcode | \Zend_Barcode_Object |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
setConfig(\Zend_Config $config) : \Zend_Renderer_ObjectSet renderer state from config object
| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config |
| Type | Description |
|---|---|
| \Zend_Renderer_Object |
setHorizontalPosition(string $value) : \Zend_Barcode_RendererHorizontal position of the barcode in the rendering resource
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
| Exception | Description |
|---|---|
| \Zend_Barcode_Renderer_Exception |
setLeftOffset(integer $value) : \Zend_Barcode_RendererManually adjust left position
| Name | Type | Description |
|---|---|---|
| $value | integer |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
| Exception | Description |
|---|---|
| \Zend_Barcode_Renderer_Exception |
setModuleSize(float $value) : \Zend_Barcode_RendererSet the size of a module
| Name | Type | Description |
|---|---|---|
| $value | float |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
| Exception | Description |
|---|---|
| \Zend_Barcode_Renderer_Exception |
setOptions(array $options) : \Zend_Renderer_ObjectSet renderer state from options array
| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Renderer_Object |
setRendererNamespace(string $namespace) : \Zend_Renderer_ObjectSet renderer namespace for autoloading
| Name | Type | Description |
|---|---|---|
| $namespace | string |
| Type | Description |
|---|---|
| \Zend_Renderer_Object |
setTopOffset(integer $value) : \Zend_Barcode_RendererManually adjust top position
| Name | Type | Description |
|---|---|---|
| $value | integer |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
| Exception | Description |
|---|---|
| \Zend_Barcode_Renderer_Exception |
setVerticalPosition(string $value) : \Zend_Barcode_RendererVertical position of the barcode in the rendering resource
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
| Exception | Description |
|---|---|
| \Zend_Barcode_Renderer_Exception |