Barcode/Object/Identcode.php

Show: PublicProtectedPrivateinherited
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 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: Identcode.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Barcode_Object_Identcode

Package: Zend\Barcode
Class for generate Identcode barcode
Parent(s)
\Zend_Barcode_Object_Code25interleaved < \Zend_Barcode_Object_Code25 < \Zend_Barcode_Object_ObjectAbstract
Children
\Zend_Barcode_Object_Leitcode
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected\$_addLeadingZeros $_addLeadingZeros = true
>VPropertyprotected\$_barcodeLength $_barcodeLength = null
>VPropertyprotectedstring $_barcodeNamespace = 'Zend_Barcode_Object'
>VPropertyprotectedarray $_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  
>VPropertyprotectedinteger $_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
>VPropertyprotectedinteger|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  
>VPropertyprotected\$_mandatoryChecksum $_mandatoryChecksum = false
>VPropertyprotectedinteger $_offsetLeft = null
>VPropertyprotectedinteger $_offsetTop = null
>VPropertyprotectedstring $_staticFont = null
>VPropertyprotectedboolean $_stretchText = false
>VPropertyprivateboolean $_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
NameTypeDescription
$optionsarray | \Zend_Config
methodprotected_addInstruction(array $instruction) : void
Parameters
NameTypeDescription
$instructionarray
methodprotected_addLeadingZeros(string $text, boolean $withoutChecksum = false) : void
Parameters
NameTypeDescription
$textstring
$withoutChecksumboolean
methodprotected_addPolygon(array $points, integer $color = null, boolean $filled = true) : void
Parameters
NameTypeDescription
$pointsarray
$colorinteger
$filledboolean
methodprotected_addText(string $text, float $size, array $position, string $font, integer $color, string $alignment = 'center', float $orientation = 0) : void
Parameters
NameTypeDescription
$textstring
$sizefloat
$positionarray
$fontstring
$colorinteger
$alignmentstring
$orientationfloat
methodprotected_calculateBarcodeWidth() : integer
inherited

Width of the barcode (in pixels)

Inherited from: \Zend_Barcode_Object_Code25interleaved::_calculateBarcodeWidth()
Returns
TypeDescription
integer
methodprotected_calculateHeight() : integer
Returns
TypeDescription
integer
methodprotected_calculateWidth() : integer
Returns
TypeDescription
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
NameTypeDescription
$mininteger
$maxinteger
Details
Throw
 
methodprotected_checkText( $value = null) : void
Parameters
NameTypeDescription
$value
Details
Throw
 
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
TypeDescription
array
methodprotected_rotate(float $x1, float $y1) : array
Parameters
NameTypeDescription
$x1float

x-position before rotation

$y1float

y-position before rotation

Returns
TypeDescription
arrayArray of two elements corresponding to the new XY point
methodprotected_validateText(string $value, array $options = array()) : void
Parameters
NameTypeDescription
$valuestring
$optionsarray
methodpublicdraw() : array
Returns
TypeDescription
arrayTable of instructions
methodpublicgetBackgroundColor() : integer
Returns
TypeDescription
integer
methodpublicgetBarHeight() : integer
Returns
TypeDescription
integer
methodpublicgetBarThickWidth() : integer
Returns
TypeDescription
integer
methodpublicgetBarThinWidth() : integer
Returns
TypeDescription
integer
methodpublicgetChecksum(string $text) : int

Get barcode checksum

Parameters
NameTypeDescription
$textstring
Returns
TypeDescription
int
methodpublicgetDrawText() : boolean
Returns
TypeDescription
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
TypeDescription
integer
methodpublicgetFont() : integer | string
Returns
TypeDescription
integer | string
methodpublicgetFontSize() : float
Returns
TypeDescription
float
methodpublicgetForeColor() : \unknown
Returns
TypeDescription
\unknown
methodpublicgetHeight( $recalculate = false) : integer
Parameters
NameTypeDescription
$recalculate
Returns
TypeDescription
integer
methodpublicgetInstructions() : array
Returns
TypeDescription
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
NameTypeDescription
$recalculateboolean
Returns
TypeDescription
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
NameTypeDescription
$recalculateboolean
Returns
TypeDescription
float
methodpublicgetOrientation() : float
Returns
TypeDescription
float
methodpublicgetQuietZone() : integer
Returns
TypeDescription
integer
methodpublicgetRawText() : string
Returns
TypeDescription
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
TypeDescription
boolean
methodpublicgetText() : string
Returns
TypeDescription
string
methodpublicgetTextToDisplay() : string

Retrieve text to display

Returns
TypeDescription
string
methodpublicgetType() : string
Returns
TypeDescription
string
methodpublicgetWidth( $recalculate = false) : integer
Parameters
NameTypeDescription
$recalculate
Returns
TypeDescription
integer
methodpublicgetWithBearerBars() : boolean
inherited

Retrieve if bearer bars are enabled

Inherited from: \Zend_Barcode_Object_Code25interleaved::getWithBearerBars()
Returns
TypeDescription
boolean
methodpublicgetWithBorder() : boolean
Returns
TypeDescription
boolean
methodpublicgetWithChecksum() : boolean
Returns
TypeDescription
boolean
methodpublicgetWithChecksumInText() : boolean
Returns
TypeDescription
boolean
methodpublicgetWithQuietZones() : boolean
Returns
TypeDescription
boolean
methodpublicsetBackgroundColor(integer $value) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$valueinteger
Returns
TypeDescription
\Zend_Barcode_Object
Details
Throw
 
methodpublicsetBarHeight(integer $value) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$valueinteger
Returns
TypeDescription
\Zend_Barcode_Object
Details
Throw
 
methodpublicsetBarThickWidth(integer $value) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$valueinteger
Returns
TypeDescription
\Zend_Barcode_Object
Details
Throw
 
methodpublicsetBarThinWidth(integer $value) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$valueinteger
Returns
TypeDescription
\Zend_Barcode_Object
Details
Throw
 
methodpublicsetBarcodeFont(string $font) : void
Parameters
NameTypeDescription
$fontstring
methodpublicsetBarcodeNamespace(string $namespace) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$namespacestring
Returns
TypeDescription
\Zend_Barcode_Object
methodpublicsetConfig(\Zend_Config $config) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Barcode_Object
methodpublicsetDrawText(boolean $value) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$valueboolean
Returns
TypeDescription
\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
NameTypeDescription
$valuefloat
Returns
TypeDescription
\Zend_Barcode_Object
Details
Throw
 
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
NameTypeDescription
$valueinteger | string
Returns
TypeDescription
\Zend_Barcode_Object
Details
Throw
 
methodpublicsetFontSize(float $value) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$valuefloat
Returns
TypeDescription
\Zend_Barcode_Object
Details
Throw
 
methodpublicsetForeColor(string $value) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Barcode_Object
Details
Throw
 
methodpublicsetOptions(array $options) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Barcode_Object
methodpublicsetOrientation(float $value) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$valuefloat
Returns
TypeDescription
\Zend_Barcode_Object
Details
Throw
 
methodpublicsetReverseColor() : \Zend_Barcode_Object
Returns
TypeDescription
\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
NameTypeDescription
$valueboolean
Returns
TypeDescription
\Zend_Barcode_Object
Details
Throw
 
methodpublicsetText(string $value) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\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
NameTypeDescription
$valueboolean
Returns
TypeDescription
\Zend_Barcode_Object_Int25
methodpublicsetWithBorder(boolean $value) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$valueboolean
Returns
TypeDescription
\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
NameTypeDescription
$valueboolean
Returns
TypeDescription
\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
NameTypeDescription
$valueboolean
Returns
TypeDescription
\Zend_Barcode_Object
Details
Throw
 
methodpublicsetWithQuietZones(boolean $value) : \Zend_Barcode_Object
Parameters
NameTypeDescription
$valueboolean
Returns
TypeDescription
\Zend_Barcode_Object
methodpublicvalidateText(string $value) : string

Check allowed characters

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
string
Details
Throw
 
Documentation was generated by phpDocumentor 2.0.0a12.