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

kenjis · kenjis · commit 2dac3a85a737 · 2023-06-19T08:38:53.000+09:00
diff --git a/admin/RELEASE.md b/admin/RELEASE.md
@@ -85,7 +85,7 @@ the existing content.
   * Title: `4.x.x Ready code`
   * Description: blank
 * Merge the PR then create a new Release:
-  * Version: `v4.x.x`
+  * Tag: `v4.x.x` (Create new tag)
   * Target: `master`
   * Title: `CodeIgniter 4.x.x`
   * Description:
@@ -97,7 +97,7 @@ the existing content.
     ## New Contributors
     *
 
-    Full Changelog: https://github.com/codeigniter4/CodeIgniter4/compare/v4.x.x...v4.x.x
+    **Full Changelog**: https://github.com/codeigniter4/CodeIgniter4/compare/v4.x.x...v4.x.x
     ```
 * Watch for the "Deploy Distributable Repos" action to make sure **framework**,
   **appstarter**, and **userguide** get updated
diff --git a/system/Encryption/Handlers/BaseHandler.php b/system/Encryption/Handlers/BaseHandler.php
@@ -13,20 +13,12 @@
 
 use CodeIgniter\Encryption\EncrypterInterface;
 use Config\Encryption;
-use Psr\Log\LoggerInterface;
 
 /**
  * Base class for encryption handling
  */
 abstract class BaseHandler implements EncrypterInterface
 {
-    /**
-     * Logger instance to record error messages and warnings.
-     *
-     * @var LoggerInterface
-     */
-    protected $logger;
-
     /**
      * Constructor
      */
diff --git a/system/ThirdParty/Kint/Utils.php b/system/ThirdParty/Kint/Utils.php
@@ -150,6 +150,10 @@ public static function composerGetExtras(string $key = 'kint'): array
      */
     public static function composerSkipFlags(): void
     {
+        if (\defined('KINT_SKIP_FACADE') && \defined('KINT_SKIP_HELPERS')) {
+            return;
+        }
+
         $extras = self::composerGetExtras();
 
         if (!empty($extras['disable-facade']) && !\defined('KINT_SKIP_FACADE')) {
diff --git a/system/ThirdParty/Kint/resources/compiled/rich.js b/system/ThirdParty/Kint/resources/compiled/rich.js
diff --git a/user_guide_src/source/changelogs/v4.1.1.rst b/user_guide_src/source/changelogs/v4.1.1.rst
@@ -14,7 +14,7 @@ Bugs Fixed
 
 - Fixed an issue where ``.gitattributes`` was preventing framework downloads.
 
-Note that this fix was also applied retroactively to ``4.0.5`` on the **framework** repo.
+Note that this fix was also applied retroactively to 4.0.5 on the **framework** repo.
 
 See the repo's
 `CHANGELOG_4.1.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/changelogs/CHANGELOG_4.1.md>`_
diff --git a/user_guide_src/source/cli/cli_library/001.php b/user_guide_src/source/cli/cli_library/001.php
@@ -1,11 +1,16 @@
 <?php
 
-namespace App\Controllers;
+namespace App\Commands;
 
+use CodeIgniter\CLI\BaseCommand;
 use CodeIgniter\CLI\CLI;
-use CodeIgniter\Controller;
 
-class MyController extends Controller
+class MyCommand extends BaseCommand
 {
     // ...
+
+    public function run(array $params)
+    {
+        // ...
+    }
 }
diff --git a/user_guide_src/source/cli/spark_commands.rst b/user_guide_src/source/cli/spark_commands.rst
@@ -6,7 +6,7 @@ CodeIgniter ships with the official command **spark** and built-in commands.
 
 .. contents::
     :local:
-    :depth: 2
+    :depth: 3
 
 ****************
 Running Commands
@@ -16,12 +16,42 @@ Running via CLI
 ===============
 
 The commands are run from the command line, in the project root directory.
-The command file **spark** has been provided that is used to run any of the CLI commands::
+The command file **spark** has been provided that is used to run any of the CLI commands.
+
+Showing List of Commands
+------------------------
+
+When called **spark** without specifying a command, a simple help page is displayed
+that also provides a list of available commands and their descriptions, sorted by
+categories::
 
     > php spark
 
-When called without specifying a command, a simple help page is displayed that also provides a list of
-available commands.
+spark list
+^^^^^^^^^^
+
+``php spark`` is the exactly same as the ``list`` command::
+
+    > php spark list
+
+You may also use the ``--simple`` option to get a raw list of all available commands,
+sorted alphabetically::
+
+    > php spark list --simple
+
+Showing Help
+------------
+
+You can get help about any CLI command using the ``help`` command as follows::
+
+    > php spark help db:seed
+
+Since v4.3.0, you can also use the ``--help`` option instead of the ``help`` command::
+
+    > php spark db:seed --help
+
+Running a Command
+-----------------
 
 You should pass the name of the command as the first argument to run that command::
 
@@ -31,17 +61,31 @@ Some commands take additional arguments, which should be provided directly after
 
     > php spark db:seed DevUserSeeder
 
-You may always pass ``--no-header`` to suppress the header output, helpful for parsing results::
-
-    > php spark cache:clear --no-header
-
 For all of the commands CodeIgniter provides, if you do not provide the required arguments, you will be prompted
 for the information it needs to run correctly::
 
-    > php spark make::controller
+    > php spark make:controller
 
     Controller class name :
 
+Suppressing Header Output
+-------------------------
+
+When you run a command, the header with CodeIgniter version and the current time
+is output::
+
+    > php spark env
+
+    CodeIgniter v4.3.5 Command Line Tool - Server Time: 2023-06-16 12:45:31 UTC+00:00
+
+    Your environment is currently set as development.
+
+You may always pass ``--no-header`` to suppress the header output, helpful for parsing results::
+
+    > php spark env --no-header
+
+    Your environment is currently set as development.
+
 Calling Commands
 ================
 
@@ -55,29 +99,3 @@ it from the command line.
 
 All output from the command that is ran is captured when not run from the command line. It is returned from the command
 so that you can choose to display it or not.
-
-******************
-Using Help Command
-******************
-
-spark help
-==========
-
-You can get help about any CLI command using the ``help`` command as follows::
-
-    > php spark help db:seed
-
-Since v4.3.0, you can also use the ``--help`` option instead of the ``help`` command::
-
-    > php spark db:seed --help
-
-spark list
-==========
-
-Use the ``list`` command to get a list of available commands and their descriptions, sorted by categories::
-
-    > php spark list
-
-You may also use the ``--simple`` option to get a raw list of all available commands, sorted alphabetically::
-
-    > php spark list --simple
diff --git a/user_guide_src/source/database/queries.rst b/user_guide_src/source/database/queries.rst
@@ -15,11 +15,16 @@ Query Basics
 Regular Queries
 ===============
 
-To submit a query, use the **query** function:
+.. _db-query:
+
+$db->query()
+------------
+
+To submit a query, use the ``query()`` method:
 
 .. literalinclude:: queries/001.php
 
-The ``query()`` function returns a database result **object** when "read"
+The ``query()`` method returns a database result **object** when "read"
 type queries are run which you can use to :doc:`show your
 results <results>`. When "write" type queries are run it simply
 returns true or false depending on success or failure. When retrieving
@@ -34,6 +39,11 @@ this:
 Simplified Queries
 ==================
 
+.. _db-simplequery:
+
+$db->simpleQuery()
+------------------
+
 The ``simpleQuery()`` method is a simplified version of the
 ``$db->query()`` method. It DOES
 NOT return a database result set, nor does it set the query timer, or
diff --git a/user_guide_src/source/helpers/inflector_helper.rst b/user_guide_src/source/helpers/inflector_helper.rst
@@ -94,7 +94,7 @@ The following functions are available:
     Takes multiple words in camelCase or PascalCase and converts them to snake_case.
     Example:
 
-    .. literalinclude:: inflector_helper/007.php
+    .. literalinclude:: inflector_helper/014.php
 
 .. php:function:: humanize($string[, $separator = '_'])
 
diff --git a/user_guide_src/source/installation/upgrade_4210.rst b/user_guide_src/source/installation/upgrade_4210.rst
@@ -15,7 +15,7 @@ Please refer to the upgrade instructions corresponding to your installation meth
 Project Files
 *************
 
-Version ``4.2.10`` did not alter any executable code in project files.
+Version 4.2.10 did not alter any executable code in project files.
 
 All Changes
 ===========
diff --git a/user_guide_src/source/installation/upgrade_4211.rst b/user_guide_src/source/installation/upgrade_4211.rst
@@ -55,7 +55,7 @@ If the following values exceed those maximum length, the session will not work p
 Project Files
 *************
 
-Version ``4.2.11`` did not alter any executable code in project files.
+Version 4.2.11 did not alter any executable code in project files.
 
 All Changes
 ===========
diff --git a/user_guide_src/source/installation/upgrade_4212.rst b/user_guide_src/source/installation/upgrade_4212.rst
@@ -15,7 +15,7 @@ Please refer to the upgrade instructions corresponding to your installation meth
 Project Files
 *************
 
-Version ``4.2.12`` did not alter any executable code in project files.
+Version 4.2.12 did not alter any executable code in project files.
 
 All Changes
 ===========
diff --git a/user_guide_src/source/installation/upgrade_423.rst b/user_guide_src/source/installation/upgrade_423.rst
@@ -15,4 +15,4 @@ Please refer to the upgrade instructions corresponding to your installation meth
 Project Files
 *************
 
-Version ``4.2.3`` is an internal change for security measures and requires no intervention in projects.
+Version 4.2.3 is an internal change for security measures and requires no intervention in projects.
diff --git a/user_guide_src/source/installation/upgrade_425.rst b/user_guide_src/source/installation/upgrade_425.rst
@@ -15,4 +15,4 @@ Please refer to the upgrade instructions corresponding to your installation meth
 Project Files
 *************
 
-Version ``4.2.5`` did not alter any project files.
+Version 4.2.5 did not alter any project files.
diff --git a/user_guide_src/source/installation/upgrade_427.rst b/user_guide_src/source/installation/upgrade_427.rst
@@ -58,7 +58,7 @@ Others
 Project Files
 *************
 
-Version ``4.2.7`` did not alter any executable code in project files.
+Version 4.2.7 did not alter any executable code in project files.
 
 All Changes
 ===========
diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst
@@ -39,13 +39,46 @@ The first element is the results from the database, **users**, which is retrieve
 the Model will hold on to the instance it used and store it in the public property, ``$pager``. So, we grab
 that and assign it to the ``$pager`` variable in the view.
 
-.. important:: It is important to understand that the ``Model::paginate()`` method uses the **Model** and **QueryBuilder** methods.
-    Therefore, trying to use ``$db->query()`` and ``Model::paginate()`` **will not work** because ``$db->query()`` executes
-    the query immediately and is not associated with a QueryBuilder.
+Customizing Query for Pagination
+================================
 
-To define conditions for pagination in a model, you can:
+To customize a query for pagination in a model, you can add
+:doc:`Query Builder <../database/query_builder>` methods before ``paginate()``
+method.
+
+Adding WHERE
+------------
+
+If you want to add WHERE conditions, you can specify conditions directly:
 
 .. literalinclude:: pagination/003.php
+    :lines: 2-
+
+You can move the conditions to a separate method:
+
+.. literalinclude:: pagination/017.php
+
+.. literalinclude:: pagination/018.php
+    :lines: 2-
+
+Adding JOIN
+-----------
+
+You can join another table:
+
+.. literalinclude:: pagination/016.php
+
+.. important:: It is important to understand that the ``Model::paginate()`` method
+    uses the **Model** and the **Query Builder** instance in the Model.
+    Therefore, trying to use ``Model::paginate()`` with :ref:`db-query`
+    **will not work** because ``$db->query()`` executes the query immediately
+    and is not associated with the Query Builder.
+
+If you need a complicated SQL query that you cannot write with Query Builder,
+try using :ref:`db-query` and `Manual Pagination`_.
+
+Displaying Pager Links
+======================
 
 Within the view, we then need to tell it where to display the resulting links::
 
diff --git a/user_guide_src/source/libraries/pagination/002.php b/user_guide_src/source/libraries/pagination/002.php
@@ -2,9 +2,7 @@
 
 namespace App\Controllers;
 
-use CodeIgniter\Controller;
-
-class UserController extends Controller
+class UserController extends BaseController
 {
     public function index()
     {
diff --git a/user_guide_src/source/libraries/pagination/003.php b/user_guide_src/source/libraries/pagination/003.php
@@ -1,26 +1,9 @@
 <?php
 
-// You can specify conditions directly.
+// In your Controller.
 $model = new \App\Models\UserModel();
 
 $data = [
     'users' => $model->where('ban', 1)->paginate(10),
     'pager' => $model->pager,
 ];
-
-// You can move the conditions to a separate method.
-// Model method
-class UserModel extends Model
-{
-    public function banned()
-    {
-        $this->builder()->where('ban', 1);
-
-        return $this; // This will allow the call chain to be used.
-    }
-}
-
-$data = [
-    'users' => $model->banned()->paginate(10),
-    'pager' => $model->pager,
-];
diff --git a/user_guide_src/source/libraries/pagination/004.php b/user_guide_src/source/libraries/pagination/004.php
@@ -2,9 +2,7 @@
 
 namespace App\Controllers;
 
-use CodeIgniter\Controller;
-
-class UserController extends Controller
+class UserController extends BaseController
 {
     public function index()
     {
diff --git a/user_guide_src/source/libraries/pagination/015.php b/user_guide_src/source/libraries/pagination/015.php
diff --git a/user_guide_src/source/libraries/pagination/016.php b/user_guide_src/source/libraries/pagination/016.php
diff --git a/user_guide_src/source/libraries/pagination/017.php b/user_guide_src/source/libraries/pagination/017.php
diff --git a/user_guide_src/source/libraries/pagination/018.php b/user_guide_src/source/libraries/pagination/018.php
diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
diff --git a/user_guide_src/source/libraries/sessions/040.php b/user_guide_src/source/libraries/sessions/040.php
