| Derek Allard | 2067d1a | 2008-11-13 22:59:24 +0000 | [diff] [blame] | 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>Loader Class : 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> |
| Derek Jones | bbedc76 | 2009-09-11 14:47:37 +0000 | [diff] [blame] | 31 | <td><h1>CodeIgniter User Guide Version 1.7.2</h1></td> |
| Derek Allard | 2067d1a | 2008-11-13 22:59:24 +0000 | [diff] [blame] | 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> › |
| 44 | <a href="../index.html">User Guide Home</a> › |
| 45 | Loader Class |
| 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 <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <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 | |
| 59 | <h1>Loader Class</h1> |
| 60 | |
| 61 | <p>Loader, as the name suggests, is used to load elements. These elements can be libraries (classes) <a href="../general/views.html">View files</a>, |
| 62 | <a href="../general/helpers.html">Helpers</a>, <a href="../general/plugins.html">Plugins</a>, or your own files.</p> |
| 63 | |
| 64 | <p class="important"><strong>Note:</strong> This class is initialized automatically by the system so there is no need to do it manually.</p> |
| 65 | |
| 66 | <p>The following functions are available in this class:</p> |
| 67 | |
| 68 | |
| 69 | <h2>$this->load->library('<var>class_name</var>', <samp>$config</samp>, <kbd>'object name'</kbd>)</h2> |
| 70 | |
| 71 | |
| 72 | <p>This function is used to load core classes. Where <var>class_name</var> is the name of the class you want to load. |
| 73 | Note: We use the terms "class" and "library" interchangeably.</p> |
| 74 | |
| 75 | <p>For example, if you would like to send email with CodeIgniter, the first step is to load the email class within your controller:</p> |
| 76 | |
| 77 | <code>$this->load->library('email');</code> |
| 78 | |
| 79 | <p>Once loaded, the library will be ready for use, using <kbd>$this->email-></kbd><samp><em>some_function</em>()</samp>. |
| 80 | |
| 81 | <p>Library files can be stored in subdirectories within the main "libraries" folder, or within your personal <dfn>application/libraries</dfn> folder. |
| 82 | To load a file located in a subdirectory, simply include the path, relative to the "libraries" folder. |
| 83 | For example, if you have file located at:</p> |
| 84 | |
| 85 | <code>libraries/flavors/chocolate.php</code> |
| 86 | |
| 87 | <p>You will load it using:</p> |
| 88 | |
| 89 | <code>$this->load->library('flavors/chocolate');</code> |
| 90 | |
| 91 | <p>You may nest the file in as many subdirectories as you want.</p> |
| 92 | |
| 93 | <h3>Setting options</h3> |
| 94 | |
| 95 | <p>The second (optional) parameter allows you to optionally pass configuration setting. You will typically pass these as an array:</p> |
| 96 | |
| 97 | <code> |
| 98 | $config = array (<br /> |
| 99 | 'mailtype' => 'html',<br /> |
| 100 | 'charset' => 'utf-8,<br /> |
| 101 | 'priority' => '1'<br /> |
| 102 | );<br /> |
| 103 | <br /> |
| 104 | $this->load->library('email', $config);</code> |
| 105 | |
| 106 | <p>Config options can usually also be set via a config file. Each library is explained in detail in its own page, so please read the information regarding each one you would like to use.</p> |
| 107 | |
| 108 | <h3>Assigning a Library to a different object name</h3> |
| 109 | |
| 110 | <p>If the third (optional) parameter is blank, the library will usually be assigned to an object with the same name as the library. For example, if the library is named <dfn>Session</dfn>, it |
| 111 | will be assigned to a variable named <dfn>$this->session</dfn>.</p> |
| 112 | |
| 113 | <p>If you prefer to set your own class names you can pass its value to the third parameter:</p> |
| 114 | |
| 115 | <code>$this->load->library('session', '', 'my_session');<br /><br /> |
| 116 | |
| 117 | // Session class is now accessed using:<br /><br /> |
| 118 | |
| 119 | $this->my_session |
| 120 | |
| 121 | </code> |
| 122 | |
| 123 | |
| 124 | |
| 125 | <h2>$this->load->view('<var>file_name</var>', <samp>$data</samp>, <kbd>true/false</kbd>)</h2> |
| 126 | |
| 127 | <p>This function is used to load your View files. If you haven't read the <a href="../general/views.html">Views</a> section of the |
| 128 | user guide it is recommended that you do since it shows you how this function is typically used.</p> |
| 129 | |
| 130 | <p>The first parameter is required. It is the name of the view file you would like to load. Note: The .php file extension does not need to be specified unless you use something other than <kbd>.php</kbd>.</p> |
| 131 | |
| 132 | <p>The second <strong>optional</strong> parameter can take |
| 133 | an associative array or an object as input, which it runs through the PHP <a href="http://www.php.net/extract">extract</a> function to |
| 134 | convert to variables that can be used in your view files. Again, read the <a href="../general/views.html">Views</a> page to learn |
| 135 | how this might be useful.</p> |
| 136 | |
| 137 | <p>The third <strong>optional</strong> parameter lets you change the behavior of the function so that it returns data as a string |
| 138 | rather than sending it to your browser. This can be useful if you want to process the data in some way. If you |
| 139 | set the parameter to <kbd>true</kbd> (boolean) it will return data. The default behavior is <kbd>false</kbd>, which sends it |
| 140 | to your browser. Remember to assign it to a variable if you want the data returned:</p> |
| 141 | |
| 142 | <code>$string = $this->load->view('<var>myfile</var>', '', <kbd>true</kbd>);</code> |
| 143 | |
| 144 | |
| 145 | <h2>$this->load->model('<var>Model_name</var>');</h2> |
| 146 | <p><code>$this->load->model('<var>Model_name</var>');</code></p> |
| 147 | <p>If your model is located in a sub-folder, include the relative path from your models folder. For example, if you have a model located at application/models/blog/queries.php you'll load it using:</p> |
| 148 | <p><code>$this->load->model('<var>blog/queries</var>');</code></p> |
| 149 | <p>If you would like your model assigned to a different object name you can specify it via the second parameter of the loading |
| 150 | function:</p> |
| 151 | <code> $this->load->model('<var>Model_name</var>', '<kbd>fubar</kbd>');<br /> |
| 152 | <br /> |
| 153 | $this-><kbd>fubar</kbd>->function();</code> |
| 154 | <h2>$this->load->database('<var>options</var>', <kbd>true/false</kbd>)</h2> |
| 155 | <p>This function lets you load the database class. The two parameters are <strong>optional</strong>. Please see the |
| Derek Allard | 3f45bbd | 2008-12-07 17:00:09 +0000 | [diff] [blame] | 156 | <a href="../database/index.html">database</a> section for more info.</p> |
| Derek Allard | 2067d1a | 2008-11-13 22:59:24 +0000 | [diff] [blame] | 157 | |
| 158 | |
| 159 | <h2>$this->load->scaffolding('<var>table_name</var>')</h2> |
| 160 | |
| 161 | <p>This function lets you enable scaffolding. Please see the |
| 162 | <a href="../general/scaffolding.html">scaffolding</a> section for more info.</p> |
| 163 | |
| 164 | |
| 165 | |
| 166 | <h2>$this->load->vars(<samp>$array</samp>)</h2> |
| 167 | |
| 168 | <p>This function takes an associative array as input and generates variables using the PHP <a href="http://www.php.net/extract">extract</a> function. |
| 169 | This function produces the same result as using the second parameter of the <dfn>$this->load->view()</dfn> function above. The reason you might |
| 170 | want to use this function independently is if you would like to set some global variables in the constructor of your controller |
| 171 | and have them become available in any view file loaded from any function. You can have multiple calls to this function. The data get cached |
| 172 | and merged into one array for conversion to variables. |
| 173 | </p> |
| 174 | |
| 175 | |
| 176 | <h2>$this->load->helper('<var>file_name</var>')</h2> |
| 177 | <p>This function loads helper files, where <var>file_name</var> is the name of the file, without the <kbd>_helper.php</kbd> extension.</p> |
| 178 | |
| 179 | |
| 180 | <h2>$this->load->plugin('<var>file_name</var>')</h2> |
| 181 | <p>This function loads plugins files, where <var>file_name</var> is the name of the file, without the <kbd>_plugin.php</kbd> extension.</p> |
| 182 | |
| 183 | <h2>$this->load->file('<var>filepath/filename</var>', <kbd>true/false</kbd>)</h2> |
| 184 | <p>This is a generic file loading function. Supply the filepath and name in the first parameter and it will open and read the file. |
| 185 | By default the data is sent to your browser, just like a View file, but if you set the second parameter to <kbd>true</kbd> (boolean) |
| 186 | it will instead return the data as a string.</p> |
| 187 | |
| 188 | |
| 189 | <h2>$this->load->lang('<var>file_name</var>')</h2> |
| 190 | <p>This function is an alias of the <a href="language.html">language loading function</a>: $this->lang->load()</p> |
| 191 | |
| 192 | <h2>$this->load->config('<var>file_name</var>')</h2> |
| 193 | <p>This function is an alias of the <a href="config.html">config file loading function</a>: $this->config->load()</p> |
| 194 | |
| 195 | |
| 196 | |
| 197 | |
| 198 | </div> |
| 199 | <!-- END CONTENT --> |
| 200 | |
| 201 | |
| 202 | <div id="footer"> |
| 203 | <p> |
| 204 | Previous Topic: <a href="input.html">Input Class</a> |
| 205 | · |
| 206 | <a href="#top">Top of Page</a> · |
| 207 | <a href="../index.html">User Guide Home</a> · |
| 208 | Next Topic: <a href="language.html">Language Class</a> |
| 209 | </p> |
| Derek Jones | 7f3719f | 2010-01-05 13:35:37 +0000 | [diff] [blame] | 210 | <p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2010 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p> |
| Derek Allard | 2067d1a | 2008-11-13 22:59:24 +0000 | [diff] [blame] | 211 | </div> |
| 212 | |
| 213 | </body> |
| admin | b0dd10f | 2006-08-25 17:25:49 +0000 | [diff] [blame] | 214 | </html> |