From ee71c80dd20bcfc60169af3eb1f628229ca30d67 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Wed, 10 Mar 2010 10:05:05 -0600
Subject: added ability to enable/disable individual sections of the Profiler

---
 user_guide/changelog.html         |  1 +
 user_guide/general/profiling.html | 90 +++++++++++++++++++++++++++++++++++----
 user_guide/libraries/output.html  |  3 ++
 3 files changed, 85 insertions(+), 9 deletions(-)

(limited to 'user_guide')

diff --git a/user_guide/changelog.html b/user_guide/changelog.html
index b196acf42..ac421286b 100644
--- a/user_guide/changelog.html
+++ b/user_guide/changelog.html
@@ -72,6 +72,7 @@ Hg Tag: </p>
 		</ul>
 	<li>Libraries
 		<ul>
+			<li>Added ability to enable / disable individual sections of the <a href="general/profiling.html">Profiler</a></li>
 			<li>Added "is_object" into the list of unit tests capable of being run.</li>
 			<li>Table library will generate an empty cell with a blank string, or NULL value.</li>
 			<li>Added a <kbd>parse_string()</kbd> method to the <a href="libraries/parser.html">Parser Class</a>.</li>
diff --git a/user_guide/general/profiling.html b/user_guide/general/profiling.html
index ec71278b1..8622edeb9 100644
--- a/user_guide/general/profiling.html
+++ b/user_guide/general/profiling.html
@@ -69,20 +69,92 @@ This information can be useful during development in order to help with debuggin
 
 <h2>Enabling the Profiler</h2>
 
-<p>To enable the profiler place the following function anywhere within your <a href="controllers.html">Controller</a> functions:</p>
-<code>$this->output->enable_profiler(TRUE);</code>
+	<p>To enable the profiler place the following function anywhere within your <a href="controllers.html">Controller</a> functions:</p>
+	<code>$this->output->enable_profiler(TRUE);</code>
 
-<p>When enabled a report will be generated and inserted at the bottom of your pages.</p>
+	<p>When enabled a report will be generated and inserted at the bottom of your pages.</p>
 
-<p>To disable the profiler you will use:</p>
-<code>$this->output->enable_profiler(FALSE);</code>
+	<p>To disable the profiler you will use:</p>
+	<code>$this->output->enable_profiler(FALSE);</code>
 
-<h2>Setting Benchmark Points</h2>
-
-<p>In order for the Profiler to compile and display your benchmark data you must name your mark points using specific syntax.</p>
 
-<p>Please read the information on setting Benchmark points in <a href="../libraries/benchmark.html">Benchmark Class</a> page.</p>
+<h2>Setting Benchmark Points</h2>
 
+	<p>In order for the Profiler to compile and display your benchmark data you must name your mark points using specific syntax.</p>
+
+	<p>Please read the information on setting Benchmark points in <a href="../libraries/benchmark.html">Benchmark Class</a> page.</p>
+
+
+<h2>Enabling and Disabling Profiler Sections</h2>
+
+	<p>Each section of Profiler data can be enabled or disabled by setting a corresponding config variable to <var>TRUE</var> or <var>FALSE</var>.  This can be done one of two ways.  First, you can set application wide defaults with the <dfn>system/application/config/profiler.php</dfn> config file.</p>
+
+	<code>$config['config']&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;= FALSE;<br />
+	$config['queries']&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;= FALSE;<br /></code>
+
+	<p>In your controllers, you can override the defaults and config file values by calling the <kbd>set_profiler_sections()</kbd> method of the <a href="../libraries/output.html">Output class</a>:</p>
+
+	<code>$sections = array(<br />
+	&nbsp;&nbsp;&nbsp;&nbsp;'config' &nbsp;=> TRUE,<br />
+	&nbsp;&nbsp;&nbsp;&nbsp;'queries' => TRUE<br />
+	&nbsp;&nbsp;&nbsp;&nbsp;);<br />
+	<br />
+	$this->output->set_profiler_sections($sections);</code>
+
+	<p>Available sections and the array key used to access them are described in the table below.</p>
+
+	<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
+		<tr>
+		<th>Key</th>
+		<th>Description</th>
+		<th>Default</th>
+		</tr><tr>
+
+		<td class="td"><strong>benchmarks</strong></td>
+		<td class="td">Elapsed time of Benchmark points and total execution time</td>
+		<td class="td">TRUE</td>
+		</tr><tr>
+
+		<td class="td"><strong>config</strong></td>
+		<td class="td">CodeIgniter Config variables</td>
+		<td class="td">TRUE</td>
+		</tr><tr>
+
+		<td class="td"><strong>controller_info</strong></td>
+		<td class="td">The Controller class and method requested</td>
+		<td class="td">TRUE</td>
+		</tr><tr>
+
+		<td class="td"><strong>get</strong></td>
+		<td class="td">Any GET data passed in the request</td>
+		<td class="td">TRUE</td>
+		</tr><tr>
+			
+		<td class="td"><strong>http_headers</strong></td>
+		<td class="td">The HTTP headers for the current request</td>
+		<td class="td">TRUE</td>
+		</tr><tr>
+
+		<td class="td"><strong>memory_usage</strong></td>
+		<td class="td">Amount of memory consumed by the current request, in bytes</td>
+		<td class="td">TRUE</td>
+		</tr><tr>
+
+		<td class="td"><strong>post</strong></td>
+		<td class="td">Any POST data passed in the request</td>
+		<td class="td">TRUE</td>
+		</tr><tr>
+
+		<td class="td"><strong>queries</strong></td>
+		<td class="td">Listing of all database queries executed, including execution time</td>
+		<td class="td">TRUE</td>
+		</tr><tr>
+		
+		<td class="td"><strong>uri_string</strong></td>
+		<td class="td">The URI of the current request</td>
+		<td class="td">TRUE</td>
+		</tr><tr>
+	</table>
 
 
 </div>
diff --git a/user_guide/libraries/output.html b/user_guide/libraries/output.html
index de22fbe28..70f0c1f7b 100644
--- a/user_guide/libraries/output.html
+++ b/user_guide/libraries/output.html
@@ -130,6 +130,9 @@ at the bottom of your pages for debugging and optimization purposes.</p>
 <p>To disable the profiler you will use:</p>
 <code>$this->output->enable_profiler(FALSE);</code>
 
+<h2>$this->output->set_profiler_sections();</h2>
+
+<p>Permits you to enable/disable specific sections of the Profiler when enabled.  Please refer to the <a href="../general/profiling.html">Profiler</a> documentation for further information.</p>
 
 <h2>$this->output->cache();</h2>
 <p>The CodeIgniter output library also controls caching.  For more information, please see the <a href="../general/caching.html">caching documentation</a>.</p>
-- 
cgit v1.2.3-24-g4f1b