Admidio API
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Packages

  • com
    • tecnick
      • tcpdf
  • None
  • PHPMailer
    • easypeasyics
  • PHPWavUtils
  • Securimage
    • classes

Classes

  • Datamatrix
  • PDF417
  • QRcode
  • TCPDF
  • TCPDF2DBarcode
  • TCPDF_COLORS
  • TCPDF_FILTERS
  • TCPDF_FONT_DATA
  • TCPDF_FONTS
  • TCPDF_IMAGES
  • TCPDF_IMPORT
  • TCPDF_PARSER
  • TCPDF_STATIC
  • TCPDFBarcode

Functions

  • str_split

Class TCPDFBarcode

Package: com\tecnick\tcpdf
Author: Nicola Asuni
Version: 1.0.027
Class:

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


Located at tcpdf_barcodes_1d.php

Methods summary

public
# __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)

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

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

Public

public array
# getBarcodeArray( )

Return an array representations of barcode.

Return an array representations of barcode.

Returns

array

Public

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

Send barcode as SVG image object to the standard output.

Send barcode as SVG image object to the standard output.

Parameters

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

Public

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

Return a SVG string representation of barcode.

Return a SVG string representation of barcode.

Parameters

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

Returns

string
SVG code.

Public

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

Return an HTML representation of barcode.

Return an HTML representation of barcode.

Parameters

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

Returns

string
HTML code.

Public

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

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

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

Parameters

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

Public

public image
# getBarcodePngData( $w = 2, $h = 30, $color = array(0,0,0) )

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

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

Parameters

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

Returns

image
or false in case of error.

Public

public array
# setBarcode( $code, $type )

Set the barcode.

Set the barcode.

Parameters

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

Returns

array
barcode array

Public

protected array
# barcode_code39( $code, $extended = false, $checksum = false )

CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9. General-purpose code in very wide use world-wide

CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9. General-purpose code in very wide use world-wide

Parameters

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

Returns

array
barcode representation.

Protected

protected encoded
# encode_code39_ext( $code )

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

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

Parameters

$code
code to represent.

Returns

encoded
string.

Protected

protected char
# checksum_code39( $code )

Calculate CODE 39 checksum (modulo 43).

Calculate CODE 39 checksum (modulo 43).

Parameters

$code
code to represent.

Returns

char
checksum.

Protected

protected array
# barcode_code93( $code )

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

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

Parameters

$code
code to represent.

Returns

array
barcode representation.

Protected

protected string
# checksum_code93( $code )

Calculate CODE 93 checksum (modulo 47).

Calculate CODE 93 checksum (modulo 47).

Parameters

$code
code to represent.

Returns

string
checksum code.

Protected

protected integer
# checksum_s25( $code )

Checksum for standard 2 of 5 barcodes.

Checksum for standard 2 of 5 barcodes.

Parameters

$code
code to process.

Returns

integer
checksum.

Protected

protected array
# barcode_msi( $code, $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.

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

Parameters

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

Returns

array
barcode representation.

Protected

protected array
# barcode_s25( $code, $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.

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

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

Returns

array
barcode representation.

Protected

protected array
# binseq_to_array( $seq, $bararray )

Convert binary barcode sequence to TCPDF barcode array.

Convert binary barcode sequence to TCPDF barcode array.

Parameters

$seq
barcode as binary sequence.
$bararray

barcode array. òparam array $bararray TCPDF barcode array to fill up

Returns

array
barcode representation.

Protected

protected array
# barcode_i25( $code, $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.

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

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

Returns

array
barcode representation.

Protected

protected array
# barcode_c128( $code, $type = '' )

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

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

Parameters

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

Returns

array
barcode representation.

Protected

protected array
# get128ABsequence( $code )

Split text code in A/B sequence for 128 code

Split text code in A/B sequence for 128 code

Parameters

$code
code to split.

Returns

array
sequence

Protected

protected array
# barcode_eanupc( $code, $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

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

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

Returns

array
barcode representation.

Protected

protected array
# 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

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

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

Returns

array
barcode representation.

Protected

protected array
# barcode_postnet( $code, $planet = false )

POSTNET and PLANET barcodes. Used by U.S. Postal Service for automated mail sorting

POSTNET and PLANET barcodes. Used by U.S. Postal Service for automated mail sorting

Parameters

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

Returns

array
barcode representation.

Protected

protected array
# 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.

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

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

Returns

array
barcode representation.

Protected

protected array
# barcode_codabar( $code )

CODABAR barcodes. Older code often used in library systems, sometimes in blood banks

CODABAR barcodes. Older code often used in library systems, sometimes in blood banks

Parameters

$code
code to represent.

Returns

array
barcode representation.

Protected

protected array
# barcode_code11( $code )

CODE11 barcodes. Used primarily for labeling telecommunications equipment

CODE11 barcodes. Used primarily for labeling telecommunications equipment

Parameters

$code
code to represent.

Returns

array
barcode representation.

Protected

protected array
# barcode_pharmacode( $code )

Pharmacode Contains digits (0 to 9)

Pharmacode Contains digits (0 to 9)

Parameters

$code
code to represent.

Returns

array
barcode representation.

Protected

protected array
# barcode_pharmacode2t( $code )

Pharmacode two-track Contains digits (0 to 9)

Pharmacode two-track Contains digits (0 to 9)

Parameters

$code
code to represent.

Returns

array
barcode representation.

Protected

protected array
# 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. 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.

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

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

Returns

array
barcode representation.

Protected

protected array
# barcode_imb_pre( $code )

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

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

Parameters

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

Returns

array
barcode representation.

Protected

public string
# dec_to_hex( $number )

Convert large integer number to hexadecimal representation. (requires PHP bcmath extension)

Convert large integer number to hexadecimal representation. (requires PHP bcmath extension)

Parameters

$number
number to convert specified as a string

Returns

string
hexadecimal representation
public string
# hex_to_dec( $hex )

Convert large hexadecimal number to decimal representation (string). (requires PHP bcmath extension)

Convert large hexadecimal number to decimal representation (string). (requires PHP bcmath extension)

Parameters

$hex
hexadecimal number to convert specified as a string

Returns

string
hexadecimal representation
protected integer
# imb_crc11fcs( $code_arr )

Intelligent Mail Barcode calculation of Frame Check Sequence

Intelligent Mail Barcode calculation of Frame Check Sequence

Parameters

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

Returns

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

Protected

protected integer
# imb_reverse_us( $num )

Reverse unsigned short value

Reverse unsigned short value

Parameters

$num
value to reversr

Returns

integer
reversed value

Protected

protected array
# imb_tables( $n, $size )

generate Nof13 tables used for Intelligent Mail Barcode

generate Nof13 tables used for Intelligent Mail Barcode

Parameters

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

Returns

array
requested table

Protected

Properties summary

protected $barcode_array

Array representation of barcode.

Array representation of barcode.

Protected

#
Admidio API API documentation generated by ApiGen