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.15.24",
+        "rector/rector": "0.15.25",
         "vimeo/psalm": "^5.0"
     },
     "suggest": {

system/BaseModel.php

@@ -63,8 +63,8 @@ abstract class BaseModel
      * The Database connection group that
      * should be instantiated.
      *
-     * @var string
-     * @phpstan-var non-empty-string
+     * @var string|null
+     * @phpstan-var non-empty-string|null
      */
     protected $DBGroup;
 

system/CLI/BaseCommand.php

@@ -105,7 +105,7 @@ abstract public function run(array $params);
     /**
      * Can be used by a command to run other commands.
      *
-     * @return mixed
+     * @return int|void
      *
      * @throws ReflectionException
      */
@@ -205,7 +205,7 @@ public function getPad(array $array, int $pad): int
     /**
      * Makes it simple to access our protected properties.
      *
-     * @return mixed
+     * @return array|Commands|LoggerInterface|string|null
      */
     public function __get(string $key)
     {

system/CLI/CLI.php

@@ -915,7 +915,7 @@ public static function getURI(): string
      *
      * **IMPORTANT:** The index here is one-based instead of zero-based.
      *
-     * @return mixed
+     * @return string|null
      */
     public static function getSegment(int $index)
     {

system/Commands/Generators/Views/model.tpl.php

@@ -10,7 +10,6 @@ class {class} extends Model
     protected $table            = '{table}';
     protected $primaryKey       = 'id';
     protected $useAutoIncrement = true;
-    protected $insertID         = 0;
     protected $returnType       = {return};
     protected $useSoftDeletes   = false;
     protected $protectFields    = true;

system/I18n/TimeDifference.php

@@ -271,7 +271,7 @@ public function humanize(?string $locale = null): string
      *
      * @param string $name
      *
-     * @return mixed
+     * @return float|int|null
      */
     public function __get($name)
     {

system/Router/RouteCollectionInterface.php

@@ -31,7 +31,7 @@ interface RouteCollectionInterface
      * @param array|Closure|string $to
      * @param array                $options
      *
-     * @return mixed
+     * @return RouteCollectionInterface
      */
     public function add(string $from, $to, ?array $options = null);
 
@@ -46,31 +46,31 @@ public function add(string $from, $to, ?array $options = null);
      * @param array|string $placeholder
      * @param string       $pattern
      *
-     * @return mixed
+     * @return RouteCollectionInterface
      */
     public function addPlaceholder($placeholder, ?string $pattern = null);
 
     /**
      * Sets the default namespace to use for Controllers when no other
      * namespace has been specified.
      *
-     * @return mixed
+     * @return RouteCollectionInterface
      */
     public function setDefaultNamespace(string $value);
 
     /**
      * Sets the default controller to use when no other controller has been
      * specified.
      *
-     * @return mixed
+     * @return RouteCollectionInterface
      */
     public function setDefaultController(string $value);
 
     /**
      * Sets the default method to call on the controller when no other
      * method has been set in the route.
      *
-     * @return mixed
+     * @return RouteCollectionInterface
      */
     public function setDefaultMethod(string $value);
 
@@ -81,7 +81,7 @@ public function setDefaultMethod(string $value);
      * find words and meaning in the URI for better SEO. But it
      * doesn't work well with PHP method names....
      *
-     * @return mixed
+     * @return RouteCollectionInterface
      */
     public function setTranslateURIDashes(bool $value);
 

user_guide_src/source/general/common_functions.rst

@@ -396,12 +396,12 @@ Miscellaneous Functions
 
     :param   string       $method: Route name or Controller::method
     :param   int|string   ...$params: One or more parameters to be passed to the route. The last parameter allows you to set the locale.
-    :returns: a route (URI path)
+    :returns: a route path (URI path relative to baseURL)
     :rtype: string
 
     .. note:: This function requires the controller/method to have a route defined in **app/Config/routes.php**.
 
-    .. important:: ``route_to()`` returns a *route*, not a full URI path for your site.
+    .. important:: ``route_to()`` returns a *route* path, not a full URI path for your site.
         If your **baseURL** contains sub folders, the return value is not the same
         as the URI to link. In that case, just use :php:func:`url_to()` instead.
         See also :ref:`urls-url-structure`.

user_guide_src/source/general/urls.rst

@@ -29,12 +29,15 @@ When you have the Base URL **https://www.example.com/** and imagine the followin
 
 We use the following terms:
 
-======== ============================
-Base URL **https://www.example.com/**
-URI path /blog/news/2022/10
-Route    /blog/news/2022/10
-Query    page=2
-======== ============================
+========== ============================ =========================================
+Term       Example                      Description
+========== ============================ =========================================
+Base URL   **https://www.example.com/** Base URL is often denoted as **baseURL**.
+URI path   /blog/news/2022/10
+Route path /blog/news/2022/10           The URI path relative to the Base URL.
+                                        It is also called as **URI string**.
+Query      page=2
+========== ============================ =========================================
 
 Base URL contains Sub folders
 -----------------------------
@@ -45,12 +48,15 @@ When you have the Base URL **https://www.example.com/ci-blog/** and imagine the
 
 We use the following terms:
 
-======== ====================================
-Base URL **https://www.example.com/ci-blog/**
-URI path /ci-blog/blog/news/2022/10
-Route    /blog/news/2022/10
-Query    page=2
-======== ====================================
+========== ==================================== =========================================
+Term       Example                              Description
+========== ==================================== =========================================
+Base URL   **https://www.example.com/ci-blog/** Base URL is often denoted as **baseURL**.
+URI path   /ci-blog/blog/news/2022/10
+Route path /blog/news/2022/10                   The URI path relative to the Base URL.
+                                                It is also called as **URI string**.
+Query      page=2
+========== ==================================== =========================================
 
 .. _urls-remove-index-php: