Barcode/Renderer/Pdf.php
Show:
inherited
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 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
Package: Zend\Barcode
Class for rendering the barcode in PDF resource
- 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 = falseinherited
Activate/Deactivate the automatic rendering of exception
Inherited from:
\Zend_Barcode_Renderer_RendererAbstract::$$_automaticRenderErrorDefault value
falseDetails- Type
- boolean
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_automaticRenderError
\Zend_Barcode_Object_ObjectAbstract $_barcodeDetails
integer $_horizontalPosition = 'left'inherited
Horizontal position of the barcode in the rendering resource
Inherited from:
\Zend_Barcode_Renderer_RendererAbstract::$$_horizontalPositionDefault value
'left'Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_horizontalPosition
integer $_leftOffset = 0inherited
Offset of the barcode from the left of the rendering resource
Inherited from:
\Zend_Barcode_Renderer_RendererAbstract::$$_leftOffsetDefault value
0Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_leftOffset
float $_moduleSize = 0.5Module size rendering
Default value
0.5Details- Type
- float
integer $_page = 0Page number in PDF resource
Default value
0Details- Type
- integer
string $_rendererNamespace = 'Zend_Barcode_Renderer'inherited
Namespace of the renderer for autoloading
Inherited from:
\Zend_Barcode_Renderer_RendererAbstract::$$_rendererNamespaceDefault value
'Zend_Barcode_Renderer'Details- Type
- string
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_rendererNamespace
integer $_topOffset = 0inherited
Offset of the barcode from the top of the rendering resource
Inherited from:
\Zend_Barcode_Renderer_RendererAbstract::$$_topOffsetDefault value
0Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_topOffset
string $_type = nullDefault value
nullDetails- Type
- string
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_type
integer $_verticalPosition = 'top'inherited
Vertical position of the barcode in the rendering resource
Inherited from:
\Zend_Barcode_Renderer_RendererAbstract::$$_verticalPositionDefault value
'top'Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Renderer_RendererAbstract::$$_verticalPosition
Methods
__construct(array | \Zend_Config $options = null) : voidParameters
| Name | Type | Description |
|---|---|---|
| $options | array | \Zend_Config |
_adjustPosition(float $supportHeight, float $supportWidth) : voidinherited
Calculate the left and top offset of the barcode in the rendering support
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::_adjustPosition()Parameters
| Name | Type | Description |
|---|---|---|
| $supportHeight | float | |
| $supportWidth | float |
_checkBarcodeObject() : voidinherited
Check if a barcode object is correctly provided
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::_checkBarcodeObject()Details
- Throw
_checkParams() : voidCheck renderer parameters
_drawInstructionList() : voidinherited
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) : voidDraw 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) : voidDraw a text in the rendering resource
Parameters
| Name | Type | Description |
|---|---|---|
| $text | string | |
| $size | float | |
| $position | array | |
| $font | string | |
| $color | integer | |
| $alignment | string | |
| $orientation | float |
_initRenderer() : voidInitialize the PDF resource
checkParams() : booleaninherited
Checking of parameters after all settings
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::checkParams()Returns
| Type | Description |
|---|---|
| boolean |
draw() : mixedinherited
Draw the barcode in the rendering resource
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::draw()Returns
| Type | Description |
|---|---|
| mixed |
getAutomaticRenderError() : booleaninherited
Retrieve the automatic rendering of exception
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getAutomaticRenderError()Returns
| Type | Description |
|---|---|
| boolean |
getBarcode() : \Zend_Barcode_Objectinherited
Retrieve the barcode object
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getBarcode()Returns
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
getHorizontalPosition() : stringinherited
Horizontal position of the barcode in the rendering resource
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getHorizontalPosition()Returns
| Type | Description |
|---|---|
| string |
getLeftOffset() : integerinherited
Retrieve vertical adjustment
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getLeftOffset()Returns
| Type | Description |
|---|---|
| integer |
getModuleSize() : floatinherited
Set the size of a module
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getModuleSize()Returns
| Type | Description |
|---|---|
| float |
getRendererNamespace() : stringinherited
Retrieve renderer namespace
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getRendererNamespace()Returns
| Type | Description |
|---|---|
| string |
getTopOffset() : integerinherited
Retrieve vertical adjustment
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getTopOffset()Returns
| Type | Description |
|---|---|
| integer |
getType() : stringReturns
| Type | Description |
|---|---|
| string |
getVerticalPosition() : stringinherited
Vertical position of the barcode in the rendering resource
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getVerticalPosition()Returns
| Type | Description |
|---|---|
| string |
render() : mixedDraw the barcode in the PDF, send headers and the PDF
Returns
| Type | Description |
|---|---|
| mixed |
setAutomaticRenderError(boolean $value) : voidinherited
Activate/Deactivate the automatic rendering of exception
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setAutomaticRenderError()Parameters
| Name | Type | Description |
|---|---|---|
| $value | boolean |
setBarcode(\Zend_Barcode_Object $barcode) : \Zend_Barcode_Rendererinherited
Set the barcode object
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setBarcode()Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $barcode | \Zend_Barcode_Object |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
setConfig(\Zend_Config $config) : \Zend_Renderer_Objectinherited
Set renderer state from config object
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setConfig()Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config |
| Type | Description |
|---|---|
| \Zend_Renderer_Object |
setHorizontalPosition(string $value) : \Zend_Barcode_Rendererinherited
Horizontal position of the barcode in the rendering resource
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setHorizontalPosition()Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
- Throw
setLeftOffset(integer $value) : \Zend_Barcode_Rendererinherited
Manually adjust left position
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setLeftOffset()Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $value | integer |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
- Throw
setModuleSize(float $value) : \Zend_Barcode_Rendererinherited
Set the size of a module
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setModuleSize()Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $value | float |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
- Throw
setOptions(array $options) : \Zend_Renderer_Objectinherited
Set renderer state from options array
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setOptions()Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Renderer_Object |
setRendererNamespace(string $namespace) : \Zend_Renderer_Objectinherited
Set renderer namespace for autoloading
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setRendererNamespace()Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $namespace | string |
| Type | Description |
|---|---|
| \Zend_Renderer_Object |
setResource( $pdf, $page = 0) : \Zend_Barcode_RendererSet an image resource to draw the barcode inside
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $page |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
- Throw
setTopOffset(integer $value) : \Zend_Barcode_Rendererinherited
Manually adjust top position
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setTopOffset()Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $value | integer |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
- Throw
setVerticalPosition(string $value) : \Zend_Barcode_Rendererinherited
Vertical position of the barcode in the rendering resource
Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setVerticalPosition()Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Barcode_Renderer |
- Throw
widthForStringUsingFontSize(string $text, \Zend_Pdf_Font $font, float $fontSize) : floatCalculate the width of a string: in case of using alignment parameter in drawText
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $text | string | |
| $font | \Zend_Pdf_Font | |
| $fontSize | float |
| Type | Description |
|---|---|
| float |