rename QROutputAbstract::getModuleValue() to prepareModuleValue() to better reflect what it does

Author: codemasher

examples/custom_output.php

@@ -31,8 +31,8 @@ public static function moduleValueIsValid($value):bool{
 	/**
 	 * @inheritDoc
 	 */
-	protected function getModuleValue($value){
-		// TODO: Implement getModuleValue() method. (abstract)
+	protected function prepareModuleValue($value){
+		// TODO: Implement prepareModuleValue() method. (abstract)
 		return null;
 	}
 

src/Output/QREps.php

@@ -52,7 +52,7 @@ public static function moduleValueIsValid($value):bool{
 	 *
 	 * @inheritDoc
 	 */
-	protected function getModuleValue($value):array{
+	protected function prepareModuleValue($value):array{
 		$values = [];
 
 		foreach(array_values($value) as $i => $val){

src/Output/QRFpdf.php

@@ -74,7 +74,7 @@ public static function moduleValueIsValid($value):bool{
 	 *
 	 * @inheritDoc
 	 */
-	protected function getModuleValue($value):array{
+	protected function prepareModuleValue($value):array{
 		$values = [];
 
 		foreach(array_values($value) as $i => $val){
@@ -107,7 +107,7 @@ public function dump(string $file = null){
 		$fpdf->AddPage();
 
 		if($this::moduleValueIsValid($this->options->bgColor)){
-			$bgColor = $this->getModuleValue($this->options->bgColor);
+			$bgColor = $this->prepareModuleValue($this->options->bgColor);
 			/** @phan-suppress-next-line PhanParamTooFewUnpack */
 			$fpdf->SetFillColor(...$bgColor);
 			$fpdf->Rect(0, 0, $this->length, $this->length, 'F');

src/Output/QRGdImage.php

@@ -110,7 +110,7 @@ public static function moduleValueIsValid($value):bool{
 	 * @inheritDoc
 	 * @throws \chillerlan\QRCode\Output\QRCodeOutputException
 	 */
-	protected function getModuleValue($value):int{
+	protected function prepareModuleValue($value):int{
 		$values = [];
 
 		foreach(array_values($value) as $i => $val){
@@ -136,7 +136,7 @@ protected function getModuleValue($value):int{
 	 * @inheritDoc
 	 */
 	protected function getDefaultModuleValue(bool $isDark):int{
-		return $this->getModuleValue(($isDark) ? [0, 0, 0] : [255, 255, 255]);
+		return $this->prepareModuleValue(($isDark) ? [0, 0, 0] : [255, 255, 255]);
 	}
 
 	/**
@@ -199,12 +199,12 @@ protected function setBgColor():void{
 		}
 
 		if($this::moduleValueIsValid($this->options->bgColor)){
-			$this->background = $this->getModuleValue($this->options->bgColor);
+			$this->background = $this->prepareModuleValue($this->options->bgColor);
 
 			return;
 		}
 
-		$this->background = $this->getModuleValue([255, 255, 255]);
+		$this->background = $this->prepareModuleValue([255, 255, 255]);
 	}
 
 	/**
@@ -219,7 +219,7 @@ protected function setTransparencyColor():void{
 		$transparencyColor = $this->background;
 
 		if($this::moduleValueIsValid($this->options->transparencyColor)){
-			$transparencyColor = $this->getModuleValue($this->options->transparencyColor);
+			$transparencyColor = $this->prepareModuleValue($this->options->transparencyColor);
 		}
 
 		imagecolortransparent($this->image, $transparencyColor);

src/Output/QRImagick.php

@@ -99,15 +99,15 @@ public static function moduleValueIsValid($value):bool{
 	 * @inheritDoc
 	 * @throws \ImagickPixelException
 	 */
-	protected function getModuleValue($value):ImagickPixel{
+	protected function prepareModuleValue($value):ImagickPixel{
 		return new ImagickPixel($value);
 	}
 
 	/**
 	 * @inheritDoc
 	 */
 	protected function getDefaultModuleValue(bool $isDark):ImagickPixel{
-		return $this->getModuleValue(($isDark) ? $this->options->markupDark : $this->options->markupLight);
+		return $this->prepareModuleValue(($isDark) ? $this->options->markupDark : $this->options->markupLight);
 	}
 
 	/**
@@ -153,12 +153,12 @@ protected function setBgColor():void{
 		}
 
 		if($this::moduleValueIsValid($this->options->bgColor)){
-			$this->background = $this->getModuleValue($this->options->bgColor);
+			$this->background = $this->prepareModuleValue($this->options->bgColor);
 
 			return;
 		}
 
-		$this->background = $this->getModuleValue('white');
+		$this->background = $this->prepareModuleValue('white');
 	}
 
 	/**
@@ -173,7 +173,7 @@ protected function setTransparencyColor():void{
 		$transparencyColor = $this->background;
 
 		if($this::moduleValueIsValid($this->options->transparencyColor)){
-			$transparencyColor = $this->getModuleValue($this->options->transparencyColor);
+			$transparencyColor = $this->prepareModuleValue($this->options->transparencyColor);
 		}
 
 		$this->imagick->transparentPaintImage($transparencyColor, 0.0, 10, false);

src/Output/QRMarkup.php

@@ -57,7 +57,7 @@ public static function moduleValueIsValid($value):bool{
 	/**
 	 * @inheritDoc
 	 */
-	protected function getModuleValue($value):string{
+	protected function prepareModuleValue($value):string{
 		return trim(strip_tags($value), " '\"\r\n\t");
 	}
 

src/Output/QROutputAbstract.php

@@ -85,7 +85,7 @@ protected function setModuleValues():void{
 			$value = ($this->options->moduleValues[$M_TYPE] ?? null);
 
 			$this->moduleValues[$M_TYPE] = $this::moduleValueIsValid($value)
-				? $this->getModuleValue($value)
+				? $this->prepareModuleValue($value)
 				: $this->getDefaultModuleValue($defaultValue);
 		}
 
@@ -98,7 +98,7 @@ protected function setModuleValues():void{
 	 *
 	 * @return mixed
 	 */
-	abstract protected function getModuleValue($value);
+	abstract protected function prepareModuleValue($value);
 
 	/**
 	 * Returns a default value for either dark or light modules (return value depends on the output module)

src/Output/QRString.php

@@ -30,7 +30,7 @@ public static function moduleValueIsValid($value):bool{
 	/**
 	 * @inheritDoc
 	 */
-	protected function getModuleValue($value):string{
+	protected function prepareModuleValue($value):string{
 		return $value;
 	}