Manual - BCGpdf417

Introduction

PDF417 code comes from the 2D barcode family. You can encode a large amount of information within a single barcode.
All the ASCII characters from 0 to 255 are supported. PDF417 encodes the data differently based on the type of characters provided. Some characters are encoded with a higher compression level. See the compression level on the technical page.

This class inherits the BCGBarcode2D class.

Example

Methods

BCGpdf417's Methods

BCGBarcode2D's Methods

BCGBarcode's Methods

Code Example


<?php
use BarcodeBakery\Common\BCGColor;
use BarcodeBakery\Common\BCGDrawing;
use BarcodeBakery\Barcode\BCGpdf417;

$colorFront = new BCGColor(0, 0, 0);
$colorBack = new BCGColor(255, 255, 255);

// Barcode Part
$code = new BCGpdf417();
$code->setScale(3);
$code->setForegroundColor($colorFront);
$code->setBackgroundColor($colorBack);
$code->setErrorLevel(2);
$code->setCompact(false);
$code->setQuietZone(true);
$code->parse('PDF417');

// Drawing Part
$drawing = new BCGDrawing('', $colorBack);
$drawing->setBarcode($code);
$drawing->draw();

header('Content-Type: image/png');

$drawing->finish(BCGDrawing::IMG_FORMAT_PNG);
?>

Method explanations

  • getQuietZone() — Gets if the quiet zone will be drawn
    Returns
    bool - true if activated, false otherwise
  • setQuietZone($quietZone) — Specifies to draw a quiet zone around the barcode
    Description
    To be read correctly, the PDF417 must have a quiet zone around the image. You can, however, turn this off.
    The default value is true.
  • getCompact() — Gets if the barcode will be compact/truncated
    Description
    Gets if the barcode will be compact/truncated.
    Returns
    bool - true if compact/truncated
  • setCompact($compact) — Specifies if the barcode must be compact/truncated
    Description
    Cuts the barcode by removing the 2 last columns on the right. Your barcode will be smaller but harder to read.
    The default value is false.
  • getColumn() — Gets the number of data column
    Description
    Gets the number of columns.
    Returns
    int
  • setColumn($column) — Sets the number of data column
    Description
    Specifies the number of data columns you want to write. You can spread your data more horizontally than vertically by modifying this parameter.
    The number of columns must be between 1 and 30.
    Setting the value to -1 makes the barcode calculate this number automatically and optimize it.
    The default value is -1.
  • getErrorLevel() — Gets the error correction level of the barcode
    Description
    Gets the error level.
    Returns
    int
  • setErrorLevel($level) — Sets the error correction level of the barcode
    Description
    This is the error correction level which allows you to detect and correct errors in the barcode.
    The level must be between 0 and 8.
    Setting this value calculates the error level automatically by trying to obtain optimal error detection.
    The number of keywords you write will be restricted depending on the error level you choose. See the technical page for more information.
    The default value is -1.
  • getRatio() — Gets the ratio for printing
    Description
    Gets the ratio for printing.
    Returns
    int
  • setRatio($ratio) — Sets the ratio for printing
    Description
    Sets the ratio for printing. This is used only if the number of columns is chosen automatically since this parameter will affect the number of columns in your barcode.
    If the number is under 1, the barcode will be spread more horizontally.
    The default value is -1.
  • 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 public.
  • 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 public.
  • 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 an 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($scale) — 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 bars
    Description
    Gets the color of the bars of the barcode.
    Returns
  • setForegroundColor($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.
  • getBackgroundColor() — Gets the color of the spaces
    Description
    Gets the color of the spaces of the barcode.
    Returns
  • setBackgroundColor($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.
  • 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($value) — 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($value) — 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.