Remove invalid inline doc comments

Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
phpmyadmin · Apr 18, 2021 · 59e4dae · 59e4dae
1 parent b4effdd
commit 59e4dae
Show file tree

Hide file tree

Showing 22 changed files with 18 additions and 38 deletions.
diff --git a/libraries/classes/Core.php b/libraries/classes/Core.php
@@ -356,7 +356,6 @@ public static function warnMissingExtension(
         bool $fatal = false,
         string $extra = ''
     ): void {
-        /** @var ErrorHandler $errorHandler */
         global $errorHandler;
 
         /* Gettext does not have to be loaded yet here */

diff --git a/libraries/classes/Database/Designer.php b/libraries/classes/Database/Designer.php
@@ -150,7 +150,6 @@ public function getHtmlForSchemaExport($db, $page)
      */
     private function getSideMenuParamsArray()
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         $params = [];

diff --git a/libraries/classes/Menu.php b/libraries/classes/Menu.php
@@ -124,7 +124,6 @@ private function getMenu(): string
      */
     private function getAllowedTabs($level)
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         $cacheKey = 'menu-levels-' . $level;
@@ -244,7 +243,6 @@ private function getBreadcrumbs(): string
      */
     private function getTableTabs()
     {
-        /** @var DatabaseInterface $dbi */
         global $route, $dbi;
 
         $isSystemSchema = Utilities::isSystemSchema($this->db);
@@ -378,7 +376,6 @@ private function getTableTabs()
      */
     private function getDbTabs()
     {
-        /** @var DatabaseInterface $dbi */
         global $route, $dbi;
 
         $isSystemSchema = Utilities::isSystemSchema($this->db);
@@ -502,7 +499,6 @@ private function getDbTabs()
      */
     private function getServerTabs()
     {
-        /** @var DatabaseInterface $dbi */
         global $route, $dbi;
 
         $isSuperUser = $dbi->isSuperUser();

diff --git a/libraries/classes/Navigation/NavigationTree.php b/libraries/classes/Navigation/NavigationTree.php
@@ -1253,7 +1253,6 @@ private function renderNode(Node $node, bool $recursive, string $class = ''): st
                     $icons = [$icons];
                 }
 
-                /** @var array $icons */
                 if (count($icons) > 1) {
                     // Generates: .second double class for NavigationTreeDefaultTabTable2
                     $divClass = 'second double';

diff --git a/libraries/classes/Navigation/Nodes/Node.php b/libraries/classes/Navigation/Nodes/Node.php
@@ -387,7 +387,6 @@ public function getData($type, $pos, $searchClause = '')
      */
     public function getPresence($type = '', $searchClause = '')
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         if (
@@ -508,7 +507,6 @@ private function isHideDb($db)
      */
     private function getDatabasesToSearch($searchClause)
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         $databases = [];
@@ -538,7 +536,6 @@ private function getDatabasesToSearch($searchClause)
      */
     private function getWhereClause($columnName, $searchClause = '')
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         $whereClause = 'WHERE TRUE ';
@@ -646,7 +643,6 @@ public function getIcon($match): string
      */
     public function getNavigationHidingData()
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         $cfgRelation = $this->relation->getRelationsParam();

diff --git a/libraries/classes/Plugins/Export/ExportJson.php b/libraries/classes/Plugins/Export/ExportJson.php
@@ -216,7 +216,6 @@ public function exportData(
         $sqlQuery,
         array $aliases = []
     ) {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         $db_alias = $db;

diff --git a/libraries/classes/Plugins/Export/ExportOds.php b/libraries/classes/Plugins/Export/ExportOds.php
@@ -216,7 +216,6 @@ public function exportData(
         $sqlQuery,
         array $aliases = []
     ) {
-        /** @var DatabaseInterface $dbi */
         global $what, $dbi;
 
         $db_alias = $db;

diff --git a/libraries/classes/Plugins/Export/ExportOdt.php b/libraries/classes/Plugins/Export/ExportOdt.php
@@ -246,7 +246,6 @@ public function exportData(
         $sqlQuery,
         array $aliases = []
     ) {
-        /** @var DatabaseInterface $dbi */
         global $what, $dbi;
 
         $db_alias = $db;

diff --git a/libraries/classes/Plugins/Export/ExportSql.php b/libraries/classes/Plugins/Export/ExportSql.php
@@ -2356,7 +2356,6 @@ public function exportData(
         $sqlQuery,
         array $aliases = []
     ) {
-        /** @var DatabaseInterface $dbi */
         global $current_row, $sql_backquotes, $dbi;
 
         // Do not export data for merge tables
@@ -2416,7 +2415,6 @@ public function exportData(
         }
 
         if ($result == false) {
-            /** @var mixed $result */
             $dbi->freeResult($result);// This makes no sense
 
             return true;

diff --git a/libraries/classes/Plugins/Export/Helpers/Pdf.php b/libraries/classes/Plugins/Export/Helpers/Pdf.php
@@ -761,7 +761,6 @@ public function getTableDef(
      */
     public function mysqlReport($query)
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         unset(

diff --git a/libraries/classes/ReplicationGui.php b/libraries/classes/ReplicationGui.php
@@ -509,7 +509,6 @@ public function handleControlRequest()
      */
     public function handleRequestForSlaveChangeMaster()
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         $sr = [

diff --git a/libraries/classes/Routing.php b/libraries/classes/Routing.php
@@ -86,7 +86,6 @@ private static function routesCachedDispatcher(callable $routeDefinitionCallback
         );
         $routeDefinitionCallback($routeCollector);
 
-        /** @var RouteCollector $routeCollector */
         $dispatchData = $routeCollector->getData();
         $canWriteCache = self::canWriteCache();
 

diff --git a/libraries/classes/Server/SysInfo/Linux.php b/libraries/classes/Server/SysInfo/Linux.php
@@ -91,6 +91,7 @@ public function memory()
             $matches
         );
 
+        /** @var array<string, int>|false $mem */
         $mem = array_combine($matches[1], $matches[2]);
         if ($mem === false) {
             return [];
@@ -112,7 +113,6 @@ public function memory()
             $mem[$idx] = intval($value);
         }
 
-        /** @var array<string, int> $mem */
         $mem['MemUsed'] = $mem['MemTotal'] - $mem['MemFree'] - $mem['Cached'] - $mem['Buffers'];
         $mem['SwapUsed'] = $mem['SwapTotal'] - $mem['SwapFree'] - $mem['SwapCached'];
 

diff --git a/libraries/classes/Tracker.php b/libraries/classes/Tracker.php
@@ -539,7 +539,6 @@ public static function deactivateTracking($dbname, $tablename, $version)
      */
     public static function getVersion($dbname, $tablename, $statement = null)
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         $relation = new Relation($dbi);

diff --git a/libraries/classes/Utils/ForeignKey.php b/libraries/classes/Utils/ForeignKey.php
@@ -4,8 +4,6 @@
 
 namespace PhpMyAdmin\Utils;
 
-use PhpMyAdmin\DatabaseInterface;
-
 use function strtolower;
 use function strtoupper;
 use function substr;
@@ -66,7 +64,6 @@ public static function isCheckEnabled(): bool
      */
     public static function handleDisableCheckInit(): bool
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         $defaultCheckValue = $dbi->getVariable('FOREIGN_KEY_CHECKS') === 'ON';
@@ -90,7 +87,6 @@ public static function handleDisableCheckInit(): bool
      */
     public static function handleDisableCheckCleanup(bool $defaultCheckValue): void
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         $dbi->setVariable(

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -916,9 +916,14 @@ parameters:
 			path: libraries/classes/Menu.php
 
 		-
-			message: "#^Method PhpMyAdmin\\\\Navigation\\\\Nodes\\\\Node\\:\\:getPresence\\(\\) should return int but returns int\\|string\\.$#"
+			message: "#^Argument of an invalid type array\\|string supplied for foreach, only iterables are supported\\.$#"
 			count: 1
-			path: libraries/classes/Navigation/Nodes/Node.php
+			path: libraries/classes/Navigation/NavigationTree.php
+
+		-
+			message: "#^Parameter \\#1 \\$var of function count expects array\\|Countable, array\\|string given\\.$#"
+			count: 1
+			path: libraries/classes/Navigation/NavigationTree.php
 
 		-
 			message: "#^Unreachable statement \\- code above always terminates\\.$#"

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1223,6 +1223,12 @@
     <PossiblyFalseReference occurrences="1">
       <code>getPresence</code>
     </PossiblyFalseReference>
+    <PossiblyInvalidArgument occurrences="1">
+      <code>$icons</code>
+    </PossiblyInvalidArgument>
+    <PossiblyInvalidIterator occurrences="1">
+      <code>$icons</code>
+    </PossiblyInvalidIterator>
     <PossiblyNullArgument occurrences="2">
       <code>$container-&gt;realName</code>
       <code>$table</code>

diff --git a/test/classes/AbstractTestCase.php b/test/classes/AbstractTestCase.php
@@ -106,9 +106,10 @@ protected function loadResponseIntoContainerBuilder(): void
     protected function getResponseHtmlResult(): string
     {
         global $containerBuilder;
-        $response = $containerBuilder->get(Response::class);
 
         /** @var Response $response */
+        $response = $containerBuilder->get(Response::class);
+
         return $response->getHTMLResult();
     }
 

diff --git a/test/classes/DatabaseInterfaceTest.php b/test/classes/DatabaseInterfaceTest.php
@@ -49,7 +49,6 @@ public function testGetCurrentUser($value, string $string, array $expected): voi
         SessionCache::remove('mysql_cur_user');
 
         $extension = new DbiDummy();
-        /** @var array $value */
         $extension->setResult('SELECT CURRENT_USER();', $value);
 
         $dbi = new DatabaseInterface($extension);

diff --git a/test/classes/Stubs/DbiDummy.php b/test/classes/Stubs/DbiDummy.php
@@ -434,8 +434,8 @@ public function escapeString($link, $str)
     /**
      * Adds query result for testing
      *
-     * @param string $query  SQL
-     * @param array  $result Expected result
+     * @param string      $query  SQL
+     * @param array|false $result Expected result
      *
      * @return void
      */

diff --git a/test/classes/TableTest.php b/test/classes/TableTest.php
@@ -988,7 +988,6 @@ public function testIsMergeCase1(): void
      */
     public function testIsMergeCase2(): void
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         $dbi->getCache()->cacheTableContent(
@@ -1007,7 +1006,6 @@ public function testIsMergeCase2(): void
      */
     public function testIsMergeCase3(): void
     {
-        /** @var DatabaseInterface $dbi */
         global $dbi;
 
         $dbi->getCache()->cacheTableContent(

diff --git a/test/classes/VersionInformationTest.php b/test/classes/VersionInformationTest.php
@@ -203,7 +203,6 @@ public function testGetLatestCompatibleVersionWithSingleServer(): void
                 true
             );
 
-        /** @var VersionInformation $mockVersionInfo */
         $compatible = $mockVersionInfo->getLatestCompatibleVersion($this->releases);
         $this->assertIsArray($compatible);
         $this->assertEquals('4.4.14.1', $compatible['version']);
@@ -234,7 +233,6 @@ public function testGetLatestCompatibleVersionWithMultipleServers(): void
                 true
             );
 
-        /** @var VersionInformation $mockVersionInfo */
         $compatible = $mockVersionInfo->getLatestCompatibleVersion($this->releases);
         $this->assertIsArray($compatible);
         $this->assertEquals('4.4.14.1', $compatible['version']);
@@ -269,7 +267,6 @@ public function testGetLatestCompatibleVersionWithOldPHPVersion(): void
                 true
             );
 
-        /** @var VersionInformation $mockVersionInfo */
         $compatible = $mockVersionInfo->getLatestCompatibleVersion($this->releases);
         $this->assertIsArray($compatible);
         $this->assertEquals('4.0.10.10', $compatible['version']);
@@ -315,7 +312,6 @@ public function testGetLatestCompatibleVersionWithNewPHPVersion(
                 ...$returnValues
             );
 
-        /** @var VersionInformation $mockVersionInfo */
         $compatible = $mockVersionInfo->getLatestCompatibleVersion($versions);
         $this->assertEquals($matchedLastVersion, $compatible['version'] ?? null);
     }
@@ -574,7 +570,6 @@ public function testEvaluateVersionCondition(): void
             ->method('getPHPVersion')
             ->will($this->returnValue('5.2.4'));
 
-        /** @var VersionInformation $mockVersionInfo */
         $this->assertTrue($mockVersionInfo->evaluateVersionCondition('PHP', '<=5.3'));
         $this->assertTrue($mockVersionInfo->evaluateVersionCondition('PHP', '<5.3'));
         $this->assertTrue($mockVersionInfo->evaluateVersionCondition('PHP', '>=5.2'));