proper names for QRMatrix getters

codemasher · codemasher · commit 1b2aa52d0324 · 2023-04-04T15:00:55.000+02:00
diff --git a/examples/imageWithLogo.php b/examples/imageWithLogo.php
@@ -52,7 +52,7 @@ public function dump(string $file = null, string $logo = null):string{
 		$lh = (($this->options->logoSpaceHeight - 2) * $this->options->scale);
 
 		// get the qrcode size
-		$ql = ($this->matrix->size() * $this->options->scale);
+		$ql = ($this->matrix->getSize() * $this->options->scale);
 
 		// scale the logo and copy it over. done!
 		imagecopyresampled($this->image, $im, (($ql - $lw) / 2), (($ql - $lh) / 2), 0, 0, $lw, $lh, $w, $h);
diff --git a/examples/svgMeltedModules.php b/examples/svgMeltedModules.php
@@ -38,7 +38,7 @@ protected function collectModules(Closure $transform):array{
 		$paths = [];
 
 		// collect the modules for each type
-		foreach($this->matrix->matrix() as $y => $row){
+		foreach($this->matrix->getMatrix() as $y => $row){
 			foreach($row as $x => $M_TYPE){
 				$M_TYPE_LAYER = $M_TYPE;
 
diff --git a/examples/svgRandomColoredDots.php b/examples/svgRandomColoredDots.php
@@ -41,7 +41,7 @@ protected function collectModules(Closure $transform):array{
 		$paths = [];
 
 		// collect the modules for each type
-		foreach($this->matrix->matrix() as $y => $row){
+		foreach($this->matrix->getMatrix() as $y => $row){
 			foreach($row as $x => $M_TYPE){
 				$M_TYPE_LAYER = $M_TYPE;
 
diff --git a/examples/svgRoundQuietzone.php b/examples/svgRoundQuietzone.php
@@ -87,7 +87,7 @@ protected function colorQuietzone(int $quietzoneSize, float $radius):void{
 		// substract 1/2 stroke width and module radius from the circle radius to not cut off modules
 		$r  = ($radius - $this->options->circleRadius * 2);
 
-		foreach($this->matrix->matrix() as $y => $row){
+		foreach($this->matrix->getMatrix() as $y => $row){
 			foreach($row as $x => $value){
 
 				// skip anything that's not quiet zone
@@ -175,7 +175,7 @@ protected function collectModules(Closure $transform):array{
 		$paths = [];
 
 		// collect the modules for each type
-		foreach($this->matrix->matrix() as $y => $row){
+		foreach($this->matrix->getMatrix() as $y => $row){
 			foreach($row as $x => $M_TYPE){
 				$M_TYPE_LAYER = $M_TYPE;
 
diff --git a/src/Common/MaskPattern.php b/src/Common/MaskPattern.php
@@ -116,7 +116,7 @@ public static function getBestPattern(QRData $dataInterface):self{
 		$penalties = [];
 
 		foreach(self::PATTERNS as $pattern){
-			$matrix  = $dataInterface->writeMatrix(new self($pattern))->matrix(true);
+			$matrix  = $dataInterface->writeMatrix(new self($pattern))->getMatrix(true);
 			$penalty = 0;
 
 			for($level = 1; $level <= 4; $level++){
diff --git a/src/Data/QRMatrix.php b/src/Data/QRMatrix.php
@@ -147,7 +147,7 @@ public function initFunctionalPatterns():self{
 	 *
 	 * @return int[][]|bool[][]
 	 */
-	public function matrix(bool $boolean = null):array{
+	public function getMatrix(bool $boolean = null):array{
 
 		if(!$boolean){
 			return $this->matrix;
@@ -169,21 +169,21 @@ public function matrix(bool $boolean = null):array{
 	/**
 	 * Returns the current version number
 	 */
-	public function version():?Version{
+	public function getVersion():?Version{
 		return $this->version;
 	}
 
 	/**
 	 * Returns the current ECC level
 	 */
-	public function eccLevel():?EccLevel{
+	public function getEccLevel():?EccLevel{
 		return $this->eccLevel;
 	}
 
 	/**
 	 * Returns the current mask pattern
 	 */
-	public function maskPattern():?MaskPattern{
+	public function getMaskPattern():?MaskPattern{
 		return $this->maskPattern;
 	}
 
@@ -192,7 +192,7 @@ public function maskPattern():?MaskPattern{
 	 *
 	 * size = version * 4 + 17 [ + 2 * quietzone size]
 	 */
-	public function size():int{
+	public function getSize():int{
 		return $this->moduleCount;
 	}
 
diff --git a/src/Decoder/Decoder.php b/src/Decoder/Decoder.php
@@ -71,9 +71,9 @@ public function decode(LuminanceSourceInterface $source):DecoderResult{
 	private function decodeMatrix(BitMatrix $matrix):DecoderResult{
 		// Read raw codewords
 		$rawCodewords      = $matrix->readCodewords();
-		$this->version     = $matrix->version();
-		$this->eccLevel    = $matrix->eccLevel();
-		$this->maskPattern = $matrix->maskPattern();
+		$this->version     = $matrix->getVersion();
+		$this->eccLevel    = $matrix->getEccLevel();
+		$this->maskPattern = $matrix->getMaskPattern();
 
 		if($this->version === null || $this->eccLevel === null || $this->maskPattern === null){
 			throw new QRCodeDecoderException('unable to read version or format info'); // @codeCoverageIgnore
diff --git a/src/Detector/AlignmentPatternFinder.php b/src/Detector/AlignmentPatternFinder.php
@@ -223,7 +223,7 @@ private function centerFromEnd(array $stateCount, int $end):float{
 	 * @return float|null vertical center of alignment pattern, or null if not found
 	 */
 	private function crossCheckVertical(int $startI, int $centerJ, int $maxCount, int $originalStateCountTotal):?float{
-		$maxI          = $this->matrix->size();
+		$maxI          = $this->matrix->getSize();
 		$stateCount    = [];
 		$stateCount[0] = 0;
 		$stateCount[1] = 0;
diff --git a/src/Detector/Detector.php b/src/Detector/Detector.php
@@ -124,7 +124,7 @@ private function calculateModuleSizeOneWay(FinderPattern $a, FinderPattern $b):f
 	 */
 	private function sizeOfBlackWhiteBlackRunBothWays(float $fromX, float $fromY, float $toX, float $toY):float{
 		$result    = $this->sizeOfBlackWhiteBlackRun((int)$fromX, (int)$fromY, (int)$toX, (int)$toY);
-		$dimension = $this->matrix->size();
+		$dimension = $this->matrix->getSize();
 		// Now count other way -- don't run off image though of course
 		$scale     = 1.0;
 		$otherToX  = ($fromX - ($toX - $fromX));
@@ -278,7 +278,7 @@ private function findAlignmentInRegion(
 		float $allowanceFactor
 	):?AlignmentPattern{
 		// Look for an alignment pattern (3 modules in size) around where it should be
-		$dimension           = $this->matrix->size();
+		$dimension           = $this->matrix->getSize();
 		$allowance           = (int)($allowanceFactor * $overallEstModuleSize);
 		$alignmentAreaLeftX  = max(0, ($estAlignmentX - $allowance));
 		$alignmentAreaRightX = min(($dimension - 1), ($estAlignmentX + $allowance));
diff --git a/src/Detector/FinderPatternFinder.php b/src/Detector/FinderPatternFinder.php
@@ -49,7 +49,7 @@ public function __construct(BitMatrix $matrix){
 	 * @return \chillerlan\QRCode\Detector\FinderPattern[]
 	 */
 	public function find():array{
-		$dimension = $this->matrix->size();
+		$dimension = $this->matrix->getSize();
 
 		// We are looking for black/white/black/white/black modules in
 		// 1:1:3:1:1 ratio; this tracks the number of such modules seen so far
@@ -286,7 +286,7 @@ private function crossCheckDiagonal(int $centerI, int $centerJ):bool{
 			return false;
 		}
 
-		$dimension = $this->matrix->size();
+		$dimension = $this->matrix->getSize();
 
 		// Now also count down, right from center
 		$i = 1;
@@ -331,7 +331,7 @@ private function crossCheckDiagonal(int $centerI, int $centerJ):bool{
 	 * @noinspection DuplicatedCode
 	 */
 	private function crossCheckVertical(int $startI, int $centerJ, int $maxCount, int $originalStateCountTotal):?float{
-		$maxI       = $this->matrix->size();
+		$maxI       = $this->matrix->getSize();
 		$stateCount = $this->getCrossCheckStateCount();
 
 		// Start counting up from center
@@ -415,7 +415,7 @@ private function crossCheckVertical(int $startI, int $centerJ, int $maxCount, in
 	 * @noinspection DuplicatedCode
 	 */
 	private function crossCheckHorizontal(int $startJ, int $centerI, int $maxCount, int $originalStateCountTotal):?float{
-		$maxJ       = $this->matrix->size();
+		$maxJ       = $this->matrix->getSize();
 		$stateCount = $this->getCrossCheckStateCount();
 
 		$j = $startJ;
diff --git a/src/Detector/GridSampler.php b/src/Detector/GridSampler.php
@@ -48,7 +48,7 @@ final class GridSampler{
 	 * @throws \chillerlan\QRCode\Detector\QRCodeDetectorException if an endpoint is lies outside the image boundaries
 	 */
 	private function checkAndNudgePoints(BitMatrix $matrix, array $points):void{
-		$dimension = $matrix->size();
+		$dimension = $matrix->getSize();
 		$nudged    = true;
 		$max       = count($points);
 
diff --git a/src/Output/QRFpdf.php b/src/Output/QRFpdf.php
@@ -115,7 +115,7 @@ public function dump(string $file = null){
 
 		$prevColor = null;
 
-		foreach($this->matrix->matrix() as $y => $row){
+		foreach($this->matrix->getMatrix() as $y => $row){
 
 			foreach($row as $x => $M_TYPE){
 
diff --git a/src/Output/QRGdImage.php b/src/Output/QRGdImage.php
@@ -228,7 +228,7 @@ protected function setTransparencyColor():void{
 	 * Creates the QR image
 	 */
 	protected function drawImage():void{
-		foreach($this->matrix->matrix() as $y => $row){
+		foreach($this->matrix->getMatrix() as $y => $row){
 			foreach($row as $x => $M_TYPE){
 				$this->setPixel($x, $y, $M_TYPE);
 			}
diff --git a/src/Output/QRImagick.php b/src/Output/QRImagick.php
@@ -186,7 +186,7 @@ protected function drawImage():void{
 		$this->imagickDraw = new ImagickDraw;
 		$this->imagickDraw->setStrokeWidth(0);
 
-		foreach($this->matrix->matrix() as $y => $row){
+		foreach($this->matrix->getMatrix() as $y => $row){
 			foreach($row as $x => $M_TYPE){
 				$this->setPixel($x, $y, $M_TYPE);
 			}
diff --git a/src/Output/QRMarkupHTML.php b/src/Output/QRMarkupHTML.php
@@ -27,7 +27,7 @@ protected function createMarkup(bool $saveToFile):string{
 
 		$html .= $this->options->eol;
 
-		foreach($this->matrix->matrix() as $row){
+		foreach($this->matrix->getMatrix() as $row){
 			$html .= '<div>';
 
 			foreach($row as $M_TYPE){
diff --git a/src/Output/QROutputAbstract.php b/src/Output/QROutputAbstract.php
@@ -23,7 +23,7 @@ abstract class QROutputAbstract implements QROutputInterface{
 	/**
 	 * the current size of the QR matrix
 	 *
-	 * @see \chillerlan\QRCode\Data\QRMatrix::size()
+	 * @see \chillerlan\QRCode\Data\QRMatrix::getSize()
 	 */
 	protected int $moduleCount;
 
@@ -71,7 +71,7 @@ public function __construct(SettingsContainerInterface $options, QRMatrix $matri
 	 * Call this method if you modify the matrix from within your custom module in case the dimensions have been changed
 	 */
 	protected function setMatrixDimensions():void{
-		$this->moduleCount = $this->matrix->size();
+		$this->moduleCount = $this->matrix->getSize();
 		$this->scale       = $this->options->scale;
 		$this->length      = ($this->moduleCount * $this->scale);
 	}
@@ -152,7 +152,7 @@ protected function collectModules(Closure $transform):array{
 		$paths = [];
 
 		// collect the modules for each type
-		foreach($this->matrix->matrix() as $y => $row){
+		foreach($this->matrix->getMatrix() as $y => $row){
 			foreach($row as $x => $M_TYPE){
 				$M_TYPE_LAYER = $M_TYPE;
 
diff --git a/src/Output/QRString.php b/src/Output/QRString.php
@@ -66,7 +66,7 @@ public function dump(string $file = null):string{
 	protected function text():string{
 		$str = [];
 
-		foreach($this->matrix->matrix() as $row){
+		foreach($this->matrix->getMatrix() as $row){
 			$r = [];
 
 			foreach($row as $M_TYPE){
@@ -83,7 +83,7 @@ protected function text():string{
 	 * JSON output
 	 */
 	protected function json():string{
-		return json_encode($this->matrix->matrix());
+		return json_encode($this->matrix->getMatrix());
 	}
 
 }
diff --git a/tests/Data/DataInterfaceTestAbstract.php b/tests/Data/DataInterfaceTestAbstract.php
@@ -73,7 +73,7 @@ public function testInitMatrix(int $maskPattern):void{
 		$matrix = $this->QRData->writeMatrix(new MaskPattern($maskPattern));
 
 		$this::assertInstanceOf(QRMatrix::class, $matrix);
-		$this::assertSame($maskPattern, $matrix->maskPattern()->getPattern());
+		$this::assertSame($maskPattern, $matrix->getMaskPattern()->getPattern());
 	}
 
 	abstract public static function stringValidateProvider():array;
diff --git a/tests/Data/QRDataTest.php b/tests/Data/QRDataTest.php
@@ -46,7 +46,7 @@ public function testSetBitBuffer():void{
 		$maskPattern = MaskPattern::getBestPattern($QRData);
 		$matrix      = $QRData->writeMatrix($maskPattern);
 
-		$this::assertSame(3, $matrix->version()->getVersionNumber());
+		$this::assertSame(3, $matrix->getVersion()->getVersionNumber());
 
 		// attempt to read
 		$options->imageBase64                 = false;
diff --git a/tests/Data/QRMatrixTest.php b/tests/Data/QRMatrixTest.php
