Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Barcode_Renderer_RendererAbstract Class Reference

Public Member Functions

 __construct ($options=null)
 Constructor.
 
 setOptions ($options)
 Set renderer state from options array.
 
 setConfig (Zend_Config $config)
 Set renderer state from config object.
 
 setRendererNamespace ($namespace)
 Set renderer namespace for autoloading.
 
 getRendererNamespace ()
 Retrieve renderer namespace.
 
 getType ()
 Retrieve renderer type.
 
 setTopOffset ($value)
 Manually adjust top position.
 
 getTopOffset ()
 Retrieve vertical adjustment.
 
 setLeftOffset ($value)
 Manually adjust left position.
 
 getLeftOffset ()
 Retrieve vertical adjustment.
 
 setAutomaticRenderError ($value)
 Activate/Deactivate the automatic rendering of exception.
 
 setHorizontalPosition ($value)
 Horizontal position of the barcode in the rendering resource.
 
 getHorizontalPosition ()
 Horizontal position of the barcode in the rendering resource.
 
 setVerticalPosition ($value)
 Vertical position of the barcode in the rendering resource.
 
 getVerticalPosition ()
 Vertical position of the barcode in the rendering resource.
 
 setModuleSize ($value)
 Set the size of a module.
 
 getModuleSize ()
 Set the size of a module.
 
 getAutomaticRenderError ()
 Retrieve the automatic rendering of exception.
 
 setBarcode ($barcode)
 Set the barcode object.
 
 getBarcode ()
 Retrieve the barcode object.
 
 checkParams ()
 Checking of parameters after all settings.
 
 draw ()
 Draw the barcode in the rendering resource.
 
 render ()
 Render the resource by sending headers and drawed resource.
 

Protected Member Functions

 _checkBarcodeObject ()
 Check if a barcode object is correctly provided.
 
 _adjustPosition ($supportHeight, $supportWidth)
 Calculate the left and top offset of the barcode in the rendering support.
 
 _checkParams ()
 Checking of parameters after all settings.
 
 _initRenderer ()
 Initialize the rendering resource.
 
 _drawPolygon ($points, $color, $filled=true)
 Draw a polygon in the rendering resource.
 
 _drawText ($text, $size, $position, $font, $color, $alignment= 'center', $orientation=0)
 Draw a polygon in the rendering resource.
 

Protected Attributes

 $_rendererNamespace = 'Zend_Barcode_Renderer'
 
 $_type = null
 
 $_automaticRenderError = false
 
 $_topOffset = 0
 
 $_leftOffset = 0
 
 $_horizontalPosition = 'left'
 
 $_verticalPosition = 'top'
 
 $_moduleSize = 1
 
 $_barcode
 
 $_resource
 Drawing resource.
 

Constructor & Destructor Documentation

__construct (   $options = null)

Constructor.

Parameters
array | Zend_Config$options
Returns
void

Member Function Documentation

_adjustPosition (   $supportHeight,
  $supportWidth 
)
protected

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

Parameters
float$supportHeight
float$supportWidth
Returns
void
_checkBarcodeObject ( )
protected

Check if a barcode object is correctly provided.

Returns
void
Exceptions
Zend_Barcode_Renderer_Exception
See Also
Zend_Barcode_Renderer_Exception
_checkParams ( )
abstractprotected

Checking of parameters after all settings.

Returns
void
_drawPolygon (   $points,
  $color,
  $filled = true 
)
abstractprotected

Draw a polygon in the rendering resource.

Parameters
array$points
integer$color
boolean$filled
_drawText (   $text,
  $size,
  $position,
  $font,
  $color,
  $alignment = 'center',
  $orientation = 0 
)
abstractprotected

Draw a polygon in the rendering resource.

Parameters
string$text
float$size
array$position
string$font
integer$color
string$alignment
float$orientation
_initRenderer ( )
abstractprotected

Initialize the rendering resource.

Returns
void
checkParams ( )

Checking of parameters after all settings.

Returns
boolean
draw ( )

Draw the barcode in the rendering resource.

Returns
mixed
getAutomaticRenderError ( )

Retrieve the automatic rendering of exception.

Returns
boolean
getBarcode ( )

Retrieve the barcode object.

Returns
Zend_Barcode_Object
getHorizontalPosition ( )

Horizontal position of the barcode in the rendering resource.

Returns
string
getLeftOffset ( )

Retrieve vertical adjustment.

Returns
integer
getModuleSize ( )

Set the size of a module.

Returns
float
getRendererNamespace ( )

Retrieve renderer namespace.

Returns
string
getTopOffset ( )

Retrieve vertical adjustment.

Returns
integer
getType ( )

Retrieve renderer type.

Returns
string
getVerticalPosition ( )

Vertical position of the barcode in the rendering resource.

Returns
string
render ( )
abstract

Render the resource by sending headers and drawed resource.

Returns
mixed
setAutomaticRenderError (   $value)

Activate/Deactivate the automatic rendering of exception.

Parameters
boolean$value
setBarcode (   $barcode)

Set the barcode object.

Parameters
Zend_Barcode_Object$barcode
Returns
Zend_Barcode_Renderer
setConfig ( Zend_Config  $config)

Set renderer state from config object.

Parameters
Zend_Config$config
Returns
Zend_Renderer_Object
setHorizontalPosition (   $value)

Horizontal position of the barcode in the rendering resource.

Parameters
string$value
Returns
Zend_Barcode_Renderer
Exceptions
Zend_Barcode_Renderer_Exception
setLeftOffset (   $value)

Manually adjust left position.

Parameters
integer$value
Returns
Zend_Barcode_Renderer
Exceptions
Zend_Barcode_Renderer_Exception
setModuleSize (   $value)

Set the size of a module.

Parameters
float$value
Returns
Zend_Barcode_Renderer
Exceptions
Zend_Barcode_Renderer_Exception
setOptions (   $options)

Set renderer state from options array.

Parameters
array$options
Returns
Zend_Renderer_Object
setRendererNamespace (   $namespace)

Set renderer namespace for autoloading.

Parameters
string$namespace
Returns
Zend_Renderer_Object
setTopOffset (   $value)

Manually adjust top position.

Parameters
integer$value
Returns
Zend_Barcode_Renderer
Exceptions
Zend_Barcode_Renderer_Exception
setVerticalPosition (   $value)

Vertical position of the barcode in the rendering resource.

Parameters
string$value
Returns
Zend_Barcode_Renderer
Exceptions
Zend_Barcode_Renderer_Exception

Member Data Documentation

$_automaticRenderError = false
protected
$_barcode
protected
$_horizontalPosition = 'left'
protected
$_leftOffset = 0
protected
$_moduleSize = 1
protected
$_rendererNamespace = 'Zend_Barcode_Renderer'
protected
$_resource
protected

Drawing resource.

$_topOffset = 0
protected
$_type = null
protected
$_verticalPosition = 'top'
protected