Merge remote-tracking branch 'upstream/develop' into 4.6

Author: kenjis

.github/workflows/test-coding-standards.yml

@@ -57,14 +57,5 @@ jobs:
       - name: Install dependencies
         run: composer update --ansi --no-interaction
 
-      - name: Run lint on `app/`, `admin/`, `public/`
-        run: utils/vendor/bin/php-cs-fixer fix --verbose --ansi --dry-run --config=.php-cs-fixer.no-header.php --using-cache=no --diff
-
-      - name: Run lint on `system/`, `utils/`, and root PHP files
-        run: utils/vendor/bin/php-cs-fixer fix --verbose --ansi --dry-run --using-cache=no --diff
-
-      - name: Run lint on `tests`
-        run: utils/vendor/bin/php-cs-fixer fix --verbose --ansi --dry-run --config=.php-cs-fixer.tests.php --using-cache=no --diff
-
-      - name: Run lint on `user_guide_src/source/`
-        run: utils/vendor/bin/php-cs-fixer fix --verbose --ansi --dry-run --config=.php-cs-fixer.user-guide.php --using-cache=no --diff
+      - name: Run lint
+        run: composer cs

.github/workflows/test-phpstan.yml

@@ -85,4 +85,4 @@ jobs:
         run: composer update --ansi --no-interaction
 
       - name: Run static analysis
-        run: vendor/bin/phpstan analyse
+        run: composer phpstan:check

admin/pre-commit

@@ -24,39 +24,10 @@ if [ "$FILES" != "" ]; then
     echo "Running PHP CS Fixer..."
 
     # Run on whole codebase to skip on unnecessary filtering
-    # Run first on app, admin, public
-    if [ -d /proc/cygdrive ]; then
-        ./utils/vendor/bin/php-cs-fixer fix --verbose --dry-run --diff --config=.php-cs-fixer.no-header.php
-    else
-        php ./utils/vendor/bin/php-cs-fixer fix --verbose --dry-run --diff --config=.php-cs-fixer.no-header.php
-    fi
-
-    if [ $? != 0 ]; then
-        echo "Files in app, admin, or public are not following the coding standards. Please fix them before commit."
-        exit 1
-    fi
-
-    # Next, run on system, tests, utils, and root PHP files
-    if [ -d /proc/cygdrive ]; then
-        ./utils/vendor/bin/php-cs-fixer fix --verbose --dry-run --diff
-    else
-        php ./utils/vendor/bin/php-cs-fixer fix --verbose --dry-run --diff
-    fi
-
-    if [ $? != 0 ]; then
-        echo "Files in system, tests, utils, or root are not following the coding standards. Please fix them before commit."
-        exit 1
-    fi
-
-    # Next, run on user_guide_src/source PHP files
-    if [ -d /proc/cygdrive ]; then
-        ./utils/vendor/bin/php-cs-fixer fix --verbose --dry-run --diff --config=.php-cs-fixer.user-guide.php
-    else
-        php ./utils/vendor/bin/php-cs-fixer fix --verbose --dry-run --diff --config=.php-cs-fixer.user-guide.php
-    fi
+    composer cs
 
     if [ $? != 0 ]; then
-        echo "Files in user_guide_src/source are not following the coding standards. Please fix them before commit."
+        echo "There are PHP files which are not following the coding standards. Please fix them before commit."
         exit 1
     fi
 fi

composer.json

@@ -28,7 +28,7 @@
         "phpunit/phpcov": "^9.0.2",
         "phpunit/phpunit": "^10.5.16",
         "predis/predis": "^1.1 || ^2.0",
-        "rector/rector": "1.2.1"
+        "rector/rector": "1.2.2"
     },
     "replace": {
         "codeigniter4/framework": "self.version"
@@ -92,15 +92,15 @@
         ],
         "analyze": [
             "Composer\\Config::disableProcessTimeout",
-            "bash -c \"XDEBUG_MODE=off vendor/bin/phpstan analyse\"",
+            "@phpstan:check",
             "vendor/bin/rector process --dry-run"
         ],
         "cs": [
             "Composer\\Config::disableProcessTimeout",
-            "utils/vendor/bin/php-cs-fixer fix --ansi --verbose --dry-run --diff --config=.php-cs-fixer.user-guide.php",
-            "utils/vendor/bin/php-cs-fixer fix --ansi --verbose --dry-run --diff --config=.php-cs-fixer.no-header.php",
-            "utils/vendor/bin/php-cs-fixer fix --ansi --verbose --dry-run --diff --config=.php-cs-fixer.tests.php",
-            "utils/vendor/bin/php-cs-fixer fix --ansi --verbose --dry-run --diff"
+            "utils/vendor/bin/php-cs-fixer check --ansi --verbose --diff --config=.php-cs-fixer.user-guide.php",
+            "utils/vendor/bin/php-cs-fixer check --ansi --verbose --diff --config=.php-cs-fixer.no-header.php",
+            "utils/vendor/bin/php-cs-fixer check --ansi --verbose --diff --config=.php-cs-fixer.tests.php",
+            "utils/vendor/bin/php-cs-fixer check --ansi --verbose --diff"
         ],
         "cs-fix": [
             "Composer\\Config::disableProcessTimeout",
@@ -110,6 +110,8 @@
             "utils/vendor/bin/php-cs-fixer fix --ansi --verbose --diff"
         ],
         "metrics": "utils/vendor/bin/phpmetrics --config=phpmetrics.json",
+        "phpstan:baseline": "vendor/bin/phpstan analyse --ansi --generate-baseline=phpstan-baseline.php",
+        "phpstan:check": "vendor/bin/phpstan analyse --verbose --ansi",
         "sa": "@analyze",
         "style": "@cs-fix",
         "test": "phpunit"
@@ -119,6 +121,8 @@
         "cs": "Check the coding style",
         "cs-fix": "Fix the coding style",
         "metrics": "Run PhpMetrics",
+        "phpstan:baseline": "Run PHPStan then dump all errors to baseline",
+        "phpstan:check": "Run PHPStan with support for identifiers",
         "test": "Run unit tests"
     }
 }

system/Files/File.php

@@ -59,7 +59,8 @@ public function __construct(string $path, bool $checkFile = false)
      *
      * Implementations SHOULD return the value stored in the "size" key of
      * the file in the $_FILES array if available, as PHP calculates this based
-     * on the actual size transmitted.
+     * on the actual size transmitted. A RuntimeException will be thrown if the file
+     * does not exist or an error occurs.
      *
      * @return false|int The file size in bytes, or false on failure
      */

system/Throttle/Throttler.php

@@ -102,8 +102,11 @@ public function check(string $key, int $capacity, int $seconds, int $cost = 1):
         // Number of seconds to get one token
         $refresh = 1 / $rate;
 
+        /** @var float|int|null $tokens */
+        $tokens = $this->cache->get($tokenName);
+
         // Check to see if the bucket has even been created yet.
-        if (($tokens = $this->cache->get($tokenName)) === null) {
+        if ($tokens === null) {
             // If it hasn't been created, then we'll set it to the maximum
             // capacity - 1, and save it to the cache.
             $tokens = $capacity - $cost;
@@ -124,7 +127,7 @@ public function check(string $key, int $capacity, int $seconds, int $cost = 1):
         // should be refilled, then checked against capacity
         // to be sure the bucket didn't overflow.
         $tokens += $rate * $elapsed;
-        $tokens = $tokens > $capacity ? $capacity : $tokens;
+        $tokens = min($tokens, $capacity);
 
         // If $tokens >= 1, then we are safe to perform the action, but
         // we need to decrement the number of available tokens.

user_guide_src/source/database/query_builder.rst

@@ -247,6 +247,8 @@ Use the ``$db->newQuery()`` method to make a subquery the main table:
 Join
 ====
 
+.. _query-builder-join:
+
 $builder->join()
 ----------------
 
@@ -270,7 +272,7 @@ RawSql
 
 .. versionadded:: 4.2.0
 
-Since v4.2.0, ``$builder->join()`` accepts a ``CodeIgniter\Database\RawSql`` instance, which expresses raw SQL strings.
+Since v4.2.0, ``$builder->join()`` accepts a ``CodeIgniter\Database\RawSql`` instance as the JOIN ON condition, which expresses raw SQL strings.
 
 .. literalinclude:: query_builder/102.php
 
@@ -1498,13 +1500,14 @@ Class Reference
     .. php:method:: join($table, $cond[, $type = ''[, $escape = null]])
 
         :param string $table: Table name to join
-        :param string $cond: The JOIN ON condition
+        :param string|RawSql $cond: The JOIN ON condition
         :param string $type: The JOIN type
         :param bool    $escape: Whether to escape values and identifiers
         :returns:   ``BaseBuilder`` instance (method chaining)
         :rtype:     ``BaseBuilder``
 
-        Adds a ``JOIN`` clause to a query.
+        Adds a ``JOIN`` clause to a query. Since v4.2.0, ``RawSql`` can be used
+        as the JOIN ON condition. See also :ref:`query-builder-join`.
 
     .. php:method:: where($key[, $value = null[, $escape = null]])
 

user_guide_src/source/libraries/files.rst

@@ -51,6 +51,8 @@ Returns the size of the file in bytes:
 .. literalinclude:: files/004.php
     :lines: 2-
 
+A ``RuntimeException`` will be thrown if the file does not exist or an error occurs.
+
 getSizeByUnit()
 ===============
 
@@ -60,6 +62,8 @@ the results in kilobytes or megabytes, respectively:
 .. literalinclude:: files/005.php
     :lines: 2-
 
+A ``RuntimeException`` will be thrown if the file does not exist or an error occurs.
+
 getMimeType()
 =============