Barcode/Object/Royalmail.php

Show:

inherited

Classes
- \Zend_Barcode_Object_Royalmail

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: Object
Version: $Id: Royalmail.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Barcode_Object_Royalmail
jump to top

Package: Zend\Barcode

Class for generate Royal maim barcode

Parent(s): \Zend_Barcode_Object_ObjectAbstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

\$_addLeadingZeros $_addLeadingZeros = true

inherited

Activate automatic addition of leading zeros if barcode length is fixed

booleanInherited from: \Zend_Barcode_Object_ObjectAbstract::$$_addLeadingZeros

Default valuetrueDetails

Type: \$_addLeadingZeros
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_addLeadingZeros

integer $_backgroundColor = 16777215

inherited

Background color of the object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_backgroundColor

Default value16777215Details

Type: integer
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_backgroundColor

integer $_barHeight = 50

inherited

Height of the bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_barHeight

Default value50Details

Type: integer
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_barHeight

integer $_barThickWidth = 3

inherited

Width of a thick bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_barThickWidth

Default value3Details

Type: integer
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_barThickWidth

integer $_barThinWidth = 1

inherited

Width of a thin bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_barThinWidth

Default value1Details

Type: integer
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_barThinWidth

\$_barcodeLength $_barcodeLength = null

inherited

Fix barcode length (numeric or string like 'even')

integer | stringInherited from: \Zend_Barcode_Object_ObjectAbstract::$$_barcodeLength

Default valuenullDetails

Type: \$_barcodeLength
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_barcodeLength

string $_barcodeNamespace = 'Zend_Barcode_Object'

inherited

Namespace of the barcode for autoloading

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_barcodeNamespace

Default value'Zend_Barcode_Object'Details

Type: string
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_barcodeNamespace

array $_codingMap = array('0' => '3300', '1' => '3210', '2' => '3201', '3' => '2310', '4' => '2301', '5' => '2211', '6' => '3120', '7' => '3030', '8' => '3021', '9' => '2130', 'A' => '2121', 'B' => '2031', 'C' => '3102', 'D' => '3012', 'E' => '3003', 'F' => '2112', 'G' => '2103', 'H' => '2013', 'I' => '1320', 'J' => '1230', 'K' => '1221', 'L' => '0330', 'M' => '0321', 'N' => '0231', 'O' => '1302', 'P' => '1212', 'Q' => '1203', 'R' => '0312', 'S' => '0303', 'T' => '0213', 'U' => '1122', 'V' => '1032', 'W' => '1023', 'X' => '0132', 'Y' => '0123', 'Z' => '0033')

Coding map - 0 = Tracker, Ascender and Descender - 1 = Tracker and Ascender - 2 = Tracker and Descender - 3 = Tracker

Default value

array('0' => '3300', '1' => '3210', '2' => '3201', '3' => '2310', '4' => '2301', '5' => '2211', '6' => '3120', '7' => '3030', '8' => '3021', '9' => '2130', 'A' => '2121', 'B' => '2031', 'C' => '3102', 'D' => '3012', 'E' => '3003', 'F' => '2112', 'G' => '2103', 'H' => '2013', 'I' => '1320', 'J' => '1230', 'K' => '1221', 'L' => '0330', 'M' => '0321', 'N' => '0231', 'O' => '1302', 'P' => '1212', 'Q' => '1203', 'R' => '0312', 'S' => '0303', 'T' => '0213', 'U' => '1122', 'V' => '1032', 'W' => '1023', 'X' => '0132', 'Y' => '0123', 'Z' => '0033')

Details

Type: array

$_columns = array('0' => 1, '1' => 2, '2' => 3, '3' => 4, '4' => 5, '5' => 0, '6' => 1, '7' => 2, '8' => 3, '9' => 4, 'A' => 5, 'B' => 0, 'C' => 1, 'D' => 2, 'E' => 3, 'F' => 4, 'G' => 5, 'H' => 0, 'I' => 1, 'J' => 2, 'K' => 3, 'L' => 4, 'M' => 5, 'N' => 0, 'O' => 1, 'P' => 2, 'Q' => 3, 'R' => 4, 'S' => 5, 'T' => 0, 'U' => 1, 'V' => 2, 'W' => 3, 'X' => 4, 'Y' => 5, 'Z' => 0)

Default value

array('0' => 1, '1' => 2, '2' => 3, '3' => 4, '4' => 5, '5' => 0, '6' => 1, '7' => 2, '8' => 3, '9' => 4, 'A' => 5, 'B' => 0, 'C' => 1, 'D' => 2, 'E' => 3, 'F' => 4, 'G' => 5, 'H' => 0, 'I' => 1, 'J' => 2, 'K' => 3, 'L' => 4, 'M' => 5, 'N' => 0, 'O' => 1, 'P' => 2, 'Q' => 3, 'R' => 4, 'S' => 5, 'T' => 0, 'U' => 1, 'V' => 2, 'W' => 3, 'X' => 4, 'Y' => 5, 'Z' => 0)

Details

Type: n/a

boolean $_drawText = true

inherited

Display (or not) human readable text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_drawText

Default valuetrueDetails

Type: boolean
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_drawText

integer $_factor = 1

inherited

Factor to multiply bar and font measure (barHeight, barThinWidth, barThickWidth & fontSize)

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_factor

Default value1Details

Type: integer
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_factor

integer|string $_font = null

inherited

Font resource - integer (1 to 5): corresponds to GD included fonts - string: corresponds to path of a TTF font

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_font

Default valuenullDetails

Type: integer | string
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_font

float $_fontSize = 10

inherited

Font size

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_fontSize

Default value10Details

Type: float
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_fontSize

integer $_foreColor = 0

inherited

Font and bars color of the object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_foreColor

Default value0Details

Type: integer
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_foreColor

integer $_height = null

inherited

Height of the object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_height

Default valuenullDetails

Type: integer
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_height

array $_instructions = array()

inherited

Set of drawing instructions

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_instructions

Default valuearray()Details

Type: array
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_instructions

\$_mandatoryChecksum $_mandatoryChecksum = false

inherited

Activation of mandatory checksum to deactivate unauthorized modification

booleanInherited from: \Zend_Barcode_Object_ObjectAbstract::$$_mandatoryChecksum

Default valuefalseDetails

Type: \$_mandatoryChecksum
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_mandatoryChecksum

boolean $_mandatoryQuietZones = false

inherited

Force quiet zones even if

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_mandatoryQuietZones

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_mandatoryQuietZones

integer $_offsetLeft = null

inherited

Offset from the left the object (calculated from the orientation)

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_offsetLeft

Default valuenullDetails

Type: integer
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_offsetLeft

integer $_offsetTop = null

inherited

Offset from the top the object (calculated from the orientation)

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_offsetTop

Default valuenullDetails

Type: integer
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_offsetTop

float $_orientation = 0

inherited

Orientation of the barcode in degrees

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_orientation

Default value0Details

Type: float
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_orientation

$_rows = array('0' => 1, '1' => 1, '2' => 1, '3' => 1, '4' => 1, '5' => 1, '6' => 2, '7' => 2, '8' => 2, '9' => 2, 'A' => 2, 'B' => 2, 'C' => 3, 'D' => 3, 'E' => 3, 'F' => 3, 'G' => 3, 'H' => 3, 'I' => 4, 'J' => 4, 'K' => 4, 'L' => 4, 'M' => 4, 'N' => 4, 'O' => 5, 'P' => 5, 'Q' => 5, 'R' => 5, 'S' => 5, 'T' => 5, 'U' => 0, 'V' => 0, 'W' => 0, 'X' => 0, 'Y' => 0, 'Z' => 0)

Default value

array('0' => 1, '1' => 1, '2' => 1, '3' => 1, '4' => 1, '5' => 1, '6' => 2, '7' => 2, '8' => 2, '9' => 2, 'A' => 2, 'B' => 2, 'C' => 3, 'D' => 3, 'E' => 3, 'F' => 3, 'G' => 3, 'H' => 3, 'I' => 4, 'J' => 4, 'K' => 4, 'L' => 4, 'M' => 4, 'N' => 4, 'O' => 5, 'P' => 5, 'Q' => 5, 'R' => 5, 'S' => 5, 'T' => 5, 'U' => 0, 'V' => 0, 'W' => 0, 'X' => 0, 'Y' => 0, 'Z' => 0)

Details

Type: n/a

string $_staticFont = null

staticinherited

TTF font name: can be set before instanciation of the object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_staticFont

Default valuenullDetails

Type: string
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_staticFont

boolean $_stretchText = false

inherited

Adjust (or not) position of human readable characters with barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_stretchText

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_stretchText

\$_substituteChecksumCharacter $_substituteChecksumCharacter = 0

inherited

Character used to substitute checksum character for validation

mixedInherited from: \Zend_Barcode_Object_ObjectAbstract::$$_substituteChecksumCharacter

Default value0Details

Type: \$_substituteChecksumCharacter
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_substituteChecksumCharacter

string $_text = null

inherited

Text to display

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_text

Default valuenullDetails

Type: string
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_text

string $_type = null

inherited

Barcode type

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_type

Default valuenullDetails

Type: string
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_type

integer $_width = null

inherited

Width of the object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_width

Default valuenullDetails

Type: integer
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_width

boolean $_withBorder = false

inherited

Activate/deactivate border of the object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_withBorder

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_withBorder

boolean $_withChecksum = false

inherited

Drawing of checksum

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_withChecksum

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_withChecksum

boolean $_withChecksumInText = false

inherited

Drawing of checksum inside text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_withChecksumInText

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_withChecksumInText

boolean $_withQuietZones = true

inherited

Activate/deactivate drawing of quiet zones

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_withQuietZones

Default valuetrueDetails

Type: boolean
Inherited_from: \Zend_Barcode_Object_ObjectAbstract::$$_withQuietZones

Methods

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

inherited

Constructor

Inherited from: \Zend_Barcode_Object_ObjectAbstract::__construct()

Parameters

Name	Type	Description
$options	array \| \Zend_Config

_addInstruction(array $instruction) : void

inherited

Add an instruction in the array of instructions

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_addInstruction()

Parameters

Name	Type	Description
$instruction	array

_addLeadingZeros(string $text, boolean $withoutChecksum = false) : void

inherited

Automatically add leading zeros if barcode length is fixed

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_addLeadingZeros()

Parameters

Name	Type	Description
$text	string
$withoutChecksum	boolean

_addPolygon(array $points, integer $color = null, boolean $filled = true) : void

inherited

Add a polygon drawing instruction in the set of instructions

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_addPolygon()

Parameters

Name	Type	Description
$points	array
$color	integer
$filled	boolean

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

inherited

Add a text drawing instruction in the set of instructions

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_addText()

Parameters

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

_calculateBarcodeHeight() : integer

inherited

Height of the barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_calculateBarcodeHeight()

Returns

Type	Description
integer

_calculateBarcodeWidth() : integer

Width of the barcode (in pixels)

Returns

Type	Description
integer

_calculateHeight() : integer

inherited

Height of the result object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_calculateHeight()

Returns

Type	Description
integer

_calculateWidth() : integer

inherited

Width of the result image (before any rotation)

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_calculateWidth()

Returns

Type	Description
integer

_checkFontAndOrientation() : void

inherited

Drawing with an angle is just allow TTF font

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_checkFontAndOrientation()

Throws

Exception	Description
\Zend_Barcode_Object_Exception

_checkParams() : void

Partial check of interleaved Postnet barcode

_checkRatio(integer $min = 2, integer $max = 3) : void

inherited

Check the ratio between the thick and the thin bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_checkRatio()

Parameters

Name	Type	Description
$min	integer
$max	integer

Throws

Exception	Description
\Zend_Barcode_Object_Exception

_checkText( $value = null) : void

inherited

Check if a text is really provided to barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_checkText()

Parameters

Name	Type	Description
$value

Throws

Exception	Description
\Zend_Barcode_Object_Exception

_drawBarcode() : void

inherited

Draw the barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_drawBarcode()

_drawBorder() : void

inherited

Partial function to draw border

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_drawBorder()

_drawText() : void

inherited

Partial function to draw text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_drawText()

_getDefaultOptions() : void

Default options for Postnet barcode

_postDrawBarcode() : void

inherited

Allow each child to draw something else (ex: bearer bars in interleaved 2 of 5 code)

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_postDrawBarcode()

_preDrawBarcode() : void

inherited

Allow each child to draw something else

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_preDrawBarcode()

_prepareBarcode() : array

Prepare array to draw barcode

.. )

Returns

Type	Description
array

_rotate(float $x1, float $y1) : array

inherited

Apply rotation on a point in X/Y dimensions

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_rotate()

Parameters

Name	Type	Description
$x1	float	x-position before rotation
$y1	float	y-position before rotation

Returns

Type	Description
array	Array of two elements corresponding to the new XY point

_validateText(string $value, array $options = array()) : void

inherited

Standard validation for most of barcode objects

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_validateText()

Parameters

Name	Type	Description
$value	string
$options	array

checkParams() : void

inherited

Checking of parameters after all settings

Inherited from: \Zend_Barcode_Object_ObjectAbstract::checkParams()

draw() : array

inherited

Complete drawing of the barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::draw()

Returns

Type	Description
array	Table of instructions

getBackgroundColor() : integer

inherited

Retrieve background color of the image

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBackgroundColor()

Returns

Type	Description
integer

getBarHeight() : integer

inherited

Get height of the barcode bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBarHeight()

Returns

Type	Description
integer

getBarThickWidth() : integer

inherited

Get thickness of thick bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBarThickWidth()

Returns

Type	Description
integer

getBarThinWidth() : integer

inherited

Get thickness of thin bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBarThinWidth()

Returns

Type	Description
integer

getBarcodeNamespace() : string

inherited

Retrieve barcode namespace

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBarcodeNamespace()

Returns

Type	Description
string

getChecksum(string $text) : int

Get barcode checksum

Parameters

Name	Type	Description
$text	string

Returns

Type	Description
int

getDrawText() : boolean

inherited

Retrieve if drawing of text to encode is enabled

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getDrawText()

Returns

Type	Description
boolean

getFactor() : integer

inherited

Get factor applying to thinBarWidth - thickBarWidth - barHeight - fontSize

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getFactor()

Returns

Type	Description
integer

getFont() : integer | string

inherited

Retrieve the font

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getFont()

Returns

Type	Description
integer \| string

getFontSize() : float

inherited

Retrieve the size of the font in case of TTF

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getFontSize()

Returns

Type	Description
float

getForeColor() : \unknown

inherited

Retrieve color of the barcode and text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getForeColor()

Returns

Type	Description
\unknown

getHeight( $recalculate = false) : integer

inherited

Get height of the result object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getHeight()

Parameters

Name	Type	Description
$recalculate

Returns

Type	Description
integer

getInstructions() : array

inherited

Retrieve the set of drawing instructions

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getInstructions()

Returns

Type	Description
array

getOffsetLeft(boolean $recalculate = false) : float

inherited

Calculate the offset from the left of the object if an orientation is activated

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getOffsetLeft()

Parameters

Name	Type	Description
$recalculate	boolean

Returns

Type	Description
float

getOffsetTop(boolean $recalculate = false) : float

inherited

Calculate the offset from the top of the object if an orientation is activated

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getOffsetTop()

Parameters

Name	Type	Description
$recalculate	boolean

Returns

Type	Description
float

getOrientation() : float

inherited

Retrieve orientation of barcode and text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getOrientation()

Returns

Type	Description
float

getQuietZone() : integer

inherited

Quiet zone before first bar and after the last bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getQuietZone()

Returns

Type	Description
integer

getRawText() : string

inherited

Retrieve text to encode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getRawText()

Returns

Type	Description
string

getStretchText() : boolean

inherited

Retrieve if the adjustment of the position of the characters to the position of the bars is enabled

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getStretchText()

Returns

Type	Description
boolean

getText() : string

inherited

Retrieve text to encode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getText()

Returns

Type	Description
string

getTextToDisplay() : string

inherited

Retrieve text to display

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getTextToDisplay()

Returns

Type	Description
string

getType() : string

inherited

Retrieve type of barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getType()

Returns

Type	Description
string

getWidth( $recalculate = false) : integer

inherited

Get width of the result object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWidth()

Parameters

Name	Type	Description
$recalculate

Returns

Type	Description
integer

getWithBorder() : boolean

inherited

Retrieve if border are draw or not

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWithBorder()

Returns

Type	Description
boolean

getWithChecksum() : boolean

inherited

Retrieve if the checksum character is automatically added to the barcode text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWithChecksum()

Returns

Type	Description
boolean

getWithChecksumInText() : boolean

inherited

Retrieve if the checksum character is automatically added to the barcode text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWithChecksumInText()

Returns

Type	Description
boolean

getWithQuietZones() : boolean

inherited

Retrieve if quiet zones are draw or not

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWithQuietZones()

Returns

Type	Description
boolean

setBackgroundColor(integer $value) : \Zend_Barcode_Object

inherited

Set the color of the background

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBackgroundColor()

Parameters

Name	Type	Description
$value	integer

Returns

Type	Description
\Zend_Barcode_Object

Throws

Exception	Description
\Zend_Barcode_Object_Exception

setBarHeight(integer $value) : \Zend_Barcode_Object

inherited

Set height of the barcode bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarHeight()

Parameters

Name	Type	Description
$value	integer

Returns

Type	Description
\Zend_Barcode_Object

Throws

Exception	Description
\Zend_Barcode_Object_Exception

setBarThickWidth(integer $value) : \Zend_Barcode_Object

inherited

Set thickness of thick bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarThickWidth()

Parameters

Name	Type	Description
$value	integer

Returns

Type	Description
\Zend_Barcode_Object

Throws

Exception	Description
\Zend_Barcode_Object_Exception

setBarThinWidth(integer $value) : \Zend_Barcode_Object

inherited

Set thickness of thin bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarThinWidth()

Parameters

Name	Type	Description
$value	integer

Returns

Type	Description
\Zend_Barcode_Object

Throws

Exception	Description
\Zend_Barcode_Object_Exception

setBarcodeFont(string $font) : void

staticinherited

Set the font for all instances of barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarcodeFont()

Parameters

Name	Type	Description
$font	string

setBarcodeNamespace(string $namespace) : \Zend_Barcode_Object

inherited

Set barcode namespace for autoloading

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarcodeNamespace()

Parameters

Name	Type	Description
$namespace	string

Returns

Type	Description
\Zend_Barcode_Object

setConfig(\Zend_Config $config) : \Zend_Barcode_Object

inherited

Set barcode state from config object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setConfig()

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_Barcode_Object

setDrawText(boolean $value) : \Zend_Barcode_Object

inherited

Activate/deactivate drawing of text to encode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setDrawText()

Parameters

Name	Type	Description
$value	boolean

Returns

Type	Description
\Zend_Barcode_Object

setFactor(float $value) : \Zend_Barcode_Object

inherited

Set factor applying to thinBarWidth - thickBarWidth - barHeight - fontSize

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setFactor()

Parameters

Name	Type	Description
$value	float

Returns

Type	Description
\Zend_Barcode_Object

Throws

Exception	Description
\Zend_Barcode_Object_Exception

setFont(integer | string $value) : \Zend_Barcode_Object

inherited

Set the font: - if integer between 1 and 5, use gd built-in fonts - if string, $value is assumed to be the path to a TTF font

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setFont()

Parameters

Name	Type	Description
$value	integer \| string

Returns

Type	Description
\Zend_Barcode_Object

Throws

Exception	Description
\Zend_Barcode_Object_Exception

setFontSize(float $value) : \Zend_Barcode_Object

inherited

Set the size of the font in case of TTF

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setFontSize()

Parameters

Name	Type	Description
$value	float

Returns

Type	Description
\Zend_Barcode_Object

Throws

Exception	Description
\Zend_Barcode_Object_Exception

setForeColor(string $value) : \Zend_Barcode_Object

inherited

Set color of the barcode and text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setForeColor()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Barcode_Object

Throws

Exception	Description
\Zend_Barcode_Object_Exception

setOptions(array $options) : \Zend_Barcode_Object

inherited

Set barcode state from options array

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Barcode_Object

setOrientation(float $value) : \Zend_Barcode_Object

inherited

Set orientation of barcode and text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setOrientation()

Parameters

Name	Type	Description
$value	float

Returns

Type	Description
\Zend_Barcode_Object

Throws

Exception	Description
\Zend_Barcode_Object_Exception

setReverseColor() : \Zend_Barcode_Object

inherited

Allow fast inversion of font/bars color and background color

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setReverseColor()

Returns

Type	Description
\Zend_Barcode_Object

setStretchText(boolean $value) : \Zend_Barcode_Object

inherited

Activate/deactivate the adjustment of the position of the characters to the position of the bars

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setStretchText()

Parameters

Name	Type	Description
$value	boolean

Returns

Type	Description
\Zend_Barcode_Object

Throws

Exception	Description
\Zend_Barcode_Object_Exception

setText(string $value) : \Zend_Barcode_Object

inherited

Set text to encode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setText()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Barcode_Object

setWithBorder(boolean $value) : \Zend_Barcode_Object

inherited

Activate/deactivate drawing of the bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setWithBorder()

Parameters

Name	Type	Description
$value	boolean

Returns

Type	Description
\Zend_Barcode_Object

setWithChecksum(boolean $value) : \Zend_Barcode_Object

inherited

Activate/deactivate the automatic generation of the checksum character added to the barcode text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setWithChecksum()

Parameters

Name	Type	Description
$value	boolean

Returns

Type	Description
\Zend_Barcode_Object

setWithChecksumInText(boolean $value) : \Zend_Barcode_Object

inherited

Activate/deactivate the automatic generation of the checksum character added to the barcode text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setWithChecksumInText()

Parameters

Name	Type	Description
$value	boolean

Returns

Type	Description
\Zend_Barcode_Object

Throws

Exception	Description
\Zend_Barcode_Object_Exception

setWithQuietZones(boolean $value) : \Zend_Barcode_Object

inherited

Activate/deactivate drawing of the quiet zones

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setWithQuietZones()

Parameters

Name	Type	Description
$value	boolean

Returns

Type	Description
\Zend_Barcode_Object

validateText(string $value) : void

inherited

Check for invalid characters

Inherited from: \Zend_Barcode_Object_ObjectAbstract::validateText()

Parameters

Name	Type	Description
$value	string	Text to be ckecked

Barcode/Object/Royalmail.php

\Zend_Barcode_Object_Royalmailjump to top

Properties

Methods

\Zend_Barcode_Object_Royalmail
jump to top