Files
geodb/doc/class-Slim.Log.html
2013-10-21 11:08:04 +02:00

940 lines
18 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Slim\Log | GeoApi</title>
<script type="text/javascript" src="resources/combined.js?3762770784"></script>
<script type="text/javascript" src="elementlist.js?3400632557"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li><a href="namespace-api.html">api</a>
</li>
<li><a href="namespace-config.html">config</a>
</li>
<li><a href="namespace-database.html">database</a>
</li>
<li><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
<li class="active"><a href="namespace-Slim.html">Slim<span></span></a>
<ul>
<li><a href="namespace-Slim.Exception.html">Exception</a>
</li>
<li><a href="namespace-Slim.Http.html">Http</a>
</li>
<li><a href="namespace-Slim.Middleware.html">Middleware</a>
</li>
</ul></li>
<li><a href="namespace-utiliy.html">utiliy</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Slim.Environment.html">Environment</a></li>
<li class="active"><a href="class-Slim.Log.html">Log</a></li>
<li><a href="class-Slim.LogWriter.html">LogWriter</a></li>
<li><a href="class-Slim.Middleware.html">Middleware</a></li>
<li><a href="class-Slim.Route.html">Route</a></li>
<li><a href="class-Slim.Router.html">Router</a></li>
<li><a href="class-Slim.Slim.html">Slim</a></li>
<li><a href="class-Slim.View.html">View</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-Slim.html" title="Summary of Slim"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Log</h1>
<div class="description">
<p>Log</p>
<p>This is the primary logger for a Slim application. You may provide a Log
Writer in conjunction with this Log to write to various output destinations
(e.g. a file). This class provides this interface:</p>
<p>debug( mixed $object ) info( mixed $object ) warn( mixed $object ) error(
mixed $object ) fatal( mixed $object )</p>
<p>This class assumes only that your Log Writer has a public
<code>write()</code> method that accepts any object as its one and only
argument. The Log Writer class may write or send its argument anywhere: a file,
STDERR, a remote web API, etc. The possibilities are endless.</p>
</div>
<div class="info">
<b>Namespace:</b> <a href="namespace-Slim.html">Slim</a><br />
<b>Package:</b> Slim<br />
<b>Author:</b>
Josh Lockhart<br />
<b>Since:</b>
1.0.0<br />
<b>Located at</b> <a href="source-class-Slim.Log.html#35-237" title="Go to source code">thirdparty/Slim/Log.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Slim.Log.html#91-100" title="Go to source code">__construct</a>( <span>mixed <var>$writer</var></span> )</code>
<div class="description short">
<p>Constructor</p>
</div>
<div class="description detailed hidden">
<p>Constructor</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$writer</var></dt>
<dd><code>mixed</code><br>$writer</dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="getEnabled" id="_getEnabled">
<td class="attributes"><code>
public
boolean
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getEnabled">#</a>
<code><a href="source-class-Slim.Log.html#102-109" title="Go to source code">getEnabled</a>( )</code>
<div class="description short">
<p>Is logging enabled?</p>
</div>
<div class="description detailed hidden">
<p>Is logging enabled?</p>
<h4>Returns</h4>
<div class="list">
<code>boolean</code><br />
</div>
</div>
</div></td>
</tr>
<tr data-order="setEnabled" id="_setEnabled">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setEnabled">#</a>
<code><a href="source-class-Slim.Log.html#111-122" title="Go to source code">setEnabled</a>( <span>boolean <var>$enabled</var></span> )</code>
<div class="description short">
<p>Enable or disable logging</p>
</div>
<div class="description detailed hidden">
<p>Enable or disable logging</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$enabled</var></dt>
<dd><code>boolean</code><br>$enabled</dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="setLevel" id="_setLevel">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setLevel">#</a>
<code><a href="source-class-Slim.Log.html#124-135" title="Go to source code">setLevel</a>( <span>integer <var>$level</var></span> )</code>
<div class="description short">
<p>Set level</p>
</div>
<div class="description detailed hidden">
<p>Set level</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$level</var></dt>
<dd><code>integer</code><br>$level</dd>
</dl></div>
<h4>Throws</h4>
<div class="list">
<code><code><a href="class-InvalidArgumentException.html">InvalidArgumentException</a></code></code><br>If invalid log level specified<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="getLevel" id="_getLevel">
<td class="attributes"><code>
public
integer
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getLevel">#</a>
<code><a href="source-class-Slim.Log.html#137-144" title="Go to source code">getLevel</a>( )</code>
<div class="description short">
<p>Get level</p>
</div>
<div class="description detailed hidden">
<p>Get level</p>
<h4>Returns</h4>
<div class="list">
<code>integer</code><br />
</div>
</div>
</div></td>
</tr>
<tr data-order="setWriter" id="_setWriter">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setWriter">#</a>
<code><a href="source-class-Slim.Log.html#146-153" title="Go to source code">setWriter</a>( <span>mixed <var>$writer</var></span> )</code>
<div class="description short">
<p>Set writer</p>
</div>
<div class="description detailed hidden">
<p>Set writer</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$writer</var></dt>
<dd><code>mixed</code><br>$writer</dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="getWriter" id="_getWriter">
<td class="attributes"><code>
public
mixed
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getWriter">#</a>
<code><a href="source-class-Slim.Log.html#155-162" title="Go to source code">getWriter</a>( )</code>
<div class="description short">
<p>Get writer</p>
</div>
<div class="description detailed hidden">
<p>Get writer</p>
<h4>Returns</h4>
<div class="list">
<code>mixed</code><br />
</div>
</div>
</div></td>
</tr>
<tr data-order="isEnabled" id="_isEnabled">
<td class="attributes"><code>
public
boolean
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_isEnabled">#</a>
<code><a href="source-class-Slim.Log.html#164-171" title="Go to source code">isEnabled</a>( )</code>
<div class="description short">
<p>Is logging enabled?</p>
</div>
<div class="description detailed hidden">
<p>Is logging enabled?</p>
<h4>Returns</h4>
<div class="list">
<code>boolean</code><br />
</div>
</div>
</div></td>
</tr>
<tr data-order="debug" id="_debug">
<td class="attributes"><code>
public
mixed|false
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_debug">#</a>
<code><a href="source-class-Slim.Log.html#173-181" title="Go to source code">debug</a>( <span>mixed <var>$object</var></span> )</code>
<div class="description short">
<p>Log debug message</p>
</div>
<div class="description detailed hidden">
<p>Log debug message</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$object</var></dt>
<dd><code>mixed</code><br>$object</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>mixed|false</code><br>What the Logger returns, or false if Logger not set or not enabled<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="info" id="_info">
<td class="attributes"><code>
public
mixed|false
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_info">#</a>
<code><a href="source-class-Slim.Log.html#183-191" title="Go to source code">info</a>( <span>mixed <var>$object</var></span> )</code>
<div class="description short">
<p>Log info message</p>
</div>
<div class="description detailed hidden">
<p>Log info message</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$object</var></dt>
<dd><code>mixed</code><br>$object</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>mixed|false</code><br>What the Logger returns, or false if Logger not set or not enabled<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="warn" id="_warn">
<td class="attributes"><code>
public
mixed|false
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_warn">#</a>
<code><a href="source-class-Slim.Log.html#193-201" title="Go to source code">warn</a>( <span>mixed <var>$object</var></span> )</code>
<div class="description short">
<p>Log warn message</p>
</div>
<div class="description detailed hidden">
<p>Log warn message</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$object</var></dt>
<dd><code>mixed</code><br>$object</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>mixed|false</code><br>What the Logger returns, or false if Logger not set or not enabled<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="error" id="_error">
<td class="attributes"><code>
public
mixed|false
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_error">#</a>
<code><a href="source-class-Slim.Log.html#203-211" title="Go to source code">error</a>( <span>mixed <var>$object</var></span> )</code>
<div class="description short">
<p>Log error message</p>
</div>
<div class="description detailed hidden">
<p>Log error message</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$object</var></dt>
<dd><code>mixed</code><br>$object</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>mixed|false</code><br>What the Logger returns, or false if Logger not set or not enabled<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="fatal" id="_fatal">
<td class="attributes"><code>
public
mixed|false
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_fatal">#</a>
<code><a href="source-class-Slim.Log.html#213-221" title="Go to source code">fatal</a>( <span>mixed <var>$object</var></span> )</code>
<div class="description short">
<p>Log fatal message</p>
</div>
<div class="description detailed hidden">
<p>Log fatal message</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$object</var></dt>
<dd><code>mixed</code><br>$object</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>mixed|false</code><br>What the Logger returns, or false if Logger not set or not enabled<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="write" id="_write">
<td class="attributes"><code>
protected
integer|false
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_write">#</a>
<code><a href="source-class-Slim.Log.html#223-236" title="Go to source code">write</a>( <span>mixed <var>$object</var></span>, <span>integer <var>$level</var></span> )</code>
<div class="description short">
<p>Log message</p>
</div>
<div class="description detailed hidden">
<p>Log message</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$object</var></dt>
<dd><code>mixed</code><br>The object to log</dd>
<dt><var>$level</var></dt>
<dd><code>integer</code><br>The message level</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>integer|false</code><br />
</div>
</div>
</div></td>
</tr>
</table>
<table class="summary" id="constants">
<caption>Constants summary</caption>
<tr data-order="FATAL" id="FATAL">
<td class="attributes"><code>integer</code></td>
<td class="name"><code>
<a href="source-class-Slim.Log.html#59" title="Go to source code"><b>FATAL</b></a>
</code></td>
<td class="value"><code><span class="php-num">0</span></code></td>
<td class="description"><div>
<a href="#FATAL" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="ERROR" id="ERROR">
<td class="attributes"><code>integer</code></td>
<td class="name"><code>
<a href="source-class-Slim.Log.html#60" title="Go to source code"><b>ERROR</b></a>
</code></td>
<td class="value"><code><span class="php-num">1</span></code></td>
<td class="description"><div>
<a href="#ERROR" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="WARN" id="WARN">
<td class="attributes"><code>integer</code></td>
<td class="name"><code>
<a href="source-class-Slim.Log.html#61" title="Go to source code"><b>WARN</b></a>
</code></td>
<td class="value"><code><span class="php-num">2</span></code></td>
<td class="description"><div>
<a href="#WARN" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="INFO" id="INFO">
<td class="attributes"><code>integer</code></td>
<td class="name"><code>
<a href="source-class-Slim.Log.html#62" title="Go to source code"><b>INFO</b></a>
</code></td>
<td class="value"><code><span class="php-num">3</span></code></td>
<td class="description"><div>
<a href="#INFO" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="DEBUG" id="DEBUG">
<td class="attributes"><code>integer</code></td>
<td class="name"><code>
<a href="source-class-Slim.Log.html#63" title="Go to source code"><b>DEBUG</b></a>
</code></td>
<td class="value"><code><span class="php-num">4</span></code></td>
<td class="description"><div>
<a href="#DEBUG" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
</table>
<table class="summary" id="properties">
<caption>Properties summary</caption>
<tr data-order="levels" id="$levels">
<td class="attributes"><code>
protected static
array
</code></td>
<td class="name">
<a href="source-class-Slim.Log.html#65-74" title="Go to source code"><var>$levels</var></a>
</td>
<td class="value"><code><span class="php-keyword1">array</span>(
self::FATAL =&gt; <span class="php-quote">'FATAL'</span>,
self::ERROR =&gt; <span class="php-quote">'ERROR'</span>,
self::WARN =&gt; <span class="php-quote">'WARN'</span>,
self::INFO =&gt; <span class="php-quote">'INFO'</span>,
self::DEBUG =&gt; <span class="php-quote">'DEBUG'</span>
)</code></td>
<td class="description"><div>
<a href="#$levels" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="writer" id="$writer">
<td class="attributes"><code>
protected
mixed
</code></td>
<td class="name">
<a href="source-class-Slim.Log.html#76-79" title="Go to source code"><var>$writer</var></a>
</td>
<td class="value"><code></code></td>
<td class="description"><div>
<a href="#$writer" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="enabled" id="$enabled">
<td class="attributes"><code>
protected
boolean
</code></td>
<td class="name">
<a href="source-class-Slim.Log.html#81-84" title="Go to source code"><var>$enabled</var></a>
</td>
<td class="value"><code></code></td>
<td class="description"><div>
<a href="#$enabled" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="level" id="$level">
<td class="attributes"><code>
protected
integer
</code></td>
<td class="name">
<a href="source-class-Slim.Log.html#86-89" title="Go to source code"><var>$level</var></a>
</td>
<td class="value"><code></code></td>
<td class="description"><div>
<a href="#$level" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
GeoApi API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>