Add native param types

Signed-off-by: Kamil Tekiela <tekiela246@gmail.com> Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
phpmyadmin · Mar 29, 2023 · 2b92201 · 2b92201
1 parent cff126e
commit 2b92201
Show file tree

Hide file tree

Showing 29 changed files with 57 additions and 84 deletions.
diff --git a/libraries/classes/Plugins/Transformations/Abs/Bool2TextTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/Bool2TextTransformationsPlugin.php
@@ -35,7 +35,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         $cfg = $GLOBALS['cfg'];
         $options = $this->getOptions($options, $cfg['DefaultTransformations']['Bool2Text']);

diff --git a/libraries/classes/Plugins/Transformations/Abs/CodeMirrorEditorTransformationPlugin.php b/libraries/classes/Plugins/Transformations/Abs/CodeMirrorEditorTransformationPlugin.php
@@ -25,7 +25,7 @@ abstract class CodeMirrorEditorTransformationPlugin extends IOTransformationsPlu
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         return $buffer;
     }

diff --git a/libraries/classes/Plugins/Transformations/Abs/DateFormatTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/DateFormatTransformationsPlugin.php
@@ -55,9 +55,8 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
-        $buffer = (string) $buffer;
         // possibly use a global transform and feed it with special options
         $cfg = $GLOBALS['cfg'];
         $options = $this->getOptions($options, $cfg['DefaultTransformations']['DateFormat']);

diff --git a/libraries/classes/Plugins/Transformations/Abs/DownloadTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/DownloadTransformationsPlugin.php
@@ -41,7 +41,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         $GLOBALS['row'] ??= null;
         $GLOBALS['fields_meta'] ??= null;

diff --git a/libraries/classes/Plugins/Transformations/Abs/ExternalTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/ExternalTransformationsPlugin.php
@@ -77,7 +77,7 @@ public function applyTransformationNoWrap(array $options = []): bool
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         // possibly use a global transform and feed it with special options
 

diff --git a/libraries/classes/Plugins/Transformations/Abs/FormattedTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/FormattedTransformationsPlugin.php
@@ -37,7 +37,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         return '<iframe srcdoc="'
             . strtr($buffer, '"', '\'')

diff --git a/libraries/classes/Plugins/Transformations/Abs/HexTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/HexTransformationsPlugin.php
@@ -39,7 +39,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         // possibly use a global transform and feed it with special options
         $cfg = $GLOBALS['cfg'];

diff --git a/libraries/classes/Plugins/Transformations/Abs/ImageLinkTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/ImageLinkTransformationsPlugin.php
@@ -34,7 +34,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         // must disable the page loader, see
         // https://wiki.phpmyadmin.net/pma/Page_loader#Bypassing_the_page_loader

diff --git a/libraries/classes/Plugins/Transformations/Abs/ImageUploadTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/ImageUploadTransformationsPlugin.php
@@ -39,7 +39,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         return $buffer;
     }

diff --git a/libraries/classes/Plugins/Transformations/Abs/InlineTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/InlineTransformationsPlugin.php
@@ -38,7 +38,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         $cfg = $GLOBALS['cfg'];
         $options = $this->getOptions($options, $cfg['DefaultTransformations']['Inline']);

diff --git a/libraries/classes/Plugins/Transformations/Abs/LongToIPv4TransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/LongToIPv4TransformationsPlugin.php
@@ -37,7 +37,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         return htmlspecialchars(FormatConverter::longToIp($buffer));
     }

diff --git a/libraries/classes/Plugins/Transformations/Abs/PreApPendTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/PreApPendTransformationsPlugin.php
@@ -37,7 +37,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         $cfg = $GLOBALS['cfg'];
         $options = $this->getOptions($options, $cfg['DefaultTransformations']['PreApPend']);

diff --git a/libraries/classes/Plugins/Transformations/Abs/RegexValidationTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/RegexValidationTransformationsPlugin.php
@@ -40,7 +40,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         // reset properties of object
         $this->reset();

diff --git a/libraries/classes/Plugins/Transformations/Abs/SQLTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/SQLTransformationsPlugin.php
@@ -33,7 +33,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         return Generator::formatSql($buffer);
     }

diff --git a/libraries/classes/Plugins/Transformations/Abs/SubstringTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/SubstringTransformationsPlugin.php
@@ -41,9 +41,8 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
-        $buffer = (string) $buffer;
         // possibly use a global transform and feed it with special options
 
         // further operations on $buffer using the $options[] array.

diff --git a/libraries/classes/Plugins/Transformations/Abs/TextFileUploadTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/TextFileUploadTransformationsPlugin.php
@@ -34,7 +34,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         return $buffer;
     }

diff --git a/libraries/classes/Plugins/Transformations/Abs/TextImageLinkTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/TextImageLinkTransformationsPlugin.php
@@ -39,7 +39,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         $cfg = $GLOBALS['cfg'];
         $options = $this->getOptions($options, $cfg['DefaultTransformations']['TextImageLink']);

diff --git a/libraries/classes/Plugins/Transformations/Abs/TextLinkTransformationsPlugin.php b/libraries/classes/Plugins/Transformations/Abs/TextLinkTransformationsPlugin.php
@@ -38,7 +38,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         $cfg = $GLOBALS['cfg'];
         $options = $this->getOptions($options, $cfg['DefaultTransformations']['TextLink']);

diff --git a/libraries/classes/Plugins/Transformations/Input/Text_Plain_Iptobinary.php b/libraries/classes/Plugins/Transformations/Input/Text_Plain_Iptobinary.php
@@ -41,7 +41,7 @@ public static function getInfo(): string
      *
      * @return string IP address
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         return FormatConverter::ipToBinary($buffer);
     }

diff --git a/libraries/classes/Plugins/Transformations/Input/Text_Plain_Iptolong.php b/libraries/classes/Plugins/Transformations/Input/Text_Plain_Iptolong.php
@@ -38,7 +38,7 @@ public static function getInfo(): string
      *
      * @return string IP address
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         return (string) FormatConverter::ipToLong($buffer);
     }

diff --git a/libraries/classes/Plugins/Transformations/Output/Text_Plain_Binarytoip.php b/libraries/classes/Plugins/Transformations/Output/Text_Plain_Binarytoip.php
@@ -40,7 +40,7 @@ public static function getInfo(): string
      *
      * @return string IP address
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         $isBinary = ($meta !== null && $meta->isBinary);
 

diff --git a/libraries/classes/Plugins/Transformations/Output/Text_Plain_Json.php b/libraries/classes/Plugins/Transformations/Output/Text_Plain_Json.php
@@ -49,7 +49,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         return '<code class="json"><pre>' . "\n"
         . htmlspecialchars($buffer) . "\n"

diff --git a/libraries/classes/Plugins/Transformations/Output/Text_Plain_Xml.php b/libraries/classes/Plugins/Transformations/Output/Text_Plain_Xml.php
@@ -49,7 +49,7 @@ public static function getInfo(): string
      * @param array              $options transformation options
      * @param FieldMetadata|null $meta    meta information
      */
-    public function applyTransformation($buffer, array $options = [], FieldMetadata|null $meta = null): string
+    public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
     {
         return '<code class="xml"><pre>' . "\n"
         . htmlspecialchars($buffer) . "\n"

diff --git a/libraries/classes/Plugins/TransformationsPlugin.php b/libraries/classes/Plugins/TransformationsPlugin.php
@@ -35,7 +35,7 @@ public function applyTransformationNoWrap(array $options = []): bool
      * @return string the transformed text
      */
     abstract public function applyTransformation(
-        $buffer,
+        string $buffer,
         array $options = [],
         FieldMetadata|null $meta = null,
     ): string;

diff --git a/libraries/classes/Utils/FormatConverter.php b/libraries/classes/Utils/FormatConverter.php
@@ -77,14 +77,16 @@ public static function ipToLong(string $buffer): int|string
     /**
      * Transforms a long to an IP
      *
-     * @param mixed $buffer Data to transform
+     * @param string $buffer Data to transform
      */
-    public static function longToIp(mixed $buffer): string
+    public static function longToIp(string $buffer): string
     {
         if (! Util::isInteger($buffer) || $buffer < 0 || $buffer > 4294967295) {
             return $buffer;
         }
 
-        return (string) long2ip((int) $buffer);
+        $bufferAsFloat = (float) $buffer;
+
+        return (string) long2ip((int) $bufferAsFloat);
     }
 }
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -6780,11 +6780,6 @@ parameters:
 			count: 1
 			path: libraries/classes/Plugins/Transformations/Abs/DateFormatTransformationsPlugin.php
 
-		-
-			message: "#^Casting to string something that's already string\\.$#"
-			count: 1
-			path: libraries/classes/Plugins/Transformations/Abs/DateFormatTransformationsPlugin.php
-
 		-
 			message: "#^Method PhpMyAdmin\\\\Plugins\\\\Transformations\\\\Abs\\\\DateFormatTransformationsPlugin\\:\\:applyTransformation\\(\\) has parameter \\$options with no value type specified in iterable type array\\.$#"
 			count: 1
@@ -6900,11 +6895,6 @@ parameters:
 			count: 2
 			path: libraries/classes/Plugins/Transformations/Abs/SubstringTransformationsPlugin.php
 
-		-
-			message: "#^Casting to string something that's already string\\.$#"
-			count: 1
-			path: libraries/classes/Plugins/Transformations/Abs/SubstringTransformationsPlugin.php
-
 		-
 			message: "#^Method PhpMyAdmin\\\\Plugins\\\\Transformations\\\\Abs\\\\SubstringTransformationsPlugin\\:\\:applyTransformation\\(\\) has parameter \\$options with no value type specified in iterable type array\\.$#"
 			count: 1
@@ -8895,11 +8885,6 @@ parameters:
 			count: 1
 			path: libraries/classes/Util.php
 
-		-
-			message: "#^Cannot cast mixed to int\\.$#"
-			count: 1
-			path: libraries/classes/Utils/FormatConverter.php
-
 		-
 			message: "#^Method PhpMyAdmin\\\\Utils\\\\FormatConverter\\:\\:binaryToIp\\(\\) should return string\\|false but returns mixed\\.$#"
 			count: 2
@@ -8910,11 +8895,6 @@ parameters:
 			count: 1
 			path: libraries/classes/Utils/FormatConverter.php
 
-		-
-			message: "#^Method PhpMyAdmin\\\\Utils\\\\FormatConverter\\:\\:longToIp\\(\\) should return string but returns mixed\\.$#"
-			count: 1
-			path: libraries/classes/Utils/FormatConverter.php
-
 		-
 			message: "#^Parameter \\#1 \\$haystack of function strpos expects string, mixed given\\.$#"
 			count: 1
@@ -11035,11 +11015,6 @@ parameters:
 			count: 1
 			path: test/classes/Utils/FormatConverterTest.php
 
-		-
-			message: "#^Method PhpMyAdmin\\\\Tests\\\\Utils\\\\FormatConverterTest\\:\\:providerLongToIp\\(\\) return type has no value type specified in iterable type array\\.$#"
-			count: 1
-			path: test/classes/Utils/FormatConverterTest.php
-
 		-
 			message: "#^Method PhpMyAdmin\\\\Tests\\\\Utils\\\\GisTest\\:\\:providerConvertToWellKnownText\\(\\) return type has no value type specified in iterable type array\\.$#"
 			count: 1

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -11680,9 +11680,6 @@
       <code>$options[1]</code>
       <code>$options[2]</code>
     </MixedArgument>
-    <RedundantCastGivenDocblockType>
-      <code>(string) $buffer</code>
-    </RedundantCastGivenDocblockType>
   </file>
   <file src="libraries/classes/Plugins/Transformations/Abs/DownloadTransformationsPlugin.php">
     <InvalidArrayOffset>
@@ -11769,9 +11766,6 @@
       <code>$options[2]</code>
       <code>$options[2]</code>
     </MixedOperand>
-    <RedundantCastGivenDocblockType>
-      <code>(string) $buffer</code>
-    </RedundantCastGivenDocblockType>
   </file>
   <file src="libraries/classes/Plugins/Transformations/Abs/TextImageLinkTransformationsPlugin.php">
     <MixedOperand>
@@ -14088,16 +14082,14 @@
     <MixedInferredReturnType>
       <code>false|string</code>
       <code>string</code>
-      <code>string</code>
     </MixedInferredReturnType>
     <MixedReturnStatement>
-      <code>$buffer</code>
       <code>$buffer</code>
       <code>$isBinary ? bin2hex($buffer) : $buffer</code>
       <code>$isBinary ? bin2hex($buffer) : $buffer</code>
     </MixedReturnStatement>
     <RedundantCast>
-      <code>(string) long2ip((int) $buffer)</code>
+      <code>(string) long2ip((int) $bufferAsFloat)</code>
     </RedundantCast>
   </file>
   <file src="libraries/classes/Utils/Gis.php">
@@ -15900,7 +15892,6 @@
       <code>array</code>
       <code>array</code>
       <code>array</code>
-      <code>array</code>
     </MixedInferredReturnType>
   </file>
   <file src="test/classes/Utils/GisTest.php">