TCPDFBarcode

class TCPDFBarcode (View source)

Properties

protected $barcode_array

Array representation of barcode.

Methods

__construct(string $code, string $type)

This is the class constructor.

array
getBarcodeArray()

Return an array representations of barcode.

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

Send barcode as SVG image object to the standard output.

string
getBarcodeSVGcode(int $w = 2, int $h = 30, string $color = 'black')

Return a SVG string representation of barcode.

string
getBarcodeHTML(int $w = 2, int $h = 30, string $color = 'black')

Return an HTML representation of barcode.

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

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

string|Imagick|false
getBarcodePngData(int $w = 2, int $h = 30, array $color = array(0, 0, 0))

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

void
setBarcode(string $code, string $type)

Set the barcode.

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

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

string
encode_code39_ext(string $code)

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

string
checksum_code39(string $code)

Calculate CODE 39 checksum (modulo 43).

array
barcode_code93(string $code)

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

string
checksum_code93(string $code)

Calculate CODE 93 checksum (modulo 47).

int
checksum_s25(string $code)

Checksum for standard 2 of 5 barcodes.

array
barcode_msi(string $code, bool $checksum = false)

MSI.

array
barcode_s25(string $code, bool $checksum = false)

Standard 2 of 5 barcodes.

array
binseq_to_array(string $seq, array $bararray)

Convert binary barcode sequence to WarnockPDF barcode array.

array
barcode_i25(string $code, bool $checksum = false)

Interleaved 2 of 5 barcodes.

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

C128 barcodes.

array
get128ABsequence(string $code)

Split text code in A/B sequence for 128 code

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

EAN13 and UPC-A barcodes.

array
barcode_eanext(string $code, string $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

array
barcode_postnet(string $code, bool $planet = false)

POSTNET and PLANET barcodes.

array
barcode_rms4cc(string $code, bool $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.

array
barcode_codabar(string $code)

CODABAR barcodes.

array
barcode_code11(string $code)

CODE11 barcodes.

array
barcode_pharmacode(string $code)

Pharmacode Contains digits (0 to 9)

array
barcode_pharmacode2t(string $code)

Pharmacode two-track Contains digits (0 to 9)

array
barcode_imb(string $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.

array
barcode_imb_pre(string $code)

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

string
dec_to_hex(string $number)

Convert large integer number to hexadecimal representation.

string
hex_to_dec(string $hex)

Convert large hexadecimal number to decimal representation (string).

int
imb_crc11fcs(string $code_arr)

Intelligent Mail Barcode calculation of Frame Check Sequence

int
imb_reverse_us(int $num)

Reverse unsigned short value

array
imb_tables(int $n, int $size)

generate Nof13 tables used for Intelligent Mail Barcode

Details

at line 73
__construct(string $code, string $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

at line 82
array getBarcodeArray()

Return an array representations of barcode.

Return Value

array

at line 93
getBarcodeSVG(int $w = 2, int $h = 30, string $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).

at line 114
string getBarcodeSVGcode(int $w = 2, int $h = 30, string $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 Value

string

SVG code.

at line 147
string getBarcodeHTML(int $w = 2, int $h = 30, string $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 Value

string

HTML code.

at line 172
getBarcodePNG(int $w = 2, int $h = 30, array $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).

at line 192
string|Imagick|false getBarcodePngData(int $w = 2, int $h = 30, array $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 Value

string|Imagick|false

image or false in case of error.

at line 249
void setBarcode(string $code, string $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 Value

void

at line 393
protected array barcode_code39(string $code, bool $extended = false, bool $checksum = false)

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.
bool $extended

if true uses the extended mode.
bool $checksum

if true add a checksum to the code.

Return Value

array

barcode representation.

at line 486
protected string encode_code39_ext(string $code)

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

Parameters

string $code

code to represent.

Return Value

string

encoded string.

at line 537
protected string checksum_code39(string $code)

Calculate CODE 39 checksum (modulo 43).

Parameters

string $code

code to represent.

Return Value

string

char checksum.

at line 560
protected array barcode_code93(string $code)

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

Parameters

string $code

code to represent.

Return Value

array

barcode representation.

at line 688
protected string checksum_code93(string $code)

Calculate CODE 93 checksum (modulo 47).

Parameters

string $code

code to represent.

Return Value

string

checksum code.

at line 737
protected int checksum_s25(string $code)

Checksum for standard 2 of 5 barcodes.

Parameters

string $code

code to process.

Return Value

int checksum.

at line 763
protected array barcode_msi(string $code, bool $checksum = false)

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.
bool $checksum

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

Return Value

array

barcode representation.

at line 822
protected array barcode_s25(string $code, bool $checksum = false)

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.
bool $checksum

if true add a checksum to the code

Return Value

array

barcode representation.

at line 863
protected array binseq_to_array(string $seq, array $bararray)

Convert binary barcode sequence to WarnockPDF barcode array.

Parameters

string $seq

barcode as binary sequence.
array $bararray

barcode array to fill up

Return Value

array

barcode representation.

at line 893
protected array barcode_i25(string $code, bool $checksum = false)

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.
bool $checksum

if true add a checksum to the code

Return Value

array

barcode representation.

at line 957
protected array barcode_c128(string $code, string $type = '')

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 Value

array

barcode representation.

at line 1287
protected array get128ABsequence(string $code)

Split text code in A/B sequence for 128 code

Parameters

string $code

code to split.

Return Value

array sequence

at line 1326
protected array barcode_eanupc(string $code, string $len = 13)

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 Value

array

barcode representation.

at line 1519
protected array barcode_eanext(string $code, string $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

Parameters

string $code

code to represent.
string $len

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

Return Value

array

barcode representation.

at line 1594
protected array barcode_postnet(string $code, bool $planet = false)

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.
bool $planet

if true print the PLANET barcode, otherwise print POSTNET

Return Value

array

barcode representation.

at line 1667
protected array barcode_rms4cc(string $code, bool $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.

Parameters

string $code

code to print
bool $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 Value

array

barcode representation.

at line 1818
protected array barcode_codabar(string $code)

CODABAR barcodes.

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

Parameters

string $code

code to represent.

Return Value

array

barcode representation.

at line 1874
protected array barcode_code11(string $code)

CODE11 barcodes.

Used primarily for labeling telecommunications equipment

Parameters

string $code

code to represent.

Return Value

array

barcode representation.

at line 1965
protected array barcode_pharmacode(string $code)

Pharmacode Contains digits (0 to 9)

Parameters

string $code

code to represent.

Return Value

array

barcode representation.

at line 1991
protected array barcode_pharmacode2t(string $code)

Pharmacode two-track Contains digits (0 to 9)

Parameters

string $code

code to represent.

Return Value

array

barcode representation.

at line 2053
protected array barcode_imb(string $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.

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 Value

array

barcode representation.

at line 2178
protected array barcode_imb_pre(string $code)

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

Parameters

string $code

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

Return Value

array

barcode representation.

at line 2228
string dec_to_hex(string $number)

Convert large integer number to hexadecimal representation.

(requires PHP bcmath extension)

Parameters

string $number

number to convert specified as a string

Return Value

string

hexadecimal representation

at line 2252
string hex_to_dec(string $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 Value

string

hexadecimal representation

at line 2269
protected int imb_crc11fcs(string $code_arr)

Intelligent Mail Barcode calculation of Frame Check Sequence

Parameters

string $code_arr

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

Return Value

int

11 bit Frame Check Sequence as integer (decimal base)

at line 2305
protected int imb_reverse_us(int $num)

Reverse unsigned short value

Parameters

int $num

value to reversr

Return Value

int

reversed value

at line 2322
protected array imb_tables(int $n, int $size)

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 Value

array

requested table