\BCGintelligentmail

__construct()

__construct() 

Constructor.

getThickness()

getThickness() : integer

Gets the thickness.

Returns

setThickness()

setThickness(integer  $thickness) 

Sets the thickness.

Parameters

getLabel()

getLabel() : string

Gets the label.

If the label was set to BCGBarcode1D::AUTO_LABEL, the label will display the value from the text parsed.

Returns

setLabel()

setLabel(string  $label) 

Sets the label.

You can use BCGBarcode::AUTO_LABEL to have the label automatically written based on the parsed text.

Parameters

getFont()

getFont() : \BCGFont

Gets the font.

Returns

setFont()

setFont(mixed  $font) 

Sets the font.

Parameters

parse()

parse(mixed  $text) 

Parses the text before displaying it.

Parameters

getChecksum()

getChecksum() : string

Gets the checksum of a Barcode.

If no checksum is available, return FALSE.

Returns

setDisplayChecksum()

setDisplayChecksum(boolean  $displayChecksum) 

Sets if the checksum is displayed with the label or not.

The checksum must be activated in some case to make this variable effective.

Parameters

getForegroundColor()

getForegroundColor() : \BCGColor

Gets the foreground color of the barcode.

Returns

setForegroundColor()

setForegroundColor(mixed  $code) 

Sets the foreground color of the barcode. It could be a BCGColor value or simply a language code (white, black, yellow.

..) or hex value.

Parameters

getBackgroundColor()

getBackgroundColor() : \BCGColor

Gets the background color of the barcode.

Returns

setBackgroundColor()

setBackgroundColor(mixed  $code) 

Sets the background color of the barcode. It could be a BCGColor value or simply a language code (white, black, yellow.

..) or hex value.

Parameters

setColor()

setColor(mixed  $fg, mixed  $bg) 

Sets the color.

Parameters

getScale()

getScale() : integer

Gets the scale of the barcode.

Returns

setScale()

setScale(integer  $scale) 

Sets the scale of the barcode in pixel.

If the scale is lower than 1, an exception is raised.

Parameters

draw()

draw(resource  $im) 

Draws the barcode.

Parameters

getDimension()

getDimension(integer  $w, integer  $h) : array<mixed,integer>

Returns the maximal size of a barcode.

Parameters

Returns

getOffsetX()

getOffsetX() : integer

Gets the X offset.

Returns

setOffsetX()

setOffsetX(integer  $offsetX) 

Sets the X offset.

Parameters

getOffsetY()

getOffsetY() : integer

Gets the Y offset.

Returns

setOffsetY()

setOffsetY(integer  $offsetY) 

Sets the Y offset.

Parameters

addLabel()

addLabel(\BCGLabel  $label) 

Adds the label to the drawing.

Parameters

removeLabel()

removeLabel(\BCGLabel  $label) 

Removes the label from the drawing.

Parameters

clearLabels()

clearLabels() 

Clears the labels.

getQuietZone()

getQuietZone() : boolean

Gets the Quiet zone.

Returns

setQuietZone()

setQuietZone(boolean  $quietZone) 

Sets the Quiet zone.

Parameters

setTrackingCode()

setTrackingCode(integer  $barcodeIdentifier, integer  $serviceTypeIdentifier, integer  $mailerIdentifier, integer  $serialNumber) 

Sets the tracking code.

Parameters

addDefaultLabel()

addDefaultLabel() 

Adds the default label.

validate()

validate() 

Validates the input.

findIndex()

findIndex(mixed  $var) : mixed

Returns the index in $keys (useful for checksum).

Parameters

Returns

findCode()

findCode(mixed  $var) : string

Returns the code of the char (useful for drawing bars).

Parameters

Returns

drawChar()

drawChar(resource  $im, string  $code, boolean  $startBar = true) 

Overloaded method for drawing special barcode.

If $startBar is false, the line begins by a bar.

Parameters

drawSingleBar()

drawSingleBar(  $im, integer  $color) 

Draws a Bar of $color depending of the resolution.

Parameters

nextX()

nextX() 

Moving the pointer right to write a bar.

calculateChecksum()

calculateChecksum() 

Method that saves FALSE into the checksumValue. This means no checksum but this method should be overriden when needed.

processChecksum()

processChecksum() : string

Returns FALSE because there is no checksum. This method should be overriden to return correctly the checksum in string with checksumValue.

Returns

drawText()

drawText(resource  $im, integer  $x1, integer  $y1, integer  $x2, integer  $y2) 

Draws the text.

The coordinate passed are the positions of the barcode. $x1 and $y1 represent the top left corner. $x2 and $y2 represent the bottom right corner.

Parameters

drawPixel()

drawPixel(resource  $im, integer  $x, integer  $y, integer  $color = self::COLOR_FG) 

Draws 1 pixel on the resource at a specific position with a determined color.

Parameters

drawRectangle()

drawRectangle(resource  $im, integer  $x1, integer  $y1, integer  $x2, integer  $y2, integer  $color = self::COLOR_FG) 

Draws an empty rectangle on the resource at a specific position with a determined color.

Parameters

drawFilledRectangle()

drawFilledRectangle(resource  $im, integer  $x1, integer  $y1, integer  $x2, integer  $y2, integer  $color = self::COLOR_FG) 

Draws a filled rectangle on the resource at a specific position with a determined color.

Parameters

getColor()

getColor(resource  $im, integer  $color) : resource

Allocates the color based on the integer.

Parameters

Returns

getBiggestLabels()

getBiggestLabels(boolean  $reversed = false) : array<mixed,\BCGLabel>

Returning the biggest label widths for LEFT/RIGHT and heights for TOP/BOTTOM.

Parameters

Returns

executeStep1()

executeStep1(string  $text, string  $barcodeIdentifier, string  $serviceTypeIdentifier, string  $mailerIdentifier, string  $serialNumber) : string

Executes Step 1: Conversion of Data Fields into Binary Data

Parameters

Returns

BCNumber

executeStep2()

executeStep2(  $number) : integer

Executes Step 2: Generation of 11-Bit CRC on Binary Data

Parameters

Returns

executeStep3()

executeStep3(string  $number) : array<mixed,integer>

Executes Step 3: Conversion from Binary Data to Codewords

Parameters

Returns

executeStep4()

executeStep4(array<mixed,integer>  $codewords, integer  $crc) : array<mixed,integer>

Executes Step 4: Inserting Additional Information into Codewords

Parameters

Returns

executeStep5()

executeStep5(array<mixed,integer>  $codewords, integer  $crc) : array<mixed,integer>

Executes Step 5: Conversion from Codewords to Characters

Parameters

Returns

executeStep6()

executeStep6(array<mixed,integer>  $characters) : string

Executes Step 6: Conversion from Characters to the Intelligent Mail Barcode

Parameters

Returns

conversionRoutingCode()

conversionRoutingCode(string  $zipcode) : string

Converts the routing code zipcode.

Parameters

Returns

BCNumber

conversionTrackingCode()

conversionTrackingCode(string  $number, string  $barcodeIdentifier, string  $serviceTypeIdentifier, string  $mailerIdentifier, string  $serialNumber) : string

Converts the tracking code number.

Parameters

Returns

BCNumber

bcdecuc()

bcdecuc(string  $dec) 

Transforms a BCNumber into unsigned char*.

Parameters