API Documentation

Zend/Barcode/Renderer/RendererAbstract.php

Show: inherited
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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Barcode_Renderer_RendererAbstract

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

Propertyprotectedboolean  $_automaticRenderError= 'false'

Activate/Deactivate the automatic rendering of exception

Default valuefalseDetails
Type
boolean
Propertyprotected\Zend_Barcode_Object_ObjectAbstract  $_barcode= ''

Barcode object

Propertyprotectedinteger  $_horizontalPosition= ''left''

Horizontal position of the barcode in the rendering resource

Default value'left'Details
Type
integer
Propertyprotectedinteger  $_leftOffset= '0'

Offset of the barcode from the left of the rendering resource

Default value0Details
Type
integer
Propertyprotectedfloat  $_moduleSize= '1'

Module size rendering

Default value1Details
Type
float
Propertyprotectedstring  $_rendererNamespace= ''Zend_Barcode_Renderer''

Namespace of the renderer for autoloading

Default value'Zend_Barcode_Renderer'Details
Type
string
Propertyprotected  $_resource= ''

Drawing resource

Details
Type
Propertyprotectedinteger  $_topOffset= '0'

Offset of the barcode from the top of the rendering resource

Default value0Details
Type
integer
Propertyprotectedstring  $_type= 'null'

Renderer type

Default valuenullDetails
Type
string
Propertyprotectedinteger  $_verticalPosition= ''top''

Vertical position of the barcode in the rendering resource

Default value'top'Details
Type
integer

Methods

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

Constructor

Parameters
Name Type Description
$options array|\Zend_Config
methodprotected_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
methodprotected_checkBarcodeObject( ) : void

Check if a barcode object is correctly provided

Throws
Exception Description
\Zend_Barcode_Renderer_Exception
methodprotected_checkParams( ) : void
abstract

Checking of parameters after all settings

methodprivate_drawInstructionList( ) : void

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

methodprotected_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
methodprotected_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
methodprotected_initRenderer( ) : void
abstract

Initialize the rendering resource

methodpubliccheckParams( ) : boolean

Checking of parameters after all settings

Returns
Type Description
boolean
methodpublicdraw( ) : mixed

Draw the barcode in the rendering resource

Returns
Type Description
mixed
methodpublicgetAutomaticRenderError( ) : boolean

Retrieve the automatic rendering of exception

Returns
Type Description
boolean
methodpublicgetBarcode( ) : \Zend_Barcode_Object

Retrieve the barcode object

Returns
Type Description
\Zend_Barcode_Object
methodpublicgetHorizontalPosition( ) : string

Horizontal position of the barcode in the rendering resource

Returns
Type Description
string
methodpublicgetLeftOffset( ) : integer

Retrieve vertical adjustment

Returns
Type Description
integer
methodpublicgetModuleSize( ) : float

Set the size of a module

Returns
Type Description
float
methodpublicgetRendererNamespace( ) : string

Retrieve renderer namespace

Returns
Type Description
string
methodpublicgetTopOffset( ) : integer

Retrieve vertical adjustment

Returns
Type Description
integer
methodpublicgetType( ) : string

Retrieve renderer type

Returns
Type Description
string
methodpublicgetVerticalPosition( ) : string

Vertical position of the barcode in the rendering resource

Returns
Type Description
string
methodpublicrender( ) : mixed
abstract

Render the resource by sending headers and drawed resource

Returns
Type Description
mixed
methodpublicsetAutomaticRenderError( boolean $value ) : void

Activate/Deactivate the automatic rendering of exception

Parameters
Name Type Description
$value boolean
methodpublicsetBarcode( \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
methodpublicsetConfig( \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
methodpublicsetHorizontalPosition( 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
Throws
Exception Description
\Zend_Barcode_Renderer_Exception
methodpublicsetLeftOffset( integer $value ) : \Zend_Barcode_Renderer

Manually adjust left position

Parameters
Name Type Description
$value integer
Returns
Type Description
\Zend_Barcode_Renderer
Throws
Exception Description
\Zend_Barcode_Renderer_Exception
methodpublicsetModuleSize( float $value ) : \Zend_Barcode_Renderer

Set the size of a module

Parameters
Name Type Description
$value float
Returns
Type Description
\Zend_Barcode_Renderer
Throws
Exception Description
\Zend_Barcode_Renderer_Exception
methodpublicsetOptions( array $options ) : \Zend_Renderer_Object

Set renderer state from options array

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Renderer_Object
methodpublicsetRendererNamespace( string $namespace ) : \Zend_Renderer_Object

Set renderer namespace for autoloading

Parameters
Name Type Description
$namespace string
Returns
Type Description
\Zend_Renderer_Object
methodpublicsetTopOffset( integer $value ) : \Zend_Barcode_Renderer

Manually adjust top position

Parameters
Name Type Description
$value integer
Returns
Type Description
\Zend_Barcode_Renderer
Throws
Exception Description
\Zend_Barcode_Renderer_Exception
methodpublicsetVerticalPosition( 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
Throws
Exception Description
\Zend_Barcode_Renderer_Exception
Documentation was generated by DocBlox 0.15.1.