329 lines
No EOL
11 KiB
HTML
329 lines
No EOL
11 KiB
HTML
<?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 Log</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 Log</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">Log Class</p>
|
|
<p class="description"><p>Standardized logging methods for ease of reporting.</p></p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_classes---Log.php.html">/classes/Log.php</a> (line <span class="field">23</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="#error" title="details" class="method-name">error</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
static <span class="method-result">boolean</span>
|
|
<a href="#information" title="details" class="method-name">information</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
static <span class="method-result">boolean</span>
|
|
<a href="#phpError" title="details" class="method-name">phpError</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type"></span> <span class="var-name">$time</span> = <span class="var-default">false</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
static <span class="method-result">boolean</span>
|
|
<a href="#query" title="details" class="method-name">query</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
static <span class="method-result">boolean</span>
|
|
<a href="#slowQuery" title="details" class="method-name">slowQuery</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
static <span class="method-result">boolean</span>
|
|
<a href="#transaction" title="details" class="method-name">transaction</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
static <span class="method-result">boolean</span>
|
|
<a href="#warning" title="details" class="method-name">warning</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</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="methoderror" id="error"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method error</span> (line <span class="line-number">56</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Log Error</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the write was successful</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">
|
|
error
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodinformation" id="information"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method information</span> (line <span class="line-number">32</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Log Information</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the write was successful</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">
|
|
information
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodphpError" id="phpError"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method phpError</span> (line <span class="line-number">92</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Log PHP Error</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the write was successful</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">
|
|
phpError
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type"></span> <span class="var-name">$time</span> = <span class="var-default">false</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$time</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodquery" id="query"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method query</span> (line <span class="line-number">104</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Log SQL Query</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the write was successful</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">
|
|
query
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodslowQuery" id="slowQuery"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method slowQuery</span> (line <span class="line-number">68</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Log Slow Query</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the write was successful</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">
|
|
slowQuery
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodtransaction" id="transaction"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method transaction</span> (line <span class="line-number">80</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Log Credit Card Transaction</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the write was successful</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">
|
|
transaction
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodwarning" id="warning"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method warning</span> (line <span class="line-number">44</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Log Warning</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the write was successful</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">
|
|
warning
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$message</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$message</span><span class="var-description">: message to log</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Sun, 17 Oct 2010 23:17:22 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |