Remove useless Message::format() method

kamil-tekiela · MauricioFauth · commit a1015877104f · 2023-03-03T21:49:46.000-03:00
Signed-off-by: Kamil Tekiela &lt;tekiela246@gmail.com&gt;
diff --git a/libraries/classes/Message.php b/libraries/classes/Message.php
@@ -8,8 +8,6 @@
 
 use function __;
 use function _ngettext;
-use function array_unshift;
-use function count;
 use function htmlspecialchars;
 use function is_array;
 use function is_float;
@@ -584,23 +582,6 @@ public static function decodeBB(string $message): string
         return Sanitize::sanitizeMessage($message, false, true);
     }
 
-    /**
-     * wrapper for sprintf()
-     *
-     * @param mixed[] ...$params Params
-     *
-     * @return string formatted
-     */
-    public static function format(...$params): string
-    {
-        if (isset($params[1]) && is_array($params[1])) {
-            array_unshift($params[1], $params[0]);
-            $params = $params[1];
-        }
-
-        return sprintf(...$params);
-    }
-
     /**
      * returns unique Message::$hash, if not exists it will be created
      *
@@ -636,8 +617,8 @@ public function getMessage(): string
             $message = $this->getMessageWithIcon($message);
         }
 
-        if (count($this->getParams()) > 0) {
-            $message = self::format($message, $this->getParams());
+        if ($this->params !== []) {
+            $message = sprintf($message, ...$this->params);
         }
 
         if ($this->useBBCode) {
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -5590,11 +5590,6 @@ parameters:
 			count: 1
 			path: libraries/classes/Message.php
 
-		-
-			message: "#^Right side of && is always true\\.$#"
-			count: 1
-			path: libraries/classes/Message.php
-
 		-
 			message: "#^Method PhpMyAdmin\\\\Navigation\\\\Navigation\\:\\:getHiddenItems\\(\\) return type has no value type specified in iterable type array\\.$#"
 			count: 1
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -8787,12 +8787,8 @@
     </PossiblyFalseOperand>
   </file>
   <file src="libraries/classes/Message.php">
-    <InvalidArgument>
-      <code>$message</code>
-    </InvalidArgument>
     <MixedArgument>
-      <code>$params</code>
-      <code>$params</code>
+      <code><![CDATA[$this->params]]></code>
     </MixedArgument>
     <MixedAssignment>
       <code>$add_message</code>
@@ -8814,10 +8810,6 @@
     <MixedReturnStatement>
       <code><![CDATA[self::$level[$this->getNumber()]]]></code>
     </MixedReturnStatement>
-    <RedundantConditionGivenDocblockType>
-      <code>is_array($params[1])</code>
-      <code><![CDATA[isset($params[1]) && is_array($params[1])]]></code>
-    </RedundantConditionGivenDocblockType>
   </file>
   <file src="libraries/classes/Navigation/Navigation.php">
     <DeprecatedMethod>
@@ -16213,13 +16205,6 @@
     </InvalidArgument>
   </file>
   <file src="test/classes/MessageTest.php">
-    <InvalidArgument>
-      <code><![CDATA['%s string']]></code>
-      <code><![CDATA['a']]></code>
-      <code><![CDATA['test string']]></code>
-      <code><![CDATA['test string']]></code>
-      <code><![CDATA['test string']]></code>
-    </InvalidArgument>
     <MixedInferredReturnType>
       <code>array</code>
       <code>array</code>
diff --git a/test/classes/MessageTest.php b/test/classes/MessageTest.php
@@ -391,29 +391,6 @@ public function testDecodeBB(string $actual, string $expected): void
         $this->assertEquals($expected, Message::decodeBB($actual));
     }
 
-    /**
-     * testing format method
-     */
-    public function testFormat(): void
-    {
-        $this->assertEquals(
-            'test string',
-            Message::format('test string'),
-        );
-        $this->assertEquals(
-            'test string',
-            Message::format('test string', 'a'),
-        );
-        $this->assertEquals(
-            'test string',
-            Message::format('test string', []),
-        );
-        $this->assertEquals(
-            'test string',
-            Message::format('%s string', ['test']),
-        );
-    }
-
     /**
      * testing getHash method
      */
