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

\Zend_Barcode_Object_Itf14

Package: Zend\Barcode

Class for generate Itf14 barcode

Parent(s)
\Zend_Barcode_Object_Code25interleaved < \Zend_Barcode_Object_Code25 < \Zend_Barcode_Object_ObjectAbstract
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\Zend_Barcode_Object_Code25interleaved::$$_addLeadingZeros
Default valuetrueDetails
Type
\$_addLeadingZeros
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_addLeadingZeros  
Inherited_from
\Zend_Barcode_Object_Code25::$$_addLeadingZeros  
Inherited_from
\Zend_Barcode_Object_Code25interleaved::$$_addLeadingZeros  
Propertyprotected\$_barcodeLength $_barcodeLength = null
Default valuenullDetails
Type
\$_barcodeLength
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_barcodeLength  
Inherited_from
\Zend_Barcode_Object_Code25::$$_barcodeLength  
Inherited_from
\Zend_Barcode_Object_Code25interleaved::$$_barcodeLength  
Propertyprotectedstring $_barcodeNamespace = 'Zend_Barcode_Object'
Default value'Zend_Barcode_Object'Details
Type
string
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_barcodeNamespace  
Inherited_from
\Zend_Barcode_Object_Code25::$$_barcodeNamespace  
Inherited_from
\Zend_Barcode_Object_Code25interleaved::$$_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\Zend_Barcode_Object_Code25interleaved::$$_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  
Inherited_from
\Zend_Barcode_Object_Code25interleaved::$$_codingMap  
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\Zend_Barcode_Object_Code25interleaved::$$_factor
Default value1Details
Type
integer
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_factor  
Inherited_from
\Zend_Barcode_Object_Code25::$$_factor  
Inherited_from
\Zend_Barcode_Object_Code25interleaved::$$_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\Zend_Barcode_Object_Code25interleaved::$$_font
Default valuenullDetails
Type
integer | string
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_font  
Inherited_from
\Zend_Barcode_Object_Code25::$$_font  
Inherited_from
\Zend_Barcode_Object_Code25interleaved::$$_font  
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\Zend_Barcode_Object_Code25interleaved::$$_mandatoryChecksum
Propertyprotectedinteger $_offsetLeft = null
Propertyprotectedinteger $_offsetTop = null
Default valuenullDetails
Type
integer
Inherited_from
\Zend_Barcode_Object_ObjectAbstract::$$_offsetTop  
Inherited_from
\Zend_Barcode_Object_Code25::$$_offsetTop  
Inherited_from
\Zend_Barcode_Object_Code25interleaved::$$_offsetTop  
Propertyprotectedstring $_staticFont = null
Propertyprotectedboolean $_stretchText = false
Propertyprotected\$_substituteChecksumCharacter $_substituteChecksumCharacter = 0
Propertyprivateboolean $_withBearerBars = false
inherited

Drawing of bearer bars

Inherited from: \Zend_Barcode_Object_Code25interleaved::$$_withBearerBars
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Barcode_Object_Code25interleaved::$$_withBearerBars  

Methods

methodpublic__construct(array | \Zend_Config $options = null) : void
Parameters
Name Type Description
$options array | \Zend_Config
methodprotected_addInstruction(array $instruction) : void
Parameters
Name Type Description
$instruction array
methodprotected_addLeadingZeros(string $text, boolean $withoutChecksum = false) : void
Parameters
Name Type Description
$text string
$withoutChecksum boolean
methodprotected_addPolygon(array $points, integer $color = null, boolean $filled = true) : void
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
Parameters
Name Type Description
$text string
$size float
$position array
$font string
$color integer
$alignment string
$orientation float
methodprotected_calculateBarcodeWidth() : integer
inherited

Width of the barcode (in pixels)

Inherited from: \Zend_Barcode_Object_Code25interleaved::_calculateBarcodeWidth()
Returns
Type Description
integer
methodprotected_calculateHeight() : integer
Returns
Type Description
integer
methodprotected_calculateWidth() : integer
Returns
Type Description
integer
methodprotected_checkParams() : void
inherited

Partial check of interleaved 2 of 5 barcode

Inherited from: \Zend_Barcode_Object_Code25::_checkParams()\Zend_Barcode_Object_Code25interleaved::_checkParams()
methodprotected_checkRatio(integer $min = 2, integer $max = 3) : void
Parameters
Name Type Description
$min integer
$max integer
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodprotected_checkText( $value = null) : void
Parameters
Name Type Description
$value
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodprotected_getDefaultOptions() : void

Default options for Identcode barcode

methodprotected_postDrawBarcode() : void
inherited

Drawing of bearer bars (if enabled)

Inherited from: \Zend_Barcode_Object_Code25interleaved::_postDrawBarcode()
methodprotected_prepareBarcode() : array
inherited

Prepare array to draw barcode

Inherited from: \Zend_Barcode_Object_Code25interleaved::_prepareBarcode()

.. )

Returns
Type Description
array
methodprotected_rotate(float $x1, float $y1) : array
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
Parameters
Name Type Description
$value string
$options array
methodpublicdraw() : array
Returns
Type Description
array Table of instructions
methodpublicgetBackgroundColor() : integer
Returns
Type Description
integer
methodpublicgetBarHeight() : integer
Returns
Type Description
integer
methodpublicgetBarThickWidth() : integer
Returns
Type Description
integer
methodpublicgetBarThinWidth() : integer
Returns
Type Description
integer
methodpublicgetBarcodeNamespace() : string
Returns
Type Description
string
methodpublicgetChecksum(string $text) : int
Parameters
Name Type Description
$text string
Returns
Type Description
int
methodpublicgetDrawText() : boolean
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()\Zend_Barcode_Object_Code25interleaved::getFactor()
Returns
Type Description
integer
methodpublicgetFont() : integer | string
Returns
Type Description
integer | string
methodpublicgetFontSize() : float
Returns
Type Description
float
methodpublicgetForeColor() : \unknown
Returns
Type Description
\unknown
methodpublicgetHeight( $recalculate = false) : integer
Parameters
Name Type Description
$recalculate
Returns
Type Description
integer
methodpublicgetInstructions() : array
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()\Zend_Barcode_Object_Code25interleaved::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()\Zend_Barcode_Object_Code25interleaved::getOffsetTop()
Parameters
Name Type Description
$recalculate boolean
Returns
Type Description
float
methodpublicgetOrientation() : float
Returns
Type Description
float
methodpublicgetQuietZone() : integer
Returns
Type Description
integer
methodpublicgetRawText() : string
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()\Zend_Barcode_Object_Code25interleaved::getStretchText()
Returns
Type Description
boolean
methodpublicgetText() : string
Returns
Type Description
string
methodpublicgetTextToDisplay() : string
Returns
Type Description
string
methodpublicgetType() : string
Returns
Type Description
string
methodpublicgetWidth( $recalculate = false) : integer
Parameters
Name Type Description
$recalculate
Returns
Type Description
integer
methodpublicgetWithBearerBars() : boolean
inherited

Retrieve if bearer bars are enabled

Inherited from: \Zend_Barcode_Object_Code25interleaved::getWithBearerBars()
Returns
Type Description
boolean
methodpublicgetWithBorder() : boolean
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()\Zend_Barcode_Object_Code25interleaved::getWithChecksum()
Returns
Type Description
boolean
methodpublicgetWithChecksumInText() : boolean
Returns
Type Description
boolean
methodpublicgetWithQuietZones() : boolean
Returns
Type Description
boolean
methodpublicsetBackgroundColor(integer $value) : \Zend_Barcode_Object
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
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
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
Parameters
Name Type Description
$value integer
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetBarcodeFont(string $font) : void
Parameters
Name Type Description
$font string
methodpublicsetBarcodeNamespace(string $namespace) : \Zend_Barcode_Object
Parameters
Name Type Description
$namespace string
Returns
Type Description
\Zend_Barcode_Object
methodpublicsetConfig(\Zend_Config $config) : \Zend_Barcode_Object
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Barcode_Object
methodpublicsetDrawText(boolean $value) : \Zend_Barcode_Object
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()\Zend_Barcode_Object_Code25interleaved::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()\Zend_Barcode_Object_Code25interleaved::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
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
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
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Barcode_Object
methodpublicsetOrientation(float $value) : \Zend_Barcode_Object
Parameters
Name Type Description
$value float
Returns
Type Description
\Zend_Barcode_Object
Throws
Exception Description
\Zend_Barcode_Object_Exception
methodpublicsetReverseColor() : \Zend_Barcode_Object
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()\Zend_Barcode_Object_Code25interleaved::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
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Barcode_Object
methodpublicsetWithBearerBars(boolean $value) : \Zend_Barcode_Object_Int25
inherited

Activate/deactivate drawing of bearer bars

Inherited from: \Zend_Barcode_Object_Code25interleaved::setWithBearerBars()
Parameters
Name Type Description
$value boolean
Returns
Type Description
\Zend_Barcode_Object_Int25
methodpublicsetWithBorder(boolean $value) : \Zend_Barcode_Object
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()\Zend_Barcode_Object_Code25interleaved::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()\Zend_Barcode_Object_Code25interleaved::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
Parameters
Name Type Description
$value boolean
Returns
Type Description
\Zend_Barcode_Object
methodpublicvalidateText(string $value) : void
Parameters
Name Type Description
$value string

Text to be ckecked

Documentation was generated by phpDocumentor 2.0.0a8.