Release v4.3.7

Author: actions-user

app/Config/App.php

@@ -126,7 +126,7 @@ class App extends BaseConfig
 
     /**
      * --------------------------------------------------------------------------
-     * URI PROTOCOL
+     * Force Global Secure Requests
      * --------------------------------------------------------------------------
      *
      * If true, this will force every request made to this application to be

app/Config/Autoload.php

@@ -13,7 +13,10 @@
  * can find the files as needed.
  *
  * NOTE: If you use an identical key in $psr4 or $classmap, then
- * the values in this file will overwrite the framework's values.
+ *       the values in this file will overwrite the framework's values.
+ *
+ * NOTE: This class is required prior to Autoloader instantiation,
+ *       and does not extend BaseConfig.
  */
 class Autoload extends AutoloadConfig
 {

app/Config/Cache.php

@@ -2,6 +2,7 @@
 
 namespace Config;
 
+use CodeIgniter\Cache\CacheInterface;
 use CodeIgniter\Cache\Handlers\DummyHandler;
 use CodeIgniter\Cache\Handlers\FileHandler;
 use CodeIgniter\Cache\Handlers\MemcachedHandler;
@@ -53,12 +54,12 @@ class Cache extends BaseConfig
      * Whether to take the URL query string into consideration when generating
      * output cache files. Valid options are:
      *
-     *    false      = Disabled
-     *    true       = Enabled, take all query parameters into account.
-     *                 Please be aware that this may result in numerous cache
-     *                 files generated for the same page over and over again.
-     *    array('q') = Enabled, but only take into account the specified list
-     *                 of query parameters.
+     *    false = Disabled
+     *    true  = Enabled, take all query parameters into account.
+     *            Please be aware that this may result in numerous cache
+     *            files generated for the same page over and over again.
+     *    ['q'] = Enabled, but only take into account the specified list
+     *            of query parameters.
      *
      * @var bool|string[]
      */
@@ -95,7 +96,8 @@ class Cache extends BaseConfig
      * A string of reserved characters that will not be allowed in keys or tags.
      * Strings that violate this restriction will cause handlers to throw.
      * Default: {}()/\@:
-     * Note: The default set is required for PSR-6 compliance.
+     *
+     * NOTE: The default set is required for PSR-6 compliance.
      */
     public string $reservedCharacters = '{}()/\@:';
 
@@ -157,6 +159,7 @@ class Cache extends BaseConfig
      * that are listed here are allowed to be used.
      *
      * @var array<string, string>
+     * @phpstan-var array<string, class-string<CacheInterface>>
      */
     public array $validHandlers = [
         'dummy'     => DummyHandler::class,

app/Config/ContentSecurityPolicy.php

@@ -39,7 +39,7 @@ class ContentSecurityPolicy extends BaseConfig
 
     // -------------------------------------------------------------------------
     // Sources allowed
-    // Note: once you set a policy to 'none', it cannot be further restricted
+    // NOTE: once you set a policy to 'none', it cannot be further restricted
     // -------------------------------------------------------------------------
 
     /**

app/Config/Filters.php

@@ -49,7 +49,7 @@ class Filters extends BaseConfig
      *
      * If you use this, you should disable auto-routing because auto-routing
      * permits any HTTP method to access a controller. Accessing the controller
-     * with a method you don’t expect could bypass the filter.
+     * with a method you don't expect could bypass the filter.
      */
     public array $methods = [];
 

app/Config/Kint.php

@@ -3,7 +3,10 @@
 namespace Config;
 
 use CodeIgniter\Config\BaseConfig;
+use Kint\Parser\ConstructablePluginInterface;
 use Kint\Renderer\AbstractRenderer;
+use Kint\Renderer\Rich\TabPluginInterface;
+use Kint\Renderer\Rich\ValuePluginInterface;
 
 /**
  * --------------------------------------------------------------------------
@@ -23,7 +26,12 @@ class Kint extends BaseConfig
     |--------------------------------------------------------------------------
     */
 
+    /**
+     * @var array<int, ConstructablePluginInterface|string>
+     * @phpstan-var list<class-string<ConstructablePluginInterface>|ConstructablePluginInterface>
+     */
     public $plugins;
+
     public int $maxDepth           = 6;
     public bool $displayCalledFrom = true;
     public bool $expanded          = false;
@@ -36,7 +44,17 @@ class Kint extends BaseConfig
     public string $richTheme = 'aante-light.css';
     public bool $richFolder  = false;
     public int $richSort     = AbstractRenderer::SORT_FULL;
+
+    /**
+     * @var array<string, string>
+     * @phpstan-var array<string, class-string<ValuePluginInterface>>
+     */
     public $richObjectPlugins;
+
+    /**
+     * @var array<string, string>
+     * @phpstan-var array<string, class-string<TabPluginInterface>>
+     */
     public $richTabPlugins;
 
     /*

app/Config/Logger.php

@@ -74,14 +74,12 @@ class Logger extends BaseConfig
      * the handler on top and continuing down.
      */
     public array $handlers = [
-
         /*
          * --------------------------------------------------------------------
          * File Handler
          * --------------------------------------------------------------------
          */
         FileHandler::class => [
-
             // The log levels that this handler will handle.
             'handles' => [
                 'critical',
@@ -99,7 +97,7 @@ class Logger extends BaseConfig
              * An extension of 'php' allows for protecting the log files via basic
              * scripting, when they are to be stored under a publicly accessible directory.
              *
-             * Note: Leaving it blank will default to 'log'.
+             * NOTE: Leaving it blank will default to 'log'.
              */
             'fileExtension' => '',
 

app/Config/Migrations.php

@@ -40,7 +40,7 @@ class Migrations extends BaseConfig
      * using the CLI command:
      *   > php spark make:migration
      *
-     * Note: if you set an unsupported format, migration runner will not find
+     * NOTE: if you set an unsupported format, migration runner will not find
      *       your migration files.
      *
      * Supported formats:

app/Config/Modules.php

@@ -4,6 +4,12 @@
 
 use CodeIgniter\Modules\Modules as BaseModules;
 
+/**
+ * Modules Configuration.
+ *
+ * NOTE: This class is required prior to Autoloader instantiation,
+ *       and does not extend BaseConfig.
+ */
 class Modules extends BaseModules
 {
     /**

app/Config/Paths.php

@@ -12,6 +12,11 @@
  * share a system folder between multiple applications, and more.
  *
  * All paths are relative to the project's root folder.
+ *
+ * NOTE: This class is required prior to Autoloader instantiation,
+ *       and does not extend BaseConfig.
+ *
+ * @immutable
  */
 class Paths
 {

app/Controllers/BaseController.php

@@ -44,7 +44,7 @@ abstract class BaseController extends Controller
     // protected $session;
 
     /**
-     * Constructor.
+     * @return void
      */
     public function initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger)
     {

app/Controllers/Home.php

@@ -4,7 +4,7 @@
 
 class Home extends BaseController
 {
-    public function index()
+    public function index(): string
     {
         return view('welcome_message');
     }

system/Autoloader/Autoloader.php

@@ -148,6 +148,8 @@ private function loadComposerInfo(Modules $modules): void
 
     /**
      * Register the loader with the SPL autoloader stack.
+     *
+     * @return void
      */
     public function register()
     {
@@ -445,6 +447,8 @@ private function loadComposerClassmap(ClassLoader $composer): void
      * Locates autoload information from Composer, if available.
      *
      * @deprecated No longer used.
+     *
+     * @return void
      */
     protected function discoverComposerNamespaces()
     {

system/BaseModel.php

@@ -1345,7 +1345,7 @@ public function skipValidation(bool $skip = true)
     }
 
     /**
-     * Allows to set validation messages.
+     * Allows to set (and reset) validation messages.
      * It could be used when you have to change default or override current validate messages.
      *
      * @param array $validationMessages Value
@@ -1376,7 +1376,7 @@ public function setValidationMessage(string $field, array $fieldMessages)
     }
 
     /**
-     * Allows to set validation rules.
+     * Allows to set (and reset) validation rules.
      * It could be used when you have to change default or override current validate rules.
      *
      * @param array $validationRules Value
@@ -1401,6 +1401,17 @@ public function setValidationRules(array $validationRules)
      */
     public function setValidationRule(string $field, $fieldRules)
     {
+        $rules = $this->validationRules;
+
+        // ValidationRules can be either a string, which is the group name,
+        // or an array of rules.
+        if (is_string($rules)) {
+            [$rules, $customErrors] = $this->validation->loadRuleGroup($rules);
+
+            $this->validationRules    = $rules;
+            $this->validationMessages = $this->validationMessages + $customErrors;
+        }
+
         $this->validationRules[$field] = $fieldRules;
 
         return $this;
@@ -1466,7 +1477,9 @@ public function getValidationRules(array $options = []): array
         // ValidationRules can be either a string, which is the group name,
         // or an array of rules.
         if (is_string($rules)) {
-            $rules = $this->validation->loadRuleGroup($rules);
+            [$rules, $customErrors] = $this->validation->loadRuleGroup($rules);
+
+            $this->validationMessages = $this->validationMessages + $customErrors;
         }
 
         if (isset($options['except'])) {
@@ -1711,7 +1724,7 @@ protected function transformDataToArray($data, string $type): array
      *
      * @param string $name Name
      *
-     * @return mixed
+     * @return array|bool|float|int|object|string|null
      */
     public function __get(string $name)
     {

system/CLI/BaseCommand.php

@@ -11,6 +11,7 @@
 
 namespace CodeIgniter\CLI;
 
+use Config\Exceptions;
 use Psr\Log\LoggerInterface;
 use ReflectionException;
 use Throwable;
@@ -121,7 +122,7 @@ protected function showError(Throwable $e)
     {
         $exception = $e;
         $message   = $e->getMessage();
-        $config    = config('Exceptions');
+        $config    = config(Exceptions::class);
 
         require $config->errorViewPath . '/cli/error_exception.php';
     }

system/CLI/CLI.php

@@ -520,7 +520,7 @@ public static function wait(int $seconds, bool $countdown = false)
     /**
      * if operating system === windows
      *
-     * @deprecated v4.3 Use `is_windows()` instead
+     * @deprecated 4.3.0 Use `is_windows()` instead
      */
     public static function isWindows(): bool
     {

system/CLI/GeneratorTrait.php

@@ -11,6 +11,7 @@
 
 namespace CodeIgniter\CLI;
 
+use Config\Generators;
 use Config\Services;
 use Throwable;
 
@@ -267,7 +268,7 @@ protected function qualifyClassName(): string
     protected function renderTemplate(array $data = []): string
     {
         try {
-            return view(config('Generators')->views[$this->name], $data, ['debug' => false]);
+            return view(config(Generators::class)->views[$this->name], $data, ['debug' => false]);
         } catch (Throwable $e) {
             log_message('error', (string) $e);
 

system/Cache/Handlers/BaseHandler.php

@@ -13,6 +13,7 @@
 
 use Closure;
 use CodeIgniter\Cache\CacheInterface;
+use Config\Cache;
 use Exception;
 use InvalidArgumentException;
 
@@ -61,7 +62,7 @@ public static function validateKey($key, $prefix = ''): string
             throw new InvalidArgumentException('Cache key cannot be empty.');
         }
 
-        $reserved = config('Cache')->reservedCharacters ?? self::RESERVED_CHARACTERS;
+        $reserved = config(Cache::class)->reservedCharacters ?? self::RESERVED_CHARACTERS;
         if ($reserved && strpbrk($key, $reserved) !== false) {
             throw new InvalidArgumentException('Cache key contains reserved characters ' . $reserved);
         }