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

Author: kenjis

composer.json

@@ -24,7 +24,7 @@
         "phpunit/phpcov": "^8.2",
         "phpunit/phpunit": "^9.1",
         "predis/predis": "^1.1 || ^2.0",
-        "rector/rector": "0.17.2",
+        "rector/rector": "0.17.3",
         "vimeo/psalm": "^5.0"
     },
     "suggest": {

user_guide_src/source/general/configuration.rst

@@ -281,17 +281,25 @@ Registrars
 
 "Registrars" are any other classes which might provide additional configuration properties.
 Registrars provide a means of altering a configuration at runtime across namespaces and files.
-There are two ways to implement a Registrar: implicit and explicit.
+
+Registrars work if :ref:`auto-discovery` is enabled in :doc:`Modules </general/modules>`.
+It alters configuration properties when the Config object is instantiated.
+
+There are two ways to implement a Registrar: **implicit** and **explicit**.
 
 .. note:: Values from **.env** always take priority over Registrars.
 
 Implicit Registrars
 ===================
 
-Any namespace may define registrars by using the **Config/Registrar.php** file, if discovery
-is enabled in :doc:`Modules </general/modules>`. These files are classes whose methods are
-named for each configuration class you wish to extend. For example, a third-party module might
-wish to supply an additional template to ``Pager`` without overwriting whatever a develop has
+Implicit Registrars can change any Config class properties.
+
+Any namespace may define implicit registrars by using the **Config/Registrar.php**
+file. These files are classes whose methods are named for each configuration class
+you wish to extend.
+
+For example, a third-party module or Composer package might
+wish to supply an additional template to ``Config\Pager`` without overwriting whatever a developer has
 already configured. In **src/Config/Registrar.php** there would be a ``Registrar`` class with
 the single ``Pager()`` method (note the case-sensitivity):
 
@@ -304,6 +312,9 @@ overwrite priority.
 Explicit Registrars
 ===================
 
+Explicit Registrars can only change the Config class properties in which they are
+registered.
+
 A configuration file can also specify any number of registrars explicitly.
 This is done by adding a ``$registrars`` property to your configuration file,
 holding an array of the names of candidate registrars:

user_guide_src/source/general/configuration/007.php

@@ -1,5 +1,7 @@
 <?php
 
+namespace CodeIgniter\Shield\Config;
+
 class Registrar
 {
     public static function Pager(): array

user_guide_src/source/general/configuration/008.php

@@ -2,6 +2,8 @@
 
 namespace Config;
 
+// ...
+
 class MyConfig extends BaseConfig
 {
     public static $registrars = [

user_guide_src/source/general/configuration/009.php

@@ -6,8 +6,8 @@
 
 class MySalesConfig extends BaseConfig
 {
-    public $target            = 100;
-    public $campaign          = 'Winter Wonderland';
+    public int $target        = 100;
+    public string $campaign   = 'Winter Wonderland';
     public static $registrars = [
         '\App\Models\RegionalSales',
     ];

user_guide_src/source/general/configuration/010.php

@@ -4,7 +4,7 @@
 
 class RegionalSales
 {
-    public static function MySalesConfig()
+    public static function MySalesConfig(): array
     {
         return [
             'target' => 45,

user_guide_src/source/general/modules.rst

@@ -11,9 +11,9 @@ language files, etc. Modules may contain as few, or as many, of these as you lik
     :local:
     :depth: 2
 
-==========
+**********
 Namespaces
-==========
+**********
 
 The core element of the modules functionality comes from the :doc:`PSR-4 compatible autoloading <../concepts/autoloader>`
 that CodeIgniter uses. While any code can use the PSR-4 autoloader and namespaces, the primary way to take full advantage of
@@ -58,9 +58,9 @@ Of course, there is nothing forcing you to use this exact structure, and you sho
 best suits your module, leaving out directories you don't need, creating new directories for Entities, Interfaces,
 or Repositories, etc.
 
-===========================
+***************************
 Autoloading Non-class Files
-===========================
+***************************
 
 More often than not that your module will not contain only PHP classes but also others like procedural
 functions, bootstrapping files, module constants files, etc. which are not normally loaded the way classes
@@ -73,31 +73,33 @@ your classes. All we need to do is provide the list of paths to those files and
 
 .. literalinclude:: modules/002.php
 
-==============
+.. _auto-discovery:
+
+**************
 Auto-Discovery
-==============
+**************
 
 Many times, you will need to specify the full namespace to files you want to include, but CodeIgniter can be
 configured to make integrating modules into your applications simpler by automatically discovering many different
 file types, including:
 
 - :doc:`Events <../extending/events>`
 - :doc:`Filters <../incoming/filters>`
-- :doc:`Registrars <./configuration>`
+- :ref:`registrars`
 - :doc:`Route files <../incoming/routing>`
 - :doc:`Services <../concepts/services>`
 
 This is configured in the file **app/Config/Modules.php**.
 
-The auto-discovery system works by scanning for particular directories and files within psr4 namespaces that have been defined in **Config/Autoload.php**.
+The auto-discovery system works by scanning for particular directories and files within psr4 namespaces that have been defined in **Config/Autoload.php** and Composer packages.
 
-The discovery process would look for discoverable items on that path and should, for example, find the routes file at **/acme/Blog/Config/Routes.php**.
+The discovery process would look for discoverable items on that path and should, for example, find the routes file at **acme/Blog/Config/Routes.php**.
 
 Enable/Disable Discover
 =======================
 
 You can turn on or off all auto-discovery in the system with the ``$enabled`` class variable. False will disable
-all discovery, optimizing performance, but negating the special capabilities of your modules.
+all discovery, optimizing performance, but negating the special capabilities of your modules and Composer packages.
 
 Specify Discovery Items
 =======================
@@ -134,9 +136,9 @@ by editing the ``$discoverInComposer`` variable in **app/Config/Modules.php**:
 
 .. literalinclude:: modules/004.php
 
-==================
+******************
 Working with Files
-==================
+******************
 
 This section will take a look at each of the file types (controllers, views, language files, etc) and how they can
 be used within the module. Some of this information is described in more detail in the relevant location of the user

user_guide_src/source/helpers/form_helper.rst

@@ -536,6 +536,10 @@ The following functions are available:
     The returned array is the same as ``Validation::getErrors()``.
     See :ref:`Validation <validation-redirect-and-validation-errors>` for details.
 
+    .. note:: This function does not work with :ref:`in-model-validation`. If you
+        want to get the validation errors in model validation, see
+        :ref:`model-getting-validation-errors`.
+
     Example::
 
         <?php $errors = validation_errors(); ?>
@@ -555,6 +559,10 @@ The following functions are available:
 
     This function uses :php:func:`validation_errors()` internally.
 
+    .. note:: This function does not work with :ref:`in-model-validation`. If you
+        want to get the validation errors in model validation, see
+        :ref:`model-getting-validation-errors`.
+
     Example::
 
         <?= validation_list_errors() ?>
@@ -575,6 +583,10 @@ The following functions are available:
 
     This function uses :php:func:`validation_errors()` internally.
 
+    .. note:: This function does not work with :ref:`in-model-validation`. If you
+        want to get the validation errors in model validation, see
+        :ref:`model-getting-validation-errors`.
+
     Example::
 
         <?= validation_show_error('username') ?>

user_guide_src/source/installation/upgrade_435.rst

@@ -18,7 +18,20 @@ Breaking Changes
 Validation Placeholders
 =======================
 
-- To use :ref:`validation-placeholders` securely, please remember to create a validation rule for the field you will use as a placeholder.
+To use :ref:`validation-placeholders` securely, please remember to create a validation rule for the field you will use as a placeholder.
+
+E.g., if you have the following code::
+
+    $validation->setRules([
+        'email' => 'required|max_length[254]|valid_email|is_unique[users.email,id,{id}]',
+    ]);
+
+You need to add the rules for ``{id}``::
+
+    $validation->setRules([
+        'id'    => 'max_length[19]|is_natural_no_zero', // Add this
+        'email' => 'required|max_length[254]|valid_email|is_unique[users.email,id,{id}]',
+    ]);
 
 Session::stop()
 ===============

user_guide_src/source/libraries/validation/002.php

@@ -3,10 +3,10 @@
 // ...
 
 $rules = [
-    'username' => 'required',
-    'password' => 'required|min_length[10]',
-    'passconf' => 'required|matches[password]',
-    'email'    => 'required|valid_email',
+    'username' => 'required|max_length[30]',
+    'password' => 'required|max_length[255]|min_length[10]',
+    'passconf' => 'required|max_length[255]|matches[password]',
+    'email'    => 'required|max_length[254]|valid_email',
 ];
 
 // ...