Barcode/Renderer/Pdf.php
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: Pdf.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Barcode_Renderer_Pdf
- Parent(s)
- \Zend_Barcode_Renderer_RendererAbstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties


boolean $_automaticRenderError = false
false
Details- Type
- boolean
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_automaticRenderError


integer $_horizontalPosition = 'left'
'left'
Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_horizontalPosition


integer $_leftOffset = 0
0
Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_leftOffset


string $_rendererNamespace = 'Zend_Barcode_Renderer'
'Zend_Barcode_Renderer'
Details- Type
- string
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_rendererNamespace


integer $_topOffset = 0
0
Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_topOffset


string $_type = null
null
Details- Type
- string
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_type


integer $_verticalPosition = 'top'
'top'
Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_verticalPosition
Methods


__construct(array | \Zend_Config $options = null) : void
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
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::_adjustPosition()Name | Type | Description |
---|---|---|
$supportHeight | float | |
$supportWidth | float |


_checkBarcodeObject() : void
Check if a barcode object is correctly provided
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::_checkBarcodeObject()- Throw


_drawInstructionList() : void
Sub process to draw the barcode instructions Needed by the automatic error rendering
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::_drawInstructionList()

_drawPolygon(array $points, integer $color, boolean $filled = true) : void
Draw 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) : void
Draw a text in the rendering resource
Name | Type | Description |
---|---|---|
$text | string | |
$size | float | |
$position | array | |
$font | string | |
$color | integer | |
$alignment | string | |
$orientation | float |


checkParams() : boolean
Checking of parameters after all settings
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::checkParams()Type | Description |
---|---|
boolean |


draw() : mixed
Draw the barcode in the rendering resource
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::draw()Type | Description |
---|---|
mixed |


getAutomaticRenderError() : boolean
Retrieve the automatic rendering of exception
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getAutomaticRenderError()Type | Description |
---|---|
boolean |


getBarcode() : \Zend_Barcode_Object
Retrieve the barcode object
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getBarcode()Type | Description |
---|---|
\Zend_Barcode_Object |


getHorizontalPosition() : string
Horizontal position of the barcode in the rendering resource
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getHorizontalPosition()Type | Description |
---|---|
string |


getLeftOffset() : integer
Retrieve vertical adjustment
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getLeftOffset()Type | Description |
---|---|
integer |


getModuleSize() : float
Set the size of a module
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getModuleSize()Type | Description |
---|---|
float |


getRendererNamespace() : string
Retrieve renderer namespace
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getRendererNamespace()Type | Description |
---|---|
string |


getTopOffset() : integer
Retrieve vertical adjustment
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getTopOffset()Type | Description |
---|---|
integer |


getVerticalPosition() : string
Vertical position of the barcode in the rendering resource
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getVerticalPosition()Type | Description |
---|---|
string |


setAutomaticRenderError(boolean $value) : void
Activate/Deactivate the automatic rendering of exception
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setAutomaticRenderError()Name | Type | Description |
---|---|---|
$value | boolean |


setBarcode(\Zend_Barcode_Object $barcode) : \Zend_Barcode_Renderer
Set the barcode object
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setBarcode()Name | Type | Description |
---|---|---|
$barcode | \Zend_Barcode_Object |
Type | Description |
---|---|
\Zend_Barcode_Renderer |


setConfig(\Zend_Config $config) : \Zend_Renderer_Object
Set renderer state from config object
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setConfig()Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Renderer_Object |


setHorizontalPosition(string $value) : \Zend_Barcode_Renderer
Horizontal position of the barcode in the rendering resource
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setHorizontalPosition()Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Barcode_Renderer |
- Throw


setLeftOffset(integer $value) : \Zend_Barcode_Renderer
Manually adjust left position
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setLeftOffset()Name | Type | Description |
---|---|---|
$value | integer |
Type | Description |
---|---|
\Zend_Barcode_Renderer |
- Throw


setModuleSize(float $value) : \Zend_Barcode_Renderer
Set the size of a module
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setModuleSize()Name | Type | Description |
---|---|---|
$value | float |
Type | Description |
---|---|
\Zend_Barcode_Renderer |
- Throw


setOptions(array $options) : \Zend_Renderer_Object
Set renderer state from options array
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setOptions()Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Renderer_Object |


setRendererNamespace(string $namespace) : \Zend_Renderer_Object
Set renderer namespace for autoloading
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setRendererNamespace()Name | Type | Description |
---|---|---|
$namespace | string |
Type | Description |
---|---|
\Zend_Renderer_Object |


setResource( $pdf, $page = 0) : \Zend_Barcode_Renderer
Set an image resource to draw the barcode inside
Name | Type | Description |
---|---|---|
$page |
Type | Description |
---|---|
\Zend_Barcode_Renderer |
- Throw


setTopOffset(integer $value) : \Zend_Barcode_Renderer
Manually adjust top position
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setTopOffset()Name | Type | Description |
---|---|---|
$value | integer |
Type | Description |
---|---|
\Zend_Barcode_Renderer |
- Throw


setVerticalPosition(string $value) : \Zend_Barcode_Renderer
Vertical position of the barcode in the rendering resource
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setVerticalPosition()Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Barcode_Renderer |
- Throw


widthForStringUsingFontSize(string $text, \Zend_Pdf_Font $font, float $fontSize) : float
Calculate the width of a string: in case of using alignment parameter in drawText
Name | Type | Description |
---|---|---|
$text | string | |
$font | \Zend_Pdf_Font | |
$fontSize | float |
Type | Description |
---|---|
float |