vendor/tecnickcom/tc-lib-barcode/src/Barcode.php line 99

Open in your IDE?
  1. <?php
  3. /**
  4. * Barcode.php
  5. *
  6. * @since 2015-02-21
  7. * @category Library
  8. * @package Barcode
  9. * @author Nicola Asuni <info@tecnick.com>
  10. * @copyright 2015-2023 Nicola Asuni - Tecnick.com LTD
  11. * @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
  12. * @link https://github.com/tecnickcom/tc-lib-barcode
  13. *
  14. * This file is part of tc-lib-barcode software library.
  15. */
  17. namespace Com\Tecnick\Barcode;
  19. use Com\Tecnick\Barcode\Exception as BarcodeException;
  21. /**
  22. * Com\Tecnick\Barcode\Barcode
  23. *
  24. * Barcode Barcode class
  25. *
  26. * @since 2015-02-21
  27. * @category Library
  28. * @package Barcode
  29. * @author Nicola Asuni <info@tecnick.com>
  30. * @copyright 2010-2023 Nicola Asuni - Tecnick.com LTD
  31. * @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
  32. * @link https://github.com/tecnickcom/tc-lib-barcode
  33. * @deprecated tc-lib-barcode 1.x is deprecated: upgrade to tecnickcom/tc-lib-barcode ^2.
  34. */
  35. class Barcode
  36. {
  37. /**
  38. * Deprecation notice message.
  39. */
  40. const DEPRECATION_NOTICE = 'tc-lib-barcode 1.x is deprecated:'
  41. . ' upgrade to tecnickcom/tc-lib-barcode ^2 (https://github.com/tecnickcom/tc-lib-barcode).';
  43. /**
  44. * Array containing the map between the barcode type and correspondent class
  45. */
  46. const TYPECLASS = array(
  47. 'C128' => 'Linear\\CodeOneTwoEight', // CODE 128
  48. 'C128A' => 'Linear\\CodeOneTwoEight\\CodeOneTwoEightA', // CODE 128 A
  49. 'C128B' => 'Linear\\CodeOneTwoEight\\CodeOneTwoEightB', // CODE 128 B
  50. 'C128C' => 'Linear\\CodeOneTwoEight\\CodeOneTwoEightC', // CODE 128 C
  51. 'C39' => 'Linear\\CodeThreeNine', // CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.
  52. 'C39+' => 'Linear\\CodeThreeNineCheck', // CODE 39 + CHECKSUM
  53. 'C39E' => 'Linear\\CodeThreeNineExt', // CODE 39 EXTENDED
  54. 'C39E+' => 'Linear\\CodeThreeNineExtCheck', // CODE 39 EXTENDED + CHECKSUM
  55. 'C93' => 'Linear\\CodeNineThree', // CODE 93 - USS-93
  56. 'CODABAR' => 'Linear\\Codabar', // CODABAR
  57. 'CODE11' => 'Linear\\CodeOneOne', // CODE 11
  58. 'EAN13' => 'Linear\\EanOneThree', // EAN 13
  59. 'EAN2' => 'Linear\\EanTwo', // EAN 2-Digits UPC-Based Extension
  60. 'EAN5' => 'Linear\\EanFive', // EAN 5-Digits UPC-Based Extension
  61. 'EAN8' => 'Linear\\EanEight', // EAN 8
  62. 'I25' => 'Linear\\InterleavedTwoOfFive', // Interleaved 2 of 5
  63. 'I25+' => 'Linear\\InterleavedTwoOfFiveCheck', // Interleaved 2 of 5 + CHECKSUM
  64. 'IMB' => 'Linear\\Imb', // IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200
  65. 'IMBPRE' => 'Linear\\ImbPre', // IMB - Intelligent Mail Barcode pre-processed
  66. 'KIX' => 'Linear\\KlantIndex', // KIX (Klant index - Customer index)
  67. 'LRAW' => 'Linear\\Raw', // 1D RAW MODE (comma-separated rows of 01 strings)
  68. 'MSI' => 'Linear\\Msi', // MSI (Variation of Plessey code)
  69. 'MSI+' => 'Linear\\MsiCheck', // MSI + CHECKSUM (modulo 11)
  70. 'PHARMA' => 'Linear\\Pharma', // PHARMACODE
  71. 'PHARMA2T' => 'Linear\\PharmaTwoTracks', // PHARMACODE TWO-TRACKS
  72. 'PLANET' => 'Linear\\Planet', // PLANET
  73. 'POSTNET' => 'Linear\\Postnet', // POSTNET
  74. 'RMS4CC' => 'Linear\\RoyalMailFourCc', // RMS4CC (Royal Mail 4-state Customer Bar Code)
  75. 'S25' => 'Linear\\StandardTwoOfFive', // Standard 2 of 5
  76. 'S25+' => 'Linear\\StandardTwoOfFiveCheck', // Standard 2 of 5 + CHECKSUM
  77. 'UPCA' => 'Linear\\UpcA', // UPC-A
  78. 'UPCE' => 'Linear\\UpcE', // UPC-E
  79. 'AZTEC' => 'Square\\Aztec', // AZTEC Code (ISO/IEC 24778:2008)
  80. 'DATAMATRIX' => 'Square\\Datamatrix', // DATAMATRIX (ISO/IEC 16022)
  81. 'PDF417' => 'Square\\PdfFourOneSeven', // PDF417 (ISO/IEC 15438:2006)
  82. 'QRCODE' => 'Square\\QrCode', // QR-CODE
  83. 'SRAW' => 'Square\\Raw', // 2D RAW MODE (comma-separated rows of 01 strings)
  84. );
  86. /**
  87. * Initialize a new barcode factory
  88. *
  89. * @deprecated tc-lib-barcode 1.x is deprecated: upgrade to tecnickcom/tc-lib-barcode ^2.
  90. */
  91. public function __construct()
  92. {
  93. // Deprecation notice, raised once per process and silenced by defining
  94. // TCLIB_BARCODE_SILENCE_DEPRECATION. The @ prevents the default handler
  95. // from printing it into the generated output.
  96. static $notice = true;
  97. if ($notice && !(defined('TCLIB_BARCODE_SILENCE_DEPRECATION') && TCLIB_BARCODE_SILENCE_DEPRECATION)) {
  98. $notice = false;
  99. @trigger_error(self::DEPRECATION_NOTICE, E_USER_DEPRECATED);
  100. }
  101. }
  103. /**
  104. * Get the list of supported Barcode types
  105. *
  106. * @return array
  107. */
  108. public function getTypes()
  109. {
  110. return array_keys(self::TYPECLASS);
  111. }
  113. /**
  114. * Get the barcode object
  115. *
  116. * @param string $type Barcode type
  117. * @param string $code Barcode content
  118. * @param int $width Barcode width in user units (excluding padding).
  119. * A negative value indicates the multiplication factor for each column.
  120. * @param int $height Barcode height in user units (excluding padding).
  121. * A negative value indicates the multiplication factor for each row.
  122. * @param string $color Foreground color in Web notation (color name, or hexadecimal code, or CSS syntax)
  123. * @param array $padding Additional padding to add around the barcode (top, right, bottom, left) in user units.
  124. * A negative value indicates the multiplication factor for each row or column.
  125. *
  126. * @return Type
  127. *
  128. * @throws BarcodeException in case of error
  129. */
  130. public function getBarcodeObj(
  131. $type,
  132. $code,
  133. $width = -1,
  134. $height = -1,
  135. $color = 'black',
  136. $padding = array(0, 0, 0, 0)
  137. ) {
  138. // extract extra parameters (if any)
  139. $params = explode(',', $type);
  140. $type = array_shift($params);
  142. if (!array_key_exists($type, self::TYPECLASS)) {
  143. throw new BarcodeException('Unsupported barcode type: ' . $type);
  144. }
  145. $bclass = '\\Com\\Tecnick\\Barcode\\Type\\' . self::TYPECLASS[$type];
  146. return new $bclass($code, $width, $height, $color, $params, $padding);
  147. }
  148. }