Merge branch 'develop' into 4.7

Author: paulbalandan

phpstan.neon.dist

@@ -1,46 +1,48 @@
 includes:
-	- utils/phpstan-baseline/loader.neon
+    - utils/phpstan-baseline/loader.neon
 
 parameters:
-	phpVersion: 80100
-	tmpDir: build/phpstan
-	level: 6
-	bootstrapFiles:
-		- phpstan-bootstrap.php
-	paths:
-		- admin/starter/tests
-		- app
-		- system
-		- tests
-	excludePaths:
-		- app/Views/errors/cli/*
-		- app/Views/errors/html/*
-		- system/Commands/Generators/Views/*
-		- system/Debug/Toolbar/Views/toolbar.tpl.php
-		- system/Images/Handlers/GDHandler.php
-		- system/Test/Filters/CITestStreamFilter.php
-		- system/ThirdParty/*
-		- system/Validation/Views/single.php
-		- tests/system/View/Views/*
-	scanDirectories:
-		- system/Helpers
-	ignoreErrors:
-		-
-			identifier: missingType.generics
-	checkMissingCallableSignature: true
-	treatPhpDocTypesAsCertain: false
-	strictRules:
-		allRules: false
-		disallowedLooseComparison: true
-		booleansInConditions: true
-		disallowedBacktick: true
-		disallowedEmpty: true
-		disallowedImplicitArrayCreation: true
-		disallowedShortTernary: true
-		matchingInheritedMethodNames: true
-	codeigniter:
-		additionalServices:
-			- AfterAutoloadModule\Config\Services
-		checkArgumentTypeOfModel: false
-	shipmonkBaselinePerIdentifier:
-		directory: %currentWorkingDirectory%
+    phpVersion: 80100
+    tmpDir: build/phpstan
+    level: 6
+    bootstrapFiles:
+        - phpstan-bootstrap.php
+    paths:
+        - admin/starter/tests
+        - app
+        - system
+        - tests
+    excludePaths:
+        analyseAndScan:
+            - app/Views/errors/cli/*
+            - app/Views/errors/html/*
+            - system/Commands/Generators/Views/*
+            - system/Debug/Toolbar/Views/toolbar.tpl.php
+            - system/Images/Handlers/GDHandler.php
+            - system/ThirdParty/*
+            - system/Validation/Views/single.php
+            - tests/system/View/Views/*
+        analyse:
+            - tests/_support/*
+    scanDirectories:
+        - system/Helpers
+    ignoreErrors:
+        -
+            identifier: missingType.generics
+    checkMissingCallableSignature: true
+    treatPhpDocTypesAsCertain: false
+    strictRules:
+        allRules: false
+        disallowedLooseComparison: true
+        booleansInConditions: true
+        disallowedBacktick: true
+        disallowedEmpty: true
+        disallowedImplicitArrayCreation: true
+        disallowedShortTernary: true
+        matchingInheritedMethodNames: true
+    codeigniter:
+        additionalServices:
+            - AfterAutoloadModule\Config\Services
+        checkArgumentTypeOfModel: false
+    shipmonkBaselinePerIdentifier:
+        directory: %currentWorkingDirectory%

system/Cache/Handlers/FileHandler.php

@@ -63,6 +63,8 @@ public function __construct(Cache $config)
 
         $this->mode   = $config->file['mode'] ?? 0640;
         $this->prefix = $config->prefix;
+
+        helper('filesystem');
     }
 
     /**
@@ -96,7 +98,7 @@ public function save(string $key, $value, int $ttl = 60)
             'data' => $value,
         ];
 
-        if ($this->writeFile($this->path . $key, serialize($contents))) {
+        if (write_file($this->path . $key, serialize($contents))) {
             try {
                 chmod($this->path . $key, $this->mode);
 
@@ -176,15 +178,15 @@ public function decrement(string $key, int $offset = 1)
      */
     public function clean()
     {
-        return $this->deleteFiles($this->path, false, true);
+        return delete_files($this->path, false, true);
     }
 
     /**
      * {@inheritDoc}
      */
     public function getCacheInfo()
     {
-        return $this->getDirFileInfo($this->path);
+        return get_dir_file_info($this->path);
     }
 
     /**
@@ -251,6 +253,8 @@ protected function getItem(string $filename)
     /**
      * Writes a file to disk, or returns false if not successful.
      *
+     * @deprecated 4.6.1 Use `write_file()` instead.
+     *
      * @param string $path
      * @param string $data
      * @param string $mode
@@ -265,7 +269,9 @@ protected function writeFile($path, $data, $mode = 'wb')
 
         flock($fp, LOCK_EX);
 
-        for ($result = $written = 0, $length = strlen($data); $written < $length; $written += $result) {
+        $result = 0;
+
+        for ($written = 0, $length = strlen($data); $written < $length; $written += $result) {
             if (($result = fwrite($fp, substr($data, $written))) === false) {
                 break;
             }
@@ -283,6 +289,8 @@ protected function writeFile($path, $data, $mode = 'wb')
      * If the second parameter is set to TRUE, any directories contained
      * within the supplied base directory will be nuked as well.
      *
+     * @deprecated 4.6.1 Use `delete_files()` instead.
+     *
      * @param string $path   File path
      * @param bool   $delDir Whether to delete any directories found in the path
      * @param bool   $htdocs Whether to skip deleting .htaccess and index page files
@@ -318,6 +326,8 @@ protected function deleteFiles(string $path, bool $delDir = false, bool $htdocs
      *
      * Any sub-folders contained within the specified path are read as well.
      *
+     * @deprecated 4.6.1 Use `get_dir_file_info()` instead.
+     *
      * @param string $sourceDir    Path to source
      * @param bool   $topLevelOnly Look only at the top level directory specified?
      * @param bool   $_recursion   Internal variable to determine recursion status - do not use in calls
@@ -360,6 +370,8 @@ protected function getDirFileInfo(string $sourceDir, bool $topLevelOnly = true,
      * Options are: name, server_path, size, date, readable, writable, executable, fileperms
      * Returns FALSE if the file cannot be found.
      *
+     * @deprecated 4.6.1 Use `get_file_info()` instead.
+     *
      * @param string       $file           Path to file
      * @param array|string $returnedValues Array or comma separated string of information returned
      *

system/Commands/Utilities/ConfigCheck.php

@@ -73,7 +73,7 @@ final class ConfigCheck extends BaseCommand
     protected $options = [];
 
     /**
-     * {@inheritDoc}
+     * @return int
      */
     public function run(array $params)
     {

system/Commands/Utilities/Environment.php

@@ -80,15 +80,15 @@ final class Environment extends BaseCommand
     ];
 
     /**
-     * {@inheritDoc}
+     * @return int
      */
     public function run(array $params)
     {
         if ($params === []) {
             CLI::write(sprintf('Your environment is currently set as %s.', CLI::color($_SERVER['CI_ENVIRONMENT'] ?? ENVIRONMENT, 'green')));
             CLI::newLine();
 
-            return;
+            return EXIT_ERROR;
         }
 
         $env = strtolower(array_shift($params));
@@ -98,21 +98,21 @@ public function run(array $params)
             CLI::error('You will not be able to run spark under a "testing" environment.', 'light_gray', 'red');
             CLI::newLine();
 
-            return;
+            return EXIT_ERROR;
         }
 
         if (! in_array($env, self::$knownTypes, true)) {
             CLI::error(sprintf('Invalid environment type "%s". Expected one of "%s".', $env, implode('" and "', self::$knownTypes)), 'light_gray', 'red');
             CLI::newLine();
 
-            return;
+            return EXIT_ERROR;
         }
 
         if (! $this->writeNewEnvironmentToEnvFile($env)) {
             CLI::error('Error in writing new environment to .env file.', 'light_gray', 'red');
             CLI::newLine();
 
-            return;
+            return EXIT_ERROR;
         }
 
         // force DotEnv to reload the new environment
@@ -124,6 +124,8 @@ public function run(array $params)
         CLI::write(sprintf('Environment is successfully changed to "%s".', $env), 'green');
         CLI::write('The ENVIRONMENT constant will be changed in the next script execution.');
         CLI::newLine();
+
+        return EXIT_SUCCESS;
     }
 
     /**

system/Commands/Utilities/Optimize.php

@@ -55,21 +55,21 @@ final class Optimize extends BaseCommand
     protected $usage = 'optimize';
 
     /**
-     * {@inheritDoc}
+     * @return int
      */
     public function run(array $params)
     {
         try {
             $this->enableCaching();
             $this->clearCache();
             $this->removeDevPackages();
+
+            return EXIT_SUCCESS;
         } catch (RuntimeException) {
             CLI::error('The "spark optimize" failed.');
 
             return EXIT_ERROR;
         }
-
-        return EXIT_SUCCESS;
     }
 
     private function clearCache(): void

system/Commands/Utilities/PhpIniCheck.php

@@ -68,7 +68,7 @@ final class PhpIniCheck extends BaseCommand
     protected $options = [];
 
     /**
-     * {@inheritDoc}
+     * @return int
      */
     public function run(array $params)
     {

system/Database/BaseBuilder.php

@@ -3407,7 +3407,7 @@ protected function resetSelect()
             'QBUnion'    => [],
         ]);
 
-        if (! empty($this->db)) {
+        if ($this->db instanceof BaseConnection) {
             $this->db->setAliasedTables([]);
         }
 

system/Encryption/Encryption.php

@@ -23,6 +23,11 @@
  * This class determines the driver, cipher, and mode to use, and then
  * initializes the appropriate encryption handler.
  *
+ * @property-read string       $digest
+ * @property-read string       $driver
+ * @property-read list<string> $drivers
+ * @property-read string       $key
+ *
  * @see \CodeIgniter\Encryption\EncryptionTest
  */
 class Encryption

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 !== [] && array_key_exists($currentIndex, $value) && is_array($value[$currentIndex])) {
+        if (isset($currentIndex) && $index !== [] && array_key_exists($currentIndex, $value) && is_array($value[$currentIndex])) {
             return $this->getValueDotNotationSyntax($index, $value[$currentIndex]);
         }
 

system/Helpers/filesystem_helper.php

@@ -123,7 +123,9 @@ function write_file(string $path, string $data, string $mode = 'wb'): bool
 
             flock($fp, LOCK_EX);
 
-            for ($result = $written = 0, $length = strlen($data); $written < $length; $written += $result) {
+            $result = 0;
+
+            for ($written = 0, $length = strlen($data); $written < $length; $written += $result) {
                 if (($result = fwrite($fp, substr($data, $written))) === false) {
                     break;
                 }

system/I18n/TimeDifference.php

@@ -17,7 +17,13 @@
 use IntlCalendar;
 
 /**
- * Class TimeDifference
+ * @property-read float|int $days
+ * @property-read float|int $hours
+ * @property-read float|int $minutes
+ * @property-read float|int $months
+ * @property-read int       $seconds
+ * @property-read float|int $weeks
+ * @property-read float|int $years
  *
  * @see \CodeIgniter\I18n\TimeDifferenceTest
  */

system/Images/Handlers/BaseHandler.php

@@ -34,7 +34,7 @@ abstract class BaseHandler implements ImageHandlerInterface
     /**
      * The image/file instance
      *
-     * @var Image
+     * @var Image|null
      */
     protected $image;
 
@@ -138,6 +138,8 @@ public function __construct($config = null)
      * Sets another image for this handler to work on.
      * Keeps us from needing to continually instantiate the handler.
      *
+     * @phpstan-assert Image $this->image
+     *
      * @return $this
      */
     public function withFile(string $path)
@@ -176,7 +178,7 @@ public function getFile()
     /**
      * Verifies that a file has been supplied and it is an image.
      *
-     * @return Image The image instance
+     * @phpstan-assert Image $this->image
      *
      * @throws ImageException
      */
@@ -187,7 +189,7 @@ protected function image(): Image
         }
 
         // Verify withFile has been called
-        if (empty($this->image)) {
+        if ($this->image === null) {
             throw ImageException::forMissingImage();
         }
 

system/Session/Handlers/FileHandler.php

@@ -201,7 +201,9 @@ public function write($id, $data): bool
         if (($length = strlen($data)) > 0) {
             $result = null;
 
-            for ($written = 0; $written < $length; $written += $result) {
+            $written = 0;
+
+            for (; $written < $length; $written += $result) {
                 if (($result = fwrite($this->fileHandle, substr($data, $written))) === false) {
                     break;
                 }