malhuda/CodeIgniter4
1
0
Fork 0
mirror of https://github.com/codeigniter4/CodeIgniter4.git synced 2025-02-20 11:44:28 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #8604 from kenjis/feat-add-Boot-class

Browse Source 
feat: add Boot class
This commit is contained in:
kenjis 2024-03-27 06:17:43 +09:00 committed by GitHub
commit 39210beb13
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 276 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
public/index.php
View File

@ -14,7 +14,10 @@ if (version_compare(PHP_VERSION, $minPhpVersion, '<')) {
PHP_VERSION
);
exit($message);
header('HTTP/1.1 503 Service Unavailable.', true, 503);
echo $message;
exit(1);
}
/*
@ -47,30 +50,9 @@ require FCPATH . '../app/Config/Paths.php';
$paths = new Config\Paths();
// LOAD DOTENV FILE
// Load environment settings from .env files into $_SERVER and $_ENV
require_once $paths->systemDirectory . '/Config/DotEnv.php';
(new CodeIgniter\Config\DotEnv($paths->appDirectory . '/../'))->load();
// DEFINE ENVIRONMENT
if (! defined('ENVIRONMENT')) {
$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';
require $paths->systemDirectory . '/Boot.php';
CodeIgniter\Boot::BootWeb($paths);
// Load Config Cache
// $factoriesCache = new \CodeIgniter\Cache\FactoriesCache();

34
spark
View File

@ -16,9 +16,12 @@
* --------------------------------------------------------------------
* The main entry point into the CLI system and allows you to run
* commands and perform maintenance on your application.
*
* Because CodeIgniter can handle CLI requests as just another web request
* this class mainly acts as a passthru to the framework itself.
*/
/*
*---------------------------------------------------------------
* CHECK SERVER API
*---------------------------------------------------------------
*/
// Refuse to run when called from php-cgi
@ -75,30 +78,9 @@ require FCPATH . '../app/Config/Paths.php';
$paths = new Config\Paths();
// LOAD DOTENV FILE
// Load environment settings from .env files into $_SERVER and $_ENV
require_once $paths->systemDirectory . '/Config/DotEnv.php';
(new CodeIgniter\Config\DotEnv($paths->appDirectory . '/../'))->load();
// DEFINE ENVIRONMENT
if (! defined('ENVIRONMENT')) {
$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';
require $paths->systemDirectory . '/Boot.php';
CodeIgniter\Boot::BootSpark($paths);
/*
* ---------------------------------------------------------------

237
system/Boot.php Normal file
View File

@ -0,0 +1,237 @@
<?php
declare(strict_types=1);
/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace CodeIgniter;
use CodeIgniter\Config\DotEnv;
use Config\Autoload;
use Config\Modules;
use Config\Paths;
use Config\Services;
/**
* Bootstrap for the application
*
* @codeCoverageIgnore
*/
class Boot
{
/**
* Used by `public/index.php`
*
* Context
* web: Invoked by HTTP request
* php-cli: Invoked by CLI via `php public/index.php`
*/
public static function bootWeb(Paths $paths): void
{
static::boot($paths);
}
/**
* Used by `spark`
*/
public static function bootSpark(Paths $paths): void
{
static::boot($paths);
}
protected static function boot(Paths $paths): void
{
static::definePathConstants($paths);
if (! defined('APP_NAMESPACE')) {
static::loadConstants();
}
static::checkMissingExtensions();
static::loadDotEnv($paths);
static::defineEnvironment();
static::loadEnvironmentBootstrap($paths);
static::loadCommonFunctions();
static::loadAutoloader();
static::setExceptionHandler();
static::initializeKint();
}
/**
* Used by `system/Test/bootstrap.php`
*/
public static function bootTest(Paths $paths): void
{
static::loadConstants();
static::checkMissingExtensions();
static::loadDotEnv($paths);
static::loadEnvironmentBootstrap($paths, false);
static::loadCommonFunctions();
static::loadAutoloader();
static::setExceptionHandler();
static::initializeKint();
}
/**
* Load environment settings from .env files into $_SERVER and $_ENV
*/
protected static function loadDotEnv(Paths $paths): void
{
require_once $paths->systemDirectory . '/Config/DotEnv.php';
(new DotEnv($paths->appDirectory . '/../'))->load();
}
protected static function defineEnvironment(): void
{
if (! defined('ENVIRONMENT')) {
// @phpstan-ignore-next-line
$env = $_ENV['CI_ENVIRONMENT'] ?? $_SERVER['CI_ENVIRONMENT']
?? getenv('CI_ENVIRONMENT')
?: 'production';
define('ENVIRONMENT', $env);
}
}
protected static function loadEnvironmentBootstrap(Paths $paths, bool $exit = true): void
{
if (is_file($paths->appDirectory . '/Config/Boot/' . ENVIRONMENT . '.php')) {
require_once $paths->appDirectory . '/Config/Boot/' . ENVIRONMENT . '.php';
return;
}
if ($exit) {
header('HTTP/1.1 503 Service Unavailable.', true, 503);
echo 'The application environment is not set correctly.';
exit(EXIT_ERROR);
}
}
/**
* The path constants provide convenient access to the folders throughout
* the application. We have to set them up here, so they are available in
* the config files that are loaded.
*/
protected static function definePathConstants(Paths $paths): void
{
// The path to the application directory.
if (! defined('APPPATH')) {
define('APPPATH', realpath(rtrim($paths->appDirectory, '\\/ ')) . DIRECTORY_SEPARATOR);
}
// The path to the project root directory. Just above APPPATH.
if (! defined('ROOTPATH')) {
define('ROOTPATH', realpath(APPPATH . '../') . DIRECTORY_SEPARATOR);
}
// The path to the system directory.
if (! defined('SYSTEMPATH')) {
define('SYSTEMPATH', realpath(rtrim($paths->systemDirectory, '\\/ ')) . DIRECTORY_SEPARATOR);
}
// The path to the writable directory.
if (! defined('WRITEPATH')) {
define('WRITEPATH', realpath(rtrim($paths->writableDirectory, '\\/ ')) . DIRECTORY_SEPARATOR);
}
// The path to the tests directory
if (! defined('TESTPATH')) {
define('TESTPATH', realpath(rtrim($paths->testsDirectory, '\\/ ')) . DIRECTORY_SEPARATOR);
}
}
protected static function loadConstants(): void
{
require_once APPPATH . 'Config/Constants.php';
}
protected static function loadCommonFunctions(): void
{
// Require app/Common.php file if exists.
if (is_file(APPPATH . 'Common.php')) {
require_once APPPATH . 'Common.php';
}
// Require system/Common.php
require_once SYSTEMPATH . 'Common.php';
}
/**
* The autoloader allows all the pieces to work together in the framework.
* We have to load it here, though, so that the config files can use the
* path constants.
*/
protected static function loadAutoloader(): void
{
if (! class_exists(Autoload::class, false)) {
require_once SYSTEMPATH . 'Config/AutoloadConfig.php';
require_once APPPATH . 'Config/Autoload.php';
require_once SYSTEMPATH . 'Modules/Modules.php';
require_once APPPATH . 'Config/Modules.php';
}
require_once SYSTEMPATH . 'Autoloader/Autoloader.php';
require_once SYSTEMPATH . 'Config/BaseService.php';
require_once SYSTEMPATH . 'Config/Services.php';
require_once APPPATH . 'Config/Services.php';
// Initialize and register the loader with the SPL autoloader stack.
Services::autoloader()->initialize(new Autoload(), new Modules())->register();
Services::autoloader()->loadHelpers();
}
protected static function setExceptionHandler(): void
{
Services::exceptions()->initialize();
}
protected static function checkMissingExtensions(): void
{
if (is_file(COMPOSER_PATH)) {
return;
}
// Run this check for manual installations
$missingExtensions = [];
foreach ([
'intl',
'json',
'mbstring',
] as $extension) {
if (! extension_loaded($extension)) {
$missingExtensions[] = $extension;
}
}
if ($missingExtensions === []) {
return;
}
$message = sprintf(
'The framework needs the following extension(s) installed and loaded: %s.',
implode(', ', $missingExtensions)
);
header('HTTP/1.1 503 Service Unavailable.', true, 503);
echo $message;
exit(EXIT_ERROR);
}
protected static function initializeKint(): void
{
Services::autoloader()->initializeKint(CI_DEBUG);
}
}

2
system/Exceptions/FrameworkException.php
View File

@ -59,6 +59,8 @@ class FrameworkException extends RuntimeException implements ExceptionInterface
/**
* @return static
*
* @deprecated 4.5.0 No longer used.
*/
public static function forMissingExtension(string $extension)
{

86
system/Test/bootstrap.php
View File

@ -11,9 +11,7 @@ declare(strict_types=1);
* the LICENSE file that was distributed with this source code.
*/
use CodeIgniter\Config\DotEnv;
use Config\Autoload;
use Config\Modules;
use CodeIgniter\Boot;
use Config\Paths;
use Config\Services;
@ -80,85 +78,9 @@ defined('VENDORPATH') || define('VENDORPATH', realpath(HOMEPATH . 'vendor') .
* and fires up an environment-specific bootstrapping.
*/
// LOAD DOTENV FILE
// Load environment settings from .env files into $_SERVER and $_ENV
require_once $paths->systemDirectory . '/Config/DotEnv.php';
(new DotEnv($paths->appDirectory . '/../'))->load();
/*
* ---------------------------------------------------------------
* LOAD ENVIRONMENT BOOTSTRAP
* ---------------------------------------------------------------
*
* Load any custom boot files based upon the current environment.
* If no boot file exists, we shouldn't continue because something
* is wrong. At the very least, they should have error reporting setup.
*/
if (is_file(APPPATH . 'Config/Boot/' . ENVIRONMENT . '.php')) {
require_once APPPATH . 'Config/Boot/' . ENVIRONMENT . '.php';
}
/*
* ---------------------------------------------------------------
* GRAB OUR CONSTANTS
* ---------------------------------------------------------------
*/
require_once APPPATH . 'Config/Constants.php';
/*
* ---------------------------------------------------------------
* LOAD COMMON FUNCTIONS
* ---------------------------------------------------------------
*/
// Load Common.php from App then System
if (is_file(APPPATH . 'Common.php')) {
require_once APPPATH . 'Common.php';
}
require_once SYSTEMPATH . 'Common.php';
/*
* ---------------------------------------------------------------
* LOAD OUR AUTOLOADER
* ---------------------------------------------------------------
*
* The autoloader allows all of the pieces to work together in the
* framework. We have to load it here, though, so that the config
* files can use the path constants.
*/
require_once SYSTEMPATH . 'Config/AutoloadConfig.php';
require_once APPPATH . 'Config/Autoload.php';
require_once SYSTEMPATH . 'Modules/Modules.php';
require_once APPPATH . 'Config/Modules.php';
require_once SYSTEMPATH . 'Autoloader/Autoloader.php';
require_once SYSTEMPATH . 'Config/BaseService.php';
require_once SYSTEMPATH . 'Config/Services.php';
require_once APPPATH . 'Config/Services.php';
// Initialize and register the loader with the SPL autoloader stack.
Services::autoloader()->initialize(new Autoload(), new Modules())->register();
Services::autoloader()->loadHelpers();
/*
* ---------------------------------------------------------------
* SET EXCEPTION AND ERROR HANDLERS
* ---------------------------------------------------------------
*/
Services::exceptions()->initialize();
/*
* ---------------------------------------------------------------
* INITIALIZE KINT
* ---------------------------------------------------------------
*/
Services::autoloader()->initializeKint(CI_DEBUG);
// LOAD THE FRAMEWORK BOOTSTRAP FILE
require $paths->systemDirectory . '/Boot.php';
Boot::bootTest($paths);
/*
* ---------------------------------------------------------------

15
system/bootstrap.php
View File

@ -11,12 +11,25 @@ declare(strict_types=1);
* the LICENSE file that was distributed with this source code.
*/
/**
* ---------------------------------------------------------------
* This file cannot be used. The code has moved to Boot.php.
* ---------------------------------------------------------------
*/
use CodeIgniter\Exceptions\FrameworkException;
use Config\Autoload;
use Config\Modules;
use Config\Paths;
use Config\Services;
header('HTTP/1.1 503 Service Unavailable.', true, 503);
$message = 'This "system/bootstrap.php" is no longer used. If you are seeing this error message,
the upgrade is not complete. Please refer to the upgrade guide and complete the upgrade.
See https://codeigniter4.github.io/userguide/installation/upgrade_450.html' . PHP_EOL;
echo $message;
/*
* ---------------------------------------------------------------
* SETUP OUR PATH CONSTANTS
@ -146,3 +159,5 @@ if (! is_file(COMPOSER_PATH)) {
*/
Services::autoloader()->initializeKint(CI_DEBUG);
exit(1);

4
user_guide_src/source/changelogs/v4.5.0.rst
View File

@ -190,6 +190,8 @@ Others
- **Web Page Caching:** ``ResponseCache`` has been improved to include the request
HTTP method in the cache key. This means that the same URI will be cached separately
if the HTTP method is different.
- **Bootstrap:** The ``CodeIgniter\Boot`` class has been introduced, replacing
**system/bootstrap.php**.
********
BREAKING
@ -254,6 +256,8 @@ Others
- **BaseModel:** The ``getIdValue()`` method has been changed to ``abstract``.
- **Routing:** The :ref:`404-override` feature does change the Response status
code to 404 by default. See :ref:`Upgrading Guide <upgrade-450-404-override>`.
- **system/bootstrap.php:** This file cannot be used. The code has been moved to
the new ``CodeIgniter\Boot`` class.
Interface Changes
=================