Where to place global functions in codeigniter

Question

I have created a few utility functions like one h() that acts as echo htmlentities($var) . I want theses functions to be available everywhere . so where do i put it.

Answer 1

As @david barker said, you might use an helper. Create a file named, for example, "site_helper", that contains all the functions.

be aware you need to check if the function already exists, though, or you'll get an "function already declared" error.

So, something like:

file site_helper.php (in application/helpers/ )

if(!function_exists('h'))
{
  function h($value)
  {
   return htmlentities($value);
  }
}

if(!functin_exists('other_function')
//....etc.

And then you can autoload it in config/autoload.php:

$autoload['helpers'] = array('site');

^-- note how you only use the part before the underscore to call the file. Also, helpers are not classes, but a collection of functions.

Answer 2

This is exactly what Helpers are for.

Create a new helper (remember to append it with _helper.php) and put it in your helper folder.

You can either auto load it in your config (so you can use it anywhere), or just manually load it when needed.

Answer 3

You should include your global variables file in your /application/config/constants.php file. Then move your global function file to /application/helpers folder. Then you should autoload the global functions file. /application/config/autoload.php

$autoload['helpers'] = array('your-global-function-file.php');

I would suggest not moving anything inside of the system folder project, as upgrading would be an absolute nightmare. Sometimes refactoring your code to conform to CI logic, maybe faster in the long run rather than trying to copy/paste stuff all over the place.

Answer 4

Use codeigniter-kint and a custom file for global Functions. This will give you a more helpful and beautiful Output like:

File: application/helpers/globalfunctions_helper.php

<?php
    /**
     * @file Global Helper Functions
     * 
     */

    if(!function_exists('pr'))
    {
      function pr($value=false){
       $CI = get_instance();
       $CI->load->library('kint');
       return @Kint::dump($value);   
      }
    }
    if(!function_exists('dp')){
      function dp($value=false)
      {
       $CI = get_instance();
       $CI->load->library('kint');
       Kint::dump($value);
       die();
      }
    }

See also: http://raveren.github.io/kint/