Barcode/Renderer/RendererAbstract.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Barcode
subpackage: Renderer
version: $Id: RendererAbstract.php 20316 2010-01-15 22:27:00Z mikaelkael $
Classes: Zend_Barcode_Renderer_RendererAbstract

Description

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.

Zend_Barcode_Renderer_RendererAbstract
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Barcode
Properties: $_rendererNamespace; $_type; $_automaticRenderError; $_topOffset; $_leftOffset; $_horizontalPosition; $_verticalPosition; $_moduleSize; $_barcode; $_resource
Methods: __construct; setOptions; setConfig; setRendererNamespace; getRendererNamespace; getType; setTopOffset; getTopOffset; setLeftOffset; getLeftOffset; setAutomaticRenderError; setHorizontalPosition; getHorizontalPosition; setVerticalPosition; getVerticalPosition; setModuleSize; getModuleSize; getAutomaticRenderError; setBarcode; getBarcode; checkParams; _checkBarcodeObject; _adjustPosition; draw; _drawInstructionList; _checkParams; render; _initRenderer; _drawPolygon; _drawText

Description

Class for rendering the barcode

Properties

$_automaticRenderError
jump to class

boolean $_automaticRenderError = 'false'

Activate/Deactivate the automatic rendering of exception

Details

$_automaticRenderError: boolean
visibility: protected
default: false
final: false
static: false

$_barcode
jump to class

Zend_Barcode_Object $_barcode = ''

Barcode object

Details

$_barcode: Zend_Barcode_Object
visibility: protected
default
final: false
static: false

$_horizontalPosition
jump to class

integer $_horizontalPosition = 'left'

Horizontal position of the barcode in the rendering resource

Details

$_horizontalPosition: integer
visibility: protected
default: left
final: false
static: false

$_leftOffset
jump to class

integer $_leftOffset = '0'

Offset of the barcode from the left of the rendering resource

Details

$_leftOffset: integer
visibility: protected
default: 0
final: false
static: false

$_moduleSize
jump to class

float $_moduleSize = '1'

Module size rendering

Details

$_moduleSize: float
visibility: protected
default: 1
final: false
static: false

$_rendererNamespace
jump to class

string $_rendererNamespace = 'Zend_Barcode_Renderer'

Namespace of the renderer for autoloading

Details

$_rendererNamespace: string
visibility: protected
default: Zend_Barcode_Renderer
final: false
static: false

$_resource
jump to class

$_resource = ''

Drawing resource

Details

visibility: protected
default
final: false
static: false

$_topOffset
jump to class

integer $_topOffset = '0'

Offset of the barcode from the top of the rendering resource

Details

$_topOffset: integer
visibility: protected
default: 0
final: false
static: false

$_type
jump to class

string $_type = 'null'

Renderer type

Details

$_type: string
visibility: protected
default: null
final: false
static: false

$_verticalPosition
jump to class

integer $_verticalPosition = 'top'

Vertical position of the barcode in the rendering resource

Details

$_verticalPosition: integer
visibility: protected
default: top
final: false
static: false

Methods

__construct
jump to class

__construct(
          array|Zend_Config $options
              =
              null
          )
        
        :
        void

Constructor

Arguments

$options: arrayZend_Config

Details

visibility: public
final: false
static: false

_adjustPosition
jump to class

_adjustPosition(
          float $supportHeight, float $supportWidth
          )
        
        :
        void

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

Arguments

$supportHeight: float
$supportWidth: float

Details

visibility: protected
final: false
static: false

_checkBarcodeObject
jump to class

_checkBarcodeObject(
          
          )
        
        :
        void

Check if a barcode object is correctly provided

Details

visibility: protected
final: false
static: false
throw

_checkParams
jump to class

_checkParams(
          
          )
        
        :
        void

Checking of parameters after all settings

Details

visibility: protected
final: false
static: false

_drawInstructionList
jump to class

_drawInstructionList(
          
          )
        
        :

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

Details

visibility: private
final: false
static: false

_drawPolygon
jump to class

_drawPolygon(
          array $points, integer $color, boolean $filled
              =
              true
          )
        
        :

Draw a polygon in the rendering resource

Arguments

$points: array
$color: integer
$filled: boolean

Details

visibility: protected
final: false
static: false

_drawText
jump to class

_drawText(
          string $text, float $size, array $position, string $font, integer $color, string $alignment
              =
              center, float $orientation
              =
              0
          )
        
        :

Draw a polygon in the rendering resource

Arguments

$text: string
$size: float
$position: array
$font: string
$color: integer
$alignment: string
$orientation: float

Details

visibility: protected
final: false
static: false

_initRenderer
jump to class

_initRenderer(
          
          )
        
        :
        void

Initialize the rendering resource

Details

visibility: protected
final: false
static: false

checkParams
jump to class

checkParams(
          
          )
        
        :
        boolean

Checking of parameters after all settings

Output

boolean

Details

visibility: public
final: false
static: false

draw
jump to class

Draw the barcode in the rendering resource

Output

mixed

Details

visibility: public
final: false
static: false

getAutomaticRenderError
jump to class

getAutomaticRenderError(
          
          )
        
        :
        boolean

Retrieve the automatic rendering of exception

Output

boolean

Details

visibility: public
final: false
static: false

getBarcode
jump to class

getBarcode(
          
          )
        
        :
        Zend_Barcode_Object

Retrieve the barcode object

Output

Zend_Barcode_Object

Details

visibility: public
final: false
static: false

getHorizontalPosition
jump to class

getHorizontalPosition(
          
          )
        
        :
        string

Horizontal position of the barcode in the rendering resource

Output

string

Details

visibility: public
final: false
static: false

getLeftOffset
jump to class

getLeftOffset(
          
          )
        
        :
        integer

Retrieve vertical adjustment

Output

integer

Details

visibility: public
final: false
static: false

getModuleSize
jump to class

getModuleSize(
          
          )
        
        :
        float

Set the size of a module

Output

float

Details

visibility: public
final: false
static: false

getRendererNamespace
jump to class

getRendererNamespace(
          
          )
        
        :
        string

Retrieve renderer namespace

Output

string

Details

visibility: public
final: false
static: false

getTopOffset
jump to class

getTopOffset(
          
          )
        
        :
        integer

Retrieve vertical adjustment

Output

integer

Details

visibility: public
final: false
static: false

getType
jump to class

getType(
          
          )
        
        :
        string

Retrieve renderer type

Output

string

Details

visibility: public
final: false
static: false

getVerticalPosition
jump to class

getVerticalPosition(
          
          )
        
        :
        string

Vertical position of the barcode in the rendering resource

Output

string

Details

visibility: public
final: false
static: false

render
jump to class

render(
          
          )
        
        :
        mixed

Render the resource by sending headers and drawed resource

Output

mixed

Details

visibility: public
final: false
static: false

setAutomaticRenderError
jump to class

setAutomaticRenderError(
          boolean $value
          )
        
        :

Activate/Deactivate the automatic rendering of exception

Arguments

$value: boolean

Details

visibility: public
final: false
static: false

setBarcode
jump to class

setBarcode(
          Zend_Barcode_Object $barcode
          )
        
        :
        Zend_Barcode_Renderer

Set the barcode object

Arguments

$barcode: Zend_Barcode_Object

Output

Zend_Barcode_Renderer

Details

visibility: public
final: false
static: false

setConfig
jump to class

setConfig(
          Zend_Config $config
          )
        
        :
        Zend_Renderer_Object

Set renderer state from config object

Arguments

$config: Zend_Config

Output

Zend_Renderer_Object

Details

visibility: public
final: false
static: false

setHorizontalPosition
jump to class

setHorizontalPosition(
          string $value
          )
        
        :
        Zend_Barcode_Renderer

Horizontal position of the barcode in the rendering resource

Arguments

$value: string

Output

Zend_Barcode_Renderer

Details

visibility: public
final: false
static: false
throw

setLeftOffset
jump to class

setLeftOffset(
          integer $value
          )
        
        :
        Zend_Barcode_Renderer

Manually adjust left position

Arguments

$value: integer

Output

Zend_Barcode_Renderer

Details

visibility: public
final: false
static: false
throw

setModuleSize
jump to class

setModuleSize(
          float $value
          )
        
        :
        Zend_Barcode_Renderer

Set the size of a module

Arguments

$value: float

Output

Zend_Barcode_Renderer

Details

visibility: public
final: false
static: false
throw

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Renderer_Object

Set renderer state from options array

Arguments

$options: array

Output

Zend_Renderer_Object

Details

visibility: public
final: false
static: false

setRendererNamespace
jump to class

setRendererNamespace(
          string $namespace
          )
        
        :
        Zend_Renderer_Object

Set renderer namespace for autoloading

Arguments

$namespace: string

Output

Zend_Renderer_Object

Details

visibility: public
final: false
static: false

setTopOffset
jump to class

setTopOffset(
          integer $value
          )
        
        :
        Zend_Barcode_Renderer

Manually adjust top position

Arguments

$value: integer

Output

Zend_Barcode_Renderer

Details

visibility: public
final: false
static: false
throw

setVerticalPosition
jump to class

setVerticalPosition(
          string $value
          )
        
        :
        Zend_Barcode_Renderer

Vertical position of the barcode in the rendering resource

Arguments

$value: string

Output

Zend_Barcode_Renderer

Details

visibility: public
final: false
static: false
throw

API Documentation

Barcode/Renderer/RendererAbstract.php

Description

Zend_Barcode_Renderer_RendererAbstractjump to top

Description

Properties

$_automaticRenderErrorjump to class

Details

$_barcodejump to class

Details

$_horizontalPositionjump to class

Details

$_leftOffsetjump to class

Details

$_moduleSizejump to class

Details

$_rendererNamespacejump to class

Details

$_resourcejump to class

Details

$_topOffsetjump to class

Details

$_typejump to class

Details

$_verticalPositionjump to class

Details

Methods

__constructjump to class

Arguments

Details

_adjustPositionjump to class

Arguments

Details

_checkBarcodeObjectjump to class

Details

_checkParamsjump to class

Details

_drawInstructionListjump to class

Details

_drawPolygonjump to class

Arguments

Details

_drawTextjump to class

Arguments

Details

_initRendererjump to class

Details

checkParamsjump to class

Output

Details

drawjump to class

Output

Details

getAutomaticRenderErrorjump to class

Output

Details

getBarcodejump to class

Output

Details

getHorizontalPositionjump to class

Output

Details

getLeftOffsetjump to class

Output

Details

getModuleSizejump to class

Output

Details

getRendererNamespacejump to class

Output

Details

getTopOffsetjump to class

Output

Details

getTypejump to class

Output

Details

getVerticalPositionjump to class

Output

Details

Zend_Barcode_Renderer_RendererAbstract
jump to top

$_automaticRenderError
jump to class

$_barcode
jump to class

$_horizontalPosition
jump to class

$_leftOffset
jump to class

$_moduleSize
jump to class

$_rendererNamespace
jump to class

$_resource
jump to class

$_topOffset
jump to class

$_type
jump to class

$_verticalPosition
jump to class

__construct
jump to class

_adjustPosition
jump to class

_checkBarcodeObject
jump to class

_checkParams
jump to class

_drawInstructionList
jump to class

_drawPolygon
jump to class

_drawText
jump to class

_initRenderer
jump to class

checkParams
jump to class

draw
jump to class

getAutomaticRenderError
jump to class

getBarcode
jump to class

getHorizontalPosition
jump to class

getLeftOffset
jump to class

getModuleSize
jump to class

getRendererNamespace
jump to class

getTopOffset
jump to class

getType
jump to class

getVerticalPosition
jump to class

render
jump to class

setAutomaticRenderError
jump to class

setBarcode
jump to class

setConfig
jump to class

setHorizontalPosition
jump to class

setLeftOffset
jump to class

setModuleSize
jump to class

setOptions
jump to class

setRendererNamespace
jump to class

setTopOffset
jump to class

setVerticalPosition
jump to class