refactor: fix phpstan only boolean allowed (#9302)

* refactor: Fix `phpstan` boolean errors * fix: Check predis response * refactor: Improve comparison with an empty string * dev: Update phpstan-baseline * fix: Revert comparison with null
codeigniter4 · Dec 28, 2024 · 8cff099 · 8cff099
1 parent 19ad2b9
commit 8cff099
Show file tree

Hide file tree

Showing 47 changed files with 128 additions and 448 deletions.
diff --git a/system/BaseModel.php b/system/BaseModel.php
@@ -639,7 +639,7 @@ public function findColumn(string $columnName)
 
         $resultSet = $this->doFindColumn($columnName);
 
-        return $resultSet ? array_column($resultSet, $columnName) : null;
+        return $resultSet !== null ? array_column($resultSet, $columnName) : null;
     }
 
     /**
@@ -1137,7 +1137,7 @@ public function delete($id = null, bool $purge = false)
             throw new InvalidArgumentException('delete(): argument #1 ($id) should not be boolean.');
         }
 
-        if ($id && (is_numeric($id) || is_string($id))) {
+        if (! in_array($id, [null, 0, '0'], true) && (is_numeric($id) || is_string($id))) {
             $id = [$id];
         }
 
@@ -1250,7 +1250,7 @@ public function errors(bool $forceDB = false)
         }
 
         // Do we have validation errors?
-        if (! $forceDB && ! $this->skipValidation && ($errors = $this->validation->getErrors())) {
+        if (! $forceDB && ! $this->skipValidation && ($errors = $this->validation->getErrors()) !== []) {
             return $errors;
         }
 

diff --git a/system/CLI/CLI.php b/system/CLI/CLI.php
@@ -225,12 +225,12 @@ public static function prompt(string $field, $options = null, $validation = null
         $extraOutput = '';
         $default     = '';
 
-        if ($validation && ! is_array($validation) && ! is_string($validation)) {
+        if (isset($validation) && ! is_array($validation) && ! is_string($validation)) {
             throw new InvalidArgumentException('$rules can only be of type string|array');
         }
 
         if (! is_array($validation)) {
-            $validation = $validation ? explode('|', $validation) : [];
+            $validation = ($validation !== null) ? explode('|', $validation) : [];
         }
 
         if (is_string($options)) {
@@ -441,7 +441,7 @@ protected static function validate(string $field, string $value, $rules): bool
      */
     public static function print(string $text = '', ?string $foreground = null, ?string $background = null)
     {
-        if ($foreground || $background) {
+        if ((string) $foreground !== '' || (string) $background !== '') {
             $text = static::color($text, $foreground, $background);
         }
 
@@ -457,7 +457,7 @@ public static function print(string $text = '', ?string $foreground = null, ?str
      */
     public static function write(string $text = '', ?string $foreground = null, ?string $background = null)
     {
-        if ($foreground || $background) {
+        if ((string) $foreground !== '' || (string) $background !== '') {
             $text = static::color($text, $foreground, $background);
         }
 
@@ -480,7 +480,7 @@ public static function error(string $text, string $foreground = 'light_red', ?st
         $stdout            = static::$isColored;
         static::$isColored = static::hasColorSupport(STDERR);
 
-        if ($foreground || $background) {
+        if ($foreground !== '' || (string) $background !== '') {
             $text = static::color($text, $foreground, $background);
         }
 
@@ -589,7 +589,7 @@ public static function color(string $text, string $foreground, ?string $backgrou
             throw CLIException::forInvalidColor('foreground', $foreground);
         }
 
-        if ($background !== null && ! array_key_exists($background, static::$background_colors)) {
+        if ((string) $background !== '' && ! array_key_exists($background, static::$background_colors)) {
             throw CLIException::forInvalidColor('background', $background);
         }
 
@@ -637,7 +637,7 @@ private static function getColoredText(string $text, string $foreground, ?string
     {
         $string = "\033[" . static::$foreground_colors[$foreground] . 'm';
 
-        if ($background !== null) {
+        if ((string) $background !== '') {
             $string .= "\033[" . static::$background_colors[$background] . 'm';
         }
 
@@ -654,7 +654,7 @@ private static function getColoredText(string $text, string $foreground, ?string
      */
     public static function strlen(?string $string): int
     {
-        if ($string === null) {
+        if ((string) $string === '') {
             return 0;
         }
 
@@ -768,7 +768,7 @@ public static function generateDimensions()
 
                     // Look for the next lines ending in ": <number>"
                     // Searching for "Columns:" or "Lines:" will fail on non-English locales
-                    if ($return === 0 && $output && preg_match('/:\s*(\d+)\n[^:]+:\s*(\d+)\n/', implode("\n", $output), $matches)) {
+                    if ($return === 0 && $output !== [] && preg_match('/:\s*(\d+)\n[^:]+:\s*(\d+)\n/', implode("\n", $output), $matches)) {
                         static::$height = (int) $matches[1];
                         static::$width  = (int) $matches[2];
                     }
@@ -835,7 +835,7 @@ public static function showProgress($thisStep = 1, int $totalSteps = 10)
      */
     public static function wrap(?string $string = null, int $max = 0, int $padLeft = 0): string
     {
-        if ($string === null || $string === '') {
+        if ((string) $string === '') {
             return '';
         }
 

diff --git a/system/Cache/Handlers/BaseHandler.php b/system/Cache/Handlers/BaseHandler.php
@@ -67,7 +67,7 @@ public static function validateKey($key, $prefix = ''): string
         }
 
         $reserved = config(Cache::class)->reservedCharacters ?? self::RESERVED_CHARACTERS;
-        if ($reserved && strpbrk($key, $reserved) !== false) {
+        if ($reserved !== '' && strpbrk($key, $reserved) !== false) {
             throw new InvalidArgumentException('Cache key contains reserved characters ' . $reserved);
         }
 

diff --git a/system/Cache/Handlers/PredisHandler.php b/system/Cache/Handlers/PredisHandler.php
@@ -19,6 +19,7 @@
 use Exception;
 use Predis\Client;
 use Predis\Collection\Iterator\Keyspace;
+use Predis\Response\Status;
 
 /**
  * Predis cache handler
@@ -121,7 +122,7 @@ public function save(string $key, $value, int $ttl = 60)
                 return false;
         }
 
-        if (! $this->redis->hmset($key, ['__ci_type' => $dataType, '__ci_value' => $value])) {
+        if (! $this->redis->hmset($key, ['__ci_type' => $dataType, '__ci_value' => $value]) instanceof Status) {
             return false;
         }
 

diff --git a/system/Commands/Server/Serve.php b/system/Commands/Server/Serve.php
@@ -110,7 +110,7 @@ public function run(array $params)
         // to ensure our environment is set and it simulates basic mod_rewrite.
         passthru($php . ' -S ' . $host . ':' . $port . ' -t ' . $docroot . ' ' . $rewrite, $status);
 
-        if ($status && $this->portOffset < $this->tries) {
+        if ($status !== EXIT_SUCCESS && $this->portOffset < $this->tries) {
             $this->portOffset++;
 
             $this->run($params);

diff --git a/system/Commands/Utilities/Routes.php b/system/Commands/Utilities/Routes.php
@@ -86,7 +86,7 @@ public function run(array $params)
         $host          = $params['host'] ?? null;
 
         // Set HTTP_HOST
-        if ($host) {
+        if ($host !== null) {
             $request              = service('request');
             $_SERVER              = $request->getServer();
             $_SERVER['HTTP_HOST'] = $host;
@@ -96,7 +96,7 @@ public function run(array $params)
         $collection = service('routes')->loadRoutes();
 
         // Reset HTTP_HOST
-        if ($host) {
+        if ($host !== null) {
             unset($_SERVER['HTTP_HOST']);
         }
 
@@ -139,7 +139,9 @@ public function run(array $params)
                 $autoRoutes = $autoRouteCollector->get();
 
                 // Check for Module Routes.
-                if ($routingConfig = config(Routing::class)) {
+                $routingConfig = config(Routing::class);
+
+                if ($routingConfig instanceof Routing) {
                     foreach ($routingConfig->moduleRoutes as $uri => $namespace) {
                         $autoRouteCollector = new AutoRouteCollectorImproved(
                             $namespace,
@@ -188,7 +190,7 @@ public function run(array $params)
             usort($tbody, static fn ($handler1, $handler2) => strcmp($handler1[3], $handler2[3]));
         }
 
-        if ($host) {
+        if ($host !== null) {
             CLI::write('Host: ' . $host);
         }
 

diff --git a/system/Common.php b/system/Common.php
@@ -441,7 +441,7 @@ function esc($data, string $context = 'html', ?string $encoding = null)
                 $escaper = new Escaper($encoding);
             }
 
-            if ($encoding && $escaper->getEncoding() !== $encoding) {
+            if ($encoding !== null && $escaper->getEncoding() !== $encoding) {
                 $escaper = new Escaper($encoding);
             }
 
@@ -739,13 +739,13 @@ function lang(string $line, array $args = [], ?string $locale = null)
         // Get active locale
         $activeLocale = $language->getLocale();
 
-        if ($locale && $locale !== $activeLocale) {
+        if ((string) $locale !== '' && $locale !== $activeLocale) {
             $language->setLocale($locale);
         }
 
         $lines = $language->getLine($line, $args);
 
-        if ($locale && $locale !== $activeLocale) {
+        if ((string) $locale !== '' && $locale !== $activeLocale) {
             // Reset to active locale
             $language->setLocale($activeLocale);
         }
@@ -849,7 +849,7 @@ function redirect(?string $route = null): RedirectResponse
     {
         $response = service('redirectresponse');
 
-        if ($route !== null) {
+        if ((string) $route !== '') {
             return $response->route($route);
         }
 

diff --git a/system/Database/Forge.php b/system/Database/Forge.php
@@ -650,7 +650,7 @@ public function dropTable(string $tableName, bool $ifExists = false, bool $casca
             return false;
         }
 
-        if ($this->db->DBPrefix && str_starts_with($tableName, $this->db->DBPrefix)) {
+        if ($this->db->DBPrefix !== '' && str_starts_with($tableName, $this->db->DBPrefix)) {
             $tableName = substr($tableName, strlen($this->db->DBPrefix));
         }
 

diff --git a/system/Database/MigrationRunner.php b/system/Database/MigrationRunner.php
@@ -389,7 +389,7 @@ public function force(string $path, string $namespace, ?string $group = null)
      */
     public function findMigrations(): array
     {
-        $namespaces = $this->namespace ? [$this->namespace] : array_keys(service('autoloader')->getNamespace());
+        $namespaces = $this->namespace !== null ? [$this->namespace] : array_keys(service('autoloader')->getNamespace());
         $migrations = [];
 
         foreach ($namespaces as $namespace) {
@@ -524,7 +524,7 @@ protected function getMigrationNumber(string $migration): string
     {
         preg_match($this->regex, $migration, $matches);
 
-        return count($matches) ? $matches[1] : '0';
+        return $matches !== [] ? $matches[1] : '0';
     }
 
     /**
@@ -539,7 +539,7 @@ protected function getMigrationName(string $migration): string
     {
         preg_match($this->regex, $migration, $matches);
 
-        return count($matches) ? $matches[2] : '';
+        return $matches !== [] ? $matches[2] : '';
     }
 
     /**
@@ -645,7 +645,7 @@ public function getHistory(string $group = 'default'): array
         }
 
         // If a namespace was specified then use it
-        if ($this->namespace) {
+        if ($this->namespace !== null) {
             $builder->where('namespace', $this->namespace);
         }
 
@@ -700,7 +700,7 @@ public function getLastBatch(): int
             ->get()
             ->getResultObject();
 
-        $batch = is_array($batch) && count($batch)
+        $batch = is_array($batch) && $batch !== []
             ? end($batch)->batch
             : 0;
 
@@ -725,7 +725,7 @@ public function getBatchStart(int $batch): string
             ->get()
             ->getResultObject();
 
-        return count($migration) ? $migration[0]->version : '0';
+        return $migration !== [] ? $migration[0]->version : '0';
     }
 
     /**

diff --git a/system/Database/MySQLi/Connection.php b/system/Database/MySQLi/Connection.php
@@ -193,7 +193,7 @@ public function connect(bool $persistent = false)
                 $clientFlags
             )) {
                 // Prior to version 5.7.3, MySQL silently downgrades to an unencrypted connection if SSL setup fails
-                if (($clientFlags & MYSQLI_CLIENT_SSL) && version_compare($this->mysqli->client_info, 'mysqlnd 5.7.3', '<=')
+                if (($clientFlags & MYSQLI_CLIENT_SSL) !== 0 && version_compare($this->mysqli->client_info, 'mysqlnd 5.7.3', '<=')
                     && empty($this->mysqli->query("SHOW STATUS LIKE 'ssl_cipher'")->fetch_object()->Value)
                 ) {
                     $this->mysqli->close();
@@ -395,7 +395,7 @@ protected function _listTables(bool $prefixLimit = false, ?string $tableName = n
     {
         $sql = 'SHOW TABLES FROM ' . $this->escapeIdentifier($this->database);
 
-        if ($tableName !== null) {
+        if ((string) $tableName !== '') {
             return $sql . ' LIKE ' . $this->escape($tableName);
         }
 
@@ -462,7 +462,9 @@ protected function _indexData(string $table): array
             throw new DatabaseException(lang('Database.failGetIndexData'));
         }
 
-        if (! $indexes = $query->getResultArray()) {
+        $indexes = $query->getResultArray();
+
+        if ($indexes === []) {
             return [];
         }
 

diff --git a/system/Database/SQLite3/Connection.php b/system/Database/SQLite3/Connection.php
@@ -89,7 +89,7 @@ public function connect(bool $persistent = false)
                 $this->database = WRITEPATH . $this->database;
             }
 
-            $sqlite = (! $this->password)
+            $sqlite = (! isset($this->password) || $this->password !== '')
                 ? new SQLite3($this->database)
                 : new SQLite3($this->database, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, $this->password);
 
@@ -194,7 +194,7 @@ protected function _escapeString(string $str): string
      */
     protected function _listTables(bool $prefixLimit = false, ?string $tableName = null): string
     {
-        if ($tableName !== null) {
+        if ((string) $tableName !== '') {
             return 'SELECT "NAME" FROM "SQLITE_MASTER" WHERE "TYPE" = \'table\''
                    . ' AND "NAME" NOT LIKE \'sqlite!_%\' ESCAPE \'!\''
                    . ' AND "NAME" LIKE ' . $this->escape($tableName);

diff --git a/system/Email/Email.php b/system/Email/Email.php
@@ -485,7 +485,7 @@ public function setFrom($from, $name = '', $returnPath = null)
         if ($this->validate) {
             $this->validateEmail($this->stringToArray($from));
 
-            if ($returnPath) {
+            if ($returnPath !== null) {
                 $this->validateEmail($this->stringToArray($returnPath));
             }
         }
@@ -1233,7 +1233,9 @@ protected function buildMessage()
                     $this->headerStr .= $hdr;
                 }
 
-                static::strlen($body) && $body .= $this->newline . $this->newline;
+                if (static::strlen($body) > 0) {
+                    $body .= $this->newline . $this->newline;
+                }
 
                 $body .= $this->getMimeMessage() . $this->newline . $this->newline
                     . '--' . $lastBoundary . $this->newline

diff --git a/system/Encryption/Handlers/OpenSSLHandler.php b/system/Encryption/Handlers/OpenSSLHandler.php
@@ -82,7 +82,7 @@ class OpenSSLHandler extends BaseHandler
     public function encrypt($data, $params = null)
     {
         // Allow key override
-        if ($params) {
+        if ($params !== null) {
             $this->key = is_array($params) && isset($params['key']) ? $params['key'] : $params;
         }
 
@@ -118,7 +118,7 @@ public function encrypt($data, $params = null)
     public function decrypt($data, $params = null)
     {
         // Allow key override
-        if ($params) {
+        if ($params !== null) {
             $this->key = is_array($params) && isset($params['key']) ? $params['key'] : $params;
         }
 

diff --git a/system/Filters/Filters.php b/system/Filters/Filters.php
@@ -557,7 +557,7 @@ public function enableFilters(array $names, string $when = 'before')
      */
     public function getArguments(?string $key = null)
     {
-        return $key === null ? $this->arguments : $this->arguments[$key];
+        return ((string) $key === '') ? $this->arguments : $this->arguments[$key];
     }
 
     // --------------------------------------------------------------------
@@ -674,7 +674,7 @@ protected function processMethods()
      */
     protected function processFilters(?string $uri = null)
     {
-        if (! isset($this->config->filters) || ! $this->config->filters) {
+        if (! isset($this->config->filters) || $this->config->filters === []) {
             return;
         }
 

diff --git a/system/HTTP/Files/FileCollection.php b/system/HTTP/Files/FileCollection.php
@@ -253,7 +253,7 @@ protected function getValueDotNotationSyntax(array $index, array $value)
     {
         $currentIndex = array_shift($index);
 
-        if (isset($currentIndex) && is_array($index) && $index && is_array($value[$currentIndex]) && $value[$currentIndex]) {
+        if (isset($currentIndex) && is_array($index) && $index !== [] && array_key_exists($currentIndex, $value) && is_array($value[$currentIndex])) {
             return $this->getValueDotNotationSyntax($index, $value[$currentIndex]);
         }