Manual - BCGdatabarexpanded

Introduction

Databar Expanded (formerly RSS Expanded) encodes data based on the GS1 organization standard. Failure to comply with this standard may result in an unreadable barcode.

To see the supported characters and supported encodation modes, see the overview page.

These barcodes are always composed of an identifier followed by its value. Since the parentheses can be a possible value, you mustn't wrap the identifier with parentheses.
Databar Expanded can contain multiple identifiers. If you are using a variable length identifier, you must terminate its value by a FNC1 character unless the value ends the barcode.

The minimal height must be 34 pixels.

Identifiers list:

This class inherits the BCGBarcode1D class.

Example

BCGdatabarexpanded's Methods

• getLinkageFlag() —‌ Gets if the linkage flag is active
• setLinkageFlag($linkageFlag) —‌ Specifies to use the linkage flag
• setStacked($stackedRow) —‌ Sets the number of desired rows

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($im) —‌ Draws the barcode on the $im
• getDimension($w, $h) —‌ Returns an array containing the required size for the image
• getScale() —‌ Gets the scale of the barcode
• setScale($x) —‌ Sets the scale of the barcode
• getForegroundColor() —‌ Gets the color of the spaces
• setForegroundColor($color) —‌ Sets the color of the spaces
• getBackgroundColor() —‌ Gets the color of the bars
• setBackgroundColor($color) —‌ Sets the color of the bars
• setColor($fg, $bg) —‌ Sets the color of the bars and spaces
• getOffsetX() —‌ Gets the X offset
• setOffsetX($v) —‌ Sets the X offset
• getOffsetY() —‌ Gets the Y offset
• setOffsetY($v) —‌ 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
require('class/BCGFontFile.php');
require('class/BCGColor.php');
require('class/BCGDrawing.php');
require('class/BCGdatabarexpanded.barcode.php');
 
$font = new BCGFontFile('./class/font/Arial.ttf', 18);
$color_black = new BCGColor(0, 0, 0);
$color_white = new BCGColor(255, 255, 255);
 
// Barcode Part
$code = new BCGdatabarexpanded();
$code->setScale(2);
$code->setThickness(30);
$code->setForegroundColor($color_black);
$code->setBackgroundColor($color_white);
$code->setFont($font);
$code->parse('0190012345678908');
 
// Drawing Part
$drawing = new BCGDrawing('', $color_white);
$drawing->setBarcode($code);
$drawing->draw();
 
header('Content-Type: image/png');
 
$drawing->finish(BCGDrawing::IMG_FORMAT_PNG);
?>

Methods Explanation

• getLinkageFlag() — Gets if the linkage flag is active
  Description

  Gets if the linkage flag is active.
  Returns

  bool
• setLinkageFlag($linkageFlag) — Specifies to use the linkage flag
  Description

  Specifies to use the linkage flag, it is used in conjunction with a UCC/EAN barcode.
  Setting this property to true won't change the size of your barcode.
  The default value is false.
• setStacked($stackedRow) — Sets the number of desired rows
  Description

  Sets the number of desired rows. The maximum number allowed is 11.
  Some values won't be possible; if you are using a fixed length encodation, the maximum number of rows will be 2.
  If the linkage flag is activated, the width of the barcode must be at least 102 pixels.
  The default value is 1.
• getThickness() — Returns the thickness of the barcode
  Description

  The 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 barcode
  Description

  The thickness of the barcode in pixels. This is the vertical size.
  This value is multiplied by the scale. Check the setScale() method.
  The default value is 30.
• getLabel() — Gets the label
  Description

  Returns the real value that will be displayed with the barcode. You have to have called the parse() method first.
  Returns

  string - final label
• setLabel($label) — Sets the label
  Description

  The text label will be written below or above the barcode depending on the barcode. You can write the special value BCGBarcode1D::AUTO_LABEL if you would like your text to be chosen automatically. It will be the value passed to the parse() method.
• getFont() — Gets the text font for the label
  Description

  Gets the text font of the label.
  Returns

  BCGFontFile, BCGFontPhp or int
• setFont($font) — Sets the text font for the label
  Description

  The value of the argument can be either an instance of the BCGFontFile 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
  Description

  Returns the value that will be appended to the barcode. This method must be called after the method parse().
  Returns

  int - checksum added or false if no checkum is included
• setDisplayChecksum($display) — Specifies the checksum to be added to the label
  Description

  Setting true will append the checksum to the default label.
  The default value is true.
• parse($text) — Analyzes a $text message to draw afterwards
  Description

  The 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($im) — Draws the barcode on the $im
  Description

  The value of the $im argument must be a GD2 image resource. The size of the image can be defined by the value received from getDimension().
• getDimension($w, $h) — Returns an array containing the required size for the image
  Description

  Returns 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.
  The BCGDrawing class uses this method to create the image resource.
  Returns

  array(int, int) - [0] is the width, [1] is the height
• getScale() — Gets the scale of the barcode
  Description

  Gets the scale of the barcode. The value is the number of the "smallest" unit in pixel.
  Returns

  int - value in pixels
• setScale($x) — Sets the scale of the barcode
  Description

  The barcode will be $x times bigger. Then a pixel will be $x by $x for its size.
• getForegroundColor() — Gets the color of the spaces
  Description

  Gets the color of the spaces of the barcode.
  Returns

  BCGColor
• setForegroundColor($color) — Sets the color of the spaces
  Description

  Sets the color of the spaces of the barcode. By default, the color is white. This argument can be a BCGColor class or any other argument that BCGColor can accept in its constructor.
• getBackgroundColor() — Gets the color of the bars
  Description

  Gets the color of the bars of the barcode.
  Returns

  BCGColor
• setBackgroundColor($color) — Sets the color of the bars
  Description

  Sets the color of the bars of the barcode. By default, the color is black. This argument can be a BCGColor class or any other argument that BCGColor can accept in its constructor.
• setColor($fg, $bg) — Sets the color of the bars and spaces
  Description

  An easy and fast method to set the color of the bars and spaces. Check the setForegroundColor() and setBackgroundColor().
• getOffsetX() — Gets the X offset
  Description

  Gets the X offset of the barcode in pixels. The value isn't multiplied by the scale.
  Returns

  int - value in pixels
• setOffsetX($v) — Sets the X offset
  Description

  Specifies the X offset of the barcode in pixels multiplied by the scale. The required size returned by getDimension() will be modified accordingly.
• getOffsetY() — Gets the Y offset
  Description

  Gets the Y offset of the barcode in pixels. The value isn't multiplied by the scale.
  Returns

  int - value in pixels
• setOffsetY($v) — Sets the Y offset
  Description

  Specifies the Y offset of the barcode in pixels multiplied by the scale. The required size returned by getDimension() will be modified accordingly.
• addLabel($label) — Adds a label to the graphic
  Description

  Adds a BCGLabel object to the drawing.
• removeLabel($label) — Removes a label from the graphic
  Description

  Removes a specific BCGLabel object from the drawing.
• clearLabels() — Removes the labels from the graphic
  Description

  Clears the BCGLabel objects from the drawing.