Barcode/Renderer/Svg.php

Show:

inherited

Classes
- \Zend_Barcode_Renderer_Svg

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 [email protected] 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: Image.php 20366 2010-01-18 03:56:52Z ralph $

\Zend_Barcode_Renderer_Svg
jump to top

Package: Zend\Barcode

Class for rendering the barcode as svg

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

inherited

Activate/Deactivate the automatic rendering of exception

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::$$_automaticRenderError

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Barcode_Renderer_RendererAbstract::$$_automaticRenderError

\Zend_Barcode_Object_ObjectAbstract $_barcode =

inherited

Barcode object

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::$$_barcode

Details

Type: \Zend_Barcode_Object_ObjectAbstract
Inherited_from: \Zend_Barcode_Renderer_RendererAbstract::$$_barcode

integer $_horizontalPosition = 'left'

inherited

Horizontal position of the barcode in the rendering resource

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::$$_horizontalPosition

Default value'left'Details

Type: integer
Inherited_from: \Zend_Barcode_Renderer_RendererAbstract::$$_horizontalPosition

integer $_leftOffset = 0

inherited

Offset of the barcode from the left of the rendering resource

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::$$_leftOffset

Default value0Details

Type: integer
Inherited_from: \Zend_Barcode_Renderer_RendererAbstract::$$_leftOffset

float $_moduleSize = 1

inherited

Module size rendering

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::$$_moduleSize

Default value1Details

Type: float
Inherited_from: \Zend_Barcode_Renderer_RendererAbstract::$$_moduleSize

string $_rendererNamespace = 'Zend_Barcode_Renderer'

inherited

Namespace of the renderer for autoloading

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::$$_rendererNamespace

Default value'Zend_Barcode_Renderer'Details

Type: string
Inherited_from: \Zend_Barcode_Renderer_RendererAbstract::$$_rendererNamespace

\DOMDocument $_resource = null

Resource for the image

Default valuenullDetails

Type: \DOMDocument

\DOMElement $_rootElement = null

Root element of the XML structure

Default valuenullDetails

Type: \DOMElement

integer $_topOffset = 0

inherited

Offset of the barcode from the top of the rendering resource

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::$$_topOffset

Default value0Details

Type: integer
Inherited_from: \Zend_Barcode_Renderer_RendererAbstract::$$_topOffset

string $_type = null

inherited

Renderer type

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::$$_type

Default valuenullDetails

Type: string
Inherited_from: \Zend_Barcode_Renderer_RendererAbstract::$$_type

integer $_userHeight = 0

Height of the rendered image wanted by user

Default value0Details

Type: integer

integer $_userWidth = 0

Width of the rendered image wanted by user

Default value0Details

Type: integer

integer $_verticalPosition = 'top'

inherited

Vertical position of the barcode in the rendering resource

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::$$_verticalPosition

Default value'top'Details

Type: integer
Inherited_from: \Zend_Barcode_Renderer_RendererAbstract::$$_verticalPosition

Methods

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

inherited

Constructor

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::__construct()

Parameters

Name	Type	Description
$options	array \| \Zend_Config

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

inherited

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

_appendRootElement(string $tagName, array $attributes = array(), string $textContent = null) : void

Append a new DOMElement to the root element

Parameters

Name	Type	Description
$tagName	string
$attributes	array
$textContent	string

_checkBarcodeObject() : void

inherited

Check if a barcode object is correctly provided

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::_checkBarcodeObject()

Throws

Exception	Description
\Zend_Barcode_Renderer_Exception

_checkDimensions() : void

Check barcode dimensions

_checkParams() : void

Check barcode parameters

_createElement(string $tagName, array $attributes = array(), string $textContent = null) : \DOMElement

Create DOMElement

Parameters

Name	Type	Description
$tagName	string
$attributes	array
$textContent	string

Returns

Type	Description
\DOMElement

_drawInstructionList() : void

inherited

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 svg 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) : void

Draw a polygon in the svg resource

Parameters

Name	Type	Description
$text	string
$size	float
$position	array
$font	string
$color	integer
$alignment	string
$orientation	float

_initRenderer() : void

Initialize the image resource

_readRootElement() : void

checkParams() : boolean

inherited

Checking of parameters after all settings

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::checkParams()

Returns

Type	Description
boolean

draw() : mixed

Draw the barcode in the rendering resource

Returns

Type	Description
mixed

getAutomaticRenderError() : boolean

inherited

Retrieve the automatic rendering of exception

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getAutomaticRenderError()

Returns

Type	Description
boolean

getBarcode() : \Zend_Barcode_Object

inherited

Retrieve the barcode object

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getBarcode()

Returns

Type	Description
\Zend_Barcode_Object

getHeight() : int

Get barcode height

Returns

Type	Description
int

getHorizontalPosition() : string

inherited

Horizontal position of the barcode in the rendering resource

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getHorizontalPosition()

Returns

Type	Description
string

getLeftOffset() : integer

inherited

Retrieve vertical adjustment

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getLeftOffset()

Returns

Type	Description
integer

getModuleSize() : float

inherited

Set the size of a module

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getModuleSize()

Returns

Type	Description
float

getRendererNamespace() : string

inherited

Retrieve renderer namespace

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getRendererNamespace()

Returns

Type	Description
string

getTopOffset() : integer

inherited

Retrieve vertical adjustment

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getTopOffset()

Returns

Type	Description
integer

getType() : string

inherited

Retrieve renderer type

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getType()

Returns

Type	Description
string

getVerticalPosition() : string

inherited

Vertical position of the barcode in the rendering resource

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::getVerticalPosition()

Returns

Type	Description
string

getWidth() : int

Get barcode width

Returns

Type	Description
int

render() : mixed

Draw and render the barcode with correct headers

Returns

Type	Description
mixed

setAutomaticRenderError(boolean $value) : void

inherited

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_Renderer

inherited

Set the barcode object

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setBarcode()

Parameters

Name	Type	Description
$barcode	\Zend_Barcode_Object

Returns

Type	Description
\Zend_Barcode_Renderer

setConfig(\Zend_Config $config) : \Zend_Renderer_Object

inherited

Set renderer state from config object

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setConfig()

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_Renderer_Object

setHeight(null | integer $value) : \Zend_Image_Barcode_Abstract

Set height of the result image

Parameters

Name	Type	Description
$value	null \| integer

Returns

Type	Description
\Zend_Image_Barcode_Abstract

Throws

Exception	Description
\Zend_Image_Barcode_Exception

setHorizontalPosition(string $value) : \Zend_Barcode_Renderer

inherited

Horizontal position of the barcode in the rendering resource

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setHorizontalPosition()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Barcode_Renderer

Throws

Exception	Description
\Zend_Barcode_Renderer_Exception

setLeftOffset(integer $value) : \Zend_Barcode_Renderer

inherited

Manually adjust left position

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setLeftOffset()

Parameters

Name	Type	Description
$value	integer

Returns

Type	Description
\Zend_Barcode_Renderer

Throws

Exception	Description
\Zend_Barcode_Renderer_Exception

setModuleSize(float $value) : \Zend_Barcode_Renderer

inherited

Set the size of a module

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setModuleSize()

Parameters

Name	Type	Description
$value	float

Returns

Type	Description
\Zend_Barcode_Renderer

Throws

Exception	Description
\Zend_Barcode_Renderer_Exception

setOptions(array $options) : \Zend_Renderer_Object

inherited

Set renderer state from options array

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Renderer_Object

setRendererNamespace(string $namespace) : \Zend_Renderer_Object

inherited

Set renderer namespace for autoloading

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setRendererNamespace()

Parameters

Name	Type	Description
$namespace	string

Returns

Type	Description
\Zend_Renderer_Object

setResource( $svg) : \Zend_Barcode_Renderer

Set an image resource to draw the barcode inside

Parameters

Name	Type	Description
$svg

Returns

Type	Description
\Zend_Barcode_Renderer

Throws

Exception	Description
\Zend_Barcode_Renderer_Exception

setTopOffset(integer $value) : \Zend_Barcode_Renderer

inherited

Manually adjust top position

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setTopOffset()

Parameters

Name	Type	Description
$value	integer

Returns

Type	Description
\Zend_Barcode_Renderer

Throws

Exception	Description
\Zend_Barcode_Renderer_Exception

setVerticalPosition(string $value) : \Zend_Barcode_Renderer

inherited

Vertical position of the barcode in the rendering resource

Inherited from: \Zend_Barcode_Renderer_RendererAbstract::setVerticalPosition()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Barcode_Renderer

Throws

Exception	Description
\Zend_Barcode_Renderer_Exception

setWidth(mixed $value) : void

Set barcode width

Parameters

Name	Type	Description
$value	mixed

Barcode/Renderer/Svg.php

\Zend_Barcode_Renderer_Svgjump to top

Properties

Methods

\Zend_Barcode_Renderer_Svg
jump to top