\BCGcode128

__construct()

__construct(\char  $start = null) 

Constructor.

Parameters

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.

setStart()

setStart(string  $table) 

Specifies the start code. Can be 'A', 'B', 'C', or null - Table A: Capitals + ASCII 0-31 + punct - Table B: Capitals + LowerCase + punct - Table C: Numbers

If null is specified, the table selection is automatically made. The default is null.

Parameters

getTilde()

getTilde() : boolean

Gets the tilde.

Returns

setTilde()

setTilde(boolean  $accept) 

Accepts tilde to be process as a special character.

If true, you can do this:

• ~~ : to make ONE tilde
• ~Fx : to insert FCNx. x is equal from 1 to 4.

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) 

Draws all chars thanks to $code. If $startBar is true, the line begins by a space.

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() 

Overloaded method to calculate checksum.

processChecksum()

processChecksum() : string

Overloaded method to display the checksum.

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

setStartFromText()

setStartFromText(string  $text) 

Specifies the starting_text table if none has been specified earlier.

Parameters

extractTilde()

extractTilde(string  $text, integer  $pos) : string

Extracts the ~ value from the $text at the $pos.

If the tilde is not ~~, ~F1, ~F2, ~F3, ~F4; an error is raised.

Parameters

Returns

getSequenceParsed()

getSequenceParsed(string  $text, string  $currentMode) : string

Gets the "dotted" sequence for the $text based on the $currentMode.

There is also a check if we use the special tilde ~

Parameters

Returns

setParseA()

setParseA(string  $text, string  $currentMode) : string

Parses the text and returns the appropriate sequence for the Table A.

Parameters

Returns

setParseB()

setParseB(string  $text, string  $currentMode) : string

Parses the text and returns the appropriate sequence for the Table B.

Parameters

Returns

setParseC()

setParseC(string  $text, string  $currentMode) : string

Parses the text and returns the appropriate sequence for the Table C.

Parameters

Returns

getSequence()

getSequence(string  $text, string  $starting_text) : string

Depending on the $text, it will return the correct sequence to encode the text.

Parameters

Returns

createBinaryStream()

createBinaryStream(string  $text, string  $seq) : array<mixed,string[]>

Depending on the sequence $seq given (returned from getSequence()), this method will return the code stream in an array. Each char will be a string of bit based on the Code 128.

Each letter from the sequence represents bits.

0 to 2 are latches A to B are Shift + Letter . is a char in the current encoding

Parameters

Returns

encodeChar()

encodeChar(array<mixed,integer>  $data, integer  $encoding, string  $seq, string  $text, integer  $i, integer  $counter, array<mixed,integer>  $indcheck) 

Encodes characters, base on its encoding and sequence

Parameters

setData()

setData(array  $data) 

Saves data into the classes.

This method will save data, calculate real column number (if -1 was selected), the real error level (if -1 was selected)... It will add Padding to the end and generate the error codes.

Parameters