Barcode/Object/Code25interleaved.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 [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: Code25interleaved.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Barcode_Object_Code25interleaved
jump to top

Package: Zend\Barcode

Class for generate Interleaved 2 of 5 barcode

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

Properties

Propertyprotected\$_addLeadingZeros $_addLeadingZeros = true
inherited

Activate automatic addition of leading zeros if barcode length is fixed

<p>boolean</p>Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_addLeadingZeros\Zend_Barcode_Object_Code25::$$_addLeadingZeros
Default valuetrueDetails
Type
\$_addLeadingZeros
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_addLeadingZeros  
Inherited_from
\Zend_Barcode_Object_Code25::$$_addLeadingZeros  
Propertyprotectedinteger $_backgroundColor = 16777215
inherited

Background color of the object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_backgroundColor\Zend_Barcode_Object_Code25::$$_backgroundColor
Default value16777215Details
Type
integer
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_backgroundColor  
Inherited_from
\Zend_Barcode_Object_Code25::$$_backgroundColor  
Propertyprotectedinteger $_barHeight = 50
inherited

Height of the bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_barHeight\Zend_Barcode_Object_Code25::$$_barHeight
Default value50Details
Type
integer
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_barHeight  
Inherited_from
\Zend_Barcode_Object_Code25::$$_barHeight  
Propertyprotectedinteger $_barThickWidth = 3
inherited

Width of a thick bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_barThickWidth\Zend_Barcode_Object_Code25::$$_barThickWidth
Default value3Details
Type
integer
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_barThickWidth  
Inherited_from
\Zend_Barcode_Object_Code25::$$_barThickWidth  
Propertyprotectedinteger $_barThinWidth = 1
inherited

Width of a thin bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_barThinWidth\Zend_Barcode_Object_Code25::$$_barThinWidth
Default value1Details
Type
integer
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_barThinWidth  
Inherited_from
\Zend_Barcode_Object_Code25::$$_barThinWidth  
Propertyprotected\$_barcodeLength $_barcodeLength = null
inherited

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

<p>integer | string</p>Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_barcodeLength\Zend_Barcode_Object_Code25::$$_barcodeLength
Default valuenullDetails
Type
\$_barcodeLength
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_barcodeLength  
Inherited_from
\Zend_Barcode_Object_Code25::$$_barcodeLength  
Propertyprotectedstring $_barcodeNamespace = 'Zend_Barcode_Object'
inherited

Namespace of the barcode for autoloading

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_barcodeNamespace\Zend_Barcode_Object_Code25::$$_barcodeNamespace
Default value'Zend_Barcode_Object'Details
Type
string
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_barcodeNamespace  
Inherited_from
\Zend_Barcode_Object_Code25::$$_barcodeNamespace  
Propertyprotectedarray $_codingMap = array('0' => '00110', '1' => '10001', '2' => '01001', '3' => '11000', '4' => '00101', '5' => '10100', '6' => '01100', '7' => '00011', '8' => '10010', '9' => '01010')
inherited

Coding map - 0 = narrow bar - 1 = wide bar

Inherited from: \Zend_Barcode_Object_Code25::$$_codingMap
Default valuearray('0' => '00110', '1' => '10001', '2' => '01001', '3' => '11000', '4' => '00101', '5' => '10100', '6' => '01100', '7' => '00011', '8' => '10010', '9' => '01010')Details
Type
array
Inherited_from
\Zend_Barcode_Object_Code25::$$_codingMap  
Propertyprotectedboolean $_drawText = true
inherited

Display (or not) human readable text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_drawText\Zend_Barcode_Object_Code25::$$_drawText
Default valuetrueDetails
Type
boolean
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_drawText  
Inherited_from
\Zend_Barcode_Object_Code25::$$_drawText  
Propertyprotectedinteger $_factor = 1
inherited

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

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_factor\Zend_Barcode_Object_Code25::$$_factor
Default value1Details
Type
integer
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_factor  
Inherited_from
\Zend_Barcode_Object_Code25::$$_factor  
Propertyprotectedinteger|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\Zend_Barcode_Object_Code25::$$_font
Default valuenullDetails
Type
integer | string
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_font  
Inherited_from
\Zend_Barcode_Object_Code25::$$_font  
Propertyprotectedfloat $_fontSize = 10
inherited

Font size

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_fontSize\Zend_Barcode_Object_Code25::$$_fontSize
Default value10Details
Type
float
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_fontSize  
Inherited_from
\Zend_Barcode_Object_Code25::$$_fontSize  
Propertyprotectedinteger $_foreColor = 0
inherited

Font and bars color of the object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_foreColor\Zend_Barcode_Object_Code25::$$_foreColor
Default value0Details
Type
integer
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_foreColor  
Inherited_from
\Zend_Barcode_Object_Code25::$$_foreColor  
Propertyprotectedinteger $_height = null
inherited

Height of the object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_height\Zend_Barcode_Object_Code25::$$_height
Default valuenullDetails
Type
integer
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_height  
Inherited_from
\Zend_Barcode_Object_Code25::$$_height  
Propertyprotectedarray $_instructions = array()
inherited

Set of drawing instructions

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_instructions\Zend_Barcode_Object_Code25::$$_instructions
Default valuearray()Details
Type
array
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_instructions  
Inherited_from
\Zend_Barcode_Object_Code25::$$_instructions  
Propertyprotected\$_mandatoryChecksum $_mandatoryChecksum = false
inherited

Activation of mandatory checksum to deactivate unauthorized modification

<p>boolean</p>Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_mandatoryChecksum\Zend_Barcode_Object_Code25::$$_mandatoryChecksum
Default valuefalseDetails
Type
\$_mandatoryChecksum
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_mandatoryChecksum  
Inherited_from
\Zend_Barcode_Object_Code25::$$_mandatoryChecksum  
Propertyprotectedboolean $_mandatoryQuietZones = false
inherited

Force quiet zones even if

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_mandatoryQuietZones\Zend_Barcode_Object_Code25::$$_mandatoryQuietZones
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_mandatoryQuietZones  
Inherited_from
\Zend_Barcode_Object_Code25::$$_mandatoryQuietZones  
Propertyprotectedinteger $_offsetLeft = null
inherited

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

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_offsetLeft\Zend_Barcode_Object_Code25::$$_offsetLeft
Default valuenullDetails
Type
integer
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_offsetLeft  
Inherited_from
\Zend_Barcode_Object_Code25::$$_offsetLeft  
Propertyprotectedinteger $_offsetTop = null
inherited

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

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_offsetTop\Zend_Barcode_Object_Code25::$$_offsetTop
Default valuenullDetails
Type
integer
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_offsetTop  
Inherited_from
\Zend_Barcode_Object_Code25::$$_offsetTop  
Propertyprotectedfloat $_orientation = 0
inherited

Orientation of the barcode in degrees

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_orientation\Zend_Barcode_Object_Code25::$$_orientation
Default value0Details
Type
float
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_orientation  
Inherited_from
\Zend_Barcode_Object_Code25::$$_orientation  
Propertyprotectedstring $_staticFont = null
staticinherited

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

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_staticFont\Zend_Barcode_Object_Code25::$$_staticFont
Default valuenullDetails
Type
string
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_staticFont  
Inherited_from
\Zend_Barcode_Object_Code25::$$_staticFont  
Propertyprotectedboolean $_stretchText = false
inherited

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

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_stretchText\Zend_Barcode_Object_Code25::$$_stretchText
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_stretchText  
Inherited_from
\Zend_Barcode_Object_Code25::$$_stretchText  
Propertyprotected\$_substituteChecksumCharacter $_substituteChecksumCharacter = 0
inherited

Character used to substitute checksum character for validation

<p>mixed</p>Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_substituteChecksumCharacter\Zend_Barcode_Object_Code25::$$_substituteChecksumCharacter
Default value0Details
Type
\$_substituteChecksumCharacter
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_substituteChecksumCharacter  
Inherited_from
\Zend_Barcode_Object_Code25::$$_substituteChecksumCharacter  
Propertyprotectedstring $_text = null
inherited

Text to display

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_text\Zend_Barcode_Object_Code25::$$_text
Default valuenullDetails
Type
string
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_text  
Inherited_from
\Zend_Barcode_Object_Code25::$$_text  
Propertyprotectedstring $_type = null
inherited

Barcode type

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_type\Zend_Barcode_Object_Code25::$$_type
Default valuenullDetails
Type
string
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_type  
Inherited_from
\Zend_Barcode_Object_Code25::$$_type  
Propertyprotectedinteger $_width = null
inherited

Width of the object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_width\Zend_Barcode_Object_Code25::$$_width
Default valuenullDetails
Type
integer
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_width  
Inherited_from
\Zend_Barcode_Object_Code25::$$_width  
Propertyprivateboolean $_withBearerBars = false

Drawing of bearer bars

Default valuefalseDetails
Type
boolean
Propertyprotectedboolean $_withBorder = false
inherited

Activate/deactivate border of the object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_withBorder\Zend_Barcode_Object_Code25::$$_withBorder
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_withBorder  
Inherited_from
\Zend_Barcode_Object_Code25::$$_withBorder  
Propertyprotectedboolean $_withChecksum = false
inherited

Drawing of checksum

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_withChecksum\Zend_Barcode_Object_Code25::$$_withChecksum
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_withChecksum  
Inherited_from
\Zend_Barcode_Object_Code25::$$_withChecksum  
Propertyprotectedboolean $_withChecksumInText = false
inherited

Drawing of checksum inside text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_withChecksumInText\Zend_Barcode_Object_Code25::$$_withChecksumInText
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_withChecksumInText  
Inherited_from
\Zend_Barcode_Object_Code25::$$_withChecksumInText  
Propertyprotectedboolean $_withQuietZones = true
inherited

Activate/deactivate drawing of quiet zones

Inherited from: \Zend_Barcode_Object_ObjectAbstract::$$_withQuietZones\Zend_Barcode_Object_Code25::$$_withQuietZones
Default valuetrueDetails
Type
boolean
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_withQuietZones  
Inherited_from
\Zend_Barcode_Object_Code25::$$_withQuietZones  

Methods

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

Constructor

Inherited from: \Zend_Barcode_Object_ObjectAbstract::__construct()\Zend_Barcode_Object_Code25::__construct()
Parameters
Name Type Description
$options array | \Zend_Config
methodprotected_addInstruction(array $instruction) : void
inherited

Add an instruction in the array of instructions

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_addInstruction()\Zend_Barcode_Object_Code25::_addInstruction()
Parameters
Name Type Description
$instruction array
methodprotected_addLeadingZeros(string $text, boolean $withoutChecksum = false) : void
inherited

Automatically add leading zeros if barcode length is fixed

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_addLeadingZeros()\Zend_Barcode_Object_Code25::_addLeadingZeros()
Parameters
Name Type Description
$text string
$withoutChecksum boolean
methodprotected_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()\Zend_Barcode_Object_Code25::_addPolygon()
Parameters
Name Type Description
$points array
$color integer
$filled boolean
methodprotected_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()\Zend_Barcode_Object_Code25::_addText()
Parameters
Name Type Description
$text string
$size float
$position array
$font string
$color integer
$alignment string
$orientation float
methodprotected_calculateBarcodeHeight() : integer
inherited

Height of the barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_calculateBarcodeHeight()\Zend_Barcode_Object_Code25::_calculateBarcodeHeight()
Returns
Type Description
integer
methodprotected_calculateBarcodeWidth() : integer

Width of the barcode (in pixels)

Returns
Type Description
integer
methodprotected_calculateHeight() : integer
inherited

Height of the result object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_calculateHeight()\Zend_Barcode_Object_Code25::_calculateHeight()
Returns
Type Description
integer
methodprotected_calculateWidth() : integer
inherited

Width of the result image (before any rotation)

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_calculateWidth()\Zend_Barcode_Object_Code25::_calculateWidth()
Returns
Type Description
integer
methodprotected_checkFontAndOrientation() : void
inherited

Drawing with an angle is just allow TTF font

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_checkFontAndOrientation()\Zend_Barcode_Object_Code25::_checkFontAndOrientation()
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodprotected_checkParams() : void
inherited

Partial check of interleaved 2 of 5 barcode

Inherited from: \Zend_Barcode_Object_Code25::_checkParams()
methodprotected_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()\Zend_Barcode_Object_Code25::_checkRatio()
Parameters
Name Type Description
$min integer
$max integer
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodprotected_checkText( $value = null) : void
inherited

Check if a text is really provided to barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_checkText()\Zend_Barcode_Object_Code25::_checkText()
Parameters
Name Type Description
$value
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodprotected_drawBarcode() : void
inherited

Draw the barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_drawBarcode()\Zend_Barcode_Object_Code25::_drawBarcode()
methodprotected_drawBorder() : void
inherited

Partial function to draw border

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_drawBorder()\Zend_Barcode_Object_Code25::_drawBorder()
methodprotected_drawText() : void
inherited

Partial function to draw text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_drawText()\Zend_Barcode_Object_Code25::_drawText()
methodprotected_getDefaultOptions() : void

Default options for Code25interleaved barcode

methodprotected_postDrawBarcode() : void

Drawing of bearer bars (if enabled)

methodprotected_preDrawBarcode() : void
inherited

Allow each child to draw something else

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_preDrawBarcode()\Zend_Barcode_Object_Code25::_preDrawBarcode()
methodprotected_prepareBarcode() : array

Prepare array to draw barcode

.. )

Returns
Type Description
array
methodprotected_rotate(float $x1, float $y1) : array
inherited

Apply rotation on a point in X/Y dimensions

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_rotate()\Zend_Barcode_Object_Code25::_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
methodprotected_validateText(string $value, array $options = array()) : void
inherited

Standard validation for most of barcode objects

Inherited from: \Zend_Barcode_Object_ObjectAbstract::_validateText()\Zend_Barcode_Object_Code25::_validateText()
Parameters
Name Type Description
$value string
$options array
methodpubliccheckParams() : void
inherited

Checking of parameters after all settings

Inherited from: \Zend_Barcode_Object_ObjectAbstract::checkParams()\Zend_Barcode_Object_Code25::checkParams()
methodpublicdraw() : array
inherited

Complete drawing of the barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::draw()\Zend_Barcode_Object_Code25::draw()
Returns
Type Description
array Table of instructions
methodpublicgetBackgroundColor() : integer
inherited

Retrieve background color of the image

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBackgroundColor()\Zend_Barcode_Object_Code25::getBackgroundColor()
Returns
Type Description
integer
methodpublicgetBarHeight() : integer
inherited

Get height of the barcode bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBarHeight()\Zend_Barcode_Object_Code25::getBarHeight()
Returns
Type Description
integer
methodpublicgetBarThickWidth() : integer
inherited

Get thickness of thick bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBarThickWidth()\Zend_Barcode_Object_Code25::getBarThickWidth()
Returns
Type Description
integer
methodpublicgetBarThinWidth() : integer
inherited

Get thickness of thin bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBarThinWidth()\Zend_Barcode_Object_Code25::getBarThinWidth()
Returns
Type Description
integer
methodpublicgetBarcodeNamespace() : string
inherited

Retrieve barcode namespace

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBarcodeNamespace()\Zend_Barcode_Object_Code25::getBarcodeNamespace()
Returns
Type Description
string
methodpublicgetChecksum(string $text) : int
inherited

Get barcode checksum

Inherited from: \Zend_Barcode_Object_Code25::getChecksum()
Parameters
Name Type Description
$text string
Returns
Type Description
int
methodpublicgetDrawText() : boolean
inherited

Retrieve if drawing of text to encode is enabled

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getDrawText()\Zend_Barcode_Object_Code25::getDrawText()
Returns
Type Description
boolean
methodpublicgetFactor() : integer
inherited

Get factor applying to thinBarWidth - thickBarWidth - barHeight - fontSize

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getFactor()\Zend_Barcode_Object_Code25::getFactor()
Returns
Type Description
integer
methodpublicgetFont() : integer | string
inherited

Retrieve the font

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getFont()\Zend_Barcode_Object_Code25::getFont()
Returns
Type Description
integer | string
methodpublicgetFontSize() : float
inherited

Retrieve the size of the font in case of TTF

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getFontSize()\Zend_Barcode_Object_Code25::getFontSize()
Returns
Type Description
float
methodpublicgetForeColor() : \unknown
inherited

Retrieve color of the barcode and text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getForeColor()\Zend_Barcode_Object_Code25::getForeColor()
Returns
Type Description
\unknown
methodpublicgetHeight( $recalculate = false) : integer
inherited

Get height of the result object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getHeight()\Zend_Barcode_Object_Code25::getHeight()
Parameters
Name Type Description
$recalculate
Returns
Type Description
integer
methodpublicgetInstructions() : array
inherited

Retrieve the set of drawing instructions

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getInstructions()\Zend_Barcode_Object_Code25::getInstructions()
Returns
Type Description
array
methodpublicgetOffsetLeft(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()\Zend_Barcode_Object_Code25::getOffsetLeft()
Parameters
Name Type Description
$recalculate boolean
Returns
Type Description
float
methodpublicgetOffsetTop(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()\Zend_Barcode_Object_Code25::getOffsetTop()
Parameters
Name Type Description
$recalculate boolean
Returns
Type Description
float
methodpublicgetOrientation() : float
inherited

Retrieve orientation of barcode and text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getOrientation()\Zend_Barcode_Object_Code25::getOrientation()
Returns
Type Description
float
methodpublicgetQuietZone() : integer
inherited

Quiet zone before first bar and after the last bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getQuietZone()\Zend_Barcode_Object_Code25::getQuietZone()
Returns
Type Description
integer
methodpublicgetRawText() : string
inherited

Retrieve text to encode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getRawText()\Zend_Barcode_Object_Code25::getRawText()
Returns
Type Description
string
methodpublicgetStretchText() : 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()\Zend_Barcode_Object_Code25::getStretchText()
Returns
Type Description
boolean
methodpublicgetText() : string
inherited

Retrieve text to encode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getText()\Zend_Barcode_Object_Code25::getText()
Returns
Type Description
string
methodpublicgetTextToDisplay() : string
inherited

Retrieve text to display

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getTextToDisplay()\Zend_Barcode_Object_Code25::getTextToDisplay()
Returns
Type Description
string
methodpublicgetType() : string
inherited

Retrieve type of barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getType()\Zend_Barcode_Object_Code25::getType()
Returns
Type Description
string
methodpublicgetWidth( $recalculate = false) : integer
inherited

Get width of the result object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWidth()\Zend_Barcode_Object_Code25::getWidth()
Parameters
Name Type Description
$recalculate
Returns
Type Description
integer
methodpublicgetWithBearerBars() : boolean

Retrieve if bearer bars are enabled

Returns
Type Description
boolean
methodpublicgetWithBorder() : boolean
inherited

Retrieve if border are draw or not

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWithBorder()\Zend_Barcode_Object_Code25::getWithBorder()
Returns
Type Description
boolean
methodpublicgetWithChecksum() : boolean
inherited

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

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWithChecksum()\Zend_Barcode_Object_Code25::getWithChecksum()
Returns
Type Description
boolean
methodpublicgetWithChecksumInText() : boolean
inherited

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

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWithChecksumInText()\Zend_Barcode_Object_Code25::getWithChecksumInText()
Returns
Type Description
boolean
methodpublicgetWithQuietZones() : boolean
inherited

Retrieve if quiet zones are draw or not

Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWithQuietZones()\Zend_Barcode_Object_Code25::getWithQuietZones()
Returns
Type Description
boolean
methodpublicsetBackgroundColor(integer $value) : \Zend_Barcode_Object
inherited

Set the color of the background

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBackgroundColor()\Zend_Barcode_Object_Code25::setBackgroundColor()
Parameters
Name Type Description
$value integer
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetBarHeight(integer $value) : \Zend_Barcode_Object
inherited

Set height of the barcode bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarHeight()\Zend_Barcode_Object_Code25::setBarHeight()
Parameters
Name Type Description
$value integer
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetBarThickWidth(integer $value) : \Zend_Barcode_Object
inherited

Set thickness of thick bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarThickWidth()\Zend_Barcode_Object_Code25::setBarThickWidth()
Parameters
Name Type Description
$value integer
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetBarThinWidth(integer $value) : \Zend_Barcode_Object
inherited

Set thickness of thin bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarThinWidth()\Zend_Barcode_Object_Code25::setBarThinWidth()
Parameters
Name Type Description
$value integer
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetBarcodeFont(string $font) : void
staticinherited

Set the font for all instances of barcode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarcodeFont()\Zend_Barcode_Object_Code25::setBarcodeFont()
Parameters
Name Type Description
$font string
methodpublicsetBarcodeNamespace(string $namespace) : \Zend_Barcode_Object
inherited

Set barcode namespace for autoloading

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarcodeNamespace()\Zend_Barcode_Object_Code25::setBarcodeNamespace()
Parameters
Name Type Description
$namespace string
Returns
Type Description
\Zend_Barcode_Object
methodpublicsetConfig(\Zend_Config $config) : \Zend_Barcode_Object
inherited

Set barcode state from config object

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setConfig()\Zend_Barcode_Object_Code25::setConfig()
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Barcode_Object
methodpublicsetDrawText(boolean $value) : \Zend_Barcode_Object
inherited

Activate/deactivate drawing of text to encode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setDrawText()\Zend_Barcode_Object_Code25::setDrawText()
Parameters
Name Type Description
$value boolean
Returns
Type Description
\Zend_Barcode_Object
methodpublicsetFactor(float $value) : \Zend_Barcode_Object
inherited

Set factor applying to thinBarWidth - thickBarWidth - barHeight - fontSize

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setFactor()\Zend_Barcode_Object_Code25::setFactor()
Parameters
Name Type Description
$value float
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetFont(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()\Zend_Barcode_Object_Code25::setFont()
Parameters
Name Type Description
$value integer | string
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetFontSize(float $value) : \Zend_Barcode_Object
inherited

Set the size of the font in case of TTF

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setFontSize()\Zend_Barcode_Object_Code25::setFontSize()
Parameters
Name Type Description
$value float
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetForeColor(string $value) : \Zend_Barcode_Object
inherited

Set color of the barcode and text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setForeColor()\Zend_Barcode_Object_Code25::setForeColor()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetOptions(array $options) : \Zend_Barcode_Object
inherited

Set barcode state from options array

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setOptions()\Zend_Barcode_Object_Code25::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Barcode_Object
methodpublicsetOrientation(float $value) : \Zend_Barcode_Object
inherited

Set orientation of barcode and text

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setOrientation()\Zend_Barcode_Object_Code25::setOrientation()
Parameters
Name Type Description
$value float
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetReverseColor() : \Zend_Barcode_Object
inherited

Allow fast inversion of font/bars color and background color

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setReverseColor()\Zend_Barcode_Object_Code25::setReverseColor()
Returns
Type Description
\Zend_Barcode_Object
methodpublicsetStretchText(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()\Zend_Barcode_Object_Code25::setStretchText()
Parameters
Name Type Description
$value boolean
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetText(string $value) : \Zend_Barcode_Object
inherited

Set text to encode

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setText()\Zend_Barcode_Object_Code25::setText()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Barcode_Object
methodpublicsetWithBearerBars(boolean $value) : \Zend_Barcode_Object_Int25

Activate/deactivate drawing of bearer bars

Parameters
Name Type Description
$value boolean
Returns
Type Description
\Zend_Barcode_Object_Int25
methodpublicsetWithBorder(boolean $value) : \Zend_Barcode_Object
inherited

Activate/deactivate drawing of the bar

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setWithBorder()\Zend_Barcode_Object_Code25::setWithBorder()
Parameters
Name Type Description
$value boolean
Returns
Type Description
\Zend_Barcode_Object
methodpublicsetWithChecksum(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()\Zend_Barcode_Object_Code25::setWithChecksum()
Parameters
Name Type Description
$value boolean
Returns
Type Description
\Zend_Barcode_Object
methodpublicsetWithChecksumInText(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()\Zend_Barcode_Object_Code25::setWithChecksumInText()
Parameters
Name Type Description
$value boolean
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetWithQuietZones(boolean $value) : \Zend_Barcode_Object
inherited

Activate/deactivate drawing of the quiet zones

Inherited from: \Zend_Barcode_Object_ObjectAbstract::setWithQuietZones()\Zend_Barcode_Object_Code25::setWithQuietZones()
Parameters
Name Type Description
$value boolean
Returns
Type Description
\Zend_Barcode_Object
methodpublicvalidateText(string $value) : void
inherited

Check for invalid characters

Inherited from: \Zend_Barcode_Object_ObjectAbstract::validateText()\Zend_Barcode_Object_Code25::validateText()
Parameters
Name Type Description
$value string

Text to be ckecked
Documentation was generated by phpDocumentor 2.0.0a8.