joshtronic/pickles
1
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity Actions
pickles/docs/PICKLES/Profiler.html
Josh Sherman 5f78540770 Updated internal documentation.
2010-11-27 21:43:43 -05:00

272 lines
No EOL
12 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Profiler</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Profiler</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Profiler Class</p>
<p class="description"><p>The Profiler class is statically interfaced with and allows for in depth profiling of a site. By default profiling is off, but can be enabled in the config.ini for a site. Out of the box the profiler will report on every class object in the system that extends the code Object class.</p><p>Note: I really wanted to use PHP Quick Profiler by Ryan Campbell of Particletree but it kept barking out errors when I tried to use it with E_STRICT turned on. Here's a link anyway since it looks awesome: http://particletree.com/features/php-quick-profiler/</p></p>
<ul class="tags">
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../PICKLES/Profiler.html">Profiler</a></span><span class="src-sym">::</span><a href="../PICKLES/Profiler.html#methodlog">log</a><span class="src-sym">(</span><span class="src-str">'some&nbsp;action&nbsp;you&nbsp;want&nbsp;to&nbsp;track'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></li>
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../PICKLES/Profiler.html">Profiler</a></span><span class="src-sym">::</span><a href="../PICKLES/Profiler.html#methodlog">log</a><span class="src-sym">(</span><span class="src-var">$object</span><span class="src-sym">,&nbsp;</span><span class="src-str">'methodName'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Profiler.php.html">/classes/Profiler.php</a> (line <span class="field">34</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#enabled" title="details" class="method-name">enabled</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$type</span>)
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#log" title="details" class="method-name">log</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#logQuery" title="details" class="method-name">logQuery</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$input_parameters</span> = <span class="var-default">false</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$explain</span> = <span class="var-default">false</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$duration</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#report" title="details" class="method-name">report</a>
()
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#timer" title="details" class="method-name">timer</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$timer</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodenabled" id="enabled"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method enabled</span> (line <span class="line-number">101</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enabled</p>
<p class="description"><p>Checks if the profiler is set to boolean true or if the passed type is specified in the profiler configuration value.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the type is enabled</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">boolean</span>
<span class="method-name">
enabled
</span>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$type</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$type</span><span class="var-description">: type(s) to check</span> </li>
</ul>
</div>
<a name="methodlog" id="log"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method log</span> (line <span class="line-number">144</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log</p>
<p class="description"><p>Logs the event to be displayed later on. Due to the nature of how much of a pain it is to determine which class method called this method I opted to make the method a passable argument for ease of use. Perhaps I'll revisit in the future. Handles all elapsed time calculations and memory usage.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">void</span>
<span class="method-name">
log
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$data</span><span class="var-description">: data to log</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$method</span><span class="var-description">: name of the class method being logged</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
</ul>
</div>
<a name="methodlogQuery" id="logQuery"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method logQuery</span> (line <span class="line-number">201</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log Query</p>
<p class="description"><p>Serves as a wrapper to get query data to the log function</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">void</span>
<span class="method-name">
logQuery
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$input_parameters</span> = <span class="var-default">false</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$explain</span> = <span class="var-default">false</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$duration</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$query</span><span class="var-description">: the query being executed</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$input_parameters</span><span class="var-description">: optional prepared statement data</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$explain</span><span class="var-description">: EXPLAIN data for the query</span> </li>
<li>
<span class="var-type">float</span>
<span class="var-name">$duration</span><span class="var-description">: the speed of the query</span> </li>
</ul>
</div>
<a name="methodreport" id="report"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method report</span> (line <span class="line-number">279</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Report</p>
<p class="description"><p>Generates the Profiler report that is displayed by the Controller. Contains all the HTML needed to display the data properly inline on the page. Will generally be displayed after the closing HTML tag.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">void</span>
<span class="method-name">
report
</span>
()
</div>
</div>
<a name="methodtimer" id="timer"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method timer</span> (line <span class="line-number">248</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Timer</p>
<p class="description"><p>Logs the start and end of a timer.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not timer profiling is enabled</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">boolean</span>
<span class="method-name">
timer
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$timer</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$timer</span><span class="var-description">: name of the timer</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 27 Nov 2010 21:43:42 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>
Reference in a new issue View git blame Copy permalink