ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes
Datamatrix Class Reference

Class to create DataMatrix ECC 200 barcode arrays for TCPDF class. More...

+ Collaboration diagram for Datamatrix:

Public Member Functions

 __construct ($code)
 This is the class constructor.
 getBarcodeArray ()
 Returns a barcode array which is readable by TCPDF.

Protected Member Functions

 getGFProduct ($a, $b, $log, $alog, $gf)
 Product of two numbers in a Power-of-Two Galois Field.
 getErrorCorrection ($wd, $nb, $nd, $nc, $gf=256, $pp=301)
 Add error correction codewords to data codewords array (ANNEX E).
 get253StateCodeword ($cwpad, $cwpos)
 Return the 253-state codeword.
 get255StateCodeword ($cwpad, $cwpos)
 Return the 255-state codeword.
 isCharMode ($chr, $mode)
 Returns true if the char belongs to the selected mode.
 lookAheadTest ($data, $pos, $mode)
 The look-ahead test scans the data to be encoded to find the best mode (Annex P - steps from J to S).
 getSwitchEncodingCodeword ($mode)
 Get the switching codeword to a new encoding mode (latch codeword)
 getMaxDataCodewords ($numcw)
 Choose the minimum matrix size and return the max number of data codewords.
 getHighLevelEncoding ($data)
 Get high level encoding using the minimum symbol data characters for ECC 200.
 placeModule ($marr, $nrow, $ncol, $row, $col, $chr, $bit)
 Places "chr+bit" with appropriate wrapping within array[].
 placeUtah ($marr, $nrow, $ncol, $row, $col, $chr)
 Places the 8 bits of a utah-shaped symbol character.
 placeCornerA ($marr, $nrow, $ncol, $chr)
 Places the 8 bits of the first special corner case.
 placeCornerB ($marr, $nrow, $ncol, $chr)
 Places the 8 bits of the second special corner case.
 placeCornerC ($marr, $nrow, $ncol, $chr)
 Places the 8 bits of the third special corner case.
 placeCornerD ($marr, $nrow, $ncol, $chr)
 Places the 8 bits of the fourth special corner case.
 getPlacementMap ($nrow, $ncol)
 Build a placement map.

Protected Attributes

 $barcode_array = array()
 Barcode array to be returned which is readable by TCPDF.
 $last_enc = ENC_ASCII
 Store last used encoding for data codewords.
 $symbattr
 Table of Data Matrix ECC 200 Symbol Attributes:
 $chset_id = array(ENC_C40 => 'C40', ENC_TXT => 'TXT', ENC_X12 =>'X12')
 Map encodation modes whit character sets.
 $chset
 Basic set of characters for each encodation mode.

Detailed Description

Class to create DataMatrix ECC 200 barcode arrays for TCPDF class.

DataMatrix (ISO/IEC 16022:2006) is a 2-dimensional bar code.

Definition at line 110 of file datamatrix.php.

Constructor & Destructor Documentation

Datamatrix::__construct (   $code)

This is the class constructor.

Creates a datamatrix object

Parameters
$code(string) Code to represent using Datamatrix.

Definition at line 235 of file datamatrix.php.

References $barcode_array, $nd, $row, ENC_ASCII, ENC_BASE256, ENC_EDF, get253StateCodeword(), getErrorCorrection(), getHighLevelEncoding(), and getPlacementMap().

{
$barcode_array = array();
if ((is_null($code)) OR ($code == '\0') OR ($code == '')) {
return false;
}
// get data codewords
$cw = $this->getHighLevelEncoding($code);
// number of data codewords
$nd = count($cw);
// check size
if ($nd > 1558) {
return false;
}
// get minimum required matrix size.
foreach ($this->symbattr as $params) {
if ($params[11] >= $nd) {
break;
}
}
if ($params[11] < $nd) {
// too much data
return false;
} elseif ($params[11] > $nd) {
// add padding
if ($this->last_enc == ENC_EDF) {
// switch to ASCII encoding
$cw[] = 124;
++$nd;
} elseif (($this->last_enc != ENC_ASCII) AND ($this->last_enc != ENC_BASE256)) {
// switch to ASCII encoding
$cw[] = 254;
++$nd;
}
if ($params[11] > $nd) {
// add first pad
$cw[] = 129;
++$nd;
// add remaining pads
for ($i = $nd; $i < $params[11]; ++$i) {
$cw[] = $this->get253StateCodeword(129, $i);
}
}
}
// add error correction codewords
$cw = $this->getErrorCorrection($cw, $params[13], $params[14], $params[15]);
// initialize empty arrays
$grid = array_fill(0, ($params[2] * $params[3]), 0);
// get placement map
$places = $this->getPlacementMap($params[2], $params[3]);
// fill the grid with data
$grid = array();
$i = 0;
// region data row max index
$rdri = ($params[4] - 1);
// region data column max index
$rdci = ($params[5] - 1);
// for each vertical region
for ($vr = 0; $vr < $params[9]; ++$vr) {
// for each row on region
for ($r = 0; $r < $params[4]; ++$r) {
// get row
$row = (($vr * $params[4]) + $r);
// for each horizontal region
for ($hr = 0; $hr < $params[8]; ++$hr) {
// for each column on region
for ($c = 0; $c < $params[5]; ++$c) {
// get column
$col = (($hr * $params[5]) + $c);
// braw bits by case
if ($r == 0) {
// top finder pattern
if ($c % 2) {
$grid[$row][$col] = 0;
} else {
$grid[$row][$col] = 1;
}
} elseif ($r == $rdri) {
// bottom finder pattern
$grid[$row][$col] = 1;
} elseif ($c == 0) {
// left finder pattern
$grid[$row][$col] = 1;
} elseif ($c == $rdci) {
// right finder pattern
if ($r % 2) {
$grid[$row][$col] = 1;
} else {
$grid[$row][$col] = 0;
}
} else { // data bit
if ($places[$i] < 2) {
$grid[$row][$col] = $places[$i];
} else {
// codeword ID
$cw_id = (floor($places[$i] / 10) - 1);
// codeword BIT mask
$cw_bit = pow(2, (8 - ($places[$i] % 10)));
$grid[$row][$col] = (($cw[$cw_id] & $cw_bit) == 0) ? 0 : 1;
}
++$i;
}
}
}
}
}
$this->barcode_array['num_rows'] = $params[0];
$this->barcode_array['num_cols'] = $params[1];
$this->barcode_array['bcode'] = $grid;
}

+ Here is the call graph for this function:

Member Function Documentation

Datamatrix::get253StateCodeword (   $cwpad,
  $cwpos 
)
protected

Return the 253-state codeword.

Parameters
$cwpad(int) Pad codeword.
$cwpos(int) Number of data codewords from the beginning of encoded data.
Returns
pad codeword

Definition at line 444 of file datamatrix.php.

Referenced by __construct().

{
$pad = ($cwpad + (((149 * $cwpos) % 253) + 1));
if ($pad > 254) {
$pad -= 254;
}
return $pad;
}

+ Here is the caller graph for this function:

Datamatrix::get255StateCodeword (   $cwpad,
  $cwpos 
)
protected

Return the 255-state codeword.

Parameters
$cwpad(int) Pad codeword.
$cwpos(int) Number of data codewords from the beginning of encoded data.
Returns
pad codeword

Definition at line 459 of file datamatrix.php.

Referenced by getHighLevelEncoding().

{
$pad = ($cwpad + (((149 * $cwpos) % 255) + 1));
if ($pad > 255) {
$pad -= 256;
}
return $pad;
}

+ Here is the caller graph for this function:

Datamatrix::getBarcodeArray ( )

Returns a barcode array which is readable by TCPDF.

Returns
array barcode array readable by TCPDF;

Definition at line 350 of file datamatrix.php.

References $barcode_array.

{
return $this->barcode_array;
}
Datamatrix::getErrorCorrection (   $wd,
  $nb,
  $nd,
  $nc,
  $gf = 256,
  $pp = 301 
)
protected

Add error correction codewords to data codewords array (ANNEX E).

Parameters
$wd(array) Array of datacodewords.
$nb(int) Number of blocks.
$nd(int) Number of data codewords per block.
$nc(int) Number of correction codewords per block.
$gf(int) numner of fields on log/antilog table (power of 2).
$pp(int) The value of its prime modulus polynomial (301 for ECC200).
Returns
array data codewords + error codewords

Definition at line 382 of file datamatrix.php.

References $log, $n, $nd, and getGFProduct().

Referenced by __construct().

{
// generate the log ($log) and antilog ($alog) tables
$log[0] = 0;
$alog[0] = 1;
for ($i = 1; $i < $gf; ++$i) {
$alog[$i] = ($alog[($i - 1)] * 2);
if ($alog[$i] >= $gf) {
$alog[$i] ^= $pp;
}
$log[$alog[$i]] = $i;
}
ksort($log);
// generate the polynomial coefficients (c)
$c = array_fill(0, ($nc + 1), 0);
$c[0] = 1;
for ($i = 1; $i <= $nc; ++$i) {
$c[$i] = $c[($i-1)];
for ($j = ($i - 1); $j >= 1; --$j) {
$c[$j] = $c[($j - 1)] ^ $this->getGFProduct($c[$j], $alog[$i], $log, $alog, $gf);
}
$c[0] = $this->getGFProduct($c[0], $alog[$i], $log, $alog, $gf);
}
ksort($c);
// total number of data codewords
$num_wd = ($nb * $nd);
// total number of error codewords
$num_we = ($nb * $nc);
// for each block
for ($b = 0; $b < $nb; ++$b) {
// create interleaved data block
$block = array();
for ($n = $b; $n < $num_wd; $n += $nb) {
$block[] = $wd[$n];
}
// initialize error codewords
$we = array_fill(0, ($nc + 1), 0);
// calculate error correction codewords for this block
for ($i = 0; $i < $nd; ++$i) {
$k = ($we[0] ^ $block[$i]);
for ($j = 0; $j < $nc; ++$j) {
$we[$j] = ($we[($j + 1)] ^ $this->getGFProduct($k, $c[($nc - $j - 1)], $log, $alog, $gf));
}
}
// add error codewords at the end of data codewords
$j = 0;
for ($i = $b; $i < $num_we; $i += $nb) {
$wd[($num_wd + $i)] = $we[$j];
++$j;
}
}
// reorder codewords
ksort($wd);
return $wd;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Datamatrix::getGFProduct (   $a,
  $b,
  $log,
  $alog,
  $gf 
)
protected

Product of two numbers in a Power-of-Two Galois Field.

Parameters
$a(int) first number to multiply.
$b(int) second number to multiply.
$log(array) Log table.
$alog(array) Anti-Log table.
$gf(array) Number of Factors of the Reed-Solomon polynomial.
Returns
int product

Definition at line 364 of file datamatrix.php.

References $log.

Referenced by getErrorCorrection().

{
if (($a == 0) OR ($b == 0)) {
return 0;
}
return ($alog[($log[$a] + $log[$b]) % ($gf - 1)]);
}

+ Here is the caller graph for this function:

Datamatrix::getHighLevelEncoding (   $data)
protected

Get high level encoding using the minimum symbol data characters for ECC 200.

Parameters
$data(string) data to encode
Returns
array of codewords

Definition at line 702 of file datamatrix.php.

References ENC_ASCII, ENC_ASCII_EXT, ENC_ASCII_NUM, ENC_BASE256, ENC_C40, ENC_EDF, ENC_TXT, ENC_X12, get255StateCodeword(), getMaxDataCodewords(), getSwitchEncodingCodeword(), isCharMode(), and lookAheadTest().

Referenced by __construct().

{
// STEP A. Start in ASCII encodation.
$enc = ENC_ASCII; // current encoding mode
$pos = 0; // current position
$cw = array(); // array of codewords to be returned
$cw_num = 0; // number of data codewords
$data_lenght = strlen($data); // number of chars
while ($pos < $data_lenght) {
switch ($enc) {
case ENC_ASCII: { // STEP B. While in ASCII encodation
if (($data_lenght > 1) AND ($pos < ($data_lenght - 1)) AND ($this->isCharMode(ord($data[$pos]), ENC_ASCII_NUM) AND $this->isCharMode(ord($data[$pos + 1]), ENC_ASCII_NUM))) {
// 1. If the next data sequence is at least 2 consecutive digits, encode the next two digits as a double digit in ASCII mode.
$cw[] = (intval(substr($data, $pos, 2)) + 130);
++$cw_num;
$pos += 2;
} else {
// 2. If the look-ahead test (starting at step J) indicates another mode, switch to that mode.
$newenc = $this->lookAheadTest($data, $pos, $enc);
if ($newenc != $enc) {
// switch to new encoding
$enc = $newenc;
$cw[] = $this->getSwitchEncodingCodeword($enc);
++$cw_num;
} else {
// get new byte
$chr = ord($data[$pos]);
++$pos;
if ($this->isCharMode($chr, ENC_ASCII_EXT)) {
// 3. If the next data character is extended ASCII (greater than 127) encode it in ASCII mode first using the Upper Shift (value 235) character.
$cw[] = 235;
$cw[] = ($chr - 127);
$cw_num += 2;
} else {
// 4. Otherwise process the next data character in ASCII encodation.
$cw[] = ($chr + 1);
++$cw_num;
}
}
}
break;
}
case ENC_C40 : // Upper-case alphanumeric
case ENC_TXT : // Lower-case alphanumeric
case ENC_X12 : { // ANSI X12
$temp_cw = array();
$p = 0;
$epos = $pos;
// get charset ID
$set_id = $this->chset_id[$enc];
// get basic charset for current encoding
$charset = $this->chset[$set_id];
do {
// 2. process the next character in C40 encodation.
$chr = ord($data[$epos]);
++$epos;
// check for extended character
if ($chr & 0x80) {
if ($enc == ENC_X12) {
return false;
}
$chr = ($chr & 0x7f);
$temp_cw[] = 1; // shift 2
$temp_cw[] = 30; // upper shift
$p += 2;
}
if (isset($charset[$chr])) {
$temp_cw[] = $charset[$chr];
++$p;
} else {
if (isset($this->chset['SH1'][$chr])) {
$temp_cw[] = 0; // shift 1
$shiftset = $this->chset['SH1'];
} elseif (isset($chr, $this->chset['SH2'][$chr])) {
$temp_cw[] = 1; // shift 2
$shiftset = $this->chset['SH2'];
} elseif (($enc == ENC_C40) AND isset($this->chset['S3C'][$chr])) {
$temp_cw[] = 2; // shift 3
$shiftset = $this->chset['S3C'];
} elseif (($enc == ENC_TXT) AND isset($this->chset['S3T'][$chr])) {
$temp_cw[] = 2; // shift 3
$shiftset = $this->chset['S3T'];
} else {
return false;
}
$temp_cw[] = $shiftset[$chr];
$p += 2;
}
if ($p >= 3) {
$c1 = array_shift($temp_cw);
$c2 = array_shift($temp_cw);
$c3 = array_shift($temp_cw);
$p -= 3;
$tmp = ((1600 * $c1) + (40 * $c2) + $c3 + 1);
$cw[] = ($tmp >> 8);
$cw[] = ($tmp % 256);
$cw_num += 2;
$pos = $epos;
// 1. If the C40 encoding is at the point of starting a new double symbol character and if the look-ahead test (starting at step J) indicates another mode, switch to that mode.
$newenc = $this->lookAheadTest($data, $pos, $enc);
if ($newenc != $enc) {
$enc = $newenc;
$cw[] = $this->getSwitchEncodingCodeword($enc);
++$cw_num;
$pos -= $p;
$p = 0;
break;
}
}
} while (($p > 0) AND ($epos < $data_lenght));
// process last data (if any)
if ($p > 0) {
// get remaining number of data symbols
$cwr = ($this->getMaxDataCodewords($cw_num + 2) - $cw_num);
if (($cwr == 1) AND ($p == 1)) {
// d. If one symbol character remains and one C40 value (data character) remains to be encoded
$c1 = array_shift($temp_cw);
--$p;
$cw[] = ($c1 + 1);
++$cw_num;
} elseif (($cwr == 2) AND ($p == 1)) {
// c. If two symbol characters remain and only one C40 value (data character) remains to be encoded
$c1 = array_shift($temp_cw);
--$p;
$cw[] = 254;
$cw[] = ($c1 + 1);
$cw_num += 2;
} elseif (($cwr == 2) AND ($p == 2)) {
// b. If two symbol characters remain and two C40 values remain to be encoded
$c1 = array_shift($temp_cw);
$c2 = array_shift($temp_cw);
$p -= 2;
$tmp = ((1600 * $c1) + (40 * $c2) + 1);
$cw[] = ($tmp >> 8);
$cw[] = ($tmp % 256);
$cw_num += 2;
} else {
// switch to ASCII encoding
if ($enc != ENC_ASCII) {
$enc = ENC_ASCII;
$cw[] = $this->getSwitchEncodingCodeword($enc);
++$cw_num;
}
}
}
break;
}
case ENC_EDF: { // F. While in EDIFACT (EDF) encodation
// initialize temporary array with 0 lenght
$temp_cw = array();
$epos = $pos;
$field_lenght = 0;
$newenc = $enc;
do {
// 2. process the next character in EDIFACT encodation.
$chr = ord($data[$epos]);
if ($this->isCharMode($chr, ENC_EDF)) {
++$epos;
$temp_cw[] = $chr;
++$field_lenght;
}
if (($field_lenght == 4) OR ($epos == $data_lenght) OR !$this->isCharMode($chr, ENC_EDF)) {
if ($field_lenght < 4) {
// set unlatch character
$temp_cw[] = 0x1f;
++$field_lenght;
// fill empty characters
for ($i = $field_lenght; $i < 4; ++$i) {
$temp_cw[] = 0;
}
$enc = ENC_ASCII;
}
// encodes four data characters in three codewords
$tcw = (($temp_cw[0] & 0x3F) << 2) + (($temp_cw[1] & 0x30) >> 4);
if ($tcw > 0) {
$cw[] = $tcw;
$cw_num++;
}
$tcw= (($temp_cw[1] & 0x0F) << 4) + (($temp_cw[2] & 0x3C) >> 2);
if ($tcw > 0) {
$cw[] = $tcw;
$cw_num++;
}
$tcw = (($temp_cw[2] & 0x03) << 6) + ($temp_cw[3] & 0x3F);
if ($tcw > 0) {
$cw[] = $tcw;
$cw_num++;
}
$temp_cw = array();
$pos = $epos;
$field_lenght = 0;
if ($enc == ENC_ASCII) {
break; // exit from EDIFACT mode
}
}
} while ($epos < $data_lenght);
break;
}
case ENC_BASE256: { // G. While in Base 256 (B256) encodation
// initialize temporary array with 0 lenght
$temp_cw = array();
$field_lenght = 0;
while (($pos < $data_lenght) AND ($field_lenght <= 1555)) {
$newenc = $this->lookAheadTest($data, $pos, $enc);
if ($newenc != $enc) {
// 1. If the look-ahead test (starting at step J) indicates another mode, switch to that mode.
$enc = $newenc;
$cw[] = $this->getSwitchEncodingCodeword($enc);
++$cw_num;
break; // exit from B256 mode
} else {
// 2. Otherwise, process the next character in Base 256 encodation.
$chr = ord($data[$pos]);
++$pos;
$temp_cw[] = $chr;
++$field_lenght;
}
}
// set field lenght
if ($field_lenght <= 249) {
$cw[] = $field_lenght;
++$cw_num;
} else {
$cw[] = (floor($field_lenght / 250) + 249);
$cw[] = ($field_lenght % 250);
$cw_num += 2;
}
if (!empty($temp_cw)) {
// add B256 field
foreach ($temp_cw as $p => $cht) {
$cw[] = $this->get255StateCodeword($chr, ($cw_num + $p));
}
}
break;
}
} // end of switch enc
} // end of while
// set last used encoding
$this->last_enc = $enc;
return $cw;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Datamatrix::getMaxDataCodewords (   $numcw)
protected

Choose the minimum matrix size and return the max number of data codewords.

Parameters
$numcw(int) Number of current codewords.
Returns
number of data codewords in matrix

Definition at line 687 of file datamatrix.php.

Referenced by getHighLevelEncoding().

{
foreach ($this->symbattr as $key => $matrix) {
if ($matrix[11] >= $numcw) {
return $matrix[11];
}
}
return 0;
}

+ Here is the caller graph for this function:

Datamatrix::getPlacementMap (   $nrow,
  $ncol 
)
protected

Build a placement map.

(Annex F - ECC 200 symbol character placement)

Parameters
$nrow(int) Number of rows.
$ncol(int) Number of columns.
Returns
array

Definition at line 1089 of file datamatrix.php.

References $row, placeCornerA(), placeCornerB(), placeCornerC(), placeCornerD(), and placeUtah().

Referenced by __construct().

{
// initialize array with zeros
$marr = array_fill(0, ($nrow * $ncol), 0);
// set starting values
$chr = 1;
$row = 4;
$col = 0;
do {
// repeatedly first check for one of the special corner cases, then
if (($row == $nrow) AND ($col == 0)) {
$marr = $this->placeCornerA($marr, $nrow, $ncol, $chr);
++$chr;
}
if (($row == ($nrow - 2)) AND ($col == 0) AND ($ncol % 4)) {
$marr = $this->placeCornerB($marr, $nrow, $ncol, $chr);
++$chr;
}
if (($row == ($nrow - 2)) AND ($col == 0) AND (($ncol % 8) == 4)) {
$marr = $this->placeCornerC($marr, $nrow, $ncol, $chr);
++$chr;
}
if (($row == ($nrow + 4)) AND ($col == 2) AND (!($ncol % 8))) {
$marr = $this->placeCornerD($marr, $nrow, $ncol, $chr);
++$chr;
}
// sweep upward diagonally, inserting successive characters,
do {
if (($row < $nrow) AND ($col >= 0) AND (!$marr[(($row * $ncol) + $col)])) {
$marr = $this->placeUtah($marr, $nrow, $ncol, $row, $col, $chr);
++$chr;
}
$row -= 2;
$col += 2;
} while (($row >= 0) AND ($col < $ncol));
++$row;
$col += 3;
// & then sweep downward diagonally, inserting successive characters,...
do {
if (($row >= 0) AND ($col < $ncol) AND (!$marr[(($row * $ncol) + $col)])) {
$marr = $this->placeUtah($marr, $nrow, $ncol, $row, $col, $chr);
++$chr;
}
$row += 2;
$col -= 2;
} while (($row < $nrow) AND ($col >= 0));
$row += 3;
++$col;
// ... until the entire array is scanned
} while (($row < $nrow) OR ($col < $ncol));
// lastly, if the lower righthand corner is untouched, fill in fixed pattern
if (!$marr[(($nrow * $ncol) - 1)]) {
$marr[(($nrow * $ncol) - 1)] = 1;
$marr[(($nrow * $ncol) - $ncol - 2)] = 1;
}
return $marr;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Datamatrix::getSwitchEncodingCodeword (   $mode)
protected

Get the switching codeword to a new encoding mode (latch codeword)

Parameters
$mode(int) New encoding mode.
Returns
(int) Switch codeword.

Definition at line 651 of file datamatrix.php.

References ENC_ASCII, ENC_BASE256, ENC_C40, ENC_EDF, ENC_TXT, and ENC_X12.

Referenced by getHighLevelEncoding().

{
switch ($mode) {
case ENC_ASCII: { // ASCII character 0 to 127
$cw = 254;
break;
}
case ENC_C40: { // Upper-case alphanumeric
$cw = 230;
break;
}
case ENC_TXT: { // Lower-case alphanumeric
$cw = 239;
break;
}
case ENC_X12: { // ANSI X12
$cw = 238;
break;
}
case ENC_EDF: { // ASCII character 32 to 94
$cw = 240;
break;
}
case ENC_BASE256: { // Function character (FNC1, Structured Append, Reader Program, or Code Page)
$cw = 231;
break;
}
}
return $cw;
}

+ Here is the caller graph for this function:

Datamatrix::isCharMode (   $chr,
  $mode 
)
protected

Returns true if the char belongs to the selected mode.

Parameters
$chr(int) Character (byte) to check.
$mode(int) Current encoding mode.
Returns
boolean true if the char is of the selected mode.

Definition at line 474 of file datamatrix.php.

References ENC_ASCII, ENC_ASCII_EXT, ENC_ASCII_NUM, ENC_BASE256, ENC_C40, ENC_EDF, ENC_TXT, and ENC_X12.

Referenced by getHighLevelEncoding(), and lookAheadTest().

{
$status = false;
switch ($mode) {
case ENC_ASCII: { // ASCII character 0 to 127
$status = (($chr >= 0) AND ($chr <= 127));
break;
}
case ENC_C40: { // Upper-case alphanumeric
$status = (($chr == 32) OR (($chr >= 48) AND ($chr <= 57)) OR (($chr >= 65) AND ($chr <= 90)));
break;
}
case ENC_TXT: { // Lower-case alphanumeric
$status = (($chr == 32) OR (($chr >= 48) AND ($chr <= 57)) OR (($chr >= 97) AND ($chr <= 122)));
break;
}
case ENC_X12: { // ANSI X12
$status = (($chr == 13) OR ($chr == 42) OR ($chr == 62));
break;
}
case ENC_EDF: { // ASCII character 32 to 94
$status = (($chr >= 32) AND ($chr <= 94));
break;
}
case ENC_BASE256: { // Function character (FNC1, Structured Append, Reader Program, or Code Page)
$status = (($chr == 232) OR ($chr == 233) OR ($chr == 234) OR ($chr == 241));
break;
}
case ENC_ASCII_EXT: { // ASCII character 128 to 255
$status = (($chr >= 128) AND ($chr <= 255));
break;
}
case ENC_ASCII_NUM: { // ASCII digits
$status = (($chr >= 48) AND ($chr <= 57));
break;
}
}
return $status;
}

+ Here is the caller graph for this function:

Datamatrix::lookAheadTest (   $data,
  $pos,
  $mode 
)
protected

The look-ahead test scans the data to be encoded to find the best mode (Annex P - steps from J to S).

Parameters
$data(string) data to encode
$pos(int) current position
$mode(int) current encoding mode
Returns
int encoding mode

Definition at line 521 of file datamatrix.php.

References ENC_ASCII, ENC_ASCII_EXT, ENC_ASCII_NUM, ENC_BASE256, ENC_C40, ENC_EDF, ENC_TXT, ENC_X12, and isCharMode().

Referenced by getHighLevelEncoding().

{
$data_length = strlen($data);
if ($pos >= $data_length) {
return $mode;
}
$charscount = 0; // count processed chars
// STEP J
if ($mode == ENC_ASCII) {
$numch = array(0, 1, 1, 1, 1, 1.25);
} else {
$numch = array(1, 2, 2, 2, 2, 2.25);
$numch[$mode] = 0;
}
while (true) {
// STEP K
if (($pos + $charscount) == $data_length) {
if ($numch[ENC_ASCII] <= ceil(min($numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_X12], $numch[ENC_EDF], $numch[ENC_BASE256]))) {
return ENC_ASCII;
}
if ($numch[ENC_BASE256] < ceil(min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_X12], $numch[ENC_EDF]))) {
return ENC_BASE256;
}
if ($numch[ENC_EDF] < ceil(min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_X12], $numch[ENC_BASE256]))) {
return ENC_EDF;
}
if ($numch[ENC_TXT] < ceil(min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_X12], $numch[ENC_EDF], $numch[ENC_BASE256]))) {
return ENC_TXT;
}
if ($numch[ENC_X12] < ceil(min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_EDF], $numch[ENC_BASE256]))) {
return ENC_X12;
}
return ENC_C40;
}
// get char
$chr = ord($data[$pos + $charscount]);
$charscount++;
// STEP L
if ($this->isCharMode($chr, ENC_ASCII_NUM)) {
$numch[ENC_ASCII] += (1 / 2);
} elseif ($this->isCharMode($chr, ENC_ASCII_EXT)) {
$numch[ENC_ASCII] = ceil($numch[ENC_ASCII]);
$numch[ENC_ASCII] += 2;
} else {
$numch[ENC_ASCII] = ceil($numch[ENC_ASCII]);
$numch[ENC_ASCII] += 1;
}
// STEP M
if ($this->isCharMode($chr, ENC_C40)) {
$numch[ENC_C40] += (2 / 3);
} elseif ($this->isCharMode($chr, ENC_ASCII_EXT)) {
$numch[ENC_C40] += (8 / 3);
} else {
$numch[ENC_C40] += (4 / 3);
}
// STEP N
if ($this->isCharMode($chr, ENC_TXT)) {
$numch[ENC_TXT] += (2 / 3);
} elseif ($this->isCharMode($chr, ENC_ASCII_EXT)) {
$numch[ENC_TXT] += (8 / 3);
} else {
$numch[ENC_TXT] += (4 / 3);
}
// STEP O
if ($this->isCharMode($chr, ENC_X12) OR $this->isCharMode($chr, ENC_C40)) {
$numch[ENC_X12] += (2 / 3);
} elseif ($this->isCharMode($chr, ENC_ASCII_EXT)) {
$numch[ENC_X12] += (13 / 3);
} else {
$numch[ENC_X12] += (10 / 3);
}
// STEP P
if ($this->isCharMode($chr, ENC_EDF)) {
$numch[ENC_EDF] += (3 / 4);
} elseif ($this->isCharMode($chr, ENC_ASCII_EXT)) {
$numch[ENC_EDF] += (17 / 4);
} else {
$numch[ENC_EDF] += (13 / 4);
}
// STEP Q
if ($this->isCharMode($chr, ENC_BASE256)) {
$numch[ENC_BASE256] += 4;
} else {
$numch[ENC_BASE256] += 1;
}
// STEP R
if ($charscount >= 4) {
if (($numch[ENC_ASCII] + 1) <= min($numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_X12], $numch[ENC_EDF], $numch[ENC_BASE256])) {
return ENC_ASCII;
}
if ((($numch[ENC_BASE256] + 1) <= $numch[ENC_ASCII])
OR (($numch[ENC_BASE256] + 1) < min($numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_X12], $numch[ENC_EDF]))) {
return ENC_BASE256;
}
if (($numch[ENC_EDF] + 1) < min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_X12], $numch[ENC_BASE256])) {
return ENC_EDF;
}
if (($numch[ENC_TXT] + 1) < min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_X12], $numch[ENC_EDF], $numch[ENC_BASE256])) {
return ENC_TXT;
}
if (($numch[ENC_X12] + 1) < min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_EDF], $numch[ENC_BASE256])) {
return ENC_X12;
}
if (($numch[ENC_C40] + 1) < min($numch[ENC_ASCII], $numch[ENC_TXT], $numch[ENC_EDF], $numch[ENC_BASE256])) {
if ($numch[ENC_C40] < $numch[ENC_X12]) {
return ENC_C40;
}
if ($numch[ENC_C40] == $numch[ENC_X12]) {
$k = ($pos + $charscount + 1);
while ($k < $data_length) {
$tmpchr = ord($data{$k});
if ($this->isCharMode($tmpchr, ENC_X12)) {
return ENC_X12;
} elseif (!($this->isCharMode($tmpchr, ENC_X12) OR $this->isCharMode($tmpchr, ENC_C40))) {
break;
}
++$k;
}
return ENC_C40;
}
}
}
} // end of while
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Datamatrix::placeCornerA (   $marr,
  $nrow,
  $ncol,
  $chr 
)
protected

Places the 8 bits of the first special corner case.

(Annex F - ECC 200 symbol character placement)

Parameters
$marr(array) Array of symbols.
$nrow(int) Number of rows.
$ncol(int) Number of columns.
$chr(int) Char byte.
Returns
array

Definition at line 1003 of file datamatrix.php.

References placeModule().

Referenced by getPlacementMap().

{
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, 0, $chr, 1);
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, 1, $chr, 2);
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, 2, $chr, 3);
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-2, $chr, 4);
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-1, $chr, 5);
$marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol-1, $chr, 6);
$marr = $this->placeModule($marr, $nrow, $ncol, 2, $ncol-1, $chr, 7);
$marr = $this->placeModule($marr, $nrow, $ncol, 3, $ncol-1, $chr, 8);
return $marr;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Datamatrix::placeCornerB (   $marr,
  $nrow,
  $ncol,
  $chr 
)
protected

Places the 8 bits of the second special corner case.

(Annex F - ECC 200 symbol character placement)

Parameters
$marr(array) Array of symbols.
$nrow(int) Number of rows.
$ncol(int) Number of columns.
$chr(int) Char byte.
Returns
array

Definition at line 1025 of file datamatrix.php.

References placeModule().

Referenced by getPlacementMap().

{
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow-3, 0, $chr, 1);
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow-2, 0, $chr, 2);
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, 0, $chr, 3);
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-4, $chr, 4);
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-3, $chr, 5);
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-2, $chr, 6);
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-1, $chr, 7);
$marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol-1, $chr, 8);
return $marr;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Datamatrix::placeCornerC (   $marr,
  $nrow,
  $ncol,
  $chr 
)
protected

Places the 8 bits of the third special corner case.

(Annex F - ECC 200 symbol character placement)

Parameters
$marr(array) Array of symbols.
$nrow(int) Number of rows.
$ncol(int) Number of columns.
$chr(int) Char byte.
Returns
array

Definition at line 1047 of file datamatrix.php.

References placeModule().

Referenced by getPlacementMap().

{
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow-3, 0, $chr, 1);
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow-2, 0, $chr, 2);
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, 0, $chr, 3);
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-2, $chr, 4);
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-1, $chr, 5);
$marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol-1, $chr, 6);
$marr = $this->placeModule($marr, $nrow, $ncol, 2, $ncol-1, $chr, 7);
$marr = $this->placeModule($marr, $nrow, $ncol, 3, $ncol-1, $chr, 8);
return $marr;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Datamatrix::placeCornerD (   $marr,
  $nrow,
  $ncol,
  $chr 
)
protected

Places the 8 bits of the fourth special corner case.

(Annex F - ECC 200 symbol character placement)

Parameters
$marr(array) Array of symbols.
$nrow(int) Number of rows.
$ncol(int) Number of columns.
$chr(int) Char byte.
Returns
array

Definition at line 1069 of file datamatrix.php.

References placeModule().

Referenced by getPlacementMap().

{
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, 0, $chr, 1);
$marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, $ncol-1, $chr, 2);
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-3, $chr, 3);
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-2, $chr, 4);
$marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-1, $chr, 5);
$marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol-3, $chr, 6);
$marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol-2, $chr, 7);
$marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol-1, $chr, 8);
return $marr;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Datamatrix::placeModule (   $marr,
  $nrow,
  $ncol,
  $row,
  $col,
  $chr,
  $bit 
)
protected

Places "chr+bit" with appropriate wrapping within array[].

(Annex F - ECC 200 symbol character placement)

Parameters
$marr(array) Array of symbols.
$nrow(int) Number of rows.
$ncol(int) Number of columns.
$row(int) Row number.
$col(int) Column number.
$chr(int) Char byte.
$bit(int) Bit.
Returns
array

Definition at line 956 of file datamatrix.php.

References $row.

Referenced by placeCornerA(), placeCornerB(), placeCornerC(), placeCornerD(), and placeUtah().

{
if ($row < 0) {
$row += $nrow;
$col += (4 - (($nrow + 4) % 8));
}
if ($col < 0) {
$col += $ncol;
$row += (4 - (($ncol + 4) % 8));
}
$marr[(($row * $ncol) + $col)] = ((10 * $chr) + $bit);
return $marr;
}

+ Here is the caller graph for this function:

Datamatrix::placeUtah (   $marr,
  $nrow,
  $ncol,
  $row,
  $col,
  $chr 
)
protected

Places the 8 bits of a utah-shaped symbol character.

(Annex F - ECC 200 symbol character placement)

Parameters
$marr(array) Array of symbols.
$nrow(int) Number of rows.
$ncol(int) Number of columns.
$row(int) Row number.
$col(int) Column number.
$chr(int) Char byte.
Returns
array

Definition at line 981 of file datamatrix.php.

References $row, and placeModule().

Referenced by getPlacementMap().

{
$marr = $this->placeModule($marr, $nrow, $ncol, $row-2, $col-2, $chr, 1);
$marr = $this->placeModule($marr, $nrow, $ncol, $row-2, $col-1, $chr, 2);
$marr = $this->placeModule($marr, $nrow, $ncol, $row-1, $col-2, $chr, 3);
$marr = $this->placeModule($marr, $nrow, $ncol, $row-1, $col-1, $chr, 4);
$marr = $this->placeModule($marr, $nrow, $ncol, $row-1, $col, $chr, 5);
$marr = $this->placeModule($marr, $nrow, $ncol, $row, $col-2, $chr, 6);
$marr = $this->placeModule($marr, $nrow, $ncol, $row, $col-1, $chr, 7);
$marr = $this->placeModule($marr, $nrow, $ncol, $row, $col, $chr, 8);
return $marr;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Field Documentation

Datamatrix::$barcode_array = array()
protected

Barcode array to be returned which is readable by TCPDF.

Definition at line 116 of file datamatrix.php.

Referenced by __construct(), and getBarcodeArray().

Datamatrix::$chset
protected

Basic set of characters for each encodation mode.

Definition at line 190 of file datamatrix.php.

Datamatrix::$chset_id = array(ENC_C40 => 'C40', ENC_TXT => 'TXT', ENC_X12 =>'X12')
protected

Map encodation modes whit character sets.

Definition at line 184 of file datamatrix.php.

Datamatrix::$last_enc = ENC_ASCII
protected

Store last used encoding for data codewords.

Definition at line 122 of file datamatrix.php.

Datamatrix::$symbattr
protected

Table of Data Matrix ECC 200 Symbol Attributes:

  • total matrix rows (including finder pattern)
  • total matrix cols (including finder pattern)
  • total matrix rows (without finder pattern)
  • total matrix cols (without finder pattern)
  • region data rows (with finder pattern)
  • region data col (with finder pattern)
  • region data rows (without finder pattern)
  • region data col (without finder pattern)
  • horizontal regions
  • vertical regions
  • regions
  • data codewords
  • error codewords
  • blocks
  • data codewords per block
  • error codewords per block

Definition at line 145 of file datamatrix.php.

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