Manual - MSI Plessey
Introduction
MSI Code allows you to encode numbers. It contains an optional checksum. You must specify to your reader that you have encoded a checksum, otherwise it will be displayed when the code is read.
This class inherits the BCGBarcode1D class.
Example
Methods
BCGmsi's Methods
-
setChecksum(
$checksum ) — Specifies if a checksum must be added
BCGBarcode1D's Methods
- getThickness() — Returns the thickness of the barcode
-
setThickness(
$thickness ) — Specifies the thickness of the barcode - getLabel() — Gets the label
-
setLabel(
$label ) — Sets the label - getFont() — Gets the text font for the label
-
setFont(
$font ) — Sets the text font for the label - getChecksum() — Gets the checksum appended to the barcode
-
setDisplayChecksum(
$display ) — Specifies the checksum to be added to the label
BCGBarcode's Methods
-
parse(
$text ) — Analyzes a$text message to draw afterwards -
draw(
$image ) — Draws the barcode on the$image -
getDimension(
$width ,$height ) — Returns an array containing the required size for the image - getScale() — Gets the scale of the barcode
-
setScale(
$scale ) — Sets the scale of the barcode - getForegroundColor() — Gets the color of the bars
-
setForegroundColor(
$color ) — Sets the color of the bars - getBackgroundColor() — Gets the color of the spaces
-
setBackgroundColor(
$color ) — Sets the color of the spaces -
setColor(
$foregroundColor ,$backgroundColor ) — Sets the color of the bars and spaces - getOffsetX() — Gets the X offset
-
setOffsetX(
$value ) — Sets the X offset - getOffsetY() — Gets the Y offset
-
setOffsetY(
$value ) — Sets the Y offset -
addLabel(
$label ) — Adds a label to the graphic -
removeLabel(
$label ) — Removes a label from the graphic - clearLabels() — Removes the labels from the graphic
Code Example
<?php
use BarcodeBakery\Common\BCGFontFile;
use BarcodeBakery\Common\BCGColor;
use BarcodeBakery\Common\BCGDrawing;
use BarcodeBakery\Barcode\BCGmsi;
$font = new BCGFontFile(__DIR__ . '/font/Arial.ttf', 18);
$colorBlack = new BCGColor(0, 0, 0);
$colorWhite = new BCGColor(255, 255, 255);
// Barcode Part
$code = new BCGmsi();
$code->setScale(2);
$code->setThickness(30);
$code->setForegroundColor($colorBlack);
$code->setBackgroundColor($colorWhite);
$code->setFont($font);
$code->setChecksum(0);
$code->parse('12345');
// Drawing Part
$drawing = new BCGDrawing($code, $colorWhite);
header('Content-Type: image/png');
$drawing->finish(BCGDrawing::IMG_FORMAT_PNG);
?>
Method explanations
-
setChecksum(
$checksum ) — Specifies if a checksum must be addedDescriptionSpecifies if a checksum must be added.
You can add 1, or 2 checksums.
-
getThickness()
—
Returns the thickness of the barcode
DescriptionThe thickness of the barcode in pixels. The value isn't multiplied by the scale.Returns
int - value in pixels -
setThickness(
$thickness ) — Specifies the thickness of the barcodeDescriptionThe thickness of the barcode in pixels. This is the vertical size. -
getLabel()
—
Gets the label
DescriptionReturns the real value that will be displayed with the barcode. You have to have called the
parse() method first.Returnsstring - final label -
setLabel(
$label ) — Sets the labelDescriptionThe text label will be written below or above the barcode depending on the barcode. You can write the special valueBCGBarcode1D::AUTO_LABEL if you would like your text to be chosen automatically. It will be the value passed to theparse() method. -
getFont()
—
Gets the text font for the label
DescriptionGets the text font for the label.Returns
-
setFont(
$font ) — Sets the text font for the labelDescriptionThe value of the argument can be either an instance of theBCGFontFile class,BCGFontPhp , or a number between 1 and 5.
If you are using numbers 1 through 5, PHP fonts are used. Check the PHP Manual. -
getChecksum()
—
Gets the checksum appended to the barcode
DescriptionReturns the value that will be appended to the barcode. This method must be called after the method
parse() .Returnsint - checksum added orfalse if no checkum is included -
setDisplayChecksum(
$display ) — Specifies the checksum to be added to the labelDescriptionSettingtrue will append the checksum to the default label.
The default value is true.
-
parse(
$text ) — Analyzes a$text message to draw afterwardsDescriptionThe data you pass to the$text argument must be supported by the type of barcode you use.
Check each barcode's introduction section to obtain more information on how to use this method within each symbology. -
draw(
$image ) — Draws the barcode on the$image DescriptionThe value of the$image argument must be an image resource. The size of the image can be defined by the value received fromgetDimension() . -
getDimension(
$width ,$height ) — Returns an array containing the required size for the imageDescriptionReturns an array in which the first index is the image width and the second index is the image height.
The arguments are used to specify the starting point of the drawing. Should be 0 for both.
TheBCGDrawing class uses this method to create the image resource.Returnsarray(int, int) - [0] is the width, [1] is the height -
getScale()
—
Gets the scale of the barcode
DescriptionGets the scale of the barcode. The value is the number of the "smallest" unit in pixel.Returns
int - value in pixels -
setScale(
$scale ) — Sets the scale of the barcodeDescriptionThe barcode will be$x times bigger. Then a pixel will be$x by$x for its size. -
getForegroundColor()
—
Gets the color of the bars
DescriptionGets the color of the bars of the barcode.Returns
-
setForegroundColor(
$color ) — Sets the color of the bars -
getBackgroundColor()
—
Gets the color of the spaces
DescriptionGets the color of the spaces of the barcode.Returns
-
setBackgroundColor(
$color ) — Sets the color of the spaces -
setColor(
$foregroundColor ,$backgroundColor ) — Sets the color of the bars and spacesDescriptionAn easy and fast method to set the color of the bars and spaces. Check thesetForegroundColor() andsetBackgroundColor() . -
getOffsetX()
—
Gets the X offset
DescriptionGets the X offset of the barcode in pixels. The value isn't multiplied by the scale.Returns
int - value in pixels -
setOffsetX(
$value ) — Sets the X offsetDescriptionSpecifies the X offset of the barcode in pixels multiplied by the scale. The required size returned bygetDimension() will be modified accordingly. -
getOffsetY()
—
Gets the Y offset
DescriptionGets the Y offset of the barcode in pixels. The value isn't multiplied by the scale.Returns
int - value in pixels -
setOffsetY(
$value ) — Sets the Y offsetDescriptionSpecifies the Y offset of the barcode in pixels multiplied by the scale. The required size returned bygetDimension() will be modified accordingly. -
addLabel(
$label ) — Adds a label to the graphicDescriptionAdds aBCGLabel object to the drawing. -
removeLabel(
$label ) — Removes a label from the graphicDescriptionRemoves a specificBCGLabel object from the drawing. -
clearLabels()
—
Removes the labels from the graphic
DescriptionClears the
BCGLabel objects from the drawing.