Class for generate Identcode barcode

 Methods

Constructor

__construct(array | \Traversable $options) 
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::__construct()
inherited_from \Zend\Barcode\Object\Code25::__construct()
inherited_from \Zend\Barcode\Object\Code25interleaved::__construct()

Parameters

$options

array\Traversable

Checking of parameters after all settings

checkParams() : bool
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::checkParams()
inherited_from \Zend\Barcode\Object\Code25::checkParams()
inherited_from \Zend\Barcode\Object\Code25interleaved::checkParams()

Returns

bool

Complete drawing of the barcode

draw() : array
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::draw()
inherited_from \Zend\Barcode\Object\Code25::draw()
inherited_from \Zend\Barcode\Object\Code25interleaved::draw()

Returns

arrayTable of instructions

Retrieve background color of the image

getBackgroundColor() : int
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getBackgroundColor()
inherited_from \Zend\Barcode\Object\Code25::getBackgroundColor()
inherited_from \Zend\Barcode\Object\Code25interleaved::getBackgroundColor()

Returns

int

Get height of the barcode bar

getBarHeight() : int
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getBarHeight()
inherited_from \Zend\Barcode\Object\Code25::getBarHeight()
inherited_from \Zend\Barcode\Object\Code25interleaved::getBarHeight()

Returns

int

Get thickness of thick bar

getBarThickWidth() : int
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getBarThickWidth()
inherited_from \Zend\Barcode\Object\Code25::getBarThickWidth()
inherited_from \Zend\Barcode\Object\Code25interleaved::getBarThickWidth()

Returns

int

Get thickness of thin bar

getBarThinWidth() : int
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getBarThinWidth()
inherited_from \Zend\Barcode\Object\Code25::getBarThinWidth()
inherited_from \Zend\Barcode\Object\Code25interleaved::getBarThinWidth()

Returns

int

Retrieve barcode namespace

getBarcodeNamespace() : string
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getBarcodeNamespace()
inherited_from \Zend\Barcode\Object\Code25::getBarcodeNamespace()
inherited_from \Zend\Barcode\Object\Code25interleaved::getBarcodeNamespace()

Returns

string

Get barcode checksum

getChecksum(string $text) : int

Parameters

$text

string

Returns

int

Retrieve if drawing of text to encode is enabled

getDrawText() : bool
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getDrawText()
inherited_from \Zend\Barcode\Object\Code25::getDrawText()
inherited_from \Zend\Barcode\Object\Code25interleaved::getDrawText()

Returns

bool

Get factor applying to thinBarWidth - thickBarWidth - barHeight - fontSize

getFactor() : int
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getFactor()
inherited_from \Zend\Barcode\Object\Code25::getFactor()
inherited_from \Zend\Barcode\Object\Code25interleaved::getFactor()

Returns

int

Retrieve the font

getFont() : int | string
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getFont()
inherited_from \Zend\Barcode\Object\Code25::getFont()
inherited_from \Zend\Barcode\Object\Code25interleaved::getFont()

Returns

intstring

Retrieve the size of the font in case of TTF

getFontSize() : float
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getFontSize()
inherited_from \Zend\Barcode\Object\Code25::getFontSize()
inherited_from \Zend\Barcode\Object\Code25interleaved::getFontSize()

Returns

float

Retrieve color of the barcode and text

getForeColor() : int
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getForeColor()
inherited_from \Zend\Barcode\Object\Code25::getForeColor()
inherited_from \Zend\Barcode\Object\Code25interleaved::getForeColor()

Returns

int

Get height of the result object

getHeight(bool $recalculate) : int
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getHeight()
inherited_from \Zend\Barcode\Object\Code25::getHeight()
inherited_from \Zend\Barcode\Object\Code25interleaved::getHeight()

Parameters

$recalculate

bool

Returns

int

Retrieve the set of drawing instructions

getInstructions() : array
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getInstructions()
inherited_from \Zend\Barcode\Object\Code25::getInstructions()
inherited_from \Zend\Barcode\Object\Code25interleaved::getInstructions()

Returns

array

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

getOffsetLeft(bool $recalculate) : float
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getOffsetLeft()
inherited_from \Zend\Barcode\Object\Code25::getOffsetLeft()
inherited_from \Zend\Barcode\Object\Code25interleaved::getOffsetLeft()

Parameters

$recalculate

bool

Returns

float

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

getOffsetTop(bool $recalculate) : float
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getOffsetTop()
inherited_from \Zend\Barcode\Object\Code25::getOffsetTop()
inherited_from \Zend\Barcode\Object\Code25interleaved::getOffsetTop()

Parameters

$recalculate

bool

Returns

float

Retrieve orientation of barcode and text

getOrientation() : float
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getOrientation()
inherited_from \Zend\Barcode\Object\Code25::getOrientation()
inherited_from \Zend\Barcode\Object\Code25interleaved::getOrientation()

Returns

float

Quiet zone before first bar and after the last bar

getQuietZone() : int
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getQuietZone()
inherited_from \Zend\Barcode\Object\Code25::getQuietZone()
inherited_from \Zend\Barcode\Object\Code25interleaved::getQuietZone()

Returns

int

Retrieve text to encode

getRawText() : string
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getRawText()
inherited_from \Zend\Barcode\Object\Code25::getRawText()
inherited_from \Zend\Barcode\Object\Code25interleaved::getRawText()

Returns

string

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

getStretchText() : bool
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getStretchText()
inherited_from \Zend\Barcode\Object\Code25::getStretchText()
inherited_from \Zend\Barcode\Object\Code25interleaved::getStretchText()

Returns

bool

Retrieve text to encode

getText() : string
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getText()
inherited_from \Zend\Barcode\Object\Code25::getText()
inherited_from \Zend\Barcode\Object\Code25interleaved::getText()

Returns

string

Retrieve text to display

getTextToDisplay() : string

Returns

string

Retrieve type of barcode

getType() : string
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getType()
inherited_from \Zend\Barcode\Object\Code25::getType()
inherited_from \Zend\Barcode\Object\Code25interleaved::getType()

Returns

string

Get width of the result object

getWidth(bool $recalculate) : int
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getWidth()
inherited_from \Zend\Barcode\Object\Code25::getWidth()
inherited_from \Zend\Barcode\Object\Code25interleaved::getWidth()

Parameters

$recalculate

bool

Returns

int

Retrieve if bearer bars are enabled

getWithBearerBars() : bool
Inherited

inherited_from \Zend\Barcode\Object\Code25interleaved::getWithBearerBars()

Returns

bool

Retrieve if border are draw or not

getWithBorder() : bool
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getWithBorder()
inherited_from \Zend\Barcode\Object\Code25::getWithBorder()
inherited_from \Zend\Barcode\Object\Code25interleaved::getWithBorder()

Returns

bool

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

getWithChecksum() : bool
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getWithChecksum()
inherited_from \Zend\Barcode\Object\Code25::getWithChecksum()
inherited_from \Zend\Barcode\Object\Code25interleaved::getWithChecksum()

Returns

bool

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

getWithChecksumInText() : bool
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getWithChecksumInText()
inherited_from \Zend\Barcode\Object\Code25::getWithChecksumInText()
inherited_from \Zend\Barcode\Object\Code25interleaved::getWithChecksumInText()

Returns

bool

Retrieve if quiet zones are draw or not

getWithQuietZones() : bool
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::getWithQuietZones()
inherited_from \Zend\Barcode\Object\Code25::getWithQuietZones()
inherited_from \Zend\Barcode\Object\Code25interleaved::getWithQuietZones()

Returns

bool

Set the color of the background

setBackgroundColor(int $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setBackgroundColor()
inherited_from \Zend\Barcode\Object\Code25::setBackgroundColor()
inherited_from \Zend\Barcode\Object\Code25interleaved::setBackgroundColor()

Parameters

$value

int

Exceptions

\Zend\Barcode\Object\Exception\ExceptionInterface

Returns

Set height of the barcode bar

setBarHeight(int $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setBarHeight()
inherited_from \Zend\Barcode\Object\Code25::setBarHeight()
inherited_from \Zend\Barcode\Object\Code25interleaved::setBarHeight()

Parameters

$value

int

Exceptions

\Zend\Barcode\Object\Exception\ExceptionInterface

Returns

Set thickness of thick bar

setBarThickWidth(int $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setBarThickWidth()
inherited_from \Zend\Barcode\Object\Code25::setBarThickWidth()
inherited_from \Zend\Barcode\Object\Code25interleaved::setBarThickWidth()

Parameters

$value

int

Exceptions

\Zend\Barcode\Object\Exception\ExceptionInterface

Returns

Set thickness of thin bar

setBarThinWidth(int $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setBarThinWidth()
inherited_from \Zend\Barcode\Object\Code25::setBarThinWidth()
inherited_from \Zend\Barcode\Object\Code25interleaved::setBarThinWidth()

Parameters

$value

int

Exceptions

\Zend\Barcode\Object\Exception\ExceptionInterface

Returns

Set barcode namespace for autoloading

setBarcodeNamespace(string $namespace) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setBarcodeNamespace()
inherited_from \Zend\Barcode\Object\Code25::setBarcodeNamespace()
inherited_from \Zend\Barcode\Object\Code25interleaved::setBarcodeNamespace()

Parameters

$namespace

string

Returns

Activate/deactivate drawing of text to encode

setDrawText(bool $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setDrawText()
inherited_from \Zend\Barcode\Object\Code25::setDrawText()
inherited_from \Zend\Barcode\Object\Code25interleaved::setDrawText()

Parameters

$value

bool

Returns

Set factor applying to thinBarWidth - thickBarWidth - barHeight - fontSize

setFactor(int | float | string | bool $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setFactor()
inherited_from \Zend\Barcode\Object\Code25::setFactor()
inherited_from \Zend\Barcode\Object\Code25interleaved::setFactor()

Parameters

$value

intfloatstringbool

Exceptions

\Zend\Barcode\Object\Exception\ExceptionInterface

Returns

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

setFont(int | string $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setFont()
inherited_from \Zend\Barcode\Object\Code25::setFont()
inherited_from \Zend\Barcode\Object\Code25interleaved::setFont()

Parameters

$value

intstring

Exceptions

\Zend\Barcode\Object\Exception\ExceptionInterface

Returns

Set the size of the font in case of TTF

setFontSize(float $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setFontSize()
inherited_from \Zend\Barcode\Object\Code25::setFontSize()
inherited_from \Zend\Barcode\Object\Code25interleaved::setFontSize()

Parameters

$value

float

Exceptions

\Zend\Barcode\Object\Exception\ExceptionInterface

Returns

Set color of the barcode and text

setForeColor(string $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setForeColor()
inherited_from \Zend\Barcode\Object\Code25::setForeColor()
inherited_from \Zend\Barcode\Object\Code25interleaved::setForeColor()

Parameters

$value

string

Exceptions

\Zend\Barcode\Object\Exception\ExceptionInterface

Returns

Set barcode state from options array

setOptions(array $options) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setOptions()
inherited_from \Zend\Barcode\Object\Code25::setOptions()
inherited_from \Zend\Barcode\Object\Code25interleaved::setOptions()

Parameters

$options

array

Returns

Set orientation of barcode and text

setOrientation(int | float | string | bool $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setOrientation()
inherited_from \Zend\Barcode\Object\Code25::setOrientation()
inherited_from \Zend\Barcode\Object\Code25interleaved::setOrientation()

Parameters

$value

intfloatstringbool

Exceptions

\Zend\Barcode\Object\Exception\ExceptionInterface

Returns

Allow fast inversion of font/bars color and background color

setReverseColor() : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setReverseColor()
inherited_from \Zend\Barcode\Object\Code25::setReverseColor()
inherited_from \Zend\Barcode\Object\Code25interleaved::setReverseColor()

Returns

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

setStretchText(bool $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setStretchText()
inherited_from \Zend\Barcode\Object\Code25::setStretchText()
inherited_from \Zend\Barcode\Object\Code25interleaved::setStretchText()

Parameters

$value

bool

Exceptions

\Zend\Barcode\Object\Exception\ExceptionInterface

Returns

Set text to encode

setText(string $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setText()
inherited_from \Zend\Barcode\Object\Code25::setText()
inherited_from \Zend\Barcode\Object\Code25interleaved::setText()

Parameters

$value

string

Returns

Activate/deactivate drawing of bearer bars

setWithBearerBars(bool $value) : \Zend\Barcode\Object\Code25
Inherited

inherited_from \Zend\Barcode\Object\Code25interleaved::setWithBearerBars()

Parameters

$value

bool

Returns

Activate/deactivate drawing of the bar

setWithBorder(bool $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setWithBorder()
inherited_from \Zend\Barcode\Object\Code25::setWithBorder()
inherited_from \Zend\Barcode\Object\Code25interleaved::setWithBorder()

Parameters

$value

bool

Returns

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

setWithChecksum(bool $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setWithChecksum()
inherited_from \Zend\Barcode\Object\Code25::setWithChecksum()
inherited_from \Zend\Barcode\Object\Code25interleaved::setWithChecksum()

Parameters

$value

bool

Returns

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

setWithChecksumInText(bool $value) : \Zend\Barcode\Object\ObjectInterface
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setWithChecksumInText()
inherited_from \Zend\Barcode\Object\Code25::setWithChecksumInText()
inherited_from \Zend\Barcode\Object\Code25interleaved::setWithChecksumInText()

Parameters

$value

bool

Exceptions

\Zend\Barcode\Object\Exception\ExceptionInterface

Returns

Activate/deactivate drawing of the quiet zones

setWithQuietZones(bool $value) : \Zend\Barcode\Object\AbstractObject
Inherited

inherited_from \Zend\Barcode\Object\AbstractObject::setWithQuietZones()
inherited_from \Zend\Barcode\Object\Code25::setWithQuietZones()
inherited_from \Zend\Barcode\Object\Code25interleaved::setWithQuietZones()

Parameters

$value

bool

Returns

Check allowed characters

validateText(string $value) : string

Parameters

$value

string

Exceptions

\Zend\Barcode\Object\Exception\BarcodeValidationException

Returns

string

 Properties