Barcode/Object/Ean13.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- 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: Ean13.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Barcode_Object_Ean13
- Parent(s)
- \Zend_Barcode_Object_ObjectAbstract
- Children
- \Zend_Barcode_Object_Upce
- \Zend_Barcode_Object_Upca
- \Zend_Barcode_Object_Ean5
- \Zend_Barcode_Object_Ean8
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties

\$_addLeadingZeros $_addLeadingZeros = truetrueDetails- Type
- \$_addLeadingZeros
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_addLeadingZeros

integer $_backgroundColor = 1677721516777215Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_backgroundColor

integer $_barHeight = 5050Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_barHeight

integer $_barThickWidth = 33Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_barThickWidth

integer $_barThinWidth = 11Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_barThinWidth

\$_barcodeLength $_barcodeLength = nullnullDetails- Type
- \$_barcodeLength
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_barcodeLength

string $_barcodeNamespace = 'Zend_Barcode_Object''Zend_Barcode_Object'Details- Type
- string
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_barcodeNamespace

array $_codingMap = array('A' => array(0 => "0001101", 1 => "0011001", 2 => "0010011", 3 => "0111101", 4 => "0100011", 5 => "0110001", 6 => "0101111", 7 => "0111011", 8 => "0110111", 9 => "0001011"), 'B' => array(0 => "0100111", 1 => "0110011", 2 => "0011011", 3 => "0100001", 4 => "0011101", 5 => "0111001", 6 => "0000101", 7 => "0010001", 8 => "0001001", 9 => "0010111"), 'C' => array(0 => "1110010", 1 => "1100110", 2 => "1101100", 3 => "1000010", 4 => "1011100", 5 => "1001110", 6 => "1010000", 7 => "1000100", 8 => "1001000", 9 => "1110100"))array('A' => array(0 => "0001101", 1 => "0011001", 2 => "0010011", 3 => "0111101", 4 => "0100011", 5 => "0110001", 6 => "0101111", 7 => "0111011", 8 => "0110111", 9 => "0001011"), 'B' => array(0 => "0100111", 1 => "0110011", 2 => "0011011", 3 => "0100001", 4 => "0011101", 5 => "0111001", 6 => "0000101", 7 => "0010001", 8 => "0001001", 9 => "0010111"), 'C' => array(0 => "1110010", 1 => "1100110", 2 => "1101100", 3 => "1000010", 4 => "1011100", 5 => "1001110", 6 => "1010000", 7 => "1000100", 8 => "1001000", 9 => "1110100"))Details- Type
- array

boolean $_drawText = truetrueDetails- Type
- boolean
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_drawText

integer $_factor = 11Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_factor

integer|string $_font = nullnullDetails- Type
- integer | string
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_font

float $_fontSize = 1010Details- Type
- float
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_fontSize

integer $_foreColor = 00Details- Type
- integer
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_foreColor

integer $_height = nullnullDetails- Type
- integer
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_height

array $_instructions = array()array()Details- Type
- array
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_instructions

\$_mandatoryChecksum $_mandatoryChecksum = falsefalseDetails- Type
- \$_mandatoryChecksum
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_mandatoryChecksum

boolean $_mandatoryQuietZones = falsefalseDetails- Type
- boolean
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_mandatoryQuietZones

integer $_offsetLeft = nullnullDetails- Type
- integer
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_offsetLeft

integer $_offsetTop = nullnullDetails- Type
- integer
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_offsetTop

float $_orientation = 00Details- Type
- float
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_orientation

$_parities = array(0 => array('A', 'A', 'A', 'A', 'A', 'A'), 1 => array('A', 'A', 'B', 'A', 'B', 'B'), 2 => array('A', 'A', 'B', 'B', 'A', 'B'), 3 => array('A', 'A', 'B', 'B', 'B', 'A'), 4 => array('A', 'B', 'A', 'A', 'B', 'B'), 5 => array('A', 'B', 'B', 'A', 'A', 'B'), 6 => array('A', 'B', 'B', 'B', 'A', 'A'), 7 => array('A', 'B', 'A', 'B', 'A', 'B'), 8 => array('A', 'B', 'A', 'B', 'B', 'A'), 9 => array('A', 'B', 'B', 'A', 'B', 'A'))array(0 => array('A', 'A', 'A', 'A', 'A', 'A'), 1 => array('A', 'A', 'B', 'A', 'B', 'B'), 2 => array('A', 'A', 'B', 'B', 'A', 'B'), 3 => array('A', 'A', 'B', 'B', 'B', 'A'), 4 => array('A', 'B', 'A', 'A', 'B', 'B'), 5 => array('A', 'B', 'B', 'A', 'A', 'B'), 6 => array('A', 'B', 'B', 'B', 'A', 'A'), 7 => array('A', 'B', 'A', 'B', 'A', 'B'), 8 => array('A', 'B', 'A', 'B', 'B', 'A'), 9 => array('A', 'B', 'B', 'A', 'B', 'A'))Details- Type
- n/a

string $_staticFont = nullnullDetails- Type
- string
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_staticFont

boolean $_stretchText = falsefalseDetails- Type
- boolean
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_stretchText

\$_substituteChecksumCharacter $_substituteChecksumCharacter = 00Details- Type
- \$_substituteChecksumCharacter
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_substituteChecksumCharacter

string $_text = nullnullDetails- Type
- string
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_text

string $_type = nullnullDetails- Type
- string
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_type

integer $_width = nullnullDetails- Type
- integer
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_width

boolean $_withBorder = falsefalseDetails- Type
- boolean
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_withBorder

boolean $_withChecksum = falsefalseDetails- Type
- boolean
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_withChecksum

boolean $_withChecksumInText = falsefalseDetails- Type
- boolean
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_withChecksumInText

boolean $_withQuietZones = truetrueDetails- Type
- boolean
- Inherited_from
- \Zend_Barcode_Object_ObjectAbstract::$$_withQuietZones
Methods

__construct(array | \Zend_Config $options = null) : void| Name | Type | Description |
|---|---|---|
| $options | array | \Zend_Config |

_addInstruction(array $instruction) : voidAdd an instruction in the array of instructions
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_addInstruction()| Name | Type | Description |
|---|---|---|
| $instruction | array |

_addLeadingZeros(string $text, boolean $withoutChecksum = false) : voidAutomatically add leading zeros if barcode length is fixed
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_addLeadingZeros()| Name | Type | Description |
|---|---|---|
| $text | string | |
| $withoutChecksum | boolean |

_addPolygon(array $points, integer $color = null, boolean $filled = true) : voidAdd a polygon drawing instruction in the set of instructions
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_addPolygon()| 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) : voidAdd a text drawing instruction in the set of instructions
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_addText()| Name | Type | Description |
|---|---|---|
| $text | string | |
| $size | float | |
| $position | array | |
| $font | string | |
| $color | integer | |
| $alignment | string | |
| $orientation | float |

_calculateBarcodeHeight() : integerHeight of the barcode
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_calculateBarcodeHeight()| Type | Description |
|---|---|
| integer |

_calculateHeight() : integerHeight of the result object
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_calculateHeight()| Type | Description |
|---|---|
| integer |

_calculateWidth() : integerWidth of the result image (before any rotation)
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_calculateWidth()| Type | Description |
|---|---|
| integer |

_checkFontAndOrientation() : voidDrawing with an angle is just allow TTF font
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_checkFontAndOrientation()- Throw

_checkRatio(integer $min = 2, integer $max = 3) : voidCheck the ratio between the thick and the thin bar
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_checkRatio()| Name | Type | Description |
|---|---|---|
| $min | integer | |
| $max | integer |
- Throw

_checkText( $value = null) : voidCheck if a text is really provided to barcode
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_checkText()| Name | Type | Description |
|---|---|---|
| $value |
- Throw

_drawBorder() : voidPartial function to draw border
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_drawBorder()
_postDrawBarcode() : voidAllow each child to draw something else (ex: bearer bars in interleaved 2 of 5 code)
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_postDrawBarcode()
_preDrawBarcode() : voidAllow each child to draw something else
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_preDrawBarcode()
_rotate(float $x1, float $y1) : arrayApply rotation on a point in X/Y dimensions
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_rotate()| Name | Type | Description |
|---|---|---|
| $x1 | float | x-position before rotation |
| $y1 | float | y-position before rotation |
| Type | Description |
|---|---|
| array | Array of two elements corresponding to the new XY point |

_validateText(string $value, array $options = array()) : voidStandard validation for most of barcode objects
Inherited from: \Zend_Barcode_Object_ObjectAbstract::_validateText()| Name | Type | Description |
|---|---|---|
| $value | string | |
| $options | array |

checkParams() : voidChecking of parameters after all settings
Inherited from: \Zend_Barcode_Object_ObjectAbstract::checkParams()
getBackgroundColor() : integerRetrieve background color of the image
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBackgroundColor()| Type | Description |
|---|---|
| integer |

getBarHeight() : integerGet height of the barcode bar
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBarHeight()| Type | Description |
|---|---|
| integer |

getBarThickWidth() : integerGet thickness of thick bar
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBarThickWidth()| Type | Description |
|---|---|
| integer |

getBarThinWidth() : integerGet thickness of thin bar
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBarThinWidth()| Type | Description |
|---|---|
| integer |

getBarcodeNamespace() : stringRetrieve barcode namespace
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getBarcodeNamespace()| Type | Description |
|---|---|
| string |

getChecksum(string $text) : intGet barcode checksum
| Name | Type | Description |
|---|---|---|
| $text | string |
| Type | Description |
|---|---|
| int |

getDrawText() : booleanRetrieve if drawing of text to encode is enabled
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getDrawText()| Type | Description |
|---|---|
| boolean |

getFactor() : integerGet factor applying to thinBarWidth - thickBarWidth - barHeight - fontSize
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getFactor()| Type | Description |
|---|---|
| integer |

getFontSize() : floatRetrieve the size of the font in case of TTF
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getFontSize()| Type | Description |
|---|---|
| float |

getForeColor() : \unknownRetrieve color of the barcode and text
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getForeColor()| Type | Description |
|---|---|
| \unknown |

getHeight( $recalculate = false) : integerGet height of the result object
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getHeight()| Name | Type | Description |
|---|---|---|
| $recalculate |
| Type | Description |
|---|---|
| integer |

getInstructions() : arrayRetrieve the set of drawing instructions
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getInstructions()| Type | Description |
|---|---|
| array |

getOffsetLeft(boolean $recalculate = false) : floatCalculate the offset from the left of the object if an orientation is activated
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getOffsetLeft()| Name | Type | Description |
|---|---|---|
| $recalculate | boolean |
| Type | Description |
|---|---|
| float |

getOffsetTop(boolean $recalculate = false) : floatCalculate the offset from the top of the object if an orientation is activated
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getOffsetTop()| Name | Type | Description |
|---|---|---|
| $recalculate | boolean |
| Type | Description |
|---|---|
| float |

getOrientation() : floatRetrieve orientation of barcode and text
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getOrientation()| Type | Description |
|---|---|
| float |

getQuietZone() : integerQuiet zone before first bar and after the last bar
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getQuietZone()| Type | Description |
|---|---|
| integer |

getStretchText() : booleanRetrieve if the adjustment of the position of the characters to the position of the bars is enabled
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getStretchText()| Type | Description |
|---|---|
| boolean |

getTextToDisplay() : stringRetrieve text to display
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getTextToDisplay()| Type | Description |
|---|---|
| string |

getWidth( $recalculate = false) : integerGet width of the result object
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWidth()| Name | Type | Description |
|---|---|---|
| $recalculate |
| Type | Description |
|---|---|
| integer |

getWithBorder() : booleanRetrieve if border are draw or not
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWithBorder()| Type | Description |
|---|---|
| boolean |

getWithChecksum() : booleanRetrieve if the checksum character is automatically added to the barcode text
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWithChecksum()| Type | Description |
|---|---|
| boolean |

getWithChecksumInText() : booleanRetrieve if the checksum character is automatically added to the barcode text
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWithChecksumInText()| Type | Description |
|---|---|
| boolean |

getWithQuietZones() : booleanRetrieve if quiet zones are draw or not
Inherited from: \Zend_Barcode_Object_ObjectAbstract::getWithQuietZones()| Type | Description |
|---|---|
| boolean |

setBackgroundColor(integer $value) : \Zend_Barcode_ObjectSet the color of the background
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBackgroundColor()| Name | Type | Description |
|---|---|---|
| $value | integer |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
- Throw

setBarHeight(integer $value) : \Zend_Barcode_ObjectSet height of the barcode bar
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarHeight()| Name | Type | Description |
|---|---|---|
| $value | integer |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
- Throw

setBarThickWidth(integer $value) : \Zend_Barcode_ObjectSet thickness of thick bar
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarThickWidth()| Name | Type | Description |
|---|---|---|
| $value | integer |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
- Throw

setBarThinWidth(integer $value) : \Zend_Barcode_ObjectSet thickness of thin bar
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarThinWidth()| Name | Type | Description |
|---|---|---|
| $value | integer |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
- Throw

setBarcodeFont(string $font) : voidSet the font for all instances of barcode
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarcodeFont()| Name | Type | Description |
|---|---|---|
| $font | string |

setBarcodeNamespace(string $namespace) : \Zend_Barcode_ObjectSet barcode namespace for autoloading
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setBarcodeNamespace()| Name | Type | Description |
|---|---|---|
| $namespace | string |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |

setConfig(\Zend_Config $config) : \Zend_Barcode_ObjectSet barcode state from config object
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setConfig()| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |

setDrawText(boolean $value) : \Zend_Barcode_ObjectActivate/deactivate drawing of text to encode
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setDrawText()| Name | Type | Description |
|---|---|---|
| $value | boolean |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |

setFactor(float $value) : \Zend_Barcode_ObjectSet factor applying to thinBarWidth - thickBarWidth - barHeight - fontSize
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setFactor()| Name | Type | Description |
|---|---|---|
| $value | float |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
- Throw

setFont(integer | string $value) : \Zend_Barcode_ObjectSet 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()| Name | Type | Description |
|---|---|---|
| $value | integer | string |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
- Throw

setFontSize(float $value) : \Zend_Barcode_ObjectSet the size of the font in case of TTF
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setFontSize()| Name | Type | Description |
|---|---|---|
| $value | float |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
- Throw

setForeColor(string $value) : \Zend_Barcode_ObjectSet color of the barcode and text
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setForeColor()| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
- Throw

setOptions(array $options) : \Zend_Barcode_ObjectSet barcode state from options array
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setOptions()| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |

setOrientation(float $value) : \Zend_Barcode_ObjectSet orientation of barcode and text
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setOrientation()| Name | Type | Description |
|---|---|---|
| $value | float |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
- Throw

setReverseColor() : \Zend_Barcode_ObjectAllow fast inversion of font/bars color and background color
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setReverseColor()| Type | Description |
|---|---|
| \Zend_Barcode_Object |

setStretchText(boolean $value) : \Zend_Barcode_ObjectActivate/deactivate the adjustment of the position of the characters to the position of the bars
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setStretchText()| Name | Type | Description |
|---|---|---|
| $value | boolean |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
- Throw

setText(string $value) : \Zend_Barcode_Object| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |

setWithBorder(boolean $value) : \Zend_Barcode_ObjectActivate/deactivate drawing of the bar
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setWithBorder()| Name | Type | Description |
|---|---|---|
| $value | boolean |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |

setWithChecksum(boolean $value) : \Zend_Barcode_ObjectActivate/deactivate the automatic generation of the checksum character added to the barcode text
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setWithChecksum()| Name | Type | Description |
|---|---|---|
| $value | boolean |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |

setWithChecksumInText(boolean $value) : \Zend_Barcode_ObjectActivate/deactivate the automatic generation of the checksum character added to the barcode text
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setWithChecksumInText()| Name | Type | Description |
|---|---|---|
| $value | boolean |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |
- Throw

setWithQuietZones(boolean $value) : \Zend_Barcode_ObjectActivate/deactivate drawing of the quiet zones
Inherited from: \Zend_Barcode_Object_ObjectAbstract::setWithQuietZones()| Name | Type | Description |
|---|---|---|
| $value | boolean |
| Type | Description |
|---|---|
| \Zend_Barcode_Object |

validateText(string $value) : voidCheck for invalid characters
Inherited from: \Zend_Barcode_Object_ObjectAbstract::validateText()| Name | Type | Description |
|---|---|---|
| $value | string | Text to be ckecked |