Use PHPStan's baseline instead of global ignore of errors

paulbalandan · paulbalandan · commit f941858bcf24 · 2021-12-13T15:05:13.000+08:00
diff --git a/phpstan-baseline.neon.dist b/phpstan-baseline.neon.dist
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -8,6 +8,9 @@ services:
 		tags:
 			- phpstan.rules.rule
 
+includes:
+	- phpstan-baseline.neon.dist
+
 parameters:
 	tmpDir: build/phpstan
 	level: 5
@@ -28,30 +31,6 @@ parameters:
 		- system/Test/Filters/CITestStreamFilter.php
 		- system/ThirdParty/*
 		- system/Validation/Views/single.php
-	ignoreErrors:
-		- '#Access to an undefined property CodeIgniter\\Database\\BaseConnection::\$mysqli|\$schema#'
-		- '#Access to an undefined property CodeIgniter\\Database\\ConnectionInterface::(\$DBDriver|\$connID|\$likeEscapeStr|\$likeEscapeChar|\$escapeChar|\$protectIdentifiers|\$schema)#'
-		- '#Call to an undefined method CodeIgniter\\Database\\BaseConnection::_(disable|enable)ForeignKeyChecks\(\)#'
-		- '#Call to an undefined method CodeIgniter\\Router\\RouteCollectionInterface::(getDefaultNamespace|isFiltered|getFilterForRoute|getFiltersForRoute|getRoutesOptions)\(\)#'
-		- '#Cannot access property [\$a-z_]+ on ((bool\|)?object\|resource)#'
-		- '#Cannot call method [a-zA-Z_]+\(\) on ((bool\|)?object\|resource)#'
-		- '#Method CodeIgniter\\Router\\RouteCollectionInterface::getRoutes\(\) invoked with 1 parameter, 0 required#'
-		- '#Method CodeIgniter\\Validation\\ValidationInterface::run\(\) invoked with 3 parameters, 0-2 required#'
-		- '#Negated boolean expression is always (true|false)#'
-		- '#Return type \(bool\) of method CodeIgniter\\HTTP\\Files\\UploadedFile::move\(\) should be compatible with return type \(CodeIgniter\\Files\\File\) of method CodeIgniter\\Files\\File::move\(\)#'
-		- '#.*\son left side of \?\? is not nullable#'
-		- '#While loop condition is always true#'
-		- '#Right side of && is always true#'
-		- '#.*in isset\(\) is not nullable#'
-		- '#.*in empty\(\) is not falsy#'
-		- '#.*on left side of \?\? always exists and is not nullable#'
-		- '#Variable \$error on left side of \?\? always exists and is always null#'
-		- '#Variable \$config in empty\(\) always exists and is not falsy#'
-		- '#If condition is always true#'
-		- '#Dead catch - CodeIgniter\\Exceptions\\PageNotFoundException is never thrown in the try block#'
-		- '#.* in isset\(\) does not exist#'
-		- '#Variable \$mockService in empty\(\) always exists and is always falsy#'
-		- '#PHPDoc type string\|null of property CodeIgniter\\Images\\Handlers\\ImageMagickHandler::\$resource is not covariant with PHPDoc type resource\|null of overridden property CodeIgniter\\Images\\Handlers\\BaseHandler::\$resource#'
 	parallel:
 		processTimeout: 300.0
 	scanDirectories:
diff --git a/system/Autoloader/Autoloader.php b/system/Autoloader/Autoloader.php
@@ -114,10 +114,10 @@ public function initialize(Autoload $config, Modules $modules)
     public function register()
     {
         // Prepend the PSR4  autoloader for maximum performance.
-        spl_autoload_register([$this, 'loadClass'], true, true); // @phpstan-ignore-line
+        spl_autoload_register([$this, 'loadClass'], true, true);
 
         // Now prepend another loader for the files in our class map.
-        spl_autoload_register([$this, 'loadClassmap'], true, true); // @phpstan-ignore-line
+        spl_autoload_register([$this, 'loadClassmap'], true, true);
 
         // Load our non-class files
         foreach ($this->files as $file) {
diff --git a/system/Cache/Handlers/FileHandler.php b/system/Cache/Handlers/FileHandler.php
@@ -241,7 +241,6 @@ protected function getItem(string $filename)
             return false;
         }
 
-        // @phpstan-ignore-next-line
         if ($data['ttl'] > 0 && time() > $data['time'] + $data['ttl']) {
             // If the file is still there then try to remove it
             if (is_file($this->path . $filename)) {
diff --git a/system/Cache/Handlers/MemcachedHandler.php b/system/Cache/Handlers/MemcachedHandler.php
@@ -146,7 +146,7 @@ public function get(string $key)
             }
         }
 
-        return is_array($data) ? $data[0] : $data; // @phpstan-ignore-line
+        return is_array($data) ? $data[0] : $data;
     }
 
     /**
@@ -172,7 +172,6 @@ public function save(string $key, $value, int $ttl = 60)
             return $this->memcached->set($key, $value, 0, $ttl);
         }
 
-        // @phpstan-ignore-next-line
         return false;
     }
 
@@ -205,7 +204,6 @@ public function increment(string $key, int $offset = 1)
 
         $key = static::validateKey($key, $this->prefix);
 
-        // @phpstan-ignore-next-line
         return $this->memcached->increment($key, $offset, $offset, 60);
     }
 
@@ -221,7 +219,7 @@ public function decrement(string $key, int $offset = 1)
         $key = static::validateKey($key, $this->prefix);
 
         // FIXME: third parameter isn't other handler actions.
-        // @phpstan-ignore-next-line
+
         return $this->memcached->decrement($key, $offset, $offset, 60);
     }
 
diff --git a/system/CodeIgniter.php b/system/CodeIgniter.php
@@ -537,7 +537,6 @@ protected function getRequestObject()
             return;
         }
 
-        // @phpstan-ignore-next-line
         if (is_cli() && ENVIRONMENT !== 'testing') {
             // @codeCoverageIgnoreStart
             $this->request = Services::clirequest($this->config);
@@ -721,7 +720,7 @@ protected function tryToRouteIt(?RouteCollectionInterface $routes = null)
         // If a {locale} segment was matched in the final route,
         // then we need to set the correct locale on our Request.
         if ($this->router->hasLocale()) {
-            $this->request->setLocale($this->router->getLocale()); // @phpstan-ignore-line
+            $this->request->setLocale($this->router->getLocale());
         }
 
         $this->benchmark->stop('routing');
@@ -816,7 +815,7 @@ protected function createController()
     protected function runController($class)
     {
         // If this is a console request then use the input segments as parameters
-        $params = defined('SPARKED') ? $this->request->getSegments() : $this->router->params(); // @phpstan-ignore-line
+        $params = defined('SPARKED') ? $this->request->getSegments() : $this->router->params();
 
         if (method_exists($class, '_remap')) {
             $output = $class->_remap($this->method, ...$params);
@@ -969,7 +968,7 @@ public function spoofRequestMethod()
             return;
         }
 
-        $method = $this->request->getPost('_method'); // @phpstan-ignore-line
+        $method = $this->request->getPost('_method');
 
         if (empty($method)) {
             return;
diff --git a/system/Common.php b/system/Common.php
@@ -1153,7 +1153,6 @@ function class_uses_recursive($class)
 
         $results = [];
 
-        // @phpstan-ignore-next-line
         foreach (array_reverse(class_parents($class)) + [$class => $class] as $class) {
             $results += trait_uses_recursive($class);
         }
diff --git a/system/Database/BaseConnection.php b/system/Database/BaseConnection.php
@@ -883,7 +883,6 @@ public function prepare(Closure $func, array $options = [])
         $this->pretend(false);
 
         if ($sql instanceof QueryInterface) {
-            // @phpstan-ignore-next-line
             $sql = $sql->getOriginalQuery();
         }
 
diff --git a/system/Database/BaseResult.php b/system/Database/BaseResult.php
@@ -154,7 +154,6 @@ public function getCustomResultObject(string $className)
             $this->customResultObject[$className][] = $row;
         }
 
-        // @phpstan-ignore-next-line
         return $this->customResultObject[$className];
     }
 
@@ -233,7 +232,6 @@ public function getResultObject(): array
             $this->resultObject[] = $row;
         }
 
-        // @phpstan-ignore-next-line
         return $this->resultObject;
     }
 
diff --git a/system/Database/Postgre/Connection.php b/system/Database/Postgre/Connection.php
@@ -117,7 +117,6 @@ public function getVersion(): string
             return $this->dataCache['version'];
         }
 
-        // @phpstan-ignore-next-line
         if (! $this->connID || ($pgVersion = pg_version($this->connID)) === false) {
             $this->initialize();
         }
diff --git a/system/Database/SQLite3/Result.php b/system/Database/SQLite3/Result.php
@@ -27,7 +27,7 @@ class Result extends BaseResult
      */
     public function getFieldCount(): int
     {
-        return $this->resultID->numColumns(); // @phpstan-ignore-line
+        return $this->resultID->numColumns();
     }
 
     /**
@@ -38,7 +38,7 @@ public function getFieldNames(): array
         $fieldNames = [];
 
         for ($i = 0, $c = $this->getFieldCount(); $i < $c; $i++) {
-            $fieldNames[] = $this->resultID->columnName($i); // @phpstan-ignore-line
+            $fieldNames[] = $this->resultID->columnName($i);
         }
 
         return $fieldNames;
@@ -58,18 +58,18 @@ public function getFieldData(): array
         ];
 
         $retVal = [];
-        $this->resultID->fetchArray(SQLITE3_NUM); // @phpstan-ignore-line
+        $this->resultID->fetchArray(SQLITE3_NUM);
 
         for ($i = 0, $c = $this->getFieldCount(); $i < $c; $i++) {
             $retVal[$i]             = new stdClass();
-            $retVal[$i]->name       = $this->resultID->columnName($i); // @phpstan-ignore-line
-            $type                   = $this->resultID->columnType($i); // @phpstan-ignore-line
+            $retVal[$i]->name       = $this->resultID->columnName($i);
+            $type                   = $this->resultID->columnType($i);
             $retVal[$i]->type       = $type;
             $retVal[$i]->type_name  = $dataTypes[$type] ?? null;
             $retVal[$i]->max_length = null;
             $retVal[$i]->length     = null;
         }
-        $this->resultID->reset(); // @phpstan-ignore-line
+        $this->resultID->reset();
 
         return $retVal;
     }
@@ -100,7 +100,7 @@ public function dataSeek(int $n = 0)
             throw new DatabaseException('SQLite3 doesn\'t support seeking to other offset.');
         }
 
-        return $this->resultID->reset(); // @phpstan-ignore-line
+        return $this->resultID->reset();
     }
 
     /**
@@ -112,7 +112,7 @@ public function dataSeek(int $n = 0)
      */
     protected function fetchAssoc()
     {
-        return $this->resultID->fetchArray(SQLITE3_ASSOC); // @phpstan-ignore-line
+        return $this->resultID->fetchArray(SQLITE3_ASSOC);
     }
 
     /**
diff --git a/system/Debug/Exceptions.php b/system/Debug/Exceptions.php
@@ -394,7 +394,7 @@ public static function highlightFile(string $file, int $lineNumber, int $lines =
         $start = max($lineNumber - (int) round($lines / 2), 0);
 
         // Get just the lines we need to display, while keeping line numbers...
-        $source = array_splice($source, $start, $lines, true); // @phpstan-ignore-line
+        $source = array_splice($source, $start, $lines, true);
 
         // Used to format the line number in the source
         $format = '% ' . strlen((string) ($start + $lines)) . 'd';
diff --git a/system/Debug/Toolbar/Collectors/Events.php b/system/Debug/Toolbar/Collectors/Events.php
@@ -74,7 +74,7 @@ protected function formatTimelineData(): array
     {
         $data = [];
 
-        $rows = $this->viewer->getPerformanceData(); // @phpstan-ignore-line
+        $rows = $this->viewer->getPerformanceData();
 
         foreach ($rows as $info) {
             $data[] = [
diff --git a/system/Debug/Toolbar/Collectors/Views.php b/system/Debug/Toolbar/Collectors/Views.php
@@ -89,7 +89,7 @@ protected function formatTimelineData(): array
     {
         $data = [];
 
-        $rows = $this->viewer->getPerformanceData(); // @phpstan-ignore-line
+        $rows = $this->viewer->getPerformanceData();
 
         foreach ($rows as $info) {
             $data[] = [
@@ -122,7 +122,7 @@ protected function formatTimelineData(): array
     public function getVarData(): array
     {
         return [
-            // @phpstan-ignore-next-line
+
             'View Data' => $this->viewer->getData(),
         ];
     }
@@ -132,7 +132,7 @@ public function getVarData(): array
      */
     public function getBadgeValue(): int
     {
-        return count($this->viewer->getPerformanceData()); // @phpstan-ignore-line
+        return count($this->viewer->getPerformanceData());
     }
 
     /**
diff --git a/system/HTTP/CURLRequest.php b/system/HTTP/CURLRequest.php
@@ -358,7 +358,7 @@ public function send(string $method, string $url)
 
         // Do we need to delay this request?
         if ($this->delay > 0) {
-            sleep($this->delay); // @phpstan-ignore-line
+            sleep($this->delay);
         }
 
         $output = $this->sendRequest($curlOptions);
diff --git a/system/HTTP/RequestTrait.php b/system/HTTP/RequestTrait.php
@@ -273,7 +273,6 @@ public function fetchGlobal(string $method, $index = null, ?int $filter = null,
             $value = $this->globals[$method][$index] ?? null;
         }
 
-        // @phpstan-ignore-next-line
         if (is_array($value)
             && (
                 $filter !== FILTER_DEFAULT
diff --git a/system/HTTP/URI.php b/system/HTTP/URI.php
@@ -625,7 +625,7 @@ public function setAuthority(string $str)
 
         if (empty($parts['host']) && $parts['path'] !== '') {
             $parts['host'] = $parts['path'];
-            unset($parts['path']); // @phpstan-ignore-line
+            unset($parts['path']);
         }
 
         $this->applyParts($parts);
diff --git a/system/Helpers/number_helper.php b/system/Helpers/number_helper.php
@@ -77,7 +77,7 @@ function number_to_amount($num, int $precision = 0, ?string $locale = null)
     {
         // Strip any formatting & ensure numeric input
         try {
-            $num = 0 + str_replace(',', '', $num); // @phpstan-ignore-line
+            $num = 0 + str_replace(',', '', $num);
         } catch (ErrorException $ee) {
             return false;
         }
diff --git a/system/Helpers/text_helper.php b/system/Helpers/text_helper.php
@@ -564,7 +564,6 @@ function random_string(string $type = 'alnum', int $len = 8): string
                         break;
                 }
 
-                // @phpstan-ignore-next-line
                 return substr(str_shuffle(str_repeat($pool, ceil($len / strlen($pool)))), 0, $len);
 
             case 'md5':
diff --git a/system/Helpers/url_helper.php b/system/Helpers/url_helper.php
@@ -352,7 +352,7 @@ function safe_mailto(string $email, string $title = '', $attributes = ''): strin
 
                 $temp[] = $ordinal;
 
-                if (count($temp) === $count) { // @phpstan-ignore-line
+                if (count($temp) === $count) {
                     $number = ($count === 3) ? (($temp[0] % 16) * 4096) + (($temp[1] % 64) * 64) + ($temp[2] % 64) : (($temp[0] % 32) * 64) + ($temp[1] % 64);
                     $x[]    = '|' . $number;
                     $count  = 1;
diff --git a/system/Images/Handlers/ImageMagickHandler.php b/system/Images/Handlers/ImageMagickHandler.php
@@ -384,10 +384,10 @@ protected function _text(string $text, array $options = [])
                     break;
             }
 
-            $xAxis = $xAxis >= 0 ? '+' . $xAxis : $xAxis; // @phpstan-ignore-line
-            $yAxis = $yAxis >= 0 ? '+' . $yAxis : $yAxis; // @phpstan-ignore-line
+            $xAxis = $xAxis >= 0 ? '+' . $xAxis : $xAxis;
+            $yAxis = $yAxis >= 0 ? '+' . $yAxis : $yAxis;
 
-            $cmd .= " -gravity {$gravity} -geometry {$xAxis}{$yAxis}"; // @phpstan-ignore-line
+            $cmd .= " -gravity {$gravity} -geometry {$xAxis}{$yAxis}";
         }
 
         // Color
diff --git a/system/Model.php b/system/Model.php
@@ -158,7 +158,7 @@ protected function doFind(bool $singleton, $id = null)
      */
     protected function doFindColumn(string $columnName)
     {
-        return $this->select($columnName)->asArray()->find(); // @phpstan-ignore-line
+        return $this->select($columnName)->asArray()->find();
     }
 
     /**
diff --git a/system/Router/Router.php b/system/Router/Router.php
@@ -124,7 +124,6 @@ public function __construct(RouteCollectionInterface $routes, ?Request $request
         $this->controller = $this->collection->getDefaultController();
         $this->method     = $this->collection->getDefaultMethod();
 
-        // @phpstan-ignore-next-line
         $this->collection->setHTTPVerb($request->getMethod() ?? strtolower($_SERVER['REQUEST_METHOD']));
     }
 
diff --git a/system/Session/Handlers/DatabaseHandler.php b/system/Session/Handlers/DatabaseHandler.php
@@ -69,7 +69,6 @@ public function __construct(AppConfig $config, string $ipAddress)
             throw SessionException::forMissingDatabaseTable();
         }
 
-        // @phpstan-ignore-next-line
         $this->DBGroup = $config->sessionDBGroup ?? config(Database::class)->defaultGroup;
 
         $this->db = Database::connect($this->DBGroup);
diff --git a/system/Session/Handlers/RedisHandler.php b/system/Session/Handlers/RedisHandler.php
@@ -206,7 +206,6 @@ public function close(): bool
             try {
                 $pingReply = $this->redis->ping();
 
-                // @phpstan-ignore-next-line
                 if (($pingReply === true) || ($pingReply === '+PONG')) {
                     if (isset($this->lockKey)) {
                         $this->redis->del($this->lockKey);
diff --git a/system/Test/CIUnitTestCase.php b/system/Test/CIUnitTestCase.php
@@ -231,7 +231,7 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        if (! $this->app) { // @phpstan-ignore-line
+        if (! $this->app) {
             $this->app = $this->createApplication();
         }
 
diff --git a/system/Test/Fabricator.php b/system/Test/Fabricator.php
@@ -510,12 +510,12 @@ protected function createMock(?int $count = null)
         $fields = [];
 
         if (! empty($this->model->useTimestamps)) {
-            $fields[$this->model->createdField] = $datetime; // @phpstan-ignore-line
-            $fields[$this->model->updatedField] = $datetime; // @phpstan-ignore-line
+            $fields[$this->model->createdField] = $datetime;
+            $fields[$this->model->updatedField] = $datetime;
         }
 
         if (! empty($this->model->useSoftDeletes)) {
-            $fields[$this->model->deletedField] = null; // @phpstan-ignore-line
+            $fields[$this->model->deletedField] = null;
         }
 
         // Iterate over new entities and add the necessary fields
diff --git a/system/Test/FeatureTestCase.php b/system/Test/FeatureTestCase.php
diff --git a/system/Test/FeatureTestTrait.php b/system/Test/FeatureTestTrait.php
diff --git a/system/Test/Mock/MockConnection.php b/system/Test/Mock/MockConnection.php

Original file line number	Diff line number	Diff line change
`@@ -241,7 +241,6 @@ protected function getItem(string $filename)`
`241`	`241`	`return false;`
`242`	`242`	`}`
`243`	`243`
`244`		`- // @phpstan-ignore-next-line`
`245`	`244`	`if ($data['ttl'] > 0 && time() > $data['time'] + $data['ttl']) {`
`246`	`245`	`// If the file is still there then try to remove it`
`247`	`246`	`if (is_file($this->path . $filename)) {`
Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,7 @@ public function get(string $key)`
`146`	`146`	`}`
`147`	`147`	`}`
`148`	`148`
`149`		`- return is_array($data) ? $data[0] : $data; // @phpstan-ignore-line`
	`149`	`+ return is_array($data) ? $data[0] : $data;`
`150`	`150`	`}`
`151`	`151`
`152`	`152`	`/**`
`@@ -172,7 +172,6 @@ public function save(string $key, $value, int $ttl = 60)`
`172`	`172`	`return $this->memcached->set($key, $value, 0, $ttl);`
`173`	`173`	`}`
`174`	`174`
`175`		`- // @phpstan-ignore-next-line`
`176`	`175`	`return false;`
`177`	`176`	`}`
`178`	`177`
`@@ -205,7 +204,6 @@ public function increment(string $key, int $offset = 1)`
`205`	`204`
`206`	`205`	`$key = static::validateKey($key, $this->prefix);`
`207`	`206`
`208`		`- // @phpstan-ignore-next-line`
`209`	`207`	`return $this->memcached->increment($key, $offset, $offset, 60);`
`210`	`208`	`}`
`211`	`209`
`@@ -221,7 +219,7 @@ public function decrement(string $key, int $offset = 1)`
`221`	`219`	`$key = static::validateKey($key, $this->prefix);`
`222`	`220`
`223`	`221`	`// FIXME: third parameter isn't other handler actions.`
`224`		`- // @phpstan-ignore-next-line`
	`222`	`+`
`225`	`223`	`return $this->memcached->decrement($key, $offset, $offset, 60);`
`226`	`224`	`}`
`227`	`225`
Original file line number	Diff line number	Diff line change
`@@ -1153,7 +1153,6 @@ function class_uses_recursive($class)`
`1153`	`1153`
`1154`	`1154`	`$results = [];`
`1155`	`1155`
`1156`		`- // @phpstan-ignore-next-line`
`1157`	`1156`	`foreach (array_reverse(class_parents($class)) + [$class => $class] as $class) {`
`1158`	`1157`	`$results += trait_uses_recursive($class);`
`1159`	`1158`	`}`
Original file line number	Diff line number	Diff line change
`@@ -883,7 +883,6 @@ public function prepare(Closure $func, array $options = [])`
`883`	`883`	`$this->pretend(false);`
`884`	`884`
`885`	`885`	`if ($sql instanceof QueryInterface) {`
`886`		`- // @phpstan-ignore-next-line`
`887`	`886`	`$sql = $sql->getOriginalQuery();`
`888`	`887`	`}`
`889`	`888`
Original file line number	Diff line number	Diff line change
`@@ -154,7 +154,6 @@ public function getCustomResultObject(string $className)`
`154`	`154`	`$this->customResultObject[$className][] = $row;`
`155`	`155`	`}`
`156`	`156`
`157`		`- // @phpstan-ignore-next-line`
`158`	`157`	`return $this->customResultObject[$className];`
`159`	`158`	`}`
`160`	`159`
`@@ -233,7 +232,6 @@ public function getResultObject(): array`
`233`	`232`	`$this->resultObject[] = $row;`
`234`	`233`	`}`
`235`	`234`
`236`		`- // @phpstan-ignore-next-line`
`237`	`235`	`return $this->resultObject;`
`238`	`236`	`}`
`239`	`237`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,6 @@ public function getVersion(): string`
`117`	`117`	`return $this->dataCache['version'];`
`118`	`118`	`}`
`119`	`119`
`120`		`- // @phpstan-ignore-next-line`
`121`	`120`	`if (! $this->connID \|\| ($pgVersion = pg_version($this->connID)) === false) {`
`122`	`121`	`$this->initialize();`
`123`	`122`	`}`