Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 733310d86671ada1be601692bdd5bbd55dae5e7a / . / user_guide / libraries / output.html
blob: 845883130aa738f871d2e2a4c7c82fe07b7f20dd [file] [log] [blame]
Derek Allard2067d1a2008-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>Output 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 Jones733310d2009-02-11 01:13:43 +0000[diff] [blame^]31<td><h1>CodeIgniter User Guide Version 1.7.1</h1></td>
Derek Allard2067d1a2008-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> &nbsp;&#8250;&nbsp;
44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Output 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&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
59<h1>Output Class</h1>
60
61<p>The Output class is a small class with one main function: To send the finalized web page to the requesting browser. It is
62also responsible for <a href="../general/caching.html">caching</a> your web pages, if you use that feature.</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>Under normal circumstances you won't even notice the Output class since it works transparently without your intervention.
67For example, when you use the <a href="../libraries/loader.html">Loader</a> class to load a view file, it's automatically
68passed to the Output class, which will be called automatically by CodeIgniter at the end of system execution.
69It is possible, however, for you to manually intervene with the output if you need to, using either of the two following functions:</p>
70
71<h2>$this->output->set_output();</h2>
72
73<p>Permits you to manually set the final output string. Usage example:</p>
74
75<code>$this->output->set_output($data);</code>
76
77<p><strong>Important:</strong> If you do set your output manually, it must be the last thing done in the function you call it from.
78For example, if you build a page in one of your controller functions, don't set the output until the end.</p>
79
80
81<h2>$this->output->get_output();</h2>
82
83<p>Permits you to manually retrieve any output that has been sent for storage in the output class. Usage example:</p>
84<code>$string = $this->output->get_output();</code>
85
86<p>Note that data will only be retrievable from this function if it has been previously sent to the output class by one of the
87CodeIgniter functions like <var>$this->load->view()</var>.</p>
88
89
90<h2>$this->output->set_header();</h2>
91
92<p>Permits you to manually set server headers, which the output class will send for you when outputting the final rendered display. Example:</p>
93
94<code>
95$this->output->set_header("HTTP/1.0 200 OK");<br />
96$this->output->set_header("HTTP/1.1 200 OK");<br />
97$this->output->set_header('Last-Modified: '.gmdate('D, d M Y H:i:s', $last_update).' GMT');<br />
98$this->output->set_header("Cache-Control: no-store, no-cache, must-revalidate");<br />
99$this->output->set_header("Cache-Control: post-check=0, pre-check=0");<br />
100$this->output->set_header("Pragma: no-cache"); </code>
101
102
103<h2>$this->output->set_status_header();</h2>
104
105<p>Permits you to manually set a server status header. Example:</p>
106
107<code>$this->output->set_status_header('401');<br />
108// Sets the header as: Unauthorized</code>
109
110<p><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">See here</a> for a full list of headers.</p>
111
112<h2>$this->output->enable_profiler();</h2>
113
114<p>Permits you to enable/disable the <a href="../general/profiling.html">Profiler</a>, which will display benchmark and other data
115at the bottom of your pages for debugging and optimization purposes.</p>
116
117<p>To enable the profiler place the following function anywhere within your <a href="../general/controllers.html">Controller</a> functions:</p>
118<code>$this->output->enable_profiler(TRUE);</code>
119
120<p>When enabled a report will be generated and inserted at the bottom of your pages.</p>
121
122<p>To disable the profiler you will use:</p>
123<code>$this->output->enable_profiler(FALSE);</code>
124
125
126<h2>$this->output->cache();</h2>
127<p>The CodeIgniter output library also controls caching. For more information, please see the <a href="../general/caching.html">caching documentation</a>.</p>
128
129</div>
130<!-- END CONTENT -->
131
132
133<div id="footer">
134<p>
135Previous Topic:&nbsp;&nbsp;<a href="language.html">Language Class</a>
136&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
137<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
138<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
139Next Topic:&nbsp;&nbsp;<a href="pagination.html">Pagination Class</a>
140</p>
141<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
142</div>
143
144</body>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]145</html>