536 lines
32 KiB
HTML
536 lines
32 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\SAI\sai
|
|
</title>
|
|
<meta name="author" content=""/>
|
|
<meta name="description" content=""/>
|
|
<base href="../">
|
|
|
|
<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="\LIB">LIB</a></li>
|
|
<li><a href="\GIT">GIT</a></li>
|
|
<li><a href="\vakata">vakata</a></li>
|
|
<li><a href="\Michelf">Michelf</a></li>
|
|
<li><a href="\MatthiasMullie">MatthiasMullie</a></li>
|
|
<li><a href="\PHPDocMD">PHPDocMD</a></li>
|
|
<li><a href="\ScssPhp">ScssPhp</a></li>
|
|
<li><a href="\SYSTEM">SYSTEM</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_getAllModules" title="getAllModules :: Get all classnames of all the registered saimods">
|
|
<span class="description">Get all classnames of all the registered saimods</span><pre>getAllModules</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_getModules" title="getModules :: Get all classnames of the registered user saimods">
|
|
<span class="description">Get all classnames of the registered user saimods</span><pre>getModules</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_getStartModule" title="getStartModule :: Get the classname of the Startmodule">
|
|
<span class="description">Get the classname of the Startmodule</span><pre>getStartModule</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_register" title="register :: Register a Sai Module">
|
|
<span class="description">Register a Sai Module</span><pre>register</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_register_start" title="register_start :: Sets the Sai Startmodule">
|
|
<span class="description">Sets the Sai Startmodule</span><pre>register_start</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_check_module" title="check_module :: Check if a given SaiModuleClass is valid">
|
|
<span class="description">Check if a given SaiModuleClass is valid</span><pre>check_module</pre>
|
|
</a>
|
|
</li>
|
|
</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>sai</h1>
|
|
<small style="display: block; text-align: right">
|
|
</small>
|
|
<p class="short_description">sai Class provided by System to register and manage saimods</p>
|
|
<div class="details">
|
|
<div class="long_description">
|
|
|
|
</div>
|
|
<table class="table table-bordered">
|
|
<tr>
|
|
<th>
|
|
package
|
|
</th>
|
|
<td>
|
|
|
|
<p>SYSTEM\SAI</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><i class="icon-custom icon-method"></i> Methods</h3>
|
|
<a id="method_check_module"></a>
|
|
<div class="element clickable method private method_check_module" data-toggle="collapse" data-target=".method_check_module .collapse">
|
|
<h2>Check if a given SaiModuleClass is valid</h2>
|
|
<pre>check_module(stringmodule) : bool</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>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>module</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p><p>Classname of the Module to be checked</p>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p><p>Returns true or false.</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getAllModules"></a>
|
|
<div class="element clickable method public method_getAllModules" data-toggle="collapse" data-target=".method_getAllModules .collapse">
|
|
<h2>Get all classnames of all the registered saimods</h2>
|
|
<pre>getAllModules() : array</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>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
array</code><p><p>Returns array with classname of all the registered Modules.</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getModules"></a>
|
|
<div class="element clickable method public method_getModules" data-toggle="collapse" data-target=".method_getModules .collapse">
|
|
<h2>Get all classnames of the registered user saimods</h2>
|
|
<pre>getModules() : array</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>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
array</code><p><p>Returns array with classname of the registered Modules.</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getStartModule"></a>
|
|
<div class="element clickable method public method_getStartModule" data-toggle="collapse" data-target=".method_getStartModule .collapse">
|
|
<h2>Get the classname of the Startmodule</h2>
|
|
<pre>getStartModule() : 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">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p><p>Returns classname of the Startmodule.</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_register"></a>
|
|
<div class="element clickable method public method_register" data-toggle="collapse" data-target=".method_register .collapse">
|
|
<h2>Register a Sai Module</h2>
|
|
<pre>register(stringmodule) : 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>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>module</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p><p>Classname of the Module</p>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
null</code><p><p>Returns null.</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_register_start"></a>
|
|
<div class="element clickable method public method_register_start" data-toggle="collapse" data-target=".method_register_start .collapse">
|
|
<h2>Sets the Sai Startmodule</h2>
|
|
<pre>register_start(stringmodule) : 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>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>module</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p><p>Classname of the Module to be Startmodule</p>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
null</code><p><p>Returns null.</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<h3><i class="icon-custom icon-property"></i> Properties</h3>
|
|
<a id="property_module_start"> </a>
|
|
<div class="element clickable property private property_module_start" data-toggle="collapse" data-target=".property_module_start .collapse">
|
|
<h2>string Classname of the Module which should be loaded at start</h2>
|
|
<pre>module_start : </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>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="property_modules"> </a>
|
|
<div class="element clickable property private property_modules" data-toggle="collapse" data-target=".property_modules .collapse">
|
|
<h2>array Classnames of all registered Sai user Modules</h2>
|
|
<pre>modules : </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>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="\SYSTEM\SAI\sai"></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="\SYSTEM\SAI">SAI</a></li>
|
|
|
|
<li class="active"><span class="divider">\</span><a href="\SYSTEM\SAI\sai">sai</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<footer class="span12">
|
|
Template is built using <a href="https://getbootstrap.com/">Twitter Bootstrap 2</a> and icons provided by
|
|
<a href="https://glyphicons.com/">Glyphicons</a>.<br/>
|
|
Documentation is powered by <a href="https://www.phpdoc.org/">phpDocumentor </a> and<br/>
|
|
generated on Thu, 21 Nov 2024 01:33:25 +0000.<br/>
|
|
</footer>
|
|
</body>
|
|
</html>
|