ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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. More...
 
 getBarcodeArray ()
 Returns a barcode array which is readable by TCPDF. More...
 

Protected Member Functions

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

Protected Attributes

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

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

◆ __construct()

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, $code, $nd, $params, $r, $row, ENC_ASCII, ENC_BASE256, ENC_EDF, get253StateCodeword(), getErrorCorrection(), getHighLevelEncoding(), and getPlacementMap().

235  {
236  $barcode_array = array();
237  if ((is_null($code)) OR ($code == '\0') OR ($code == '')) {
238  return false;
239  }
240  // get data codewords
241  $cw = $this->getHighLevelEncoding($code);
242  // number of data codewords
243  $nd = count($cw);
244  // check size
245  if ($nd > 1558) {
246  return false;
247  }
248  // get minimum required matrix size.
249  foreach ($this->symbattr as $params) {
250  if ($params[11] >= $nd) {
251  break;
252  }
253  }
254  if ($params[11] < $nd) {
255  // too much data
256  return false;
257  } elseif ($params[11] > $nd) {
258  // add padding
259  if ((($params[11] - $nd) > 1) AND ($cw[($nd - 1)] != 254)) {
260  if ($this->last_enc == ENC_EDF) {
261  // switch to ASCII encoding
262  $cw[] = 124;
263  ++$nd;
264  } elseif (($this->last_enc != ENC_ASCII) AND ($this->last_enc != ENC_BASE256)) {
265  // switch to ASCII encoding
266  $cw[] = 254;
267  ++$nd;
268  }
269  }
270  if ($params[11] > $nd) {
271  // add first pad
272  $cw[] = 129;
273  ++$nd;
274  // add remaining pads
275  for ($i = $nd; $i < $params[11]; ++$i) {
276  $cw[] = $this->get253StateCodeword(129, $i);
277  }
278  }
279  }
280  // add error correction codewords
281  $cw = $this->getErrorCorrection($cw, $params[13], $params[14], $params[15]);
282  // initialize empty arrays
283  $grid = array_fill(0, ($params[2] * $params[3]), 0);
284  // get placement map
285  $places = $this->getPlacementMap($params[2], $params[3]);
286  // fill the grid with data
287  $grid = array();
288  $i = 0;
289  // region data row max index
290  $rdri = ($params[4] - 1);
291  // region data column max index
292  $rdci = ($params[5] - 1);
293  // for each vertical region
294  for ($vr = 0; $vr < $params[9]; ++$vr) {
295  // for each row on region
296  for ($r = 0; $r < $params[4]; ++$r) {
297  // get row
298  $row = (($vr * $params[4]) + $r);
299  // for each horizontal region
300  for ($hr = 0; $hr < $params[8]; ++$hr) {
301  // for each column on region
302  for ($c = 0; $c < $params[5]; ++$c) {
303  // get column
304  $col = (($hr * $params[5]) + $c);
305  // braw bits by case
306  if ($r == 0) {
307  // top finder pattern
308  if ($c % 2) {
309  $grid[$row][$col] = 0;
310  } else {
311  $grid[$row][$col] = 1;
312  }
313  } elseif ($r == $rdri) {
314  // bottom finder pattern
315  $grid[$row][$col] = 1;
316  } elseif ($c == 0) {
317  // left finder pattern
318  $grid[$row][$col] = 1;
319  } elseif ($c == $rdci) {
320  // right finder pattern
321  if ($r % 2) {
322  $grid[$row][$col] = 1;
323  } else {
324  $grid[$row][$col] = 0;
325  }
326  } else { // data bit
327  if ($places[$i] < 2) {
328  $grid[$row][$col] = $places[$i];
329  } else {
330  // codeword ID
331  $cw_id = (floor($places[$i] / 10) - 1);
332  // codeword BIT mask
333  $cw_bit = pow(2, (8 - ($places[$i] % 10)));
334  $grid[$row][$col] = (($cw[$cw_id] & $cw_bit) == 0) ? 0 : 1;
335  }
336  ++$i;
337  }
338  }
339  }
340  }
341  }
342  $this->barcode_array['num_rows'] = $params[0];
343  $this->barcode_array['num_cols'] = $params[1];
344  $this->barcode_array['bcode'] = $grid;
345  }
$code
$code
Definition: example_050.php:99
ENC_EDF
const ENC_EDF
EDIFACT encoding: ASCII character 32 to 94 (4/3 bytes per CW)
Definition: datamatrix.php:84
$r
$r
Definition: example_031.php:79
Datamatrix\getPlacementMap
getPlacementMap($nrow, $ncol)
Build a placement map.
Definition: datamatrix.php:1116
$nd
$nd
Definition: error.php:11
Datamatrix\getErrorCorrection
getErrorCorrection($wd, $nb, $nd, $nc, $gf=256, $pp=301)
Add error correction codewords to data codewords array (ANNEX E).
Definition: datamatrix.php:384
Datamatrix\get253StateCodeword
get253StateCodeword($cwpad, $cwpos)
Return the 253-state codeword.
Definition: datamatrix.php:446
ENC_BASE256
const ENC_BASE256
BASE 256 encoding: ASCII character 0 to 255 (1 byte per CW)
Definition: datamatrix.php:89
ENC_ASCII
const ENC_ASCII(!defined('DATAMATRIXDEFS'))
ASCII encoding: ASCII character 0 to 127 (1 byte per CW)
Definition: datamatrix.php:64
Datamatrix\getHighLevelEncoding
getHighLevelEncoding($data)
Get high level encoding using the minimum symbol data characters for ECC 200.
Definition: datamatrix.php:707
Datamatrix\$barcode_array
$barcode_array
Barcode array to be returned which is readable by TCPDF.
Definition: datamatrix.php:116
$params
$params
Definition: example_049.php:96
+ Here is the call graph for this function:

Member Function Documentation

◆ get253StateCodeword()

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 446 of file datamatrix.php.

Referenced by __construct().

446  {
447  $pad = ($cwpad + (((149 * $cwpos) % 253) + 1));
448  if ($pad > 254) {
449  $pad -= 254;
450  }
451  return $pad;
452  }
+ Here is the caller graph for this function:

◆ get255StateCodeword()

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 461 of file datamatrix.php.

Referenced by getHighLevelEncoding().

461  {
462  $pad = ($cwpad + (((149 * $cwpos) % 255) + 1));
463  if ($pad > 255) {
464  $pad -= 256;
465  }
466  return $pad;
467  }
+ Here is the caller graph for this function:

◆ getBarcodeArray()

Datamatrix::getBarcodeArray ( )

Returns a barcode array which is readable by TCPDF.

Returns
array barcode array readable by TCPDF;

Definition at line 352 of file datamatrix.php.

References $barcode_array.

352  {
353  return $this->barcode_array;
354  }
Datamatrix\$barcode_array
$barcode_array
Barcode array to be returned which is readable by TCPDF.
Definition: datamatrix.php:116

◆ getErrorCorrection()

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 384 of file datamatrix.php.

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

Referenced by __construct().

384  {
385  // generate the log ($log) and antilog ($alog) tables
386  $log[0] = 0;
387  $alog[0] = 1;
388  for ($i = 1; $i < $gf; ++$i) {
389  $alog[$i] = ($alog[($i - 1)] * 2);
390  if ($alog[$i] >= $gf) {
391  $alog[$i] ^= $pp;
392  }
393  $log[$alog[$i]] = $i;
394  }
395  ksort($log);
396  // generate the polynomial coefficients (c)
397  $c = array_fill(0, ($nc + 1), 0);
398  $c[0] = 1;
399  for ($i = 1; $i <= $nc; ++$i) {
400  $c[$i] = $c[($i-1)];
401  for ($j = ($i - 1); $j >= 1; --$j) {
402  $c[$j] = $c[($j - 1)] ^ $this->getGFProduct($c[$j], $alog[$i], $log, $alog, $gf);
403  }
404  $c[0] = $this->getGFProduct($c[0], $alog[$i], $log, $alog, $gf);
405  }
406  ksort($c);
407  // total number of data codewords
408  $num_wd = ($nb * $nd);
409  // total number of error codewords
410  $num_we = ($nb * $nc);
411  // for each block
412  for ($b = 0; $b < $nb; ++$b) {
413  // create interleaved data block
414  $block = array();
415  for ($n = $b; $n < $num_wd; $n += $nb) {
416  $block[] = $wd[$n];
417  }
418  // initialize error codewords
419  $we = array_fill(0, ($nc + 1), 0);
420  // calculate error correction codewords for this block
421  for ($i = 0; $i < $nd; ++$i) {
422  $k = ($we[0] ^ $block[$i]);
423  for ($j = 0; $j < $nc; ++$j) {
424  $we[$j] = ($we[($j + 1)] ^ $this->getGFProduct($k, $c[($nc - $j - 1)], $log, $alog, $gf));
425  }
426  }
427  // add error codewords at the end of data codewords
428  $j = 0;
429  for ($i = $b; $i < $num_we; $i += $nb) {
430  $wd[($num_wd + $i)] = $we[$j];
431  ++$j;
432  }
433  }
434  // reorder codewords
435  ksort($wd);
436  return $wd;
437  }
$nd
$nd
Definition: error.php:11
$n
$n
Definition: RandomTest.php:80
Datamatrix\getGFProduct
getGFProduct($a, $b, $log, $alog, $gf)
Product of two numbers in a Power-of-Two Galois Field.
Definition: datamatrix.php:366
$log
$log
Definition: inc.setup_header.php:135
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getGFProduct()

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 366 of file datamatrix.php.

References $log.

Referenced by getErrorCorrection().

366  {
367  if (($a == 0) OR ($b == 0)) {
368  return 0;
369  }
370  return ($alog[($log[$a] + $log[$b]) % ($gf - 1)]);
371  }
$log
$log
Definition: inc.setup_header.php:135
+ Here is the caller graph for this function:

◆ getHighLevelEncoding()

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 707 of file datamatrix.php.

References $data, 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().

707  {
708  // STEP A. Start in ASCII encodation.
709  $enc = ENC_ASCII; // current encoding mode
710  $pos = 0; // current position
711  $cw = array(); // array of codewords to be returned
712  $cw_num = 0; // number of data codewords
713  $data_length = strlen($data); // number of chars
714  while ($pos < $data_length) {
715  // set last used encoding
716  $this->last_enc = $enc;
717  switch ($enc) {
718  case ENC_ASCII: { // STEP B. While in ASCII encodation
719  if (($data_length > 1) AND ($pos < ($data_length - 1)) AND ($this->isCharMode(ord($data[$pos]), ENC_ASCII_NUM) AND $this->isCharMode(ord($data[$pos + 1]), ENC_ASCII_NUM))) {
720  // 1. If the next data sequence is at least 2 consecutive digits, encode the next two digits as a double digit in ASCII mode.
721  $cw[] = (intval(substr($data, $pos, 2)) + 130);
722  ++$cw_num;
723  $pos += 2;
724  } else {
725  // 2. If the look-ahead test (starting at step J) indicates another mode, switch to that mode.
726  $newenc = $this->lookAheadTest($data, $pos, $enc);
727  if ($newenc != $enc) {
728  // switch to new encoding
729  $enc = $newenc;
730  $cw[] = $this->getSwitchEncodingCodeword($enc);
731  ++$cw_num;
732  } else {
733  // get new byte
734  $chr = ord($data[$pos]);
735  ++$pos;
736  if ($this->isCharMode($chr, ENC_ASCII_EXT)) {
737  // 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.
738  $cw[] = 235;
739  $cw[] = ($chr - 127);
740  $cw_num += 2;
741  } else {
742  // 4. Otherwise process the next data character in ASCII encodation.
743  $cw[] = ($chr + 1);
744  ++$cw_num;
745  }
746  }
747  }
748  break;
749  }
750  case ENC_C40 : // Upper-case alphanumeric
751  case ENC_TXT : // Lower-case alphanumeric
752  case ENC_X12 : { // ANSI X12
753  $temp_cw = array();
754  $p = 0;
755  $epos = $pos;
756  // get charset ID
757  $set_id = $this->chset_id[$enc];
758  // get basic charset for current encoding
759  $charset = $this->chset[$set_id];
760  do {
761  // 2. process the next character in C40 encodation.
762  $chr = ord($data[$epos]);
763  ++$epos;
764  // check for extended character
765  if ($chr & 0x80) {
766  if ($enc == ENC_X12) {
767  return false;
768  }
769  $chr = ($chr & 0x7f);
770  $temp_cw[] = 1; // shift 2
771  $temp_cw[] = 30; // upper shift
772  $p += 2;
773  }
774  if (isset($charset[$chr])) {
775  $temp_cw[] = $charset[$chr];
776  ++$p;
777  } else {
778  if (isset($this->chset['SH1'][$chr])) {
779  $temp_cw[] = 0; // shift 1
780  $shiftset = $this->chset['SH1'];
781  } elseif (isset($chr, $this->chset['SH2'][$chr])) {
782  $temp_cw[] = 1; // shift 2
783  $shiftset = $this->chset['SH2'];
784  } elseif (($enc == ENC_C40) AND isset($this->chset['S3C'][$chr])) {
785  $temp_cw[] = 2; // shift 3
786  $shiftset = $this->chset['S3C'];
787  } elseif (($enc == ENC_TXT) AND isset($this->chset['S3T'][$chr])) {
788  $temp_cw[] = 2; // shift 3
789  $shiftset = $this->chset['S3T'];
790  } else {
791  return false;
792  }
793  $temp_cw[] = $shiftset[$chr];
794  $p += 2;
795  }
796  if ($p >= 3) {
797  $c1 = array_shift($temp_cw);
798  $c2 = array_shift($temp_cw);
799  $c3 = array_shift($temp_cw);
800  $p -= 3;
801  $tmp = ((1600 * $c1) + (40 * $c2) + $c3 + 1);
802  $cw[] = ($tmp >> 8);
803  $cw[] = ($tmp % 256);
804  $cw_num += 2;
805  $pos = $epos;
806  // 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.
807  $newenc = $this->lookAheadTest($data, $pos, $enc);
808  if ($newenc != $enc) {
809  // switch to new encoding
810  $enc = $newenc;
811  if ($enc != ENC_ASCII) {
812  // set unlatch character
813  $cw[] = $this->getSwitchEncodingCodeword(ENC_ASCII);
814  ++$cw_num;
815  }
816  $cw[] = $this->getSwitchEncodingCodeword($enc);
817  ++$cw_num;
818  $pos -= $p;
819  $p = 0;
820  break;
821  }
822  }
823  } while (($p > 0) AND ($epos < $data_length));
824  // process last data (if any)
825  if ($p > 0) {
826  // get remaining number of data symbols
827  $cwr = ($this->getMaxDataCodewords($cw_num) - $cw_num);
828  if (($cwr == 1) AND ($p == 1)) {
829  // d. If one symbol character remains and one C40 value (data character) remains to be encoded
830  $c1 = array_shift($temp_cw);
831  --$p;
832  $cw[] = ($chr + 1);
833  ++$cw_num;
834  $pos = $epos;
835  $enc = ENC_ASCII;
836  $this->last_enc = $enc;
837  } elseif (($cwr == 2) AND ($p == 1)) {
838  // c. If two symbol characters remain and only one C40 value (data character) remains to be encoded
839  $c1 = array_shift($temp_cw);
840  --$p;
841  $cw[] = 254;
842  $cw[] = ($chr + 1);
843  $cw_num += 2;
844  $pos = $epos;
845  $enc = ENC_ASCII;
846  $this->last_enc = $enc;
847  } elseif (($cwr == 2) AND ($p == 2)) {
848  // b. If two symbol characters remain and two C40 values remain to be encoded
849  $c1 = array_shift($temp_cw);
850  $c2 = array_shift($temp_cw);
851  $p -= 2;
852  $tmp = ((1600 * $c1) + (40 * $c2) + 1);
853  $cw[] = ($tmp >> 8);
854  $cw[] = ($tmp % 256);
855  $cw_num += 2;
856  $pos = $epos;
857  $enc = ENC_ASCII;
858  $this->last_enc = $enc;
859  } else {
860  // switch to ASCII encoding
861  if ($enc != ENC_ASCII) {
862  $enc = ENC_ASCII;
863  $this->last_enc = $enc;
864  $cw[] = $this->getSwitchEncodingCodeword($enc);
865  ++$cw_num;
866  $pos = ($epos - $p);
867  }
868  }
869  }
870  break;
871  }
872  case ENC_EDF: { // F. While in EDIFACT (EDF) encodation
873  // initialize temporary array with 0 length
874  $temp_cw = array();
875  $epos = $pos;
876  $field_length = 0;
877  $newenc = $enc;
878  do {
879  // 2. process the next character in EDIFACT encodation.
880  $chr = ord($data[$epos]);
881  if ($this->isCharMode($chr, ENC_EDF)) {
882  ++$epos;
883  $temp_cw[] = $chr;
884  ++$field_length;
885  }
886  if (($field_length == 4) OR ($epos == $data_length) OR !$this->isCharMode($chr, ENC_EDF)) {
887  if (($epos == $data_length) AND ($field_length < 3)) {
888  $enc = ENC_ASCII;
889  $cw[] = $this->getSwitchEncodingCodeword($enc);
890  ++$cw_num;
891  break;
892  }
893  if ($field_length < 4) {
894  // set unlatch character
895  $temp_cw[] = 0x1f;
896  ++$field_length;
897  // fill empty characters
898  for ($i = $field_length; $i < 4; ++$i) {
899  $temp_cw[] = 0;
900  }
901  $enc = ENC_ASCII;
902  $this->last_enc = $enc;
903  }
904  // encodes four data characters in three codewords
905  $tcw = (($temp_cw[0] & 0x3F) << 2) + (($temp_cw[1] & 0x30) >> 4);
906  if ($tcw > 0) {
907  $cw[] = $tcw;
908  $cw_num++;
909  }
910  $tcw= (($temp_cw[1] & 0x0F) << 4) + (($temp_cw[2] & 0x3C) >> 2);
911  if ($tcw > 0) {
912  $cw[] = $tcw;
913  $cw_num++;
914  }
915  $tcw = (($temp_cw[2] & 0x03) << 6) + ($temp_cw[3] & 0x3F);
916  if ($tcw > 0) {
917  $cw[] = $tcw;
918  $cw_num++;
919  }
920  $temp_cw = array();
921  $pos = $epos;
922  $field_length = 0;
923  if ($enc == ENC_ASCII) {
924  break; // exit from EDIFACT mode
925  }
926  }
927  } while ($epos < $data_length);
928  break;
929  }
930  case ENC_BASE256: { // G. While in Base 256 (B256) encodation
931  // initialize temporary array with 0 length
932  $temp_cw = array();
933  $field_length = 0;
934  while (($pos < $data_length) AND ($field_length <= 1555)) {
935  $newenc = $this->lookAheadTest($data, $pos, $enc);
936  if ($newenc != $enc) {
937  // 1. If the look-ahead test (starting at step J) indicates another mode, switch to that mode.
938  $enc = $newenc;
939  break; // exit from B256 mode
940  } else {
941  // 2. Otherwise, process the next character in Base 256 encodation.
942  $chr = ord($data[$pos]);
943  ++$pos;
944  $temp_cw[] = $chr;
945  ++$field_length;
946  }
947  }
948  // set field length
949  if ($field_length <= 249) {
950  $cw[] = $this->get255StateCodeword($field_length, ($cw_num + 1));
951  ++$cw_num;
952  } else {
953  $cw[] = $this->get255StateCodeword((floor($field_length / 250) + 249), ($cw_num + 1));
954  $cw[] = $this->get255StateCodeword(($field_length % 250), ($cw_num + 2));
955  $cw_num += 2;
956  }
957  if (!empty($temp_cw)) {
958  // add B256 field
959  foreach ($temp_cw as $p => $cht) {
960  $cw[] = $this->get255StateCodeword($cht, ($cw_num + $p + 1));
961  }
962  }
963  break;
964  }
965  } // end of switch enc
966  } // end of while
967  return $cw;
968  }
ENC_ASCII_NUM
const ENC_ASCII_NUM
ASCII number encoding: ASCII digits (2 bytes per CW)
Definition: datamatrix.php:99
Datamatrix\get255StateCodeword
get255StateCodeword($cwpad, $cwpos)
Return the 255-state codeword.
Definition: datamatrix.php:461
ENC_TXT
const ENC_TXT
TEXT encoding: Lower-case alphanumeric (3/2 bytes per CW)
Definition: datamatrix.php:74
ENC_EDF
const ENC_EDF
EDIFACT encoding: ASCII character 32 to 94 (4/3 bytes per CW)
Definition: datamatrix.php:84
Datamatrix\lookAheadTest
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)...
Definition: datamatrix.php:523
Datamatrix\isCharMode
isCharMode($chr, $mode)
Returns true if the char belongs to the selected mode.
Definition: datamatrix.php:476
$data
$data
Definition: example_011.php:126
ENC_ASCII_EXT
const ENC_ASCII_EXT
ASCII extended encoding: ASCII character 128 to 255 (1/2 byte per CW)
Definition: datamatrix.php:94
Datamatrix\getSwitchEncodingCodeword
getSwitchEncodingCodeword($mode)
Get the switching codeword to a new encoding mode (latch codeword)
Definition: datamatrix.php:653
ENC_C40
const ENC_C40
C40 encoding: Upper-case alphanumeric (3/2 bytes per CW)
Definition: datamatrix.php:69
Datamatrix\getMaxDataCodewords
getMaxDataCodewords($numcw)
Choose the minimum matrix size and return the max number of data codewords.
Definition: datamatrix.php:692
ENC_BASE256
const ENC_BASE256
BASE 256 encoding: ASCII character 0 to 255 (1 byte per CW)
Definition: datamatrix.php:89
ENC_ASCII
const ENC_ASCII(!defined('DATAMATRIXDEFS'))
ASCII encoding: ASCII character 0 to 127 (1 byte per CW)
Definition: datamatrix.php:64
ENC_X12
const ENC_X12
X12 encoding: ANSI X12 (3/2 byte per CW)
Definition: datamatrix.php:79
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMaxDataCodewords()

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 692 of file datamatrix.php.

Referenced by getHighLevelEncoding().

692  {
693  foreach ($this->symbattr as $key => $matrix) {
694  if ($matrix[11] >= $numcw) {
695  return $matrix[11];
696  }
697  }
698  return 0;
699  }
+ Here is the caller graph for this function:

◆ getPlacementMap()

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 1116 of file datamatrix.php.

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

Referenced by __construct().

1116  {
1117  // initialize array with zeros
1118  $marr = array_fill(0, ($nrow * $ncol), 0);
1119  // set starting values
1120  $chr = 1;
1121  $row = 4;
1122  $col = 0;
1123  do {
1124  // repeatedly first check for one of the special corner cases, then
1125  if (($row == $nrow) AND ($col == 0)) {
1126  $marr = $this->placeCornerA($marr, $nrow, $ncol, $chr);
1127  ++$chr;
1128  }
1129  if (($row == ($nrow - 2)) AND ($col == 0) AND ($ncol % 4)) {
1130  $marr = $this->placeCornerB($marr, $nrow, $ncol, $chr);
1131  ++$chr;
1132  }
1133  if (($row == ($nrow - 2)) AND ($col == 0) AND (($ncol % 8) == 4)) {
1134  $marr = $this->placeCornerC($marr, $nrow, $ncol, $chr);
1135  ++$chr;
1136  }
1137  if (($row == ($nrow + 4)) AND ($col == 2) AND (!($ncol % 8))) {
1138  $marr = $this->placeCornerD($marr, $nrow, $ncol, $chr);
1139  ++$chr;
1140  }
1141  // sweep upward diagonally, inserting successive characters,
1142  do {
1143  if (($row < $nrow) AND ($col >= 0) AND (!$marr[(($row * $ncol) + $col)])) {
1144  $marr = $this->placeUtah($marr, $nrow, $ncol, $row, $col, $chr);
1145  ++$chr;
1146  }
1147  $row -= 2;
1148  $col += 2;
1149  } while (($row >= 0) AND ($col < $ncol));
1150  ++$row;
1151  $col += 3;
1152  // & then sweep downward diagonally, inserting successive characters,...
1153  do {
1154  if (($row >= 0) AND ($col < $ncol) AND (!$marr[(($row * $ncol) + $col)])) {
1155  $marr = $this->placeUtah($marr, $nrow, $ncol, $row, $col, $chr);
1156  ++$chr;
1157  }
1158  $row += 2;
1159  $col -= 2;
1160  } while (($row < $nrow) AND ($col >= 0));
1161  $row += 3;
1162  ++$col;
1163  // ... until the entire array is scanned
1164  } while (($row < $nrow) OR ($col < $ncol));
1165  // lastly, if the lower righthand corner is untouched, fill in fixed pattern
1166  if (!$marr[(($nrow * $ncol) - 1)]) {
1167  $marr[(($nrow * $ncol) - 1)] = 1;
1168  $marr[(($nrow * $ncol) - $ncol - 2)] = 1;
1169  }
1170  return $marr;
1171  }
Datamatrix\placeUtah
placeUtah($marr, $nrow, $ncol, $row, $col, $chr)
Places the 8 bits of a utah-shaped symbol character.
Definition: datamatrix.php:1008
Datamatrix\placeCornerD
placeCornerD($marr, $nrow, $ncol, $chr)
Places the 8 bits of the fourth special corner case.
Definition: datamatrix.php:1096
Datamatrix\placeCornerC
placeCornerC($marr, $nrow, $ncol, $chr)
Places the 8 bits of the third special corner case.
Definition: datamatrix.php:1074
Datamatrix\placeCornerB
placeCornerB($marr, $nrow, $ncol, $chr)
Places the 8 bits of the second special corner case.
Definition: datamatrix.php:1052
Datamatrix\placeCornerA
placeCornerA($marr, $nrow, $ncol, $chr)
Places the 8 bits of the first special corner case.
Definition: datamatrix.php:1030
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSwitchEncodingCodeword()

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 653 of file datamatrix.php.

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

Referenced by getHighLevelEncoding().

653  {
654  switch ($mode) {
655  case ENC_ASCII: { // ASCII character 0 to 127
656  $cw = 254;
657  if ($this->last_enc == ENC_EDF) {
658  $cw = 124;
659  }
660  break;
661  }
662  case ENC_C40: { // Upper-case alphanumeric
663  $cw = 230;
664  break;
665  }
666  case ENC_TXT: { // Lower-case alphanumeric
667  $cw = 239;
668  break;
669  }
670  case ENC_X12: { // ANSI X12
671  $cw = 238;
672  break;
673  }
674  case ENC_EDF: { // ASCII character 32 to 94
675  $cw = 240;
676  break;
677  }
678  case ENC_BASE256: { // Function character (FNC1, Structured Append, Reader Program, or Code Page)
679  $cw = 231;
680  break;
681  }
682  }
683  return $cw;
684  }
ENC_TXT
const ENC_TXT
TEXT encoding: Lower-case alphanumeric (3/2 bytes per CW)
Definition: datamatrix.php:74
ENC_EDF
const ENC_EDF
EDIFACT encoding: ASCII character 32 to 94 (4/3 bytes per CW)
Definition: datamatrix.php:84
ENC_C40
const ENC_C40
C40 encoding: Upper-case alphanumeric (3/2 bytes per CW)
Definition: datamatrix.php:69
ENC_BASE256
const ENC_BASE256
BASE 256 encoding: ASCII character 0 to 255 (1 byte per CW)
Definition: datamatrix.php:89
ENC_ASCII
const ENC_ASCII(!defined('DATAMATRIXDEFS'))
ASCII encoding: ASCII character 0 to 127 (1 byte per CW)
Definition: datamatrix.php:64
ENC_X12
const ENC_X12
X12 encoding: ANSI X12 (3/2 byte per CW)
Definition: datamatrix.php:79
+ Here is the caller graph for this function:

◆ isCharMode()

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 476 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().

476  {
477  $status = false;
478  switch ($mode) {
479  case ENC_ASCII: { // ASCII character 0 to 127
480  $status = (($chr >= 0) AND ($chr <= 127));
481  break;
482  }
483  case ENC_C40: { // Upper-case alphanumeric
484  $status = (($chr == 32) OR (($chr >= 48) AND ($chr <= 57)) OR (($chr >= 65) AND ($chr <= 90)));
485  break;
486  }
487  case ENC_TXT: { // Lower-case alphanumeric
488  $status = (($chr == 32) OR (($chr >= 48) AND ($chr <= 57)) OR (($chr >= 97) AND ($chr <= 122)));
489  break;
490  }
491  case ENC_X12: { // ANSI X12
492  $status = (($chr == 13) OR ($chr == 42) OR ($chr == 62));
493  break;
494  }
495  case ENC_EDF: { // ASCII character 32 to 94
496  $status = (($chr >= 32) AND ($chr <= 94));
497  break;
498  }
499  case ENC_BASE256: { // Function character (FNC1, Structured Append, Reader Program, or Code Page)
500  $status = (($chr == 232) OR ($chr == 233) OR ($chr == 234) OR ($chr == 241));
501  break;
502  }
503  case ENC_ASCII_EXT: { // ASCII character 128 to 255
504  $status = (($chr >= 128) AND ($chr <= 255));
505  break;
506  }
507  case ENC_ASCII_NUM: { // ASCII digits
508  $status = (($chr >= 48) AND ($chr <= 57));
509  break;
510  }
511  }
512  return $status;
513  }
ENC_ASCII_NUM
const ENC_ASCII_NUM
ASCII number encoding: ASCII digits (2 bytes per CW)
Definition: datamatrix.php:99
ENC_TXT
const ENC_TXT
TEXT encoding: Lower-case alphanumeric (3/2 bytes per CW)
Definition: datamatrix.php:74
ENC_EDF
const ENC_EDF
EDIFACT encoding: ASCII character 32 to 94 (4/3 bytes per CW)
Definition: datamatrix.php:84
ENC_ASCII_EXT
const ENC_ASCII_EXT
ASCII extended encoding: ASCII character 128 to 255 (1/2 byte per CW)
Definition: datamatrix.php:94
ENC_C40
const ENC_C40
C40 encoding: Upper-case alphanumeric (3/2 bytes per CW)
Definition: datamatrix.php:69
ENC_BASE256
const ENC_BASE256
BASE 256 encoding: ASCII character 0 to 255 (1 byte per CW)
Definition: datamatrix.php:89
ENC_ASCII
const ENC_ASCII(!defined('DATAMATRIXDEFS'))
ASCII encoding: ASCII character 0 to 127 (1 byte per CW)
Definition: datamatrix.php:64
ENC_X12
const ENC_X12
X12 encoding: ANSI X12 (3/2 byte per CW)
Definition: datamatrix.php:79
+ Here is the caller graph for this function:

◆ lookAheadTest()

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 523 of file datamatrix.php.

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

Referenced by getHighLevelEncoding().

523  {
524  $data_length = strlen($data);
525  if ($pos >= $data_length) {
526  return $mode;
527  }
528  $charscount = 0; // count processed chars
529  // STEP J
530  if ($mode == ENC_ASCII) {
531  $numch = array(0, 1, 1, 1, 1, 1.25);
532  } else {
533  $numch = array(1, 2, 2, 2, 2, 2.25);
534  $numch[$mode] = 0;
535  }
536  while (true) {
537  // STEP K
538  if (($pos + $charscount) == $data_length) {
539  if ($numch[ENC_ASCII] <= ceil(min($numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_X12], $numch[ENC_EDF], $numch[ENC_BASE256]))) {
540  return ENC_ASCII;
541  }
542  if ($numch[ENC_BASE256] < ceil(min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_X12], $numch[ENC_EDF]))) {
543  return ENC_BASE256;
544  }
545  if ($numch[ENC_EDF] < ceil(min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_X12], $numch[ENC_BASE256]))) {
546  return ENC_EDF;
547  }
548  if ($numch[ENC_TXT] < ceil(min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_X12], $numch[ENC_EDF], $numch[ENC_BASE256]))) {
549  return ENC_TXT;
550  }
551  if ($numch[ENC_X12] < ceil(min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_EDF], $numch[ENC_BASE256]))) {
552  return ENC_X12;
553  }
554  return ENC_C40;
555  }
556  // get char
557  $chr = ord($data[$pos + $charscount]);
558  $charscount++;
559  // STEP L
560  if ($this->isCharMode($chr, ENC_ASCII_NUM)) {
561  $numch[ENC_ASCII] += (1 / 2);
562  } elseif ($this->isCharMode($chr, ENC_ASCII_EXT)) {
563  $numch[ENC_ASCII] = ceil($numch[ENC_ASCII]);
564  $numch[ENC_ASCII] += 2;
565  } else {
566  $numch[ENC_ASCII] = ceil($numch[ENC_ASCII]);
567  $numch[ENC_ASCII] += 1;
568  }
569  // STEP M
570  if ($this->isCharMode($chr, ENC_C40)) {
571  $numch[ENC_C40] += (2 / 3);
572  } elseif ($this->isCharMode($chr, ENC_ASCII_EXT)) {
573  $numch[ENC_C40] += (8 / 3);
574  } else {
575  $numch[ENC_C40] += (4 / 3);
576  }
577  // STEP N
578  if ($this->isCharMode($chr, ENC_TXT)) {
579  $numch[ENC_TXT] += (2 / 3);
580  } elseif ($this->isCharMode($chr, ENC_ASCII_EXT)) {
581  $numch[ENC_TXT] += (8 / 3);
582  } else {
583  $numch[ENC_TXT] += (4 / 3);
584  }
585  // STEP O
586  if ($this->isCharMode($chr, ENC_X12) OR $this->isCharMode($chr, ENC_C40)) {
587  $numch[ENC_X12] += (2 / 3);
588  } elseif ($this->isCharMode($chr, ENC_ASCII_EXT)) {
589  $numch[ENC_X12] += (13 / 3);
590  } else {
591  $numch[ENC_X12] += (10 / 3);
592  }
593  // STEP P
594  if ($this->isCharMode($chr, ENC_EDF)) {
595  $numch[ENC_EDF] += (3 / 4);
596  } elseif ($this->isCharMode($chr, ENC_ASCII_EXT)) {
597  $numch[ENC_EDF] += (17 / 4);
598  } else {
599  $numch[ENC_EDF] += (13 / 4);
600  }
601  // STEP Q
602  if ($this->isCharMode($chr, ENC_BASE256)) {
603  $numch[ENC_BASE256] += 4;
604  } else {
605  $numch[ENC_BASE256] += 1;
606  }
607  // STEP R
608  if ($charscount >= 4) {
609  if (($numch[ENC_ASCII] + 1) <= min($numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_X12], $numch[ENC_EDF], $numch[ENC_BASE256])) {
610  return ENC_ASCII;
611  }
612  if ((($numch[ENC_BASE256] + 1) <= $numch[ENC_ASCII])
613  OR (($numch[ENC_BASE256] + 1) < min($numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_X12], $numch[ENC_EDF]))) {
614  return ENC_BASE256;
615  }
616  if (($numch[ENC_EDF] + 1) < min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_X12], $numch[ENC_BASE256])) {
617  return ENC_EDF;
618  }
619  if (($numch[ENC_TXT] + 1) < min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_X12], $numch[ENC_EDF], $numch[ENC_BASE256])) {
620  return ENC_TXT;
621  }
622  if (($numch[ENC_X12] + 1) < min($numch[ENC_ASCII], $numch[ENC_C40], $numch[ENC_TXT], $numch[ENC_EDF], $numch[ENC_BASE256])) {
623  return ENC_X12;
624  }
625  if (($numch[ENC_C40] + 1) < min($numch[ENC_ASCII], $numch[ENC_TXT], $numch[ENC_EDF], $numch[ENC_BASE256])) {
626  if ($numch[ENC_C40] < $numch[ENC_X12]) {
627  return ENC_C40;
628  }
629  if ($numch[ENC_C40] == $numch[ENC_X12]) {
630  $k = ($pos + $charscount + 1);
631  while ($k < $data_length) {
632  $tmpchr = ord($data{$k});
633  if ($this->isCharMode($tmpchr, ENC_X12)) {
634  return ENC_X12;
635  } elseif (!($this->isCharMode($tmpchr, ENC_X12) OR $this->isCharMode($tmpchr, ENC_C40))) {
636  break;
637  }
638  ++$k;
639  }
640  return ENC_C40;
641  }
642  }
643  }
644  } // end of while
645  }
ENC_ASCII_NUM
const ENC_ASCII_NUM
ASCII number encoding: ASCII digits (2 bytes per CW)
Definition: datamatrix.php:99
ENC_TXT
const ENC_TXT
TEXT encoding: Lower-case alphanumeric (3/2 bytes per CW)
Definition: datamatrix.php:74
ENC_EDF
const ENC_EDF
EDIFACT encoding: ASCII character 32 to 94 (4/3 bytes per CW)
Definition: datamatrix.php:84
Datamatrix\isCharMode
isCharMode($chr, $mode)
Returns true if the char belongs to the selected mode.
Definition: datamatrix.php:476
$data
$data
Definition: example_011.php:126
ENC_ASCII_EXT
const ENC_ASCII_EXT
ASCII extended encoding: ASCII character 128 to 255 (1/2 byte per CW)
Definition: datamatrix.php:94
ENC_C40
const ENC_C40
C40 encoding: Upper-case alphanumeric (3/2 bytes per CW)
Definition: datamatrix.php:69
ENC_BASE256
const ENC_BASE256
BASE 256 encoding: ASCII character 0 to 255 (1 byte per CW)
Definition: datamatrix.php:89
ENC_ASCII
const ENC_ASCII(!defined('DATAMATRIXDEFS'))
ASCII encoding: ASCII character 0 to 127 (1 byte per CW)
Definition: datamatrix.php:64
ENC_X12
const ENC_X12
X12 encoding: ANSI X12 (3/2 byte per CW)
Definition: datamatrix.php:79
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ placeCornerA()

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 1030 of file datamatrix.php.

References placeModule().

Referenced by getPlacementMap().

1030  {
1031  $marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, 0, $chr, 1);
1032  $marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, 1, $chr, 2);
1033  $marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, 2, $chr, 3);
1034  $marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-2, $chr, 4);
1035  $marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-1, $chr, 5);
1036  $marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol-1, $chr, 6);
1037  $marr = $this->placeModule($marr, $nrow, $ncol, 2, $ncol-1, $chr, 7);
1038  $marr = $this->placeModule($marr, $nrow, $ncol, 3, $ncol-1, $chr, 8);
1039  return $marr;
1040  }
Datamatrix\placeModule
placeModule($marr, $nrow, $ncol, $row, $col, $chr, $bit)
Places "chr+bit" with appropriate wrapping within array[].
Definition: datamatrix.php:983
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ placeCornerB()

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 1052 of file datamatrix.php.

References placeModule().

Referenced by getPlacementMap().

1052  {
1053  $marr = $this->placeModule($marr, $nrow, $ncol, $nrow-3, 0, $chr, 1);
1054  $marr = $this->placeModule($marr, $nrow, $ncol, $nrow-2, 0, $chr, 2);
1055  $marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, 0, $chr, 3);
1056  $marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-4, $chr, 4);
1057  $marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-3, $chr, 5);
1058  $marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-2, $chr, 6);
1059  $marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-1, $chr, 7);
1060  $marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol-1, $chr, 8);
1061  return $marr;
1062  }
Datamatrix\placeModule
placeModule($marr, $nrow, $ncol, $row, $col, $chr, $bit)
Places "chr+bit" with appropriate wrapping within array[].
Definition: datamatrix.php:983
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ placeCornerC()

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 1074 of file datamatrix.php.

References placeModule().

Referenced by getPlacementMap().

1074  {
1075  $marr = $this->placeModule($marr, $nrow, $ncol, $nrow-3, 0, $chr, 1);
1076  $marr = $this->placeModule($marr, $nrow, $ncol, $nrow-2, 0, $chr, 2);
1077  $marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, 0, $chr, 3);
1078  $marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-2, $chr, 4);
1079  $marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-1, $chr, 5);
1080  $marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol-1, $chr, 6);
1081  $marr = $this->placeModule($marr, $nrow, $ncol, 2, $ncol-1, $chr, 7);
1082  $marr = $this->placeModule($marr, $nrow, $ncol, 3, $ncol-1, $chr, 8);
1083  return $marr;
1084  }
Datamatrix\placeModule
placeModule($marr, $nrow, $ncol, $row, $col, $chr, $bit)
Places "chr+bit" with appropriate wrapping within array[].
Definition: datamatrix.php:983
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ placeCornerD()

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 1096 of file datamatrix.php.

References placeModule().

Referenced by getPlacementMap().

1096  {
1097  $marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, 0, $chr, 1);
1098  $marr = $this->placeModule($marr, $nrow, $ncol, $nrow-1, $ncol-1, $chr, 2);
1099  $marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-3, $chr, 3);
1100  $marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-2, $chr, 4);
1101  $marr = $this->placeModule($marr, $nrow, $ncol, 0, $ncol-1, $chr, 5);
1102  $marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol-3, $chr, 6);
1103  $marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol-2, $chr, 7);
1104  $marr = $this->placeModule($marr, $nrow, $ncol, 1, $ncol-1, $chr, 8);
1105  return $marr;
1106  }
Datamatrix\placeModule
placeModule($marr, $nrow, $ncol, $row, $col, $chr, $bit)
Places "chr+bit" with appropriate wrapping within array[].
Definition: datamatrix.php:983
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ placeModule()

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 983 of file datamatrix.php.

References $row.

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

983  {
984  if ($row < 0) {
985  $row += $nrow;
986  $col += (4 - (($nrow + 4) % 8));
987  }
988  if ($col < 0) {
989  $col += $ncol;
990  $row += (4 - (($ncol + 4) % 8));
991  }
992  $marr[(($row * $ncol) + $col)] = ((10 * $chr) + $bit);
993  return $marr;
994  }
+ Here is the caller graph for this function:

◆ placeUtah()

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 1008 of file datamatrix.php.

References $row, and placeModule().

Referenced by getPlacementMap().

1008  {
1009  $marr = $this->placeModule($marr, $nrow, $ncol, $row-2, $col-2, $chr, 1);
1010  $marr = $this->placeModule($marr, $nrow, $ncol, $row-2, $col-1, $chr, 2);
1011  $marr = $this->placeModule($marr, $nrow, $ncol, $row-1, $col-2, $chr, 3);
1012  $marr = $this->placeModule($marr, $nrow, $ncol, $row-1, $col-1, $chr, 4);
1013  $marr = $this->placeModule($marr, $nrow, $ncol, $row-1, $col, $chr, 5);
1014  $marr = $this->placeModule($marr, $nrow, $ncol, $row, $col-2, $chr, 6);
1015  $marr = $this->placeModule($marr, $nrow, $ncol, $row, $col-1, $chr, 7);
1016  $marr = $this->placeModule($marr, $nrow, $ncol, $row, $col, $chr, 8);
1017  return $marr;
1018  }
Datamatrix\placeModule
placeModule($marr, $nrow, $ncol, $row, $col, $chr, $bit)
Places "chr+bit" with appropriate wrapping within array[].
Definition: datamatrix.php:983
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $barcode_array

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().

◆ $chset

Datamatrix::$chset
protected

Basic set of characters for each encodation mode.

Definition at line 190 of file datamatrix.php.

◆ $chset_id

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.

◆ $last_enc

Datamatrix::$last_enc = ENC_ASCII
protected

Store last used encoding for data codewords.

Definition at line 122 of file datamatrix.php.

◆ $symbattr

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: