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

Public Member Functions
	__construct ($code, $type)
	This is the class constructor.

	dec_to_hex ($number)
	Convert large integer number to hexadecimal representation.

	getBarcodeArray ()
	Return an array representations of barcode.

	getBarcodeHTML ($w=2, $h=30, $color='black')
	Return an HTML representation of barcode.

	getBarcodePNG ($w=2, $h=30, $color=array(0, 0, 0))
	Send a PNG image representation of barcode (requires GD or Imagick library).

	getBarcodePngData ($w=2, $h=30, $color=array(0, 0, 0))
	Return a PNG image representation of barcode (requires GD or Imagick library).

	getBarcodeSVG ($w=2, $h=30, $color='black')
	Send barcode as SVG image object to the standard output.

	getBarcodeSVGcode ($w=2, $h=30, $color='black')
	Return a SVG string representation of barcode.

	hex_to_dec ($hex)
	Convert large hexadecimal number to decimal representation (string).

	setBarcode ($code, $type)
	Set the barcode.

Protected Member Functions
	barcode_c128 ($code, $type='')
	C128 barcodes.

	barcode_codabar ($code)
	CODABAR barcodes.

	barcode_code11 ($code)
	CODE11 barcodes.

	barcode_code39 ($code, $extended=false, $checksum=false)
	CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.

	barcode_code93 ($code)
	CODE 93 - USS-93 Compact code similar to Code 39.

	barcode_eanext ($code, $len=5)
	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_eanupc ($code, $len=13)
	EAN13 and UPC-A barcodes.

	barcode_i25 ($code, $checksum=false)
	Interleaved 2 of 5 barcodes.

	barcode_imb ($code)
	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_pre ($code)
	IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200.

	barcode_msi ($code, $checksum=false)
	MSI.

	barcode_pharmacode ($code)
	Pharmacode Contains digits (0 to 9)

	barcode_pharmacode2t ($code)
	Pharmacode two-track Contains digits (0 to 9)

	barcode_postnet ($code, $planet=false)
	POSTNET and PLANET barcodes.

	barcode_rms4cc ($code, $kix=false)
	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_s25 ($code, $checksum=false)
	Standard 2 of 5 barcodes.

	binseq_to_array ($seq, $bararray)
	Convert binary barcode sequence to WarnockPDF barcode array.

	checksum_code39 ($code)
	Calculate CODE 39 checksum (modulo 43).

	checksum_code93 ($code)
	Calculate CODE 93 checksum (modulo 47).

	checksum_s25 ($code)
	Checksum for standard 2 of 5 barcodes.

	encode_code39_ext ($code)
	Encode a string to be used for CODE 39 Extended mode.

	get128ABsequence ($code)
	Split text code in A/B sequence for 128 code.

	imb_crc11fcs ($code_arr)
	Intelligent Mail Barcode calculation of Frame Check Sequence.

	imb_reverse_us ($num)
	Reverse unsigned short value.

	imb_tables ($n, $size)
	generate Nof13 tables used for Intelligent Mail Barcode

Protected Attributes
	$barcode_array = array()
	Array representation of barcode.

Detailed Description

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

..

Version: 1.0.027

Author: Nicola Asuni

Constructor & Destructor Documentation

◆ __construct()

TCPDFBarcode::__construct	(		$code,
			$type )

This is the class constructor.

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)

Parameters

string	$code	code to print
string	$type	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

Member Function Documentation

◆ barcode_c128()

TCPDFBarcode::barcode_c128	(		$code,
			$type = '' )

protected

C128 barcodes.

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

Parameters

string	$code	code to represent.
string	$type	barcode type: A, B, C or empty for automatic switch (AUTO mode)

Return values

array barcode representation.

◆ barcode_codabar()

TCPDFBarcode::barcode_codabar ( $code )

protected

CODABAR barcodes.

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

Parameters

string $code code to represent.

Return values

array barcode representation.

◆ barcode_code11()

TCPDFBarcode::barcode_code11 ( $code )

protected

CODE11 barcodes.

Used primarily for labeling telecommunications equipment

Parameters

string $code code to represent.

Return values

array barcode representation.

◆ barcode_code39()

TCPDFBarcode::barcode_code39	(	$code,
		$extended = false,
		$checksum = false )

protected

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

General-purpose code in very wide use world-wide

Parameters

string	$code	code to represent.
boolean	$extended	if true uses the extended mode.
boolean	$checksum	if true add a checksum to the code.

Return values

array barcode representation.

◆ barcode_code93()

TCPDFBarcode::barcode_code93 ( $code )

protected

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

Parameters

string $code code to represent.

Return values

array barcode representation.

◆ barcode_eanext()

TCPDFBarcode::barcode_eanext	(		$code,
			$len = 5 )

protected

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.

Parameters

string	$code	code to represent.
string	$len	barcode type: 2 = 2-Digit, 5 = 5-Digit

Return values

array barcode representation.

◆ barcode_eanupc()

TCPDFBarcode::barcode_eanupc	(		$code,
			$len = 13 )

protected

EAN13 and UPC-A barcodes.

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

Parameters

string	$code	code to represent.
string	$len	barcode type: 6 = UPC-E, 8 = EAN8, 13 = EAN13, 12 = UPC-A

Return values

array barcode representation.

◆ barcode_i25()

TCPDFBarcode::barcode_i25	(		$code,
			$checksum = false )

protected

Interleaved 2 of 5 barcodes.

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.

Parameters

string	$code	code to represent.
boolean	$checksum	if true add a checksum to the code

Return values

array barcode representation.

◆ barcode_imb()

TCPDFBarcode::barcode_imb ( $code )

protected

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.

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.

Parameters

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

Return values

array barcode representation.

◆ barcode_imb_pre()

TCPDFBarcode::barcode_imb_pre ( $code )

protected

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

Parameters

string $code pre-formatted IMB barcode (65 chars "FADT")

Return values

array barcode representation.

◆ barcode_msi()

TCPDFBarcode::barcode_msi	(		$code,
			$checksum = false )

protected

MSI.

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

Parameters

string	$code	code to represent.
boolean	$checksum	if true add a checksum to the code (modulo 11)

Return values

array barcode representation.

◆ barcode_pharmacode()

TCPDFBarcode::barcode_pharmacode ( $code )

protected

Pharmacode Contains digits (0 to 9)

Parameters

string $code code to represent.

Return values

array barcode representation.

◆ barcode_pharmacode2t()

TCPDFBarcode::barcode_pharmacode2t ( $code )

protected

Pharmacode two-track Contains digits (0 to 9)

Parameters

string $code code to represent.

Return values

array barcode representation.

◆ barcode_postnet()

TCPDFBarcode::barcode_postnet	(		$code,
			$planet = false )

protected

POSTNET and PLANET barcodes.

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

Parameters

string	$code	zip code to represent. Must be a string containing a zip code of the form DDDDD or DDDDD-DDDD.
boolean	$planet	if true print the PLANET barcode, otherwise print POSTNET

Return values

array barcode representation.

◆ barcode_rms4cc()

TCPDFBarcode::barcode_rms4cc	(		$code,
			$kix = false )

protected

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.

Parameters

string	$code	code to print
boolean	$kix	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.

Return values

array barcode representation.

◆ barcode_s25()

TCPDFBarcode::barcode_s25	(		$code,
			$checksum = false )

protected

Standard 2 of 5 barcodes.

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

Parameters

string	$code	code to represent.
boolean	$checksum	if true add a checksum to the code

Return values

array barcode representation.

◆ binseq_to_array()

TCPDFBarcode::binseq_to_array	(		$seq,
			$bararray )

protected

Convert binary barcode sequence to WarnockPDF barcode array.

Parameters

string	$seq	barcode as binary sequence.
array	$bararray	barcode array to fill up

Return values

array barcode representation.

◆ checksum_code39()

TCPDFBarcode::checksum_code39 ( $code )

protected

Calculate CODE 39 checksum (modulo 43).

Parameters

string $code code to represent.

Return values

string char checksum.

◆ checksum_code93()

TCPDFBarcode::checksum_code93 ( $code )

protected

Calculate CODE 93 checksum (modulo 47).

Parameters

string $code code to represent.

Return values

string checksum code.

◆ checksum_s25()

TCPDFBarcode::checksum_s25 ( $code )

protected

Checksum for standard 2 of 5 barcodes.

Parameters

string $code code to process.

Return values

int checksum.

◆ dec_to_hex()

TCPDFBarcode::dec_to_hex ( $number )

Convert large integer number to hexadecimal representation.

(requires PHP bcmath extension)

Parameters

string $number number to convert specified as a string

Return values

string hexadecimal representation

◆ encode_code39_ext()

TCPDFBarcode::encode_code39_ext ( $code )

protected

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

Parameters

string $code code to represent.

Return values

string encoded string.

◆ get128ABsequence()

TCPDFBarcode::get128ABsequence ( $code )

protected

Split text code in A/B sequence for 128 code.

Parameters

string $code code to split.

Return values

array sequence

◆ getBarcodeArray()

TCPDFBarcode::getBarcodeArray ( )

Return an array representations of barcode.

Return values

array

◆ getBarcodeHTML()

TCPDFBarcode::getBarcodeHTML	(	$w = 2,
		$h = 30,
		$color = 'black' )

Return an HTML representation of barcode.

Parameters

int	$w	Width of a single bar element in pixels.
int	$h	Height of a single bar element in pixels.
string	$color	Foreground color for bar elements (background is transparent).

Return values

string HTML code.

◆ getBarcodePNG()

TCPDFBarcode::getBarcodePNG	(	$w = 2,
		$h = 30,
		$color = array(0,0,0) )

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

Parameters

int	$w	Width of a single bar element in pixels.
int	$h	Height of a single bar element in pixels.
array	$color	RGB (0-255) foreground color for bar elements (background is transparent).

◆ getBarcodePngData()

TCPDFBarcode::getBarcodePngData	(	$w = 2,
		$h = 30,
		$color = array(0,0,0) )

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

Parameters

int	$w	Width of a single bar element in pixels.
int	$h	Height of a single bar element in pixels.
array	$color	RGB (0-255) foreground color for bar elements (background is transparent).

Return values

string|Imagick|false image or false in case of error.

◆ getBarcodeSVG()

TCPDFBarcode::getBarcodeSVG	(	$w = 2,
		$h = 30,
		$color = 'black' )

Send barcode as SVG image object to the standard output.

Parameters

int	$w	Minimum width of a single bar in user units.
int	$h	Height of barcode in user units.
string	$color	Foreground color (in SVG format) for bar elements (background is transparent).

◆ getBarcodeSVGcode()

TCPDFBarcode::getBarcodeSVGcode	(	$w = 2,
		$h = 30,
		$color = 'black' )

Return a SVG string representation of barcode.

Parameters

int	$w	Minimum width of a single bar in user units.
int	$h	Height of barcode in user units.
string	$color	Foreground color (in SVG format) for bar elements (background is transparent).

Return values

string SVG code.

◆ hex_to_dec()

TCPDFBarcode::hex_to_dec ( $hex )

Convert large hexadecimal number to decimal representation (string).

(requires PHP bcmath extension)

Parameters

string $hex hexadecimal number to convert specified as a string

Return values

string hexadecimal representation

◆ imb_crc11fcs()

TCPDFBarcode::imb_crc11fcs ( $code_arr )

protected

Intelligent Mail Barcode calculation of Frame Check Sequence.

Parameters

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

Return values

int	11 bit Frame Check Sequence as integer (decimal base)

◆ imb_reverse_us()

TCPDFBarcode::imb_reverse_us ( $num )

protected

Reverse unsigned short value.

Parameters

int $num value to reversr

Return values

int	reversed value

◆ imb_tables()

TCPDFBarcode::imb_tables	(		$n,
			$size )

protected

generate Nof13 tables used for Intelligent Mail Barcode

Parameters

int	$n	is the type of table: 2 for 2of13 table, 5 for 5of13table
int	$size	size of table (78 for n=2 and 1287 for n=5)

Return values

array requested table

◆ setBarcode()

TCPDFBarcode::setBarcode	(		$code,
			$type )

Set the barcode.

Parameters

string	$code	code to print
string	$type	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

Return values

void

The documentation for this class was generated from the following file:

lib/tcpdf/tcpdf_barcodes_1d.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ barcode_c128()

◆ barcode_codabar()

◆ barcode_code11()

◆ barcode_code39()

◆ barcode_code93()

◆ barcode_eanext()

◆ barcode_eanupc()

◆ barcode_i25()

◆ barcode_imb()

◆ barcode_imb_pre()

◆ barcode_msi()

◆ barcode_pharmacode()

◆ barcode_pharmacode2t()

◆ barcode_postnet()

◆ barcode_rms4cc()

◆ barcode_s25()

◆ binseq_to_array()

◆ checksum_code39()

◆ checksum_code93()

◆ checksum_s25()

◆ dec_to_hex()

◆ encode_code39_ext()

◆ get128ABsequence()

◆ getBarcodeArray()

◆ getBarcodeHTML()

◆ getBarcodePNG()

◆ getBarcodePngData()

◆ getBarcodeSVG()

◆ getBarcodeSVGcode()

◆ hex_to_dec()

◆ imb_crc11fcs()

◆ imb_reverse_us()

◆ imb_tables()

◆ setBarcode()