Manual - BCGBarcode2D

Introduction

This class is an abstract class that contains the base methods to create 2D barcodes only.

This class inherits the BCGBarcode class.

BCGBarcode2D's Methods

• setScaleX($scaleX) —‌ Sets the scaling X for the barcode
• setScaleY($scaleY) —‌ Sets the scaling Y for the barcode

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

// To get an example of how to use this class, check children classes.

Methods Explanation

• setScaleX($scaleX) — Sets the scaling X for the barcode
  Description

  The width in pixel of one module.
  The default value is 1.
  Note that this method is protected.
• setScaleY($scaleY) — Sets the scaling Y for the barcode
  Description

  The height in pixel of one module.
  The default value is 1.
  Note that this method is protected.
• 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.