Creating Core System Classes

Every time CodeIgniter runs there are several base classes that are initialized automatically as part of the coreframework. It is possible, however, to swap any of the core system classes with your own version or even just extendthe core versions.

Most users will never have any need to do this, but the option to replace or extend them does exist for thosewho would like to significantly alter the CodeIgniter core.

Note

Messing with a core system class has a lot of implications, so make sure you know what you are doing beforeattempting it.

System Class List

The following is a list of the core system files that are invoked every time CodeIgniter runs:

  • Config\Services
  • CodeIgniter\Autoloader\Autoloader
  • CodeIgniter\Config\DotEnv
  • CodeIgniter\Controller
  • CodeIgniter\Debug\Exceptions
  • CodeIgniter\Debug\Timer
  • CodeIgniter\Events\Events
  • CodeIgniter\HTTP\CLIRequest (if launched from command line only)
  • CodeIgniter\HTTP\IncomingRequest (if launched over HTTP)
  • CodeIgniter\HTTP\Request
  • CodeIgniter\HTTP\Response
  • CodeIgniter\HTTP\Message
  • CodeIgniter\HTTP\URI
  • CodeIgniter\Log\Logger
  • CodeIgniter\Log\Handlers\BaseHandler
  • CodeIgniter\Log\Handlers\FileHandler
  • CodeIgniter\Router\RouteCollection
  • CodeIgniter\Router\Router
  • CodeIgniter\Security\Security
  • CodeIgniter\View\View
  • CodeIgniter\View\Escaper

Replacing Core Classes

To use one of your own system classes instead of a default one, ensure that the Autoloadercan find your class, that your new class extends the appropriate interface, and modify the appropriateService to load your class in place of the core class.

For example, if you have a new App\Libraries\RouteCollection class that you would like to use in place ofthe core system class, you would create your class like this:

  1. <?php namespace App\Libraries;
  2.  
  3. use CodeIgniter\Router\RouteCollectionInterface;
  4.  
  5. class RouteCollection implements RouteCollectionInterface
  6. {
  7.  
  8. }

Then you would modify the routes service to load your class instead:

  1. public static function routes(bool $getShared = true)
  2. {
  3.         if ($getShared)
  4.         {
  5.                 return static::getSharedInstance('routes');
  6.         }
  7.  
  8.         return new RouteCollection(static::locator(), config('Modules'));
  9. }

Extending Core Classes

If all you need to is add some functionality to an existing library - perhaps add a method or two - then it’s overkillto recreate the entire library. In this case, it’s better to simply extend the class. Extending the class is nearlyidentical to replacing a class with one exception:

  • The class declaration must extend the parent class.

For example, to extend the native RouteCollection class, you would declare your class with:

  1. <?php namespace App\Libraries;
  2.  
  3. use CodeIgniter\Router\RouteCollection;
  4.  
  5. class RouteCollection extends RouteCollection
  6. {
  7.  
  8. }

If you need to use a constructor in your class make sure you extend the parent constructor:

  1. <?php namespace App\Libraries;
  2.  
  3. use CodeIgniter\Router\RouteCollection;
  4.  
  5. class RouteCollection extends RouteCollection
  6. {
  7.      public function __construct()
  8.      {
  9.          parent::__construct();
  10.      }
  11.  }

Tip: Any functions in your class that are named identically to the methods in the parent class will be usedinstead of the native ones (this is known as “method overriding”). This allows you to substantially alter the CodeIgniter core.