400 lines
23 KiB
HTML
400 lines
23 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 » \SYSTEM\system
|
|
</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> 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> Errors
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../markers.html">
|
|
<i class="icon-list-alt"></i> Markers
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../deprecated.html">
|
|
<i class="icon-list-alt"></i> Deprecated
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="go_to_top">
|
|
<a href="#___" style="color: inherit">Back to top  <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_getSystemDBInfo" title="getSystemDBInfo :: Returns the Database Connection from System Config.">
|
|
<span class="description">Returns the Database Connection from System Config.</span><pre>getSystemDBInfo</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_isSystemDbInfoPG" title="isSystemDbInfoPG :: Check if the System-Environment-Wide Database Connection is MYSQL or PostgreSQL">
|
|
<span class="description">Check if the System-Environment-Wide Database Connection is MYSQL or PostgreSQL</span><pre>isSystemDbInfoPG</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_register_errorhandler_dbwriter" title="register_errorhandler_dbwriter :: Register the Database Writer Error Handle which will write all Catched
|
|
SystemExceptions to the Database">
|
|
<span class="description">Register the Database Writer Error Handle which will write all Catched
|
|
SystemExceptions to the Database</span><pre>register_errorhandler_dbwriter</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_register_errorhandler_jsonoutput" title="register_errorhandler_jsonoutput :: Register the JSON Output Error Handle which will print all Errors as JSON
|
|
to the caller">
|
|
<span class="description">Register the JSON Output Error Handle which will print all Errors as JSON
|
|
to the caller</span><pre>register_errorhandler_jsonoutput</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_start" title="start :: Start the System Environment. This Function sums up many things needed to
|
|
be done after include of the autoload file.">
|
|
<span class="description">Start the System Environment. This Function sums up many things needed to
|
|
be done after include of the autoload file.</span><pre>start</pre>
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header protected">» Protected
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header private">» Private
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header">
|
|
<i class="icon-custom icon-constant"></i> Constants
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="span8">
|
|
<div class="element class">
|
|
<h1>system</h1>
|
|
<small style="display: block; text-align: right">
|
|
</small>
|
|
<p class="short_description">System Class provided by System to start the environment (system clock & config
|
|
aswell as optional includes) and handles the Systemwide Database Credentials</p>
|
|
<div class="details">
|
|
<div class="long_description">
|
|
|
|
</div>
|
|
<table class="table table-bordered">
|
|
<tr>
|
|
<th>
|
|
package
|
|
</th>
|
|
<td>
|
|
|
|
<p>SYSTEM</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><i class="icon-custom icon-method"></i> Methods</h3>
|
|
<a id="method_getSystemDBInfo"></a>
|
|
<div class="element clickable method public method_getSystemDBInfo" data-toggle="collapse" data-target=".method_getSystemDBInfo .collapse">
|
|
<h2>Returns the Database Connection from System Config.</h2>
|
|
<pre>getSystemDBInfo() : object</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Supports MYSQL and PostgreSQL</p></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Response</h3>
|
|
<code>object</code><p><p>Returns \SYSTEM\DB\DBInfoPG or \SYSTEM\DB\DBInfoMYS depending on configrated Database.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_isSystemDbInfoPG"></a>
|
|
<div class="element clickable method public method_isSystemDbInfoPG" data-toggle="collapse" data-target=".method_isSystemDbInfoPG .collapse">
|
|
<h2>Check if the System-Environment-Wide Database Connection is MYSQL or PostgreSQL</h2>
|
|
<pre>isSystemDbInfoPG() : 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">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Response</h3>
|
|
<code>boolean</code><p><p>Returns true if Databaseconnection is PostgreSQL else false.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_register_errorhandler_dbwriter"></a>
|
|
<div class="element clickable method public method_register_errorhandler_dbwriter" data-toggle="collapse" data-target=".method_register_errorhandler_dbwriter .collapse">
|
|
<h2>Register the Database Writer Error Handle which will write all Catched
|
|
SystemExceptions to the Database</h2>
|
|
<pre>register_errorhandler_dbwriter() : 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">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Response</h3>
|
|
<code>null</code><p><p>Returns null</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_register_errorhandler_jsonoutput"></a>
|
|
<div class="element clickable method public method_register_errorhandler_jsonoutput" data-toggle="collapse" data-target=".method_register_errorhandler_jsonoutput .collapse">
|
|
<h2>Register the JSON Output Error Handle which will print all Errors as JSON
|
|
to the caller</h2>
|
|
<pre>register_errorhandler_jsonoutput() : 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">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Response</h3>
|
|
<code>null</code><p><p>Returns null</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_start"></a>
|
|
<div class="element clickable method public method_start" data-toggle="collapse" data-target=".method_start .collapse">
|
|
<h2>Start the System Environment. This Function sums up many things needed to
|
|
be done after include of the autoload file.</h2>
|
|
<pre>start(array $config, boolean $short_exc = true, boolean $short_res = true, boolean $error_db = true, boolean $error_json = true) : null</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Flushes given Config values
|
|
Starts the internal clock.
|
|
Sets Error-reporting level according to config
|
|
(opt)Allows to turn off optional includes which pollute global Namespace.
|
|
(opt)Register Error-Handler-DB-Writer to log System Events to the Database
|
|
(opt)Register Error-Handler-JSON-Output to return Errors as JSON.</p>
|
|
<p>Config has following format
|
|
array( array(ID, VALUE), array(ID, VALUE))
|
|
For IDs @see \SYSTEM\CONFIG\config_ids
|
|
Extend this class to define your own.</p></div>
|
|
|
|
<table class="table">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$config</h4>
|
|
<code>array</code><p><p>Configuration Array passed upon Enviroment Start</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$short_exc</h4>
|
|
<code>boolean</code><p><p>Include Shortcut for System Log Classes in global Namespace</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$short_res</h4>
|
|
<code>boolean</code><p><p>Include Shortcut for System Result Classes in global Namespace</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$error_db</h4>
|
|
<code>boolean</code><p><p>Include Shortcut for System Log Classes in global Namespace</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$error_json</h4>
|
|
<code>boolean</code><p><p>Include Shortcut for System Log Classes in global Namespace</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>null</code><p><p>Returns null.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<a id="\SYSTEM\system"></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.html">SYSTEM</a></li>
|
|
|
|
<li class="active"><span class="divider">\</span><a href="../classes/SYSTEM.system.html">system</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>
|