Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / f5a519822db2201b98f822ad4f8659bad2ce9bcd / . / user_guide / general / helpers.html
blob: a91c8c21f11b9c3268fe0e6417fcc17bfc531b34 [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
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]5<title>CodeIgniter User Guide</title>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]25<meta name='description' content='CodeIgniter User Guide' />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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 Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]36<td><h1>CodeIgniter User Guide Version 1.5.3</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">
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]48<a href="http://www.codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]49<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
50Helper Functions
51</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]52<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>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]53</tr>
54</table>
55<!-- END BREADCRUMB -->
56
57<br clear="all" />
58
59
60<!-- START CONTENT -->
61<div id="content">
62
63<h1>Helper Functions</h1>
64
65<p>Helpers, as the name suggests, help you with tasks. Each helper file is simply a collection of functions in a particular
66category. There are <dfn>URL Helpers</dfn>, that assist in creating links, there are <dfn>Form Helpers</dfn>
67that help you create form elements, <dfn>Text Helpers</dfn> perform various text formatting routines,
68<dfn>Cookie Helpers</dfn> set and read cookies, <dfn>File Helpers</dfn> help you deal with files, etc.
69</p>
70
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]71<p>Unlike most other systems in CodeIgniter, Helpers are not written in an Object Oriented format. They are simple, procedural functions.
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]72Each helper function performs one specific task, with no dependence on other functions.</p>
73
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]74<p>CodeIgniter does not load Helper Files by default, so the first step in using
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]75a Helper is to load it. Once loaded, it becomes globally available in your <a href="../general/controllers.html">controller</a> and <a href="../general/views.html">views</a>.</p>
76
admin7c5595f2006-09-20 23:35:42 +0000[diff] [blame]77<p>Helpers are typically stored in your <dfn>system/helpers</dfn> directory. Alternately you can create a folder called <kbd>helpers</kbd> inside
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]78your <kbd>application</kbd> folder and store them there. CodeIgniter will look first in your <dfn>system/application/helpers</dfn>
admine334c472006-10-21 19:44:22 +0000[diff] [blame]79directory. If the directory does not exist or the specified helper is not located there CI will instead look in your global
admin7c5595f2006-09-20 23:35:42 +0000[diff] [blame]80<dfn>system/helpers</dfn> folder.</p>
81
82
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]83<h2>Loading a Helper</h2>
84
85<p>Loading a helper file is quite simple using the following function:</p>
86
87<code>$this->load->helper('<var>name</var>');</code>
88
89<p>Where <var>name</var> is the file name of the helper, without the .php file extension or the "helper" part.</p>
90
91<p>For example, to load the <dfn>URL Helper</dfn> file, which is named <var>url_helper.php</var>, you would do this:</p>
92
93<code>$this->load->helper('<var>url</var>');</code>
94
95<p>A helper can be loaded anywhere within your controller functions (or even within your View files, although that's not a good practice),
96as long as you load it before you use it. You can load your helpers in your controller constructor so that they become available
97automatically in any function, or you can load a helper in a specific function that needs it.</p>
98
99<p class="important">Note: The Helper loading function above does not return a value, so don't try to assign it to a variable. Just use it as shown.</p>
100
101
102<h2>Loading Multiple Helpers</h2>
103
104<p>If you need to load more than one helper you can specify them in an array, like this:</p>
105
106<code>$this->load->helper( <samp>array(</samp>'<var>helper1</var>', '<var>helper2</var>', '<var>helper3</var>'<samp>)</samp> );</code>
107
108<h2>Auto-loading Helpers</h2>
109
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]110<p>If you find that you need a particular helper globally throughout your application, you can tell CodeIgniter to auto-load it during system initialization.
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]111This is done by opening the <var>application/config/autoload.php</var> file and adding the helper to the autoload array.</p>
112
113
114<h2>Using a Helper</h2>
115
116<p>Once you've loaded the Helper File containing the function you intend to use, you'll call it the way you would a standard PHP function.</p>
117
118<p>For example, to create a link using the <dfn>anchor()</dfn> function in one of your view files you would do this:</p>
119
120<code>&lt;?=anchor('blog/comments', 'Click Here');?&gt;</code>
121
122<p>Where "Click Here" is the name of the link, and "blog/comments" is the URI to the controller/function you wish to link to.</p>
123
124
125<h2>Now What?</h2>
126
127<p>In the Table of Contents you'll find a list of all the available Helper Files. Browse each one to see what they do.</p>
128
129
130</div>
131<!-- END CONTENT -->
132
133
134<div id="footer">
135<p>
Derek Allard9da4dbc2007-04-03 11:39:35 +0000[diff] [blame]136Previous Topic:&nbsp;&nbsp;<a href="models.html">Models</a>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]137&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
138<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
139<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
140Next Topic:&nbsp;&nbsp;<a href="plugins.html">Plugins</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]141</p>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]142<p><a href="http://www.codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2007 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]143</div>
144
145</body>
146</html>