Where should I require vendor/autoload.php in CodeIgniter?

Question

I want to add some code that will run for every controller. Adding the code to CodeIgniter's CI_CONTROLLER class seems unconventional.

Where is the right place to include code you want to run for every controller?

Here is the code:

require_once 'vendor/autoload.php';

$bugsnag = Bugsnag\Client::make("my-secret-key-is-here");
Bugsnag\Handler::register($bugsnag);

These classes both come from a dependency installed with Composer.

I suspect I should create a helper, and include it in application/config/autoload.php. But new to CodeIgniter, so not sure of conventions.

Edit: I am using CodeIgniter 3.1.6.

Answer 1

If you want to execute arbitrary code at different points in CodeIgniter's life cycle, you can use the hooks feature.

Official Documentation: https://codeigniter.com/user_guide/general/hooks.html

1. Enable hooks

• Go to /application/config/config.php.
• Search for enable_hooks and set it to true: $config['enable_hooks'] = TRUE;

2. Add desired code to CodeIgniter's hook file:

• Go to /application/config/hooks.php.

• Choose the desired lifecycle to hook into (see doc link above for a list)

• Add code to the lifecycle, e.g. $hook['pre_controller'] = function(){... your code goes here ...}

For this question's example, my hooks.php looks like this:

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

// This is the code I added:
$hook['pre_system'] = function(){
  require_once 'vendor/autoload.php';

  $bugsnag = Bugsnag\Client::make("my-client-key");
  Bugsnag\Handler::register($bugsnag);
}

?>

Answer 2

I would just extend the Controller Class.

See "Extending Core Class":

"If all you need to do is add some functionality to an existing library - perhaps add a method or two - then it’s overkill to replace the entire library with your version. In this case it’s better to simply extend the class."

...

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

class MY_Controller extends CI_Controller {

    ....

}

Any function you put inside would be added to the core, otherwise, if you use the same name as an existing method, it would replace just that one method.

You'd name it MY_Controller.php and put it inside application/core/, where it's picked up to override CI_Controller automatically.

If you are extending the Controller core class, then be sure to extend your new class in your application controller’s constructors.

class Welcome extends MY_Controller {

        public function __construct()
        {
                parent::__construct();
                // Your own constructor code
        }

        public function index()
        {
                $this->load->view('welcome_message');
        }
}

---

Looks like you could also use a pre_system or pre_controller hook as described here:

https://www.codeigniter.com/user_guide/general/hooks.html

Answer 3

Go to application/config/config.php and set $config['composer_autoload'] = FALSE; to TRUE:

Enabling this setting will tell CodeIgniter to look for a Composer package auto-loader script in application/vendor/autoload.php.

As a result you need not to call require_once 'vendor/autoload.php';.

Answer 4

Assuming it's CodeIgnitor 3.X Go to application/config/config.php and change:

$config['composer_autoload'] = FALSE;

to

$config['composer_autoload'] = TRUE;

just below the above line include

require_once APPPATH.'vendor/autoload.php';

Or in your controller include

require_once APPPATH.'vendor/autoload.php';

From How to use composer packages in codeigniter?