Merge pull request #18828 from kamil-tekiela/parameter-names

MauricioFauth · web-flow · commit 67cd9b4dc9c0 · 2023-12-03T20:51:46.000-03:00
Fix parameter names
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -14466,22 +14466,22 @@ parameters:
 			path: src/Plugins/Export/Helpers/Pdf.php
 
 		-
-			message: "#^Parameter \\#1 \\$orientation of method TCPDF\\:\\:AddPage\\(\\) expects string, mixed given\\.$#"
+			message: "#^Parameter \\#1 \\$margin \\(float\\) of method PhpMyAdmin\\\\Plugins\\\\Export\\\\Helpers\\\\Pdf\\:\\:setTopMargin\\(\\) should be contravariant with parameter \\$margin \\(float\\|int\\) of method TCPDF\\:\\:setTopMargin\\(\\)$#"
 			count: 1
 			path: src/Plugins/Export/Helpers/Pdf.php
 
 		-
-			message: "#^Parameter \\#1 \\$s of method TCPDF\\:\\:GetStringWidth\\(\\) expects string, mixed given\\.$#"
+			message: "#^Parameter \\#1 \\$orientation of method TCPDF\\:\\:AddPage\\(\\) expects string, mixed given\\.$#"
 			count: 1
 			path: src/Plugins/Export/Helpers/Pdf.php
 
 		-
-			message: "#^Parameter \\#1 \\$str of static method TCPDF_STATIC\\:\\:empty_string\\(\\) expects string, mixed given\\.$#"
+			message: "#^Parameter \\#1 \\$s of method TCPDF\\:\\:GetStringWidth\\(\\) expects string, mixed given\\.$#"
 			count: 1
 			path: src/Plugins/Export/Helpers/Pdf.php
 
 		-
-			message: "#^Parameter \\#1 \\$topMargin \\(float\\) of method PhpMyAdmin\\\\Plugins\\\\Export\\\\Helpers\\\\Pdf\\:\\:setTopMargin\\(\\) should be contravariant with parameter \\$margin \\(float\\|int\\) of method TCPDF\\:\\:setTopMargin\\(\\)$#"
+			message: "#^Parameter \\#1 \\$str of static method TCPDF_STATIC\\:\\:empty_string\\(\\) expects string, mixed given\\.$#"
 			count: 1
 			path: src/Plugins/Export/Helpers/Pdf.php
 
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -5819,9 +5819,6 @@
     </MixedOperand>
   </file>
   <file src="src/Engines/Pbxt.php">
-    <ParamNameMismatch>
-      <code>$formattedSize</code>
-    </ParamNameMismatch>
     <PossiblyUnusedMethod>
       <code>getPageDocumentation</code>
     </PossiblyUnusedMethod>
@@ -7922,9 +7919,6 @@
       <code><![CDATA[$this->footerset[$this->page]]]></code>
       <code><![CDATA[$this->footerset[$this->page]]]></code>
     </MixedArrayOffset>
-    <ParamNameMismatch>
-      <code>$errorMessage</code>
-    </ParamNameMismatch>
     <PropertyNotSetInConstructor>
       <code>Pdf</code>
       <code>Pdf</code>
@@ -9123,9 +9117,6 @@
       <code>$y</code>
       <code>count($colFits) * $sColWidth</code>
     </MixedOperand>
-    <ParamNameMismatch>
-      <code>$topMargin</code>
-    </ParamNameMismatch>
     <PossiblyNullOperand>
       <code><![CDATA[$GLOBALS['maxY']]]></code>
     </PossiblyNullOperand>
diff --git a/src/Engines/Pbxt.php b/src/Engines/Pbxt.php
@@ -141,17 +141,15 @@ public function getVariables(): array
      * returns the pbxt engine specific handling for
      * DETAILS_TYPE_SIZE variables.
      *
-     * @param int|string $formattedSize the size expression (for example 8MB)
+     * @param int|string $value the size expression (for example 8MB)
      *
      * @return string[] the formatted value and its unit
      * @psalm-return array{string, string}
      */
-    public function resolveTypeSize(int|string $formattedSize): array
+    public function resolveTypeSize(int|string $value): array
     {
-        if (is_string($formattedSize) && preg_match('/^[0-9]+[a-zA-Z]+$/', $formattedSize)) {
-            $value = Util::extractValueFromFormattedSize($formattedSize);
-        } else {
-            $value = $formattedSize;
+        if (is_string($value) && preg_match('/^[0-9]+[a-zA-Z]+$/', $value)) {
+            $value = Util::extractValueFromFormattedSize($value);
         }
 
         return Util::formatByteDown($value);
diff --git a/src/Pdf.php b/src/Pdf.php
@@ -129,13 +129,13 @@ public function _putpages(): void
     /**
      * Displays an error message
      *
-     * @param string $errorMessage the error message
+     * @param string $msg the error message
      */
     // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function Error(mixed $errorMessage = ''): never
+    public function Error(mixed $msg = ''): never
     {
         echo Message::error(
-            __('Error while creating PDF:') . ' ' . $errorMessage,
+            __('Error while creating PDF:') . ' ' . $msg,
         )->getDisplay();
         ResponseRenderer::getInstance()->callExit();
     }
diff --git a/src/Plugins/Export/Helpers/Pdf.php b/src/Plugins/Export/Helpers/Pdf.php
@@ -296,11 +296,11 @@ public function morepagestable(int|float $lineheight = 8): void
      * Defines the top margin.
      * The method can be called before creating the first page.
      *
-     * @param float $topMargin the margin
+     * @param float $margin the margin
      */
-    public function setTopMargin(mixed $topMargin): void
+    public function setTopMargin(mixed $margin): void
     {
-        $this->tMargin = $topMargin;
+        $this->tMargin = $margin;
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -14466,22 +14466,22 @@ parameters:`
`14466`	`14466`	`path: src/Plugins/Export/Helpers/Pdf.php`
`14467`	`14467`
`14468`	`14468`	`-`
`14469`		`- message: "#^Parameter \\#1 \\$orientation of method TCPDF\\:\\:AddPage\\(\\) expects string, mixed given\\.$#"`
	`14469`	`+ message: "#^Parameter \\#1 \\$margin \\(float\\) of method PhpMyAdmin\\\\Plugins\\\\Export\\\\Helpers\\\\Pdf\\:\\:setTopMargin\\(\\) should be contravariant with parameter \\$margin \\(float\\\|int\\) of method TCPDF\\:\\:setTopMargin\\(\\)$#"`
`14470`	`14470`	`count: 1`
`14471`	`14471`	`path: src/Plugins/Export/Helpers/Pdf.php`
`14472`	`14472`
`14473`	`14473`	`-`
`14474`		`- message: "#^Parameter \\#1 \\$s of method TCPDF\\:\\:GetStringWidth\\(\\) expects string, mixed given\\.$#"`
	`14474`	`+ message: "#^Parameter \\#1 \\$orientation of method TCPDF\\:\\:AddPage\\(\\) expects string, mixed given\\.$#"`
`14475`	`14475`	`count: 1`
`14476`	`14476`	`path: src/Plugins/Export/Helpers/Pdf.php`
`14477`	`14477`
`14478`	`14478`	`-`
`14479`		`- message: "#^Parameter \\#1 \\$str of static method TCPDF_STATIC\\:\\:empty_string\\(\\) expects string, mixed given\\.$#"`
	`14479`	`+ message: "#^Parameter \\#1 \\$s of method TCPDF\\:\\:GetStringWidth\\(\\) expects string, mixed given\\.$#"`
`14480`	`14480`	`count: 1`
`14481`	`14481`	`path: src/Plugins/Export/Helpers/Pdf.php`
`14482`	`14482`
`14483`	`14483`	`-`
`14484`		`- message: "#^Parameter \\#1 \\$topMargin \\(float\\) of method PhpMyAdmin\\\\Plugins\\\\Export\\\\Helpers\\\\Pdf\\:\\:setTopMargin\\(\\) should be contravariant with parameter \\$margin \\(float\\\|int\\) of method TCPDF\\:\\:setTopMargin\\(\\)$#"`
	`14484`	`+ message: "#^Parameter \\#1 \\$str of static method TCPDF_STATIC\\:\\:empty_string\\(\\) expects string, mixed given\\.$#"`
`14485`	`14485`	`count: 1`
`14486`	`14486`	`path: src/Plugins/Export/Helpers/Pdf.php`
`14487`	`14487`
Original file line number	Diff line number	Diff line change
`@@ -141,17 +141,15 @@ public function getVariables(): array`
`141`	`141`	`* returns the pbxt engine specific handling for`
`142`	`142`	`* DETAILS_TYPE_SIZE variables.`
`143`	`143`	`*`
`144`		`- * @param int\|string $formattedSize the size expression (for example 8MB)`
	`144`	`+ * @param int\|string $value the size expression (for example 8MB)`
`145`	`145`	`*`
`146`	`146`	`* @return string[] the formatted value and its unit`
`147`	`147`	`* @psalm-return array{string, string}`
`148`	`148`	`*/`
`149`		`- public function resolveTypeSize(int\|string $formattedSize): array`
	`149`	`+ public function resolveTypeSize(int\|string $value): array`
`150`	`150`	`{`
`151`		`- if (is_string($formattedSize) && preg_match('/^[0-9]+[a-zA-Z]+$/', $formattedSize)) {`
`152`		`- $value = Util::extractValueFromFormattedSize($formattedSize);`
`153`		`- } else {`
`154`		`- $value = $formattedSize;`
	`151`	`+ if (is_string($value) && preg_match('/^[0-9]+[a-zA-Z]+$/', $value)) {`
	`152`	`+ $value = Util::extractValueFromFormattedSize($value);`
`155`	`153`	`}`
`156`	`154`
`157`	`155`	`return Util::formatByteDown($value);`
Original file line number	Diff line number	Diff line change
`@@ -129,13 +129,13 @@ public function _putpages(): void`
`129`	`129`	`/**`
`130`	`130`	`* Displays an error message`
`131`	`131`	`*`
`132`		`- * @param string $errorMessage the error message`
	`132`	`+ * @param string $msg the error message`
`133`	`133`	`*/`
`134`	`134`	`// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps`
`135`		`- public function Error(mixed $errorMessage = ''): never`
	`135`	`+ public function Error(mixed $msg = ''): never`
`136`	`136`	`{`
`137`	`137`	`echo Message::error(`
`138`		`- __('Error while creating PDF:') . ' ' . $errorMessage,`
	`138`	`+ __('Error while creating PDF:') . ' ' . $msg,`
`139`	`139`	`)->getDisplay();`
`140`	`140`	`ResponseRenderer::getInstance()->callExit();`
`141`	`141`	`}`
Original file line number	Diff line number	Diff line change
`@@ -296,11 +296,11 @@ public function morepagestable(int\|float $lineheight = 8): void`
`296`	`296`	`* Defines the top margin.`
`297`	`297`	`* The method can be called before creating the first page.`
`298`	`298`	`*`
`299`		`- * @param float $topMargin the margin`
	`299`	`+ * @param float $margin the margin`
`300`	`300`	`*/`
`301`		`- public function setTopMargin(mixed $topMargin): void`
	`301`	`+ public function setTopMargin(mixed $margin): void`
`302`	`302`	`{`
`303`		`- $this->tMargin = $topMargin;`
	`303`	`+ $this->tMargin = $margin;`
`304`	`304`	`}`
`305`	`305`
`306`	`306`	`/**`