Merge branch '4.3' into BatchUpdateSQL

Author: sclubricants

admin/RELEASE.md

@@ -51,16 +51,7 @@ git clone [email protected]:codeigniter4/userguide.git
 * Create a new PR from `develop` to `master`:
     * Title: "4.x.x Ready code"
     * Description: blank
-* Merge the PR then fast-forward `develop` to catch the merge commit
-* Update the next minor upgrade branch `4.x`
-```console
-git fetch origin
-git checkout 4.x
-git merge origin/4.x
-git merge origin/develop
-git push origin HEAD
-```
-* Create a new Release:
+* Merge the PR then create a new Release:
     * Version: "v4.x.x"
     * Title: "CodeIgniter 4.x.x"
     * Description:
@@ -76,25 +67,23 @@ composer create-project codeigniter4/appstarter release-test
 cd release-test
 composer test && composer info codeigniter4/framework
 ```
-* publish any Security Advisories that were resolved from private forks
-
-## User Guide
-
-**This is now handled by GitHub Actions!**
-
-Verify that the Actions succeeded:
-* "Deploy User Guide", this repo
-* "Deploy Production", UG repo
-* "pages-build-deployment", both repos
-
-See the legacy notes in Appendix for reference or to help manually recover from workflow failures.
-
-## Announcement
-
-> Note: This forum is restricted to administrators.
-
-* Make a new topic in the "News & Discussion" forums: https://forum.codeigniter.com/forum-2.html
-* The content is somewhat organic, but should include any major features and changes as well as a link to the User Guide's changelog
+* Verify that the User Guide Actions succeeded:
+    * "Deploy User Guide", framework repo
+    * "Deploy Production", UG repo
+    * "pages-build-deployment", both repos
+* Fast-forward `develop` branch to catch the merge commit from `master`
+* Update the next minor upgrade branch `4.x`:
+```console
+git fetch origin
+git checkout 4.x
+git merge origin/4.x
+git merge origin/develop
+git push origin HEAD
+```
+* Publish any Security Advisories that were resolved from private forks
+* Announce the release on the forums and Slack channel (note: this forum is restricted to administrators):
+    * Make a new topic in the "News & Discussion" forums: https://forum.codeigniter.com/forum-2.html
+    * The content is somewhat organic, but should include any major features and changes as well as a link to the User Guide's changelog
 
 ## After Publishing Security Advisory
 

composer.json

@@ -24,7 +24,7 @@
         "phpstan/phpstan": "^1.7.1",
         "phpunit/phpunit": "^9.1",
         "predis/predis": "^1.1 || ^2.0",
-        "rector/rector": "0.14.1",
+        "rector/rector": "0.14.2",
         "vimeo/psalm": "^4.26"
     },
     "suggest": {

contributing/workflow.md

@@ -179,6 +179,29 @@ For instance, to commit your work from a debugging session:
 
 Just make sure that your commits in a feature branch are all related.
 
+### GPG-Signing Old Commits
+
+Any developer can forget GPG-signing their commits with the option `-S`, like `git commit -S -m 'Signed GPG'`. In such a case, all you need to do is the following:
+
+Latest commit only:
+```console
+> git switch your-branch
+> git commit --amend --no-edit --no-verify -S
+> git push --force-with-lease origin your-branch
+```
+
+All commits:
+```console
+> git switch your-branch
+> git rebase -i --root --exec 'git commit --amend --no-edit --no-verify -S'
+> git push --force-with-lease origin your-branch
+```
+
+As a faster alternative, you can still securely sign commits without the `-S` option in `git commit` by setting `git config --global commit.gpgsign true` and `git config --global user.signingkey 3AC5C34371567BD2` to all local repositories. Without the `--global` option, the change is applied to one local repository only.
+
+> **Note**
+> `3AC5C34371567BD2` is your GPG Key ID
+
 ### Changing a Commit Message
 
 See <https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message>.

phpstan-baseline.neon.dist

@@ -635,11 +635,6 @@ parameters:
 			count: 1
 			path: system/Throttle/Throttler.php
 
-		-
-			message: "#^Variable \\$error on left side of \\?\\? always exists and is always null\\.$#"
-			count: 1
-			path: system/Validation/Validation.php
-
 		-
 			message: "#^Property CodeIgniter\\\\View\\\\Cell\\:\\:\\$cache \\(CodeIgniter\\\\Cache\\\\CacheInterface\\) in empty\\(\\) is not falsy\\.$#"
 			count: 2

rector.php

@@ -110,10 +110,6 @@
             __DIR__ . '/app/Config/Validation.php',
             __DIR__ . '/tests/system/Validation/StrictRules/ValidationTest.php',
             __DIR__ . '/tests/system/Validation/ValidationTest.php',
-
-            // expected Qualified name
-            __DIR__ . '/tests/system/Autoloader/FileLocatorTest.php',
-            __DIR__ . '/tests/system/Router/RouteCollectionTest.php',
         ],
 
         // sometime too detail

system/BaseModel.php

@@ -19,7 +19,6 @@
 use CodeIgniter\Exceptions\ModelException;
 use CodeIgniter\I18n\Time;
 use CodeIgniter\Pager\Pager;
-use CodeIgniter\Validation\Validation;
 use CodeIgniter\Validation\ValidationInterface;
 use Config\Services;
 use InvalidArgumentException;
@@ -198,7 +197,7 @@ abstract class BaseModel
     /**
      * Our validator instance.
      *
-     * @var Validation
+     * @var ValidationInterface
      */
     protected $validation;
 
@@ -326,7 +325,7 @@ public function __construct(?ValidationInterface $validation = null)
         $this->tempAllowCallbacks = $this->allowCallbacks;
 
         /**
-         * @var Validation|null $validation
+         * @var ValidationInterface|null $validation
          */
         $validation ??= Services::validation(null, false);
         $this->validation = $validation;

system/CodeIgniter.php

@@ -718,18 +718,13 @@ protected function generateCacheName(Cache $config): string
             return md5($this->request->getPath());
         }
 
-        $uri = $this->request->getUri();
-        if ($config->cacheQueryString) {
-            if (is_array($config->cacheQueryString)) {
-                $name = URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath(), $uri->getQuery(['only' => $config->cacheQueryString]));
-            } else {
-                $name = URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath(), $uri->getQuery());
-            }
-        } else {
-            $name = URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath());
-        }
+        $uri = clone $this->request->getUri();
+
+        $query = $config->cacheQueryString
+            ? $uri->getQuery(is_array($config->cacheQueryString) ? ['only' => $config->cacheQueryString] : [])
+            : '';
 
-        return md5($name);
+        return md5($uri->setFragment('')->setQuery($query));
     }
 
     /**

system/Config/BaseService.php

@@ -49,7 +49,7 @@
 use CodeIgniter\Session\Session;
 use CodeIgniter\Throttle\Throttler;
 use CodeIgniter\Typography\Typography;
-use CodeIgniter\Validation\Validation;
+use CodeIgniter\Validation\ValidationInterface;
 use CodeIgniter\View\Cell;
 use CodeIgniter\View\Parser;
 use CodeIgniter\View\RendererInterface;
@@ -127,7 +127,7 @@
  * @method static Toolbar                    toolbar(ConfigToolbar $config = null, $getShared = true)
  * @method static Typography                 typography($getShared = true)
  * @method static URI                        uri($uri = null, $getShared = true)
- * @method static Validation                 validation(ConfigValidation $config = null, $getShared = true)
+ * @method static ValidationInterface        validation(ConfigValidation $config = null, $getShared = true)
  * @method static Cell                       viewcell($getShared = true)
  */
 class BaseService

system/Config/Services.php

@@ -54,6 +54,7 @@
 use CodeIgniter\Throttle\Throttler;
 use CodeIgniter\Typography\Typography;
 use CodeIgniter\Validation\Validation;
+use CodeIgniter\Validation\ValidationInterface;
 use CodeIgniter\View\Cell;
 use CodeIgniter\View\Parser;
 use CodeIgniter\View\RendererInterface;
@@ -733,7 +734,7 @@ public static function uri(?string $uri = null, bool $getShared = true)
     /**
      * The Validation class provides tools for validating input data.
      *
-     * @return Validation
+     * @return ValidationInterface
      */
     public static function validation(?ValidationConfig $config = null, bool $getShared = true)
     {

system/Controller.php

@@ -15,7 +15,7 @@
 use CodeIgniter\HTTP\RequestInterface;
 use CodeIgniter\HTTP\ResponseInterface;
 use CodeIgniter\Validation\Exceptions\ValidationException;
-use CodeIgniter\Validation\Validation;
+use CodeIgniter\Validation\ValidationInterface;
 use Config\Services;
 use Psr\Log\LoggerInterface;
 
@@ -62,7 +62,7 @@ class Controller
     /**
      * Once validation has been run, will hold the Validation instance.
      *
-     * @var Validation
+     * @var ValidationInterface
      */
     protected $validator;
 

system/Database/BaseConnection.php

@@ -32,7 +32,7 @@
  * @property mixed      $encrypt
  * @property array      $failover
  * @property string     $hostname
- * @property mixed      $lastQuery
+ * @property Query      $lastQuery
  * @property string     $password
  * @property bool       $pConnect
  * @property int|string $port
@@ -151,7 +151,7 @@ abstract class BaseConnection implements ConnectionInterface
     /**
      * Encryption flag/data
      *
-     * @var mixed
+     * @var array|bool
      */
     protected $encrypt = false;
 
@@ -182,7 +182,7 @@ abstract class BaseConnection implements ConnectionInterface
      * The last query object that was executed
      * on this connection.
      *
-     * @var mixed
+     * @var Query
      */
     protected $lastQuery;
 
@@ -933,7 +933,7 @@ public function prepare(Closure $func, array $options = [])
     /**
      * Returns the last query's statement object.
      *
-     * @return mixed
+     * @return Query
      */
     public function getLastQuery()
     {
@@ -1150,9 +1150,10 @@ private function protectDotItem(string $item, string $alias, bool $protectIdenti
      *
      * This function escapes column and table names
      *
-     * @param mixed $item
+     * @param array|string $item
      *
-     * @return mixed
+     * @return array|string
+     * @phpstan-return ($item is array ? array : string)
      */
     public function escapeIdentifiers($item)
     {
@@ -1232,9 +1233,10 @@ abstract public function affectedRows(): int;
      * Escapes data based on type.
      * Sets boolean and null types
      *
-     * @param mixed $str
+     * @param array|bool|float|int|object|string|null $str
      *
-     * @return mixed
+     * @return array|float|int|string
+     * @phpstan-return ($str is array ? array : float|int|string)
      */
     public function escape($str)
     {

system/Database/ConnectionInterface.php

@@ -131,9 +131,10 @@ public function getLastQuery();
      * Escapes data based on type.
      * Sets boolean and null types.
      *
-     * @param mixed $str
+     * @param array|bool|float|int|object|string|null $str
      *
-     * @return mixed
+     * @return array|float|int|string
+     * @phpstan-return ($str is array ? array : float|int|string)
      */
     public function escape($str);
 

system/Database/Postgre/Connection.php

@@ -171,9 +171,10 @@ public function affectedRows(): int
      *
      * Escapes data based on type
      *
-     * @param mixed $str
+     * @param array|bool|float|int|object|string|null $str
      *
-     * @return mixed
+     * @return array|float|int|string
+     * @phpstan-return ($str is array ? array : float|int|string)
      */
     public function escape($str)
     {

system/I18n/Time.php

@@ -1122,12 +1122,11 @@ protected static function hasRelativeKeywords(string $time): bool
 
     /**
      * Outputs a short format version of the datetime.
-     *
-     * @throws Exception
+     * The output is NOT localized intentionally.
      */
     public function __toString(): string
     {
-        return IntlDateFormatter::formatObject($this->toDateTime(), $this->toStringFormat, $this->locale);
+        return $this->format('Y-m-d H:i:s');
     }
 
     /**
@@ -1180,12 +1179,4 @@ public function __wakeup(): void
         $this->timezone = new DateTimeZone($timezone);
         parent::__construct($this->date, $this->timezone);
     }
-
-    /**
-     * Returns the datetime string ('Y-m-d H:i:s') that is safe to databases regardless of locale.
-     */
-    public function toDatabase(): string
-    {
-        return $this->format('Y-m-d H:i:s');
-    }
 }

system/Validation/Validation.php

@@ -331,6 +331,7 @@ protected function processRules(
 
                 $param = ($param === false) ? '' : $param;
 
+                // @phpstan-ignore-next-line $error may be set by rule methods.
                 $this->errors[$field] = $error ?? $this->getErrorMessage(
                     $rule,
                     $field,
@@ -405,7 +406,7 @@ public function withRequest(RequestInterface $request): ValidationInterface
      *
      *    [
      *        'rule' => 'message',
-     *        'rule' => 'message'
+     *        'rule' => 'message',
      *    ]
      *
      * @param array|string $rules
@@ -499,7 +500,7 @@ public function hasRule(string $field): bool
      *
      * @param string $group Group.
      *
-     * @throws InvalidArgumentException If group not found.
+     * @throws ValidationException If group not found.
      *
      * @return string[] Rule group.
      */
@@ -521,7 +522,7 @@ public function getRuleGroup(string $group): array
      *
      * @param string $group Group.
      *
-     * @throws InvalidArgumentException If group not found.
+     * @throws ValidationException If group not found.
      */
     public function setRuleGroup(string $group)
     {
@@ -593,12 +594,14 @@ protected function loadRuleSets()
      * same format used with setRules(). Additionally, check
      * for {group}_errors for an array of custom error messages.
      *
-     * @return array|ValidationException|null
+     * @throws ValidationException
+     *
+     * @return array
      */
     public function loadRuleGroup(?string $group = null)
     {
         if (empty($group)) {
-            return null;
+            return [];
         }
 
         if (! isset($this->config->{$group})) {