tc-lib-barcode

tc-lib-barcode API reference

Com\Tecnick\Barcode

Classes:

  • Barcode: Barcode factory class
  • Exception: Custom Exception class
  • Math: Arbitrary precision arithmetic on non-negative decimal integer strings.
  • Type: Barcode Type class

Interfaces:

  • Model: Barcode Model interface

Enums:

  • BarcodeType: Backed enum for the supported barcode symbologies.

Com\Tecnick\Barcode\Type

Classes:

  • Convert: Barcode Convert class
  • GsOneElementString: GS1 Application Identifier element strings (GS1 General Specifications) Reads the bracketed form “(ai)value(ai)value…”, which is also the human readable interpretation, and checks the Application Id
  • Hibc: Hibc data structure class HIBC (Health Industry Bar Code) data structures Validates a data structure of the Supplier Labeling Standard (ANSI/HIBC 2.6) or of the Provider Applications Standard (ANSI/HI
  • Linear: Barcode type class
  • Raw: Raw Barcode type class RAW MODE (comma-separated rows)
  • ReedSolomon: Reed-Solomon error correction over GF(2^n)
  • Square: Barcode type class

Traits:

  • HibcPayload: HibcPayload trait Wires the HIBC data structure of Hibc to a carrier symbology.

Com\Tecnick\Barcode\Type\Linear

Classes:

  • AustraliaPost: Com\Tecnick\Barcode\Type\Linear\AustraliaPost;
  • Codabar: Com\Tecnick\Barcode\Type\Linear\Codabar;
  • CodeFourNine: Com\Tecnick\Barcode\Type\Linear\CodeFourNine;
  • CodeNineThree: Com\Tecnick\Barcode\Type\Linear\CodeNineThree;
  • CodeOneOne: Com\Tecnick\Barcode\Type\Linear\CodeOneOne;
  • CodeOneSixK: Com\Tecnick\Barcode\Type\Linear\CodeOneSixK;
  • CodeOneTwoEight: Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight;
  • CodeThreeNine: CodeThreeNine Barcode type class CODE 39
  • CodeThreeNineCheck: CodeThreeNineCheck Barcode type class CODE 39 + CHECKSUM
  • CodeThreeNineExt: CodeThreeNineExt Barcode type class CODE 39 EXTENDED
  • CodeThreeNineExtCheck: CodeThreeNineExtCheck Barcode type class CODE 39 EXTENDED + CHECKSUM
  • CodeThreeTwo: Com\Tecnick\Barcode\Type\Linear\CodeThreeTwo;
  • DatalogicTwoOfFive: Com\Tecnick\Barcode\Type\Linear\DatalogicTwoOfFive;
  • DeutschePost: Com\Tecnick\Barcode\Type\Linear\DeutschePost;
  • EanEight: Com\Tecnick\Barcode\Type\Linear\EanEight;
  • EanFive: Com\Tecnick\Barcode\Type\Linear\EanFive;
  • EanOneThree: Com\Tecnick\Barcode\Type\Linear\EanOneThree;
  • EanTwo: Com\Tecnick\Barcode\Type\Linear\EanTwo;
  • FourState: Shared layer of the four state postal symbologies A bar occupies one of three rows: the ascender, the tracker and the descender.
  • GsOneDataBar: Com\Tecnick\Barcode\Type\Linear\GsOneDataBar;
  • GsOneDataBarExpanded: Com\Tecnick\Barcode\Type\Linear\GsOneDataBarExpanded;
  • GsOneDataBarExpandedStacked: Com\Tecnick\Barcode\Type\Linear\GsOneDataBarExpandedStacked;
  • GsOneDataBarLimited: Com\Tecnick\Barcode\Type\Linear\GsOneDataBarLimited;
  • GsOneDataBarOmni: Com\Tecnick\Barcode\Type\Linear\GsOneDataBarOmni;
  • GsOneDataBarStacked: Com\Tecnick\Barcode\Type\Linear\GsOneDataBarStacked;
  • GsOneDataBarStackedOmni: Com\Tecnick\Barcode\Type\Linear\GsOneDataBarStackedOmni;
  • GsOneDataBarTruncated: Com\Tecnick\Barcode\Type\Linear\GsOneDataBarTruncated;
  • GsOneOneFour: Com\Tecnick\Barcode\Type\Linear\GsOneOneFour;
  • GsOneOneTwoEight: Com\Tecnick\Barcode\Type\Linear\GsOneOneTwoEight;
  • HibcOneTwoEight: Com\Tecnick\Barcode\Type\Linear\HibcOneTwoEight;
  • HibcThreeNine: Com\Tecnick\Barcode\Type\Linear\HibcThreeNine;
  • IataTwoOfFive: Com\Tecnick\Barcode\Type\Linear\IataTwoOfFive;
  • Identcode: Com\Tecnick\Barcode\Type\Linear\Identcode;
  • Imb: Com\Tecnick\Barcode\Type\Linear\Imb;
  • ImbPre: Com\Tecnick\Barcode\Type\Linear\ImbPre;
  • InterleavedTwoOfFive: Com\Tecnick\Barcode\Type\Linear\InterleavedTwoOfFive;
  • InterleavedTwoOfFiveCheck: Com\Tecnick\Barcode\Type\Linear\InterleavedTwoOfFiveCheck;
  • ItfOneFour: Com\Tecnick\Barcode\Type\Linear\ItfOneFour;
  • JapanPost: Com\Tecnick\Barcode\Type\Linear\JapanPost;
  • KlantIndex: Com\Tecnick\Barcode\Type\Linear\KlantIndex;
  • Leitcode: Com\Tecnick\Barcode\Type\Linear\Leitcode;
  • Logmars: Com\Tecnick\Barcode\Type\Linear\Logmars;
  • Mailmark: Com\Tecnick\Barcode\Type\Linear\Mailmark;
  • MatrixTwoOfFive: Com\Tecnick\Barcode\Type\Linear\MatrixTwoOfFive;
  • Msi: Com\Tecnick\Barcode\Type\Linear\Msi;
  • MsiCheck: Com\Tecnick\Barcode\Type\Linear\MsiCheck;
  • Pharma: Com\Tecnick\Barcode\Type\Linear\Pharma;
  • PharmaTwoTracks: Com\Tecnick\Barcode\Type\Linear\PharmaTwoTracks;
  • Planet: Com\Tecnick\Barcode\Type\Linear\Planet;
  • Plessey: Com\Tecnick\Barcode\Type\Linear\Plessey;
  • Postnet: Com\Tecnick\Barcode\Type\Linear\Postnet;
  • Pzn: Com\Tecnick\Barcode\Type\Linear\Pzn;
  • Raw: Raw Barcode type class RAW MODE (comma-separated rows)
  • RoyalMailFourCc: Com\Tecnick\Barcode\Type\Linear\RoyalMailFourCc;
  • SsccOneEight: Com\Tecnick\Barcode\Type\Linear\SsccOneEight;
  • StandardTwoOfFive: Com\Tecnick\Barcode\Type\Linear\StandardTwoOfFive;
  • StandardTwoOfFiveCheck: Com\Tecnick\Barcode\Type\Linear\StandardTwoOfFiveCheck;
  • Telepen: Com\Tecnick\Barcode\Type\Linear\Telepen;
  • UpcA: Com\Tecnick\Barcode\Type\Linear\UpcA;
  • UpcE: Com\Tecnick\Barcode\Type\Linear\UpcE;

Traits:

  • FixedLengthCheckDigit: FixedLengthCheckDigit trait Shared by the symbologies of a fixed digit count whose last digit is a check digit: the input is either the data digits, which get the check digit appended, or the whole co

Com\Tecnick\Barcode\Type\Linear\CodeFourNine

Classes:

  • Data: Data for CodeFourNine Barcode type class

Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight

Classes:

  • CodeOneTwoEightA: Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight\CodeOneTwoEightA;
  • CodeOneTwoEightB: Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight\CodeOneTwoEightB;
  • CodeOneTwoEightC: Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight\CodeOneTwoEightC;
  • Process: Com\Tecnick\Barcode\Type\Linear\CodeOneTwoEight\Process;

Com\Tecnick\Barcode\Type\Linear\GsOneDataBar

Classes:

  • Compaction: General purpose data compaction of GS1 DataBar Expanded (ISO/IEC 24724) Turns a character sequence into a binary string with three encodation schemes: numeric, which packs a pair of digits or a digit
  • Data: Tables of the GS1 DataBar family (ISO/IEC 24724)
  • Encodation: Encodation methods of GS1 DataBar Expanded (ISO/IEC 24724) Chooses the encodation method of a sequence of GS1 Application Identifier element strings and builds its compressed data field.

Com\Tecnick\Barcode\Type\Linear\Mailmark

Classes:

  • PostCode: Destination Post Code plus DPS field of a 4-state Mailmark barcode The field is either the fixed international string or one of six patterns of character types.

Com\Tecnick\Barcode\Type\Square

Classes:

  • Aztec: Aztec Barcode type class
  • AztecRune: AztecRune Barcode type class Aztec Rune (ISO/IEC 24778:2008 Annex A) Fixed size symbol carrying a single value from 0 to 255.
  • Datamatrix: Datamatrix Barcode type class DATAMATRIX (ISO/IEC 16022)
  • Dmre: Dmre Barcode type class Data Matrix Rectangular Extension (ISO/IEC 21471) Rectangular symbol sizes added to Data Matrix ECC 200 for narrow marking areas.
  • HanXin: HanXin Barcode type class Han Xin Code (GB/T 21049, ISO/IEC 20830) Matrix symbology with four position detection patterns, a stepped alignment pattern and eighty four symbol versions.
  • HibcAztec: HibcAztec Barcode type class HIBC in Aztec Code (ANSI/HIBC 2.6 and ANSI/HIBC 1.3) Aztec Code symbol carrying a Health Industry Bar Code data structure.
  • HibcDatamatrix: HibcDatamatrix Barcode type class HIBC in Data Matrix ECC 200 (ANSI/HIBC 2.6 and ANSI/HIBC 1.3) Data Matrix symbol carrying a Health Industry Bar Code data structure.
  • HibcQrCode: HibcQrCode Barcode type class HIBC in QR Code (ANSI/HIBC 2.6 and ANSI/HIBC 1.3) QR Code symbol carrying a Health Industry Bar Code data structure.
  • MicroQrCode: MicroQrCode Barcode type class Micro QR Code (ISO/IEC 18004) Matrix symbology with a single finder pattern, four symbol sizes and a fixed error correction level per size.
  • PdfFourOneSeven: PdfFourOneSeven Barcode type class PDF417 (ISO/IEC 15438:2006) Continuous multi-row symbology encoding the 128 ASCII characters and the extended ones.
  • PdfFourOneSevenCompact: PdfFourOneSevenCompact Barcode type class Compact PDF417, also known as truncated PDF417 (ISO/IEC 15438:2006) PDF417 symbol with the right row indicator column removed and the stop pattern reduced to
  • QrCode: QrCode Barcode type class QR Code (ISO/IEC 18004) Matrix symbology with three finder patterns and forty symbol versions.
  • Raw: Raw Barcode type class RAW MODE (comma-separated rows)

Com\Tecnick\Barcode\Type\Square\Aztec

Classes:

  • Bitstream: Bitstream for Aztec Barcode type class
  • Codeword: Codeword utility methods for Aztec Barcode type class
  • Data: Data for Aztec Barcode type class
  • Encode: Encode for Aztec Barcode type class
  • Layers: Layers for Aztec Barcode type class
  • Rune: Encode for the Aztec Rune Barcode type class

Enums:

  • AztecHint: Backed enum for the Aztec Code encoding hint: A (automatic, default) or B (binary).
  • AztecRange: Backed enum for the Aztec Code symbol range mode: A (automatic selection between Compact and Full Range, default) or F (force Full Range).

Com\Tecnick\Barcode\Type\Square\Datamatrix

Classes:

  • Data: Data for Datamatrix Barcode type class
  • Encode: Encode methods for Datamatrix Barcode type class
  • EncodeTxt: Encode TXT/C40 methods for Datamatrix Barcode type class
  • ErrorCorrection: Error correction methods and other utilities for Datamatrix Barcode type class
  • Modes: Modes for Datamatrix Barcode type class
  • Placement: Placement methods for Datamatrix Barcode type class
  • Steps: Steps methods for Datamatrix Barcode type class

Enums:

  • DatamatrixEncoding: Backed enum for the Data Matrix default encoding scheme.
  • DatamatrixShape: Backed enum for the Data Matrix symbol shape: S (square, default) or R (rectangular).

Com\Tecnick\Barcode\Type\Square\Dmre

Enums:

  • DmreSize: Backed enum for the DMRE symbol size: the eighteen sizes of ISO/IEC 21471 as rows by columns, or Auto to choose the smallest one that fits the data.

Com\Tecnick\Barcode\Type\Square\HanXin

Classes:

  • Compaction: Data analysis and information bit stream of the HanXin Barcode type class
  • Data: Symbol tables for the HanXin Barcode type class
  • Encode: Symbol builder for the HanXin Barcode type class
  • Geometry: Function pattern placement of the HanXin Barcode type class The matrix cells hold 1 for a dark module, 0 for a light one, the string ‘I’ for a module of a function information area and null for a modu

Enums:

  • HanXinEccLevel: Backed enum for the Han Xin Code error correction level.

Com\Tecnick\Barcode\Type\Square\MicroQrCode

Classes:

  • Compaction: Encodation modes of the MicroQrCode Barcode type class
  • Data: Symbol tables for the MicroQrCode Barcode type class
  • Encode: Symbol builder for the MicroQrCode Barcode type class

Enums:

Com\Tecnick\Barcode\Type\Square\PdfFourOneSeven

Classes:

  • Compaction: Compaction methods for PdfFourOneSeven Barcode type class
  • Data: Data for PdfFourOneSeven Barcode type class
  • Sequence: Sequence methods for PdfFourOneSeven Barcode type class

Com\Tecnick\Barcode\Type\Square\QrCode

Classes:

  • Compaction: Encodation modes of the QrCode Barcode type class, sections 7.4.3 to 7.4.7 of ISO/IEC 18004.
  • Data: Symbol tables for the QrCode Barcode type class.
  • Encode: Symbol builder for the QrCode Barcode type class, sections 7.5 to 7.10 of ISO/IEC 18004.
  • Geometry: Function patterns of the QrCode Barcode type class, section 7.3 of ISO/IEC 18004: the finder patterns and their separators, the timing patterns, the alignment patterns, and the modules reserved for th

Enums:

  • QrEccLevel: Backed enum for the QR Code error correction level.
  • QrEncodingMode: Backed enum for the QR Code data encoding mode hint.

A

B

C

D

E

F

G

H

I

J

K

L

M

P

Q

R

S

T

U