TCPDFBarcode

class

TCPDFBarcode PHP class to creates array representations for common 1D barcodes to be used with TCPDF (http://www.tcpdf.org).

package

com.tecnick.tcpdf

version 1.0.027
author

Nicola Asuni

Methods

This is the class constructor.

__construct(string $code,string $type)

Return an array representations for common 1D barcodes:

  • $arrcode['code'] code to be printed on text label
  • $arrcode['maxh'] max barcode height
  • $arrcode['maxw'] max barcode width
  • $arrcode['bcode'][$k] single bar or space in $k position
  • $arrcode['bcode'][$k]['t'] bar type: true = bar, false = space.
  • $arrcode['bcode'][$k]['w'] bar width in units.
  • $arrcode['bcode'][$k]['h'] bar height in units.
  • $arrcode['bcode'][$k]['p'] bar top position (0 = top, 1 = middle)
public

Arguments

$code

string

code to print

$type

string

type of barcode:

  • C39 : CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.
  • C39+ : CODE 39 with checksum
  • C39E : CODE 39 EXTENDED
  • C39E+ : CODE 39 EXTENDED + CHECKSUM
  • C93 : CODE 93 - USS-93
  • S25 : Standard 2 of 5
  • S25+ : Standard 2 of 5 + CHECKSUM
  • I25 : Interleaved 2 of 5
  • I25+ : Interleaved 2 of 5 + CHECKSUM
  • C128 : CODE 128
  • C128A : CODE 128 A
  • C128B : CODE 128 B
  • C128C : CODE 128 C
  • EAN2 : 2-Digits UPC-Based Extension
  • EAN5 : 5-Digits UPC-Based Extension
  • EAN8 : EAN 8
  • EAN13 : EAN 13
  • UPCA : UPC-A
  • UPCE : UPC-E
  • MSI : MSI (Variation of Plessey code)
  • MSI+ : MSI + CHECKSUM (modulo 11)
  • POSTNET : POSTNET
  • PLANET : PLANET
  • RMS4CC : RMS4CC (Royal Mail 4-state Customer Code) - CBC (Customer Bar Code)
  • KIX : KIX (Klant index - Customer index)
  • IMB: Intelligent Mail Barcode - Onecode - USPS-B-3200
  • CODABAR : CODABAR
  • CODE11 : CODE 11
  • PHARMA : PHARMACODE
  • PHARMA2T : PHARMACODE TWO-TRACKS

C128 barcodes.

barcode_c128(string $code,string $type = ''): array

Very capable code, excellent density, high reliability; in very wide use world-wide

protected

Arguments

$code

string

code to represent.

$type

string

barcode type: A, B, C or empty for automatic switch (AUTO mode)

Response

array

barcode representation.

CODABAR barcodes.

barcode_codabar(string $code): array

Older code often used in library systems, sometimes in blood banks

protected

Arguments

$code

string

code to represent.

Response

array

barcode representation.

CODE11 barcodes.

barcode_code11(string $code): array

Used primarily for labeling telecommunications equipment

protected

Arguments

$code

string

code to represent.

Response

array

barcode representation.

CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.

barcode_code39(string $code,boolean $extended = false,boolean $checksum = false): array

General-purpose code in very wide use world-wide

protected

Arguments

$code

string

code to represent.

$extended

boolean

if true uses the extended mode.

$checksum

boolean

if true add a checksum to the code.

Response

array

barcode representation.

CODE 93 - USS-93 Compact code similar to Code 39

barcode_code93(string $code): array
protected

Arguments

$code

string

code to represent.

Response

array

barcode representation.

UPC-Based Extensions 2-Digit Ext.: Used to indicate magazines and newspaper issue numbers 5-Digit Ext.: Used to mark suggested retail price of books

barcode_eanext(string $code,string $len = 5): array
protected

Arguments

$code

string

code to represent.

$len

string

barcode type: 2 = 2-Digit, 5 = 5-Digit

Response

array

barcode representation.

EAN13 and UPC-A barcodes.

barcode_eanupc(string $code,string $len = 13): array

EAN13: European Article Numbering international retail product code UPC-A: Universal product code seen on almost all retail products in the USA and Canada UPC-E: Short version of UPC symbol

protected

Arguments

$code

string

code to represent.

$len

string

barcode type: 6 = UPC-E, 8 = EAN8, 13 = EAN13, 12 = UPC-A

Response

array

barcode representation.

Interleaved 2 of 5 barcodes.

barcode_i25(string $code,boolean $checksum = false): array

Compact numeric code, widely used in industry, air cargo Contains digits (0 to 9) and encodes the data in the width of both bars and spaces.

protected

Arguments

$code

string

code to represent.

$checksum

boolean

if true add a checksum to the code

Response

array

barcode representation.

IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200 (requires PHP bcmath extension) Intelligent Mail barcode is a 65-bar code for use on mail in the United States.

barcode_imb(string $code): array

The fields are described as follows:

  • The Barcode Identifier shall be assigned by USPS to encode the presort identification that is currently printed in human readable form on the optional endorsement line (OEL) as well as for future USPS use. This shall be two digits, with the second digit in the range of 0–4. The allowable encoding ranges shall be 00–04, 10–14, 20–24, 30–34, 40–44, 50–54, 60–64, 70–74, 80–84, and 90–94.
  • The Service Type Identifier shall be assigned by USPS for any combination of services requested on the mailpiece. The allowable encoding range shall be 000http://it2.php.net/manual/en/function.dechex.php–999. Each 3-digit value shall correspond to a particular mail class with a particular combination of service(s). Each service program, such as OneCode Confirm and OneCode ACS, shall provide the list of Service Type Identifier values.
  • The Mailer or Customer Identifier shall be assigned by USPS as a unique, 6 or 9 digit number that identifies a business entity. The allowable encoding range for the 6 digit Mailer ID shall be 000000- 899999, while the allowable encoding range for the 9 digit Mailer ID shall be 900000000-999999999.
  • The Serial or Sequence Number shall be assigned by the mailer for uniquely identifying and tracking mailpieces. The allowable encoding range shall be 000000000–999999999 when used with a 6 digit Mailer ID and 000000-999999 when used with a 9 digit Mailer ID. e. The Delivery Point ZIP Code shall be assigned by the mailer for routing the mailpiece. This shall replace POSTNET for routing the mailpiece to its final delivery point. The length may be 0, 5, 9, or 11 digits. The allowable encoding ranges shall be no ZIP Code, 00000–99999, 000000000–999999999, and 00000000000–99999999999.

protected

Arguments

$code

string

code to print, separate the ZIP (routing code) from the rest using a minus char '-' (BarcodeID_ServiceTypeID_MailerID_SerialNumber-RoutingCode)

Response

array

barcode representation.

IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200

barcode_imb_pre(string $code): array
protected

Arguments

$code

string

pre-formatted IMB barcode (65 chars "FADT")

Response

array

barcode representation.

MSI.

barcode_msi(string $code,boolean $checksum = false): array

Variation of Plessey code, with similar applications Contains digits (0 to 9) and encodes the data only in the width of bars.

protected

Arguments

$code

string

code to represent.

$checksum

boolean

if true add a checksum to the code (modulo 11)

Response

array

barcode representation.

Pharmacode Contains digits (0 to 9)

barcode_pharmacode(string $code): array
protected

Arguments

$code

string

code to represent.

Response

array

barcode representation.

Pharmacode two-track Contains digits (0 to 9)

barcode_pharmacode2t(string $code): array
protected

Arguments

$code

string

code to represent.

Response

array

barcode representation.

POSTNET and PLANET barcodes.

barcode_postnet(string $code,boolean $planet = false): array

Used by U.S. Postal Service for automated mail sorting

protected

Arguments

$code

string

zip code to represent. Must be a string containing a zip code of the form DDDDD or DDDDD-DDDD.

$planet

boolean

if true print the PLANET barcode, otherwise print POSTNET

Response

array

barcode representation.

RMS4CC - CBC - KIX RMS4CC (Royal Mail 4-state Customer Code) - CBC (Customer Bar Code) - KIX (Klant index - Customer index) RM4SCC is the name of the barcode symbology used by the Royal Mail for its Cleanmail service.

barcode_rms4cc(string $code,boolean $kix = false): array
protected

Arguments

$code

string

code to print

$kix

boolean

if true prints the KIX variation (doesn't use the start and end symbols, and the checksum) - in this case the house number must be sufficed with an X and placed at the end of the code.

Response

array

barcode representation.

Standard 2 of 5 barcodes.

barcode_s25(string $code,boolean $checksum = false): array

Used in airline ticket marking, photofinishing Contains digits (0 to 9) and encodes the data only in the width of bars.

protected

Arguments

$code

string

code to represent.

$checksum

boolean

if true add a checksum to the code

Response

array

barcode representation.

Convert binary barcode sequence to WarnockPDF barcode array.

binseq_to_array(string $seq,array $bararray): array
protected

Arguments

$seq

string

barcode as binary sequence.

$bararray

array

barcode array to fill up

Response

array

barcode representation.

Calculate CODE 39 checksum (modulo 43).

checksum_code39(string $code): string
protected

Arguments

$code

string

code to represent.

Response

string

char checksum.

Calculate CODE 93 checksum (modulo 47).

checksum_code93(string $code): string
protected

Arguments

$code

string

code to represent.

Response

string

checksum code.

Checksum for standard 2 of 5 barcodes.

checksum_s25(string $code): integer
protected

Arguments

$code

string

code to process.

Response

integer

checksum.

Convert large integer number to hexadecimal representation.

dec_to_hex(string $number): string

(requires PHP bcmath extension)

Arguments

$number

string

number to convert specified as a string

Response

string

hexadecimal representation

Encode a string to be used for CODE 39 Extended mode.

encode_code39_ext(string $code): string
protected

Arguments

$code

string

code to represent.

Response

string

encoded string.

Split text code in A/B sequence for 128 code

get128ABsequence(string $code): array
protected

Arguments

$code

string

code to split.

Response

array

sequence

Return an array representations of barcode.

getBarcodeArray(): array
public

Response

array

Return an HTML representation of barcode.

getBarcodeHTML(integer $w = 2,integer $h = 30,string $color = 'black'): string
public

Arguments

$w

integer

Width of a single bar element in pixels.

$h

integer

Height of a single bar element in pixels.

$color

string

Foreground color for bar elements (background is transparent).

Response

string

HTML code.

Send a PNG image representation of barcode (requires GD or Imagick library).

getBarcodePNG(integer $w = 2,integer $h = 30,array $color = array(0, 0, 0))
public

Arguments

$w

integer

Width of a single bar element in pixels.

$h

integer

Height of a single bar element in pixels.

$color

array

RGB (0-255) foreground color for bar elements (background is transparent).

Return a PNG image representation of barcode (requires GD or Imagick library).

getBarcodePngData(integer $w = 2,integer $h = 30,array $color = array(0, 0, 0)): string|\Imagick|false
public

Arguments

$w

integer

Width of a single bar element in pixels.

$h

integer

Height of a single bar element in pixels.

$color

array

RGB (0-255) foreground color for bar elements (background is transparent).

Response

string|\Imagick|false

image or false in case of error.

Send barcode as SVG image object to the standard output.

getBarcodeSVG(integer $w = 2,integer $h = 30,string $color = 'black')
public

Arguments

$w

integer

Minimum width of a single bar in user units.

$h

integer

Height of barcode in user units.

$color

string

Foreground color (in SVG format) for bar elements (background is transparent).

Return a SVG string representation of barcode.

getBarcodeSVGcode(integer $w = 2,integer $h = 30,string $color = 'black'): string
public

Arguments

$w

integer

Minimum width of a single bar in user units.

$h

integer

Height of barcode in user units.

$color

string

Foreground color (in SVG format) for bar elements (background is transparent).

Response

string

SVG code.

Convert large hexadecimal number to decimal representation (string).

hex_to_dec(string $hex): string

(requires PHP bcmath extension)

Arguments

$hex

string

hexadecimal number to convert specified as a string

Response

string

hexadecimal representation

Intelligent Mail Barcode calculation of Frame Check Sequence

imb_crc11fcs(string $code_arr): integer
protected

Arguments

$code_arr

string

array of hexadecimal values (13 bytes holding 102 bits right justified).

Response

integer

11 bit Frame Check Sequence as integer (decimal base)

Reverse unsigned short value

imb_reverse_us(integer $num): integer
protected

Arguments

$num

integer

value to reversr

Response

integer

reversed value

generate Nof13 tables used for Intelligent Mail Barcode

imb_tables(integer $n,integer $size): array
protected

Arguments

$n

integer

is the type of table: 2 for 2of13 table, 5 for 5of13table

$size

integer

size of table (78 for n=2 and 1287 for n=5)

Response

array

requested table

Set the barcode.

setBarcode(string $code,string $type): void
public

Arguments

$code

string

code to print

$type

string

type of barcode:

  • C39 : CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.
  • C39+ : CODE 39 with checksum
  • C39E : CODE 39 EXTENDED
  • C39E+ : CODE 39 EXTENDED + CHECKSUM
  • C93 : CODE 93 - USS-93
  • S25 : Standard 2 of 5
  • S25+ : Standard 2 of 5 + CHECKSUM
  • I25 : Interleaved 2 of 5
  • I25+ : Interleaved 2 of 5 + CHECKSUM
  • C128 : CODE 128
  • C128A : CODE 128 A
  • C128B : CODE 128 B
  • C128C : CODE 128 C
  • EAN2 : 2-Digits UPC-Based Extension
  • EAN5 : 5-Digits UPC-Based Extension
  • EAN8 : EAN 8
  • EAN13 : EAN 13
  • UPCA : UPC-A
  • UPCE : UPC-E
  • MSI : MSI (Variation of Plessey code)
  • MSI+ : MSI + CHECKSUM (modulo 11)
  • POSTNET : POSTNET
  • PLANET : PLANET
  • RMS4CC : RMS4CC (Royal Mail 4-state Customer Code) - CBC (Customer Bar Code)
  • KIX : KIX (Klant index - Customer index)
  • IMB: Intelligent Mail Barcode - Onecode - USPS-B-3200
  • IMBPRE: Pre-processed Intelligent Mail Barcode - Onecode - USPS-B-3200, using only F,A,D,T letters
  • CODABAR : CODABAR
  • CODE11 : CODE 11
  • PHARMA : PHARMACODE
  • PHARMA2T : PHARMACODE TWO-TRACKS

Properties

Array representation of barcode.

barcode_array :
protected

Type(s)