docu_system/classes/SYSTEM.LOG.log.html
2017-07-25 11:40:54 +02:00

473 lines
29 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title> SYSTEM - PHP Framework &raquo; \SYSTEM\LOG\log
</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<link href="../css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
<![endif]-->
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script>
<script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
<script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script>
<script src="../js/bootstrap.js" type="text/javascript"></script>
<script src="../js/template.js" type="text/javascript"></script>
<script src="../js/prettify/prettify.min.js" type="text/javascript"></script>
<link rel="shortcut icon" href="../img/favicon.ico"/>
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png"/>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span> <span class="icon-bar"></span>
<span class="icon-bar"></span> </a>
<a class="brand" href="../index.html">SYSTEM - PHP Framework</a>
<div class="nav-collapse">
<ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/SYSTEM.html">SYSTEM</a></li>
<li><a href="../namespaces/LIB.html">LIB</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graph_class.html">
<i class="icon-list-alt"></i>&#160;Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../errors.html">
<i class="icon-list-alt"></i>&#160;Errors
</a>
</li>
<li>
<a href="../markers.html">
<i class="icon-list-alt"></i>&#160;Markers
</a>
</li>
<li>
<a href="../deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="go_to_top">
<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>
</div>
</div>
<div id="___" class="container">
<noscript>
<div class="alert alert-warning">
Javascript is disabled; several features are only available if Javascript is enabled.
</div>
</noscript>
<style>
.deprecated h2 {
text-decoration: line-through;
}
</style>
<div class="row">
<div class="span4">
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button>
<button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button>
<button class="btn protected" title="Show protected elements">Protected</button>
<button class="btn private" title="Show private elements">Private</button>
<button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
<ul>
<li class="method public">
<a href="#method___error_handler" title="__error_handler :: Error Handler for System-log handling">
<span class="description">Error Handler for System-log handling</span><pre>__error_handler</pre>
</a>
</li>
<li class="method public">
<a href="#method___exception_handler" title="__exception_handler :: Exception Handler for System-log handling">
<span class="description">Exception Handler for System-log handling</span><pre>__exception_handler</pre>
</a>
</li>
<li class="method public">
<a href="#method___fatal_error_handler" title="__fatal_error_handler :: Fatal Error Handler for System-log handling
(unused - experimental)">
<span class="description">Fatal Error Handler for System-log handling
(unused - experimental)</span><pre>__fatal_error_handler</pre>
</a>
</li>
<li class="method public">
<a href="#method___shutdown_handler" title="__shutdown_handler :: Shutdown Handler for System-log handling">
<span class="description">Shutdown Handler for System-log handling</span><pre>__shutdown_handler</pre>
</a>
</li>
<li class="method public">
<a href="#method_registerHandler" title="registerHandler :: Register a Log Handler">
<span class="description">Register a Log Handler</span><pre>registerHandler</pre>
</a>
</li>
</ul>
</li>
<li class="nav-header protected">» Protected
<ul>
</ul>
</li>
<li class="nav-header private">» Private
<ul>
<li class="method private">
<a href="#method_call_handlers" title="call_handlers :: Call handlers function upon error">
<span class="description">Call handlers function upon error</span><pre>call_handlers</pre>
</a>
</li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants
<ul>
<li class="constant ">
<a href="#constant_HANDLER_FUNC_CALL" title="HANDLER_FUNC_CALL :: string Variable to store hander function call name">
<span class="description">string Variable to store hander function call name</span><pre>HANDLER_FUNC_CALL</pre>
</a>
</li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<div class="element class">
<h1>log</h1>
<small style="display: block; text-align: right">
</small>
<p class="short_description">Log Class provided by System to manage log handlers.</p>
<div class="details">
<div class="long_description">
</div>
<table class="table table-bordered">
<tr>
<th>
package
</th>
<td>
<p>SYSTEM\LOG</p>
</td>
</tr>
</table>
<h3><i class="icon-custom icon-method"></i> Methods</h3>
<a id="method___error_handler"></a>
<div class="element clickable method public method___error_handler" data-toggle="collapse" data-target=".method___error_handler .collapse">
<h2>Error Handler for System-log handling</h2>
<pre>__error_handler(integer $code, string $message, string $file, string $line, boolean $thrown = true) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$code</h4>
<code>integer</code><p><p>Errorcode</p></p>
</div>
<div class="subelement argument">
<h4>$message</h4>
<code>string</code><p><p>Error Message</p></p>
</div>
<div class="subelement argument">
<h4>$file</h4>
<code>string</code><p><p>Error File</p></p>
</div>
<div class="subelement argument">
<h4>$line</h4>
<code>string</code><p><p>Error File-Line</p></p>
</div>
<div class="subelement argument">
<h4>$thrown</h4>
<code>boolean</code><p><p>Was the Error thrown?</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns true or false</p></p>
</div>
</div>
</div>
<a id="method___exception_handler"></a>
<div class="element clickable method public method___exception_handler" data-toggle="collapse" data-target=".method___exception_handler .collapse">
<h2>Exception Handler for System-log handling</h2>
<pre>__exception_handler(\Exception $E, boolean $thrown = true) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$E</h4>
<code>\Exception</code><p><p>Thrown Execption to be handled</p></p>
</div>
<div class="subelement argument">
<h4>$thrown</h4>
<code>boolean</code><p><p>Was the Exception thrown?</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns true or false depending on thrown</p></p>
</div>
</div>
</div>
<a id="method___fatal_error_handler"></a>
<div class="element clickable method public method___fatal_error_handler" data-toggle="collapse" data-target=".method___fatal_error_handler .collapse">
<h2>Fatal Error Handler for System-log handling
(unused - experimental)</h2>
<pre>__fatal_error_handler(string $bufferContent, boolean $thrown = true) : string</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$bufferContent</h4>
<code>string</code><p><p>Website contens before sent to user</p></p>
</div>
<div class="subelement argument">
<h4>$thrown</h4>
<code>boolean</code><p><p>Was the Error thrown?</p></p>
</div>
<h3>Response</h3>
<code>string</code><p><p>Returns the buffercontent or an json error.</p></p>
</div>
</div>
</div>
<a id="method___shutdown_handler"></a>
<div class="element clickable method public method___shutdown_handler" data-toggle="collapse" data-target=".method___shutdown_handler .collapse">
<h2>Shutdown Handler for System-log handling</h2>
<pre>__shutdown_handler(boolean $thrown = true) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$thrown</h4>
<code>boolean</code><p><p>Was the Error thrown?</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns true or false</p></p>
</div>
</div>
</div>
<a id="method_call_handlers"></a>
<div class="element clickable method private method_call_handlers" data-toggle="collapse" data-target=".method_call_handlers .collapse">
<h2>Call handlers function upon error</h2>
<pre>call_handlers(\Exception $E, boolean $thrown = true) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$E</h4>
<code>\Exception</code><p><p>Thrown Execption to be handled</p></p>
</div>
<div class="subelement argument">
<h4>$thrown</h4>
<code>boolean</code><p><p>Was the Exception thrown?</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns true or false.</p></p>
</div>
</div>
</div>
<a id="method_registerHandler"></a>
<div class="element clickable method public method_registerHandler" data-toggle="collapse" data-target=".method_registerHandler .collapse">
<h2>Register a Log Handler</h2>
<pre>registerHandler(\SYSTEM\LOG\class $handler) : null</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$handler</h4>
<code>\SYSTEM\LOG\class</code><p><p>Classname of the handler to be registered</p></p>
</div>
<h3>Response</h3>
<code>null</code><p><p>Returns null.</p></p>
</div>
</div>
</div>
<h3><i class="icon-custom icon-constant"></i> Constants</h3>
<a id="constant_HANDLER_FUNC_CALL"> </a>
<div class="element clickable constant constant_HANDLER_FUNC_CALL" data-toggle="collapse" data-target=".constant_HANDLER_FUNC_CALL .collapse">
<h2>string Variable to store hander function call name</h2>
<pre>HANDLER_FUNC_CALL</pre>
<div class="labels">
</div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<h3><i class="icon-custom icon-property"></i> Properties</h3>
<a id="property_handlers"> </a>
<div class="element clickable property private property_handlers" data-toggle="collapse" data-target=".property_handlers .collapse">
<h2>array Variable to store all registred log handlers</h2>
<pre>handlers : </pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Type(s)</h3>
<code></code>
</div>
</div>
</div>
</div>
</div>
<a id="\SYSTEM\LOG\log"></a>
<ul class="breadcrumb">
<li><a href="../index.html"><i class="icon-custom icon-class"></i></a></li>
<li><span class="divider">\</span><a href="../namespaces/SYSTEM.LOG.html">LOG</a></li>
<li class="active"><span class="divider">\</span><a href="../classes/SYSTEM.LOG.log.html">log</a></li>
</ul>
</div>
</div>
</div>
<footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
<a href="http://glyphicons.com/">Glyphicons</a>.<br/>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
generated on Tue, 25 Jul 2017 11:33:08 +0200.<br/>
</footer>
</body>
</html>