fix: move Kint loading to Autoloader

.github/workflows/test-phpcpd.yml

@@ -57,4 +57,5 @@ jobs:
             --exclude system/Debug/Exceptions.php
             --exclude system/HTTP/SiteURI.php
             --exclude system/Validation/Rules.php
+            --exclude system/Autoloader/Autoloader.php
             -- app/ public/ system/

public/index.php

@@ -1,6 +1,11 @@
 <?php
 
-// Check PHP version.
+/*
+ *---------------------------------------------------------------
+ * CHECK PHP VERSION
+ *---------------------------------------------------------------
+ */
+
 $minPhpVersion = '8.1'; // If you update this, don't forget to update `spark`.
 if (version_compare(PHP_VERSION, $minPhpVersion, '<')) {
     $message = sprintf(
@@ -12,6 +17,12 @@
     exit($message);
 }
 
+/*
+ *---------------------------------------------------------------
+ * SET THE CURRENT DIRECTORY
+ *---------------------------------------------------------------
+ */
+
 // Path to the front controller (this file)
 define('FCPATH', __DIR__ . DIRECTORY_SEPARATOR);
 
@@ -29,25 +40,38 @@
  * and fires up an environment-specific bootstrapping.
  */
 
-// Load our paths config file
+// LOAD OUR PATHS CONFIG FILE
 // This is the line that might need to be changed, depending on your folder structure.
 require FCPATH . '../app/Config/Paths.php';
 // ^^^ Change this line if you move your application folder
 
 $paths = new Config\Paths();
 
-// Location of the framework bootstrap file.
-require rtrim($paths->systemDirectory, '\\/ ') . DIRECTORY_SEPARATOR . 'bootstrap.php';
-
+// LOAD DOTENV FILE
 // Load environment settings from .env files into $_SERVER and $_ENV
-require_once SYSTEMPATH . 'Config/DotEnv.php';
-(new CodeIgniter\Config\DotEnv(ROOTPATH))->load();
+require_once $paths->systemDirectory . '/Config/DotEnv.php';
+(new CodeIgniter\Config\DotEnv($paths->appDirectory . '/../'))->load();
 
-// Define ENVIRONMENT
+// DEFINE ENVIRONMENT
 if (! defined('ENVIRONMENT')) {
-    define('ENVIRONMENT', env('CI_ENVIRONMENT', 'production'));
+    $env = $_ENV['CI_ENVIRONMENT'] ?? $_SERVER['CI_ENVIRONMENT'] ?? getenv('CI_ENVIRONMENT');
+    define('ENVIRONMENT', ($env !== false) ? $env : 'production');
+    unset($env);
+}
+
+// LOAD ENVIRONMENT BOOTSTRAP
+if (is_file($paths->appDirectory . '/Config/Boot/' . ENVIRONMENT . '.php')) {
+    require_once $paths->appDirectory . '/Config/Boot/' . ENVIRONMENT . '.php';
+} else {
+    header('HTTP/1.1 503 Service Unavailable.', true, 503);
+    echo 'The application environment is not set correctly.';
+
+    exit(EXIT_ERROR); // EXIT_ERROR
 }
 
+// LOAD THE FRAMEWORK BOOTSTRAP FILE
+require rtrim($paths->systemDirectory, '\\/ ') . DIRECTORY_SEPARATOR . 'bootstrap.php';
+
 // Load Config Cache
 // $factoriesCache = new \CodeIgniter\Cache\FactoriesCache();
 // $factoriesCache->load('config');

spark

@@ -12,7 +12,7 @@
 
 /*
  * --------------------------------------------------------------------
- * CodeIgniter command-line tools
+ * CODEIGNITER COMMAND-LINE TOOLS
  * --------------------------------------------------------------------
  * The main entry point into the CLI system and allows you to run
  * commands and perform maintenance on your application.
@@ -26,7 +26,12 @@ if (strpos(PHP_SAPI, 'cgi') === 0) {
     exit("The cli tool is not supported when running php-cgi. It needs php-cli to function!\n\n");
 }
 
-// Check PHP version.
+/*
+ *---------------------------------------------------------------
+ * CHECK PHP VERSION
+ *---------------------------------------------------------------
+ */
+
 $minPhpVersion = '8.1'; // If you update this, don't forget to update `public/index.php`.
 if (version_compare(PHP_VERSION, $minPhpVersion, '<')) {
     $message = sprintf(
@@ -42,6 +47,12 @@ if (version_compare(PHP_VERSION, $minPhpVersion, '<')) {
 error_reporting(E_ALL);
 ini_set('display_errors', '1');
 
+/*
+ *---------------------------------------------------------------
+ * SET THE CURRENT DIRECTORY
+ *---------------------------------------------------------------
+ */
+
 // Path to the front controller
 define('FCPATH', __DIR__ . DIRECTORY_SEPARATOR . 'public' . DIRECTORY_SEPARATOR);
 
@@ -57,32 +68,56 @@ chdir(FCPATH);
  * and fires up an environment-specific bootstrapping.
  */
 
-// Load our paths config file
+// LOAD OUR PATHS CONFIG FILE
 // This is the line that might need to be changed, depending on your folder structure.
 require FCPATH . '../app/Config/Paths.php';
 // ^^^ Change this line if you move your application folder
 
 $paths = new Config\Paths();
 
-// Location of the framework bootstrap file.
-require rtrim($paths->systemDirectory, '\\/ ') . DIRECTORY_SEPARATOR . 'bootstrap.php';
-
+// LOAD DOTENV FILE
 // Load environment settings from .env files into $_SERVER and $_ENV
-require_once SYSTEMPATH . 'Config/DotEnv.php';
-(new CodeIgniter\Config\DotEnv(ROOTPATH))->load();
+require_once $paths->systemDirectory . '/Config/DotEnv.php';
+(new CodeIgniter\Config\DotEnv($paths->appDirectory . '/../'))->load();
 
-// Define ENVIRONMENT
+// DEFINE ENVIRONMENT
 if (! defined('ENVIRONMENT')) {
-    define('ENVIRONMENT', env('CI_ENVIRONMENT', 'production'));
+    $env = $_ENV['CI_ENVIRONMENT'] ?? $_SERVER['CI_ENVIRONMENT'] ?? getenv('CI_ENVIRONMENT');
+    define('ENVIRONMENT', ($env !== false) ? $env : 'production');
+    unset($env);
+}
+
+// LOAD ENVIRONMENT BOOTSTRAP
+if (is_file($paths->appDirectory . '/Config/Boot/' . ENVIRONMENT . '.php')) {
+    require_once $paths->appDirectory . '/Config/Boot/' . ENVIRONMENT . '.php';
+} else {
+    header('HTTP/1.1 503 Service Unavailable.', true, 503);
+    echo 'The application environment is not set correctly.';
+
+    exit(EXIT_ERROR); // EXIT_ERROR
 }
 
-// Grab our CodeIgniter
+// LOAD THE FRAMEWORK BOOTSTRAP FILE
+require rtrim($paths->systemDirectory, '\\/ ') . DIRECTORY_SEPARATOR . 'bootstrap.php';
+
+/*
+ * ---------------------------------------------------------------
+ * GRAB OUR CODEIGNITER INSTANCE
+ * ---------------------------------------------------------------
+ */
+
 $app = Config\Services::codeigniter();
 $app->initialize();
 
-// Grab our Console
+/*
+ * ---------------------------------------------------------------
+ * GRAB OUR CONSOLE
+ * ---------------------------------------------------------------
+ */
+
 $console = new CodeIgniter\CLI\Console();
 
+// SHOW HEADER
 // Show basic information before we do anything else.
 if (is_int($suppress = array_search('--no-header', $_SERVER['argv'], true))) {
     unset($_SERVER['argv'][$suppress]); // @codeCoverageIgnore
@@ -91,6 +126,12 @@ if (is_int($suppress = array_search('--no-header', $_SERVER['argv'], true))) {
 
 $console->showHeader($suppress);
 
+/*
+ *---------------------------------------------------------------
+ * EXECUTE THE COMMAND
+ *---------------------------------------------------------------
+ */
+
 // fire off the command in the main framework.
 $exit = $console->run();
 

system/Autoloader/Autoloader.php

@@ -17,8 +17,13 @@
 use Composer\Autoload\ClassLoader;
 use Composer\InstalledVersions;
 use Config\Autoload;
+use Config\Kint as KintConfig;
 use Config\Modules;
+use Config\Services;
 use InvalidArgumentException;
+use Kint;
+use Kint\Renderer\CliRenderer;
+use Kint\Renderer\RichRenderer;
 use RuntimeException;
 
 /**
@@ -481,4 +486,76 @@ public function loadHelpers(): void
     {
         helper($this->helpers);
     }
+
+    /**
+     * Initializes Kint
+     */
+    public function initializeKint(bool $debug = false): void
+    {
+        if ($debug) {
+            $this->autoloadKint();
+            $this->configureKint();
+        } elseif (class_exists(Kint::class)) {
+            // In case that Kint is already loaded via Composer.
+            Kint::$enabled_mode = false;
+        }
+
+        helper('kint');
+    }
+
+    private function autoloadKint(): void
+    {
+        // If we have KINT_DIR it means it's already loaded via composer
+        if (! defined('KINT_DIR')) {
+            spl_autoload_register(function ($class) {
+                $class = explode('\\', $class);
+
+                if (array_shift($class) !== 'Kint') {
+                    return;
+                }
+
+                $file = SYSTEMPATH . 'ThirdParty/Kint/' . implode('/', $class) . '.php';
+
+                if (is_file($file)) {
+                    require_once $file;
+                }
+            });
+
+            require_once SYSTEMPATH . 'ThirdParty/Kint/init.php';
+        }
+    }
+
+    private function configureKint(): void
+    {
+        $config = new KintConfig();
+
+        Kint::$depth_limit         = $config->maxDepth;
+        Kint::$display_called_from = $config->displayCalledFrom;
+        Kint::$expanded            = $config->expanded;
+
+        if (isset($config->plugins) && is_array($config->plugins)) {
+            Kint::$plugins = $config->plugins;
+        }
+
+        $csp = Services::csp();
+        if ($csp->enabled()) {
+            RichRenderer::$js_nonce  = $csp->getScriptNonce();
+            RichRenderer::$css_nonce = $csp->getStyleNonce();
+        }
+
+        RichRenderer::$theme  = $config->richTheme;
+        RichRenderer::$folder = $config->richFolder;
+        RichRenderer::$sort   = $config->richSort;
+        if (isset($config->richObjectPlugins) && is_array($config->richObjectPlugins)) {
+            RichRenderer::$value_plugins = $config->richObjectPlugins;
+        }
+        if (isset($config->richTabPlugins) && is_array($config->richTabPlugins)) {
+            RichRenderer::$tab_plugins = $config->richTabPlugins;
+        }
+
+        CliRenderer::$cli_colors         = $config->cliColors;
+        CliRenderer::$force_utf8         = $config->cliForceUTF8;
+        CliRenderer::$detect_width       = $config->cliDetectWidth;
+        CliRenderer::$min_terminal_width = $config->cliMinWidth;
+    }
 }

system/CodeIgniter.php

@@ -186,24 +186,11 @@ public function __construct(App $config)
      */
     public function initialize()
     {
-        // Define environment variables
-        $this->bootstrapEnvironment();
-
-        // Setup Exception Handling
-        Services::exceptions()->initialize();
-
-        // Run this check for manual installations
-        if (! is_file(COMPOSER_PATH)) {
-            $this->resolvePlatformExtensions(); // @codeCoverageIgnore
-        }
-
         // Set default locale on the server
         Locale::setDefault($this->config->defaultLocale ?? 'en');
 
         // Set default timezone on the server
         date_default_timezone_set($this->config->appTimezone ?? 'UTC');
-
-        $this->initializeKint();
     }
 
     /**
@@ -214,6 +201,8 @@ public function initialize()
      * @throws FrameworkException
      *
      * @codeCoverageIgnore
+     *
+     * @deprecated 4.5.0 Moved to system/bootstrap.php.
      */
     protected function resolvePlatformExtensions()
     {
@@ -240,6 +229,8 @@ protected function resolvePlatformExtensions()
      * Initializes Kint
      *
      * @return void
+     *
+     * @deprecated 4.5.0 Moved to Autoloader.
      */
     protected function initializeKint()
     {
@@ -255,6 +246,9 @@ protected function initializeKint()
         helper('kint');
     }
 
+    /**
+     * @deprecated 4.5.0 Moved to Autoloader.
+     */
     private function autoloadKint(): void
     {
         // If we have KINT_DIR it means it's already loaded via composer
@@ -277,6 +271,9 @@ private function autoloadKint(): void
         }
     }
 
+    /**
+     * @deprecated 4.5.0 Moved to Autoloader.
+     */
     private function configureKint(): void
     {
         $config = new KintConfig();
@@ -578,6 +575,8 @@ protected function detectEnvironment()
      * is wrong. At the very least, they should have error reporting setup.
      *
      * @return void
+     *
+     * @deprecated 4.5.0 Moved to system/bootstrap.php.
      */
     protected function bootstrapEnvironment()
     {