Przeglądaj źródła

:shower: remove DATA_* prefix from Mode::* constants

codemasher 4 lat temu
rodzic
commit
9fde82f9c2

+ 3 - 1
src/Common/EccLevel.php

@@ -208,7 +208,9 @@ final class EccLevel{
 	}
 
 	/**
-	 * returns an array wit the max bit lengths for version 1-40 and the current ECC level
+	 * returns an array with the max bit lengths for version 1-40 and the current ECC level
+	 *
+	 * @return int[]
 	 */
 	public function getMaxBits():array{
 		return array_combine(

+ 23 - 23
src/Common/Mode.php

@@ -21,23 +21,23 @@ final class Mode{
 	// ISO/IEC 18004:2000 Table 2
 
 	/** @var int */
-	public const DATA_TERMINATOR       = 0b0000;
+	public const TERMINATOR       = 0b0000;
 	/** @var int */
-	public const DATA_NUMBER           = 0b0001;
+	public const NUMBER           = 0b0001;
 	/** @var int */
-	public const DATA_ALPHANUM         = 0b0010;
+	public const ALPHANUM         = 0b0010;
 	/** @var int */
-	public const DATA_BYTE             = 0b0100;
+	public const BYTE             = 0b0100;
 	/** @var int */
-	public const DATA_KANJI            = 0b1000;
+	public const KANJI            = 0b1000;
 	/** @var int */
-	public const DATA_STRCTURED_APPEND = 0b0011;
+	public const STRCTURED_APPEND = 0b0011;
 	/** @var int */
-	public const DATA_FNC1_FIRST       = 0b0101;
+	public const FNC1_FIRST       = 0b0101;
 	/** @var int */
-	public const DATA_FNC1_SECOND      = 0b1001;
+	public const FNC1_SECOND      = 0b1001;
 	/** @var int */
-	public const DATA_ECI              = 0b0111;
+	public const ECI              = 0b0111;
 
 	/**
 	 * mode length bits for the version breakpoints 1-9, 10-26 and 27-40
@@ -45,10 +45,10 @@ final class Mode{
 	 * ISO/IEC 18004:2000 Table 3 - Number of bits in Character Count Indicator
 	 */
 	public const LENGTH_BITS = [
-		self::DATA_NUMBER   => [10, 12, 14],
-		self::DATA_ALPHANUM => [ 9, 11, 13],
-		self::DATA_BYTE     => [ 8, 16, 16],
-		self::DATA_KANJI    => [ 8, 10, 12],
+		self::NUMBER   => [10, 12, 14],
+		self::ALPHANUM => [9, 11, 13],
+		self::BYTE     => [8, 16, 16],
+		self::KANJI    => [8, 10, 12],
 	];
 
 	/**
@@ -56,11 +56,11 @@ final class Mode{
 	 *
 	 * @var string[]
 	 */
-	public const DATA_INTERFACES = [
-		self::DATA_NUMBER   => Number::class,
-		self::DATA_ALPHANUM => AlphaNum::class,
-		self::DATA_KANJI    => Kanji::class,
-		self::DATA_BYTE     => Byte::class,
+	public const INTERFACES = [
+		self::NUMBER   => Number::class,
+		self::ALPHANUM => AlphaNum::class,
+		self::KANJI    => Kanji::class,
+		self::BYTE     => Byte::class,
 	];
 
 	/**
@@ -70,11 +70,11 @@ final class Mode{
 	 *
 	 * @var int[]
 	 */
-	public const DATA_MODES = [
-		self::DATA_NUMBER   => 0,
-		self::DATA_ALPHANUM => 1,
-		self::DATA_BYTE     => 2,
-		self::DATA_KANJI    => 3,
+	public const MODES = [
+		self::NUMBER   => 0,
+		self::ALPHANUM => 1,
+		self::BYTE     => 2,
+		self::KANJI    => 3,
 	];
 
 	/**

+ 1 - 1
src/Common/Version.php

@@ -313,7 +313,7 @@ final class Version{
 	 * the maximum character count for the given $mode and $eccLevel
 	 */
 	public function getMaxLengthForMode(int $mode, EccLevel $eccLevel):?int{
-		return self::MAX_LENGTH[$this->version][Mode::DATA_MODES[$mode]][$eccLevel->getOrdinal()] ?? null;
+		return self::MAX_LENGTH[$this->version][Mode::MODES[$mode]][$eccLevel->getOrdinal()] ?? null;
 	}
 
 	/**

+ 1 - 1
src/Data/AlphaNum.php

@@ -39,7 +39,7 @@ final class AlphaNum extends QRDataModeAbstract{
 	/**
 	 * @inheritDoc
 	 */
-	protected static int $datamode = Mode::DATA_ALPHANUM;
+	protected static int $datamode = Mode::ALPHANUM;
 
 	/**
 	 * @inheritDoc

+ 1 - 1
src/Data/Byte.php

@@ -25,7 +25,7 @@ final class Byte extends QRDataModeAbstract{
 	/**
 	 * @inheritDoc
 	 */
-	protected static int $datamode = Mode::DATA_BYTE;
+	protected static int $datamode = Mode::BYTE;
 
 	/**
 	 * @inheritDoc

+ 1 - 1
src/Data/ECI.php

@@ -22,7 +22,7 @@ final class ECI extends QRDataModeAbstract{
 	/**
 	 * @inheritDoc
 	 */
-	protected static int $datamode = Mode::DATA_ECI;
+	protected static int $datamode = Mode::ECI;
 
 	/**
 	 * The current ECI encoding id

+ 1 - 1
src/Data/Kanji.php

@@ -25,7 +25,7 @@ final class Kanji extends QRDataModeAbstract{
 	/**
 	 * @inheritDoc
 	 */
-	protected static int $datamode = Mode::DATA_KANJI;
+	protected static int $datamode = Mode::KANJI;
 
 	/**
 	 *

+ 1 - 1
src/Data/Number.php

@@ -32,7 +32,7 @@ final class Number extends QRDataModeAbstract{
 	/**
 	 * @inheritDoc
 	 */
-	protected static int $datamode = Mode::DATA_NUMBER;
+	protected static int $datamode = Mode::NUMBER;
 
 	/**
 	 * @inheritDoc

+ 8 - 8
src/Decoder/Decoder.php

@@ -240,20 +240,20 @@ final class Decoder{
 			$datamode = $bits->read(4); // mode is encoded by 4 bits
 
 			// OK, assume we're done. Really, a TERMINATOR mode should have been recorded here
-			if($datamode === Mode::DATA_TERMINATOR){
+			if($datamode === Mode::TERMINATOR){
 				break;
 			}
 
-			if($datamode === Mode::DATA_ECI){
+			if($datamode === Mode::ECI){
 				// Count doesn't apply to ECI
 				$eciCharset = ECI::parseValue($bits);
 			}
 			/** @noinspection PhpStatementHasEmptyBodyInspection */
-			elseif($datamode === Mode::DATA_FNC1_FIRST || $datamode === Mode::DATA_FNC1_SECOND){
+			elseif($datamode === Mode::FNC1_FIRST || $datamode === Mode::FNC1_SECOND){
 				// We do little with FNC1 except alter the parsed result a bit according to the spec
 #				$fc1InEffect = true;
 			}
-			elseif($datamode === Mode::DATA_STRCTURED_APPEND){
+			elseif($datamode === Mode::STRCTURED_APPEND){
 				if($bits->available() < 16){
 					throw new RuntimeException('structured append: not enough bits left');
 				}
@@ -274,10 +274,10 @@ final class Decoder{
 				}*/
 #				else{
 					// "Normal" QR code modes:
-					if($datamode === Mode::DATA_NUMBER){
+					if($datamode === Mode::NUMBER){
 						$result .= Number::decodeSegment($bits, $versionNumber);
 					}
-					elseif($datamode === Mode::DATA_ALPHANUM){
+					elseif($datamode === Mode::ALPHANUM){
 						$str = AlphaNum::decodeSegment($bits, $versionNumber);
 
 						// See section 6.4.8.1, 6.4.8.2
@@ -300,7 +300,7 @@ final class Decoder{
 */
 						$result .= $str;
 					}
-					elseif($datamode === Mode::DATA_BYTE){
+					elseif($datamode === Mode::BYTE){
 						$str = Byte::decodeSegment($bits, $versionNumber);
 
 						if($eciCharset !== null){
@@ -321,7 +321,7 @@ final class Decoder{
 
 						$result .= $str;
 					}
-					elseif($datamode === Mode::DATA_KANJI){
+					elseif($datamode === Mode::KANJI){
 						$result .= Kanji::decodeSegment($bits, $versionNumber);
 					}
 					else{

+ 1 - 1
src/QRCode.php

@@ -146,7 +146,7 @@ class QRCode{
 
 		if($data !== null){
 			/** @var \chillerlan\QRCode\Data\QRDataModeInterface $dataInterface */
-			foreach(Mode::DATA_INTERFACES as $dataInterface){
+			foreach(Mode::INTERFACES as $dataInterface){
 
 				if($dataInterface::validateString($data)){
 					$this->addSegment(new $dataInterface($data));

+ 4 - 4
tests/Common/BitBufferTest.php

@@ -26,10 +26,10 @@ final class BitBufferTest extends TestCase{
 
 	public function bitProvider():array{
 		return [
-			'number'   => [Mode::DATA_NUMBER, 16],
-			'alphanum' => [Mode::DATA_ALPHANUM, 32],
-			'byte'     => [Mode::DATA_BYTE, 64],
-			'kanji'    => [Mode::DATA_KANJI, 128],
+			'number'   => [Mode::NUMBER, 16],
+			'alphanum' => [Mode::ALPHANUM, 32],
+			'byte'     => [Mode::BYTE, 64],
+			'kanji'    => [Mode::KANJI, 128],
 		];
 	}
 

+ 1 - 1
tests/QRCodeReaderTest.php

@@ -110,7 +110,7 @@ class QRCodeReaderTest extends TestCase{
 				yield 'version: '.$version.$eccLevel => [
 					$version,
 					$eccLevel,
-					substr($str, 0, $version->getMaxLengthForMode(Mode::DATA_BYTE, $eccLevel) ?? '')
+					substr($str, 0, $version->getMaxLengthForMode(Mode::BYTE, $eccLevel) ?? '')
 				];
 			}
 		}