Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / a8b10bed6b1064548b8af605e5b16113b457de02 / . / user_guide / libraries / loader.html
blob: 4bc5d634453a735495888cd776f57d6c78515928 [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +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>
3<head>
4
5<title>Code Igniter User Guide</title>
6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]10<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]12<script type="text/javascript" src="../nav/moo.fx.js"></script>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]13<script type="text/javascript">
14window.onload = function() {
admine334c472006-10-21 19:44:22 +0000[diff] [blame]15 myHeight = new fx.Height('nav', {duration: 400});
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]16 myHeight.hide();
17}
18</script>
19
20<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
21<meta http-equiv='expires' content='-1' />
22<meta http-equiv= 'pragma' content='no-cache' />
23<meta name='robots' content='all' />
24<meta name='author' content='Rick Ellis' />
25<meta name='description' content='Code Igniter User Guide' />
26
27</head>
28<body>
29
30<!-- START NAVIGATION -->
31<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
32<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
33<div id="masthead">
34<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
35<tr>
Derek Allardf743c732007-02-14 01:36:46 +0000[diff] [blame]36<td><h1>Code Igniter User Guide Version 1.5.2</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]37<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]38</tr>
39</table>
40</div>
41<!-- END NAVIGATION -->
42
43
44<!-- START BREADCRUMB -->
45<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
46<tr>
47<td id="breadcrumb">
48<a href="http://www.codeigniter.com/">Code Igniter Home</a> &nbsp;&#8250;&nbsp;
49<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
50Loader Class
51</td>
52<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.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>
53</tr>
54</table>
55<!-- END BREADCRUMB -->
56
57<br clear="all" />
58
59
60<!-- START CONTENT -->
61<div id="content">
62
63
64<h1>Loader Class</h1>
65
admine334c472006-10-21 19:44:22 +0000[diff] [blame]66<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>,
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]67<a href="../general/helpers.html">Helpers</a>, <a href="../general/plugins.html">Plugins</a>, or your own files.</p>
68
69<p class="important"><strong>Note:</strong> This class is initialized automatically by the system so there is no need to do it manually.</p>
70
71<p>The following functions are available in this class:</p>
72
73
74
admin2f0bac82006-10-09 17:36:45 +0000[diff] [blame]75<h2>$this->load->library('<var>class_name</var>')</h2>
76
admine334c472006-10-21 19:44:22 +0000[diff] [blame]77<p>This function is used to load core classes. Where <var>class_name</var> is the name of the class you want to load.
admin2f0bac82006-10-09 17:36:45 +0000[diff] [blame]78Note: We use the terms "class" and "library" interchangeably.</p>
79
80<p>For example, if you would like to send email with Code Igniter, the first step is to load the email class within your controller:</p>
81
82<code>$this->load->library('email');</code>
83
84<p>Once loaded, the library will be ready for use, using <kbd>$this->email-></kbd><samp><em>some_function</em>()</samp>.
85
admine7e1dcd2006-10-21 18:04:01 +0000[diff] [blame]86Each library is described in detail in its own page, so please read the information regarding each one you would like to use.</p>
admin2f0bac82006-10-09 17:36:45 +0000[diff] [blame]87
admine334c472006-10-21 19:44:22 +0000[diff] [blame]88<p>Parameters can be passed to the library via an array in the second parameter.
admincf493902006-10-10 07:12:31 +0000[diff] [blame]89
90
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]91<h2>$this->load->view('<var>file_name</var>', <samp>$data</samp>, <kbd>true/false</kbd>)</h2>
92
93<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
94user guide it is recommended that you do since it shows you how this function is typically used.</p>
95
admin1b90c272006-10-31 18:22:29 +0000[diff] [blame]96<p>The first parameter is required. It is the name of the view file you would like to load. &nbsp;Note: The .php file extension does not need to be specified unless you use something other then <kbd>.php</kbd>.</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]97
98<p>The second <strong>optional</strong> parameter can take
admine334c472006-10-21 19:44:22 +0000[diff] [blame]99an associative array or an object as input, which it runs through the PHP <a href="http://www.php.net/extract">extract</a> function to
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]100convert to variables that can be used in your view files. Again, read the <a href="../general/views.html">Views</a> page to learn
101how this might be useful.</p>
102
103<p>The third <strong>optional</strong> parameter lets you change the behavior of the function so that it returns data as a string
104rather than sending it to your browser. This can be useful if you want to process the data in some way. If you
105set the parameter to <kbd>true</kbd> (boolean) it will return data. The default behavior is <kbd>false</kbd>, which sends it
106to your browser. Remember to assign it to a variable if you wan the data returned:</p>
107
108<code>$string = $this->load->view('<var>myfile</var>', '', <kbd>true</kbd>);</code>
109
110
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]111<h2>$this->load->database('<var>options</var>', <kbd>true/false</kbd>)</h2>
112
admine334c472006-10-21 19:44:22 +0000[diff] [blame]113<p>This function lets you load the database class. The two parameters are <strong>optional</strong>. Please see the
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]114<a href="./database/index.html">database</a> section for more info.</p>
115
116
117<h2>$this->load->scaffolding('<var>table_name</var>')</h2>
118
admine334c472006-10-21 19:44:22 +0000[diff] [blame]119<p>This function lets you enable scaffolding. Please see the
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]120<a href="../general/scaffolding.html">scaffolding</a> section for more info.</p>
121
122
123
124<h2>$this->load->vars(<samp>$array</samp>)</h2>
125
126<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.
admine334c472006-10-21 19:44:22 +0000[diff] [blame]127This function produces the same result as using the second parameter of the <dfn>$this->load->view()</dfn> function above. The reason you might
128want to use this function independently is if you would like to set some global variables in the constructor of your controller
129and have them become available in any view file loaded from any function. You can have multiple calls to this function. The data get cached
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]130and merged into one array for conversion to variables.
131</p>
132
133
134<h2>$this->load->helper('<var>file_name</var>')</h2>
135<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>
136
137
138<h2>$this->load->plugin('<var>file_name</var>')</h2>
139<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>
140
141<h2>$this->load->file('<var>filepath/filename</var>', <kbd>true/false</kbd>)</h2>
admine334c472006-10-21 19:44:22 +0000[diff] [blame]142<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.
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]143By 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)
144it will instead return the data as a string.</p>
145
146
147<h2>$this->load->lang('<var>file_name</var>')</h2>
148<p>This function is an alias of the <a href="language.html">language loading function</a>: $this->lang->load()</p>
149
150<h2>$this->load->config('<var>file_name</var>')</h2>
151<p>This function is an alias of the <a href="config.html">config file loading function</a>: $this->config->load()</p>
152
153
154
155
156</div>
157<!-- END CONTENT -->
158
159
160<div id="footer">
161<p>
162Previous Topic:&nbsp;&nbsp;<a href="input.html">Input Class</a>
163&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
164<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
165<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
166Next Topic:&nbsp;&nbsp;<a href="language.html">Language Class</a>
167<p>
168<p><a href="http://www.codeigniter.com">Code Igniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 &nbsp;&middot;&nbsp; <a href="http://www.pmachine.com">pMachine, Inc.</a></p>
169</div>
170
171</body>
172</html>