Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / c644128fdd49a47d791240e0e38b54cd22412bc5 / . / user_guide / general / errors.html
blob: d78dd4947c05b39e5b3689ab09a054d2b6a3b65a [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;
50Error Handling
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>Error Handling</h1>
64
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]65<p>CodeIgniter lets you build error reporting into your applications using the functions described below.
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]66In addition, it has an error logging class that permits error and debugging messages to be saved as text files.</p>
67
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]68<p class="important"><strong>Note:</strong> By default, CodeIgniter displays all PHP errors. You might
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]69wish to change this behavior once your development is complete. You'll find the <dfn>error_reporting()</dfn>
70function located at the top of your main index.php file. Disabling error reporting will NOT prevent log files
71from being written if there are errors.</p>
72
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]73<p>Unlike most systems in CodeIgniter, the error functions are simple procedural interfaces that are available
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]74globally throughout the application. This approach permits error messages to get triggered without having to worry
75about class/function scoping.</p>
76
77<p>The following functions let you generate errors:</p>
78
79<h2>show_error('<var>message</var>')</h2>
80<p>This function will display the error message supplied to it using the following error template:</p>
81<p><dfn>application/errors/</dfn><kbd>error_general.php</kbd></p>
82
83<h2>show_404('<var>page</var>')</h2>
84<p>This function will display the 404 error message supplied to it using the following error template:</p>
85<p><dfn>application/errors/</dfn><kbd>error_404.php</kbd></p>
86
87<p>The function expects the string passed to it to be the file path to the page that isn't found.
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]88Note that CodeIgniter automatically shows 404 messages if controllers are not found.</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]89
90
91<h2>log_message('<var>level</var>', '<samp>message</samp>')</h2>
92
admine334c472006-10-21 19:44:22 +0000[diff] [blame]93<p>This function lets you write messages to your log files. You must supply one of three "levels"
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]94in the first parameter, indicating what type of message it is (debug, error, info), with the message
95itself in the second parameter. Example:</p>
96
97<code>
98if ($some_var == "")<br />
99{<br />
100&nbsp;&nbsp;&nbsp;&nbsp;log_message('error', 'Some variable did not contain a value.');<br />
101}<br />
102else<br />
103{<br />
104&nbsp;&nbsp;&nbsp;&nbsp;log_message('debug', 'Some variable was correctly set');<br />
105}<br />
106<br />
107log_message('info', 'The purpose of some variable is to provide some value.');<br />
108</code>
109
110<p>There are three message types:</p>
111
112<ol>
113<li>Error Messages. These are actual errors, such as PHP errors or user errors.</li>
114<li>Debug Messages. These are messages that assist in debugging. For example, if a class has been initialized, you could log this as debugging info.</li>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]115<li>Informational Messages. These are the lowest priority messages, simply giving information regarding some process. CodeIgniter doesn't natively generate any info messages but you may want to in your application.</li>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]116</ol>
117
118
admine334c472006-10-21 19:44:22 +0000[diff] [blame]119<p class="important"><strong>Note:</strong> In order for the log file to actually be written, the
120 "logs" folder must be writable. In addition, you must set the "threshold" for logging.
adminb06d69f2006-10-13 21:44:17 +0000[diff] [blame]121You might, for example, only want error messages to be logged, and not the other two types.
122If you set it to zero logging will be disabled.</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]123
124
125
126</div>
127<!-- END CONTENT -->
128
129
130<div id="footer">
131<p>
132Previous Topic:&nbsp;&nbsp;<a href="routing.html">URI Routing</a>
133&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
134<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
135<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
136Next Topic:&nbsp;&nbsp;<a href="caching.html">Page Caching</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame^]137</p>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]138<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]139</div>
140
141</body>
142</html>