user_guide/general/core_classes.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   3 <head>
   4
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6 <title>Creating Core System Classes : CodeIgniter User Guide</title>
   7
   8 <style type='text/css' media='all'>@import url('../userguide.css');</style>
   9 <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
  10
  11 <script type="text/javascript" src="../nav/nav.js"></script>
  12 <script type="text/javascript" src="../nav/prototype.lite.js"></script>
  13 <script type="text/javascript" src="../nav/moo.fx.js"></script>
  14 <script type="text/javascript" src="../nav/user_guide_menu.js"></script>
  15
  16 <meta http-equiv='expires' content='-1' />
  17 <meta http-equiv= 'pragma' content='no-cache' />
  18 <meta name='robots' content='all' />
  19 <meta name='author' content='ExpressionEngine Dev Team' />
  20 <meta name='description' content='CodeIgniter User Guide' />
  21
  22 </head>
  23 <body>
  24
  25 <!-- START NAVIGATION -->
  26 <div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
  27 <div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
  28 <div id="masthead">
  29 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
  30 <tr>
  31 <td><h1>CodeIgniter User Guide Version 2.0.2</h1></td>
  32 <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
  33 </tr>
  34 </table>
  35 </div>
  36 <!-- END NAVIGATION -->
  37
  38
  39 <!-- START BREADCRUMB -->
  40 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
  41 <tr>
  42 <td id="breadcrumb">
  43 <a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
  44 <a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
  45 Creating Core System Classes
  46 </td>
  47 <td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
  48 </tr>
  49 </table>
  50 <!-- END BREADCRUMB -->
  51
  52 <br clear="all" />
  53
  54
  55 <!-- START CONTENT -->
  56 <div id="content">
  57
  58 <h1>Creating Core System Classes</h1>
  59
  60 <p>Every time CodeIgniter runs there are several base classes that are initialized automatically as part of the core framework.
  61 It is possible, however, to swap any of the core system classes with your own versions or even extend the core versions.</p>
  62
  63 <p><strong>Most users will never have any need to do this,
  64 but the option to replace or extend them does exist for those who would like to significantly alter the CodeIgniter core.</strong>
  65 </p>
  66
  67 <p class="important"><strong>Note:</strong>&nbsp; Messing with a core system class has a lot of implications, so make sure you
  68 know what you are doing before attempting it.</p>
  69
  70
  71 <h2>System Class List</h2>
  72
  73 <p>The following is a list of the core system files that are invoked every time CodeIgniter runs:</p>
  74
  75 <ul>
  76 <li>Benchmark</li>
  77 <li>Config</li>
  78 <li>Controller</li>
  79 <li>Exceptions</li>
  80 <li>Hooks</li>
  81 <li>Input</li>
  82 <li>Language</li>
  83 <li>Loader</li>
  84 <li>Log</li>
  85 <li>Output</li>
  86 <li>Router</li>
  87 <li>URI</li>
  88 <li>Utf8</li>
  89 </ul>
  90
  91 <h2>Replacing Core Classes</h2>
  92
  93 <p>To use one of your own system classes instead of a default one simply place your version inside your local <dfn>application/core</dfn> directory:</p>
  94
  95 <code>application/core/<dfn>some-class.php</dfn></code>
  96
  97 <p>If this directory does not exist you can create it.</p>
  98
  99 <p>Any file named identically to one from the list above will be used instead of the one normally used.</p>
 100
 101 <p>Please note that your class must use <kbd>CI</kbd> as a prefix. For example, if your file is named <kbd>Input.php</kbd> the class will be named:</p>
 102
 103 <code>
 104 class CI_Input {<br /><br />
 105
 106 }
 107 </code>
 108
 109
 110
 111 <h2>Extending Core Class</h2>
 112
 113 <p>If all you need to do is add some functionality to an existing library - perhaps add a function or two - then
 114 it's overkill to replace the entire library with your version.  In this case it's better to simply extend the class.
 115 Extending a class is nearly identical to replacing a class with a couple exceptions:</p>
 116
 117 <ul>
 118 <li>The class declaration must extend the parent class.</li>
 119 <li>Your new class name and filename must be prefixed with <kbd>MY_</kbd> (this item is configurable.  See below.).</li>
 120 </ul>
 121
 122 <p>For example, to extend the native <kbd>Input</kbd> class you'll create a file named <dfn>application/core/</dfn><kbd>MY_Input.php</kbd>, and declare your class with:</p>
 123
 124 <code>
 125 class MY_Input extends CI_Input {<br /><br />
 126
 127 }</code>
 128
 129 <p>Note: If you need to use a constructor in your class make sure you extend the parent constructor:</p>
 130
 131 <code>
 132 class MY_Input extends CI_Input {<br />
 133 <br />
 134 &nbsp;&nbsp;&nbsp;&nbsp;function __construct()<br />
 135 &nbsp;&nbsp;&nbsp;&nbsp;{<br />
 136 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;parent::__construct();<br />
 137 &nbsp;&nbsp;&nbsp;&nbsp;}<br />
 138 }</code>
 139
 140 <p class="important"><strong>Tip:</strong>&nbsp; Any functions in your class that are named identically to the functions in the parent class will be used instead of the native ones
 141 (this is known as "method overriding").
 142 This allows you to substantially alter the CodeIgniter core.</p>
 143
 144 <p>If you are extending the Controller core class, then be sure to extend your new class in your application controller's constructors.</p>
 145
 146 <code>class Welcome extends MY_Controller {<br />
 147 <br />
 148 &nbsp;&nbsp;&nbsp;&nbsp;function __construct()<br />
 149 &nbsp;&nbsp;&nbsp;&nbsp;{<br />
 150 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;parent::__construct();<br />
 151 &nbsp;&nbsp;&nbsp;&nbsp;}<br />
 152 <br />
 153 &nbsp;&nbsp;&nbsp;&nbsp;function index()<br />
 154 &nbsp;&nbsp;&nbsp;&nbsp;{<br />
 155 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;$this->load->view('welcome_message');<br />
 156 &nbsp;&nbsp;&nbsp;&nbsp;}<br />
 157 }</code>
 158
 159 <h3>Setting Your Own Prefix</h3>
 160
 161 <p>To set your own sub-class prefix, open your <dfn>application/config/config.php</dfn> file and look for this item:</p>
 162
 163 <code>$config['subclass_prefix'] = 'MY_';</code>
 164
 165 <p>Please note that all native CodeIgniter libraries are prefixed with <kbd>CI_</kbd> so DO NOT use that as your prefix.</p>
 166
 167
 168
 169
 170 </div>
 171 <!-- END CONTENT -->
 172
 173
 174 <div id="footer">
 175 <p>
 176 Previous Topic:&nbsp;&nbsp;<a href="creating_libraries.html">Creating Your Own Libraries</a>
 177 &nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 178 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 179 <a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 180 Next Topic:&nbsp;&nbsp;<a href="hooks.html">Hooks - Extending the Core</a>
 181 </p>
 182 <p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
 183 </div>
 184
 185 </body>
 186 </html>