PEEL Shopping
Open source ecommerce : PEEL Shopping
Public Member Functions | Protected Member Functions | Protected Attributes
TCPDFBarcode Class Reference

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. More...
 
 getBarcodeArray ()
 Return an array representations of barcode. More...
 
 getBarcodeSVG ($w=2, $h=30, $color='black')
 Send barcode as SVG image object to the standard output. More...
 
 getBarcodeSVGcode ($w=2, $h=30, $color='black')
 Return a SVG string representation of barcode. More...
 
 getBarcodeHTML ($w=2, $h=30, $color='black')
 Return an HTML representation of barcode. More...
 
 getBarcodePNG ($w=2, $h=30, $color=array(0, 0, 0))
 Return a PNG image representation of barcode (requires GD or Imagick library). More...
 
 setBarcode ($code, $type)
 Set the barcode. More...
 
 dec_to_hex ($number)
 Convert large integer number to hexadecimal representation. More...
 
 hex_to_dec ($hex)
 Convert large hexadecimal number to decimal representation (string). More...
 

Protected Member Functions

 barcode_code39 ($code, $extended=false, $checksum=false)
 CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9. More...
 
 encode_code39_ext ($code)
 Encode a string to be used for CODE 39 Extended mode. More...
 
 checksum_code39 ($code)
 Calculate CODE 39 checksum (modulo 43). More...
 
 barcode_code93 ($code)
 CODE 93 - USS-93 Compact code similar to Code 39. More...
 
 checksum_code93 ($code)
 Calculate CODE 93 checksum (modulo 47). More...
 
 checksum_s25 ($code)
 Checksum for standard 2 of 5 barcodes. More...
 
 barcode_msi ($code, $checksum=false)
 MSI. More...
 
 barcode_s25 ($code, $checksum=false)
 Standard 2 of 5 barcodes. More...
 
 binseq_to_array ($seq, $bararray)
 Convert binary barcode sequence to TCPDF barcode array. More...
 
 barcode_i25 ($code, $checksum=false)
 Interleaved 2 of 5 barcodes. More...
 
 barcode_c128 ($code, $type='')
 C128 barcodes. More...
 
 get128ABsequence ($code)
 Split text code in A/B sequence for 128 code. More...
 
 barcode_eanupc ($code, $len=13)
 EAN13 and UPC-A barcodes. More...
 
 barcode_eanext ($code, $len=5)
 UPC-Based Extentions 2-Digit Ext. More...
 
 barcode_postnet ($code, $planet=false)
 POSTNET and PLANET barcodes. More...
 
 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. More...
 
 barcode_codabar ($code)
 CODABAR barcodes. More...
 
 barcode_code11 ($code)
 CODE11 barcodes. More...
 
 barcode_pharmacode ($code)
 Pharmacode Contains digits (0 to 9) More...
 
 barcode_pharmacode2t ($code)
 Pharmacode two-track Contains digits (0 to 9) More...
 
 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. More...
 
 imb_crc11fcs ($code_arr)
 Intelligent Mail Barcode calculation of Frame Check Sequence. More...
 
 imb_reverse_us ($num)
 Reverse unsigned short value. More...
 
 imb_tables ($n, $size)
 generate Nof13 tables used for Intelligent Mail Barcode More...
 

Protected Attributes

 $barcode_array
 Array representation of barcode. More...
 

Detailed Description

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


Definition at line 50 of file barcodes.php.

Constructor & Destructor Documentation

__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
$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 Extention
  • EAN5 : 5-Digits UPC-Based Extention
  • 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

Definition at line 73 of file barcodes.php.

Member Function Documentation

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

C128 barcodes.

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

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

Definition at line 938 of file barcodes.php.

barcode_codabar (   $code)
protected

CODABAR barcodes.

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

Parameters
$code(string) code to represent.
Returns
array barcode representation.

Definition at line 1799 of file barcodes.php.

barcode_code11 (   $code)
protected

CODE11 barcodes.

Used primarily for labeling telecommunications equipment

Parameters
$code(string) code to represent.
Returns
array barcode representation.

Definition at line 1855 of file barcodes.php.

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
$code(string) code to represent.
$extended(boolean) if true uses the extended mode.
$checksum(boolean) if true add a checksum to the code.
Returns
array barcode representation.

Definition at line 373 of file barcodes.php.

barcode_code93 (   $code)
protected

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

Parameters
$code(string) code to represent.
Returns
array barcode representation.

Definition at line 540 of file barcodes.php.

barcode_eanext (   $code,
  $len = 5 
)
protected

UPC-Based Extentions 2-Digit Ext.

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

Parameters
$code(string) code to represent.
$len(string) barcode type: 2 = 2-Digit, 5 = 5-Digit
Returns
array barcode representation.

Definition at line 1500 of file barcodes.php.

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
$code(string) code to represent.
$len(string) barcode type: 6 = UPC-E, 8 = EAN8, 13 = EAN13, 12 = UPC-A
Returns
array barcode representation.

Definition at line 1307 of file barcodes.php.

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
$code(string) code to represent.
$checksum(boolean) if true add a checksum to the code
Returns
array barcode representation.

Definition at line 874 of file barcodes.php.

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
$code(string) code to print, separate the ZIP (routing code) from the rest using a minus char '-' (BarcodeID_ServiceTypeID_MailerID_SerialNumber-RoutingCode)
Returns
array barcode representation.

Definition at line 2035 of file barcodes.php.

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
$code(string) code to represent.
$checksum(boolean) if true add a checksum to the code (modulo 11)
Returns
array barcode representation.

Definition at line 743 of file barcodes.php.

barcode_pharmacode (   $code)
protected

Pharmacode Contains digits (0 to 9)

Parameters
$code(string) code to represent.
Returns
array barcode representation.

Definition at line 1946 of file barcodes.php.

barcode_pharmacode2t (   $code)
protected

Pharmacode two-track Contains digits (0 to 9)

Parameters
$code(string) code to represent.
Returns
array barcode representation.

Definition at line 1972 of file barcodes.php.

barcode_postnet (   $code,
  $planet = false 
)
protected

POSTNET and PLANET barcodes.

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

Parameters
$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
Returns
array barcode representation.

Definition at line 1575 of file barcodes.php.

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
$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.
Returns
array barcode representation.

Definition at line 1648 of file barcodes.php.

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
$code(string) code to represent.
$checksum(boolean) if true add a checksum to the code
Returns
array barcode representation.

Definition at line 802 of file barcodes.php.

binseq_to_array (   $seq,
  $bararray 
)
protected

Convert binary barcode sequence to TCPDF barcode array.

Parameters
$seq(string) barcode as binary sequence.
$bararray(array) barcode array. òparam array $bararray TCPDF barcode array to fill up
Returns
array barcode representation.

Definition at line 844 of file barcodes.php.

checksum_code39 (   $code)
protected

Calculate CODE 39 checksum (modulo 43).

Parameters
$code(string) code to represent.
Returns
char checksum.

Definition at line 517 of file barcodes.php.

checksum_code93 (   $code)
protected

Calculate CODE 93 checksum (modulo 47).

Parameters
$code(string) code to represent.
Returns
string checksum code.

Definition at line 668 of file barcodes.php.

checksum_s25 (   $code)
protected

Checksum for standard 2 of 5 barcodes.

Parameters
$code(string) code to process.
Returns
int checksum.

Definition at line 717 of file barcodes.php.

dec_to_hex (   $number)

Convert large integer number to hexadecimal representation.

(requires PHP bcmath extension)

Parameters
$number(string) number to convert specified as a string
Returns
string hexadecimal representation

Definition at line 2159 of file barcodes.php.

encode_code39_ext (   $code)
protected

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

Parameters
$code(string) code to represent.
Returns
encoded string.

Definition at line 466 of file barcodes.php.

get128ABsequence (   $code)
protected

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

Parameters
$code(string) code to split.
Returns
array sequence

Definition at line 1268 of file barcodes.php.

getBarcodeArray ( )

Return an array representations of barcode.

Returns
array

Definition at line 82 of file barcodes.php.

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

Return an HTML representation of barcode.

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

Definition at line 147 of file barcodes.php.

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

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

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

Definition at line 173 of file barcodes.php.

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

Send barcode as SVG image object to the standard output.

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

Definition at line 93 of file barcodes.php.

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

Return a SVG string representation of barcode.

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

Definition at line 114 of file barcodes.php.

hex_to_dec (   $hex)

Convert large hexadecimal number to decimal representation (string).

(requires PHP bcmath extension)

Parameters
$hex(string) hexadecimal number to convert specified as a string
Returns
string hexadecimal representation

Definition at line 2183 of file barcodes.php.

imb_crc11fcs (   $code_arr)
protected

Intelligent Mail Barcode calculation of Frame Check Sequence.

Parameters
$code_arr(string) array of hexadecimal values (13 bytes holding 102 bits right justified).
Returns
int 11 bit Frame Check Sequence as integer (decimal base)

Definition at line 2200 of file barcodes.php.

imb_reverse_us (   $num)
protected

Reverse unsigned short value.

Parameters
$num(int) value to reversr
Returns
int reversed value

Definition at line 2236 of file barcodes.php.

imb_tables (   $n,
  $size 
)
protected

generate Nof13 tables used for Intelligent Mail Barcode

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

Definition at line 2253 of file barcodes.php.

setBarcode (   $code,
  $type 
)

Set the barcode.

Parameters
$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 Extention
  • EAN5 : 5-Digits UPC-Based Extention
  • 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
Returns
array barcode array

Definition at line 233 of file barcodes.php.

Field Documentation

$barcode_array
protected

Array representation of barcode.

Definition at line 56 of file barcodes.php.

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

This documentation for Open ecommerce PEEL Shopping and PEEL.fr has been generated by Doxygen on Thu Oct 15 2015 14:41:44 - Peel ecommerce is a product of Agence web Advisto SAS. All rights reserved.