1289 lines
86 KiB
HTML
1289 lines
86 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\API\api_default
|
|
</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 inherited">
|
|
<a href="#method_call_account_action_change_email" title="call_account_action_change_email :: System Account Request Change EMail Token">
|
|
<span class="description">System Account Request Change EMail Token</span><pre>call_account_action_change_email</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_change_password" title="call_account_action_change_password :: System Account Change Password">
|
|
<span class="description">System Account Change Password</span><pre>call_account_action_change_password</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_check" title="call_account_action_check :: System Account Right Check">
|
|
<span class="description">System Account Right Check</span><pre>call_account_action_check</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_confirm" title="call_account_action_confirm :: System Account Confirm Tokens">
|
|
<span class="description">System Account Confirm Tokens</span><pre>call_account_action_confirm</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_confirm_email" title="call_account_action_confirm_email :: System Account Request Confirm EMail Token">
|
|
<span class="description">System Account Request Confirm EMail Token</span><pre>call_account_action_confirm_email</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_create" title="call_account_action_create :: System Account Create">
|
|
<span class="description">System Account Create</span><pre>call_account_action_create</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_isloggedin" title="call_account_action_isloggedin :: System Account isloggedin check">
|
|
<span class="description">System Account isloggedin check</span><pre>call_account_action_isloggedin</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_login" title="call_account_action_login :: System Account Login">
|
|
<span class="description">System Account Login</span><pre>call_account_action_login</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_logout" title="call_account_action_logout :: System Account Logout">
|
|
<span class="description">System Account Logout</span><pre>call_account_action_logout</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_reset_password" title="call_account_action_reset_password :: System Account Request Reset Password Token">
|
|
<span class="description">System Account Request Reset Password Token</span><pre>call_account_action_reset_password</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_bug" title="call_bug :: API Bug Call to report Bugs">
|
|
<span class="description">API Bug Call to report Bugs</span><pre>call_bug</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_cache" title="call_cache :: API Cache Call to request cached Data (usually js and css)">
|
|
<span class="description">API Cache Call to request cached Data (usually js and css)</span><pre>call_cache</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_cron" title="call_cron :: System run Cron Call">
|
|
<span class="description">System run Cron Call</span><pre>call_cron</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_files" title="call_files :: System File Request Call">
|
|
<span class="description">System File Request Call</span><pre>call_files</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_pages" title="call_pages :: System State-Pages Request Call">
|
|
<span class="description">System State-Pages Request Call</span><pre>call_pages</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_text" title="call_text :: System Text Request Call">
|
|
<span class="description">System Text Request Call</span><pre>call_text</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_get_class" title="get_class :: API Class function - implement this function and return the Classname">
|
|
<span class="description">API Class function - implement this function and return the Classname</span><pre>get_class</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_static__" title="static__ :: Static Time-Parameter _ Call to avoid caching and API Errors for JS requests">
|
|
<span class="description">Static Time-Parameter _ Call to avoid caching and API Errors for JS requests</span><pre>static__</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_static__escaped_fragment_" title="static__escaped_fragment_ :: Static Call handler for Hashbang-Crawling Requests">
|
|
<span class="description">Static Call handler for Hashbang-Crawling Requests</span><pre>static__escaped_fragment_</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_static__lang" title="static__lang :: Static Call to change Language for the current Session/User">
|
|
<span class="description">Static Call to change Language for the current Session/User</span><pre>static__lang</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_static__result" title="static__result :: Static Call to change Result-Type for the current Session/User">
|
|
<span class="description">Static Call to change Result-Type for the current Session/User</span><pre>static__result</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>api_default</h1>
|
|
<small style="display: block; text-align: right">
|
|
Extends <a href="classes/SYSTEM-API-api-system.html"><abbr title="\SYSTEM\API\api_system">api_system</abbr></a>
|
|
Implements <a href="classes/SYSTEM-API-api-default-interface.html"><abbr title="\SYSTEM\API\api_default_interface">api_default_interface</abbr></a>
|
|
</small>
|
|
<p class="short_description">API Default class providing defaulting capabilities and Hashbang-Crawling-Scheme.</p>
|
|
<div class="details">
|
|
<div class="long_description">
|
|
|
|
</div>
|
|
<table class="table table-bordered">
|
|
<tr>
|
|
<th>
|
|
package
|
|
</th>
|
|
<td>
|
|
|
|
<p>SYSTEM\API</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><i class="icon-custom icon-method"></i> Methods</h3>
|
|
<a id="method_call_account_action_change_email"></a>
|
|
<div class="element clickable method public method_call_account_action_change_email inherited" data-toggle="collapse" data-target=".method_call_account_action_change_email .collapse">
|
|
<h2>System Account Request Change EMail Token</h2>
|
|
<pre>call_account_action_change_email(stringnew_email) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>new_email</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>Users new EMail Address</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_change_password"></a>
|
|
<div class="element clickable method public method_call_account_action_change_password inherited" data-toggle="collapse" data-target=".method_call_account_action_change_password .collapse">
|
|
<h2>System Account Change Password</h2>
|
|
<pre>call_account_action_change_password(stringold_password_sha1, stringnew_password_sha1) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>old_password_sha1</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>Users Old Password SHA1 String</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>new_password_sha1</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>Users New Password SHA1 String</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_check"></a>
|
|
<div class="element clickable method public method_call_account_action_check inherited" data-toggle="collapse" data-target=".method_call_account_action_check .collapse">
|
|
<h2>System Account Right Check</h2>
|
|
<pre>call_account_action_check(intrightid) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>rightid</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
|
|
int</code><p><p>RightID of the right 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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_confirm"></a>
|
|
<div class="element clickable method public method_call_account_action_confirm inherited" data-toggle="collapse" data-target=".method_call_account_action_confirm .collapse">
|
|
<h2>System Account Confirm Tokens</h2>
|
|
<pre>call_account_action_confirm(stringtoken) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>token</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>Token to do specifics with your Account</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_confirm_email"></a>
|
|
<div class="element clickable method public method_call_account_action_confirm_email inherited" data-toggle="collapse" data-target=".method_call_account_action_confirm_email .collapse">
|
|
<h2>System Account Request Confirm EMail Token</h2>
|
|
<pre>call_account_action_confirm_email() : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_create"></a>
|
|
<div class="element clickable method public method_call_account_action_create inherited" data-toggle="collapse" data-target=".method_call_account_action_create .collapse">
|
|
<h2>System Account Create</h2>
|
|
<pre>call_account_action_create(stringusername, \SYSTEM\API\sha1password_sha1, \SYSTEM\API\emailemail, \SYSTEM\API\langlocale = null) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>username</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>Username</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>password_sha1</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
|
|
\SYSTEM\API\sha1</code><p><p>User Password SHA1 String</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>email</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
|
|
\SYSTEM\API\email</code><p><p>Email of the new User</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>locale</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
|
|
\SYSTEM\API\lang</code><p><p>Locale which the User wants to register or null for default language</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_isloggedin"></a>
|
|
<div class="element clickable method public method_call_account_action_isloggedin inherited" data-toggle="collapse" data-target=".method_call_account_action_isloggedin .collapse">
|
|
<h2>System Account isloggedin check</h2>
|
|
<pre>call_account_action_isloggedin() : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_login"></a>
|
|
<div class="element clickable method public method_call_account_action_login inherited" data-toggle="collapse" data-target=".method_call_account_action_login .collapse">
|
|
<h2>System Account Login</h2>
|
|
<pre>call_account_action_login(stringusername, \SYSTEM\API\sha1password_sha1, \SYSTEM\API\langlocale = null) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>username</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>Username</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>password_sha1</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
|
|
\SYSTEM\API\sha1</code><p><p>User Password SHA1 String</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>locale</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
|
|
\SYSTEM\API\lang</code><p><p>Locale which the User wants to login with</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_logout"></a>
|
|
<div class="element clickable method public method_call_account_action_logout inherited" data-toggle="collapse" data-target=".method_call_account_action_logout .collapse">
|
|
<h2>System Account Logout</h2>
|
|
<pre>call_account_action_logout() : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_reset_password"></a>
|
|
<div class="element clickable method public method_call_account_action_reset_password inherited" data-toggle="collapse" data-target=".method_call_account_action_reset_password .collapse">
|
|
<h2>System Account Request Reset Password Token</h2>
|
|
<pre>call_account_action_reset_password(stringusername) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>username</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>Username</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_bug"></a>
|
|
<div class="element clickable method public method_call_bug inherited" data-toggle="collapse" data-target=".method_call_bug .collapse">
|
|
<h2>API Bug Call to report Bugs</h2>
|
|
<pre>call_bug(stringmessage, \SYSTEM\API\JSONdata) : null</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>message</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>Bugreport Message</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>data</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
|
|
\SYSTEM\API\JSON</code><p><p>Bugreport Data</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 JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_cache"></a>
|
|
<div class="element clickable method public method_call_cache inherited" data-toggle="collapse" data-target=".method_call_cache .collapse">
|
|
<h2>API Cache Call to request cached Data (usually js and css)</h2>
|
|
<pre>call_cache(intid, \SYSTEM\API\sha1ident) : mixed</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>id</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
|
|
int</code><p><p>Cache id to be queried</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>ident</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
|
|
\SYSTEM\API\sha1</code><p><p>Cache ident to be queried</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
|
|
mixed</code><p><p>Returns cached Data from Database</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_cron"></a>
|
|
<div class="element clickable method public method_call_cron inherited" data-toggle="collapse" data-target=".method_call_cron .collapse">
|
|
<h2>System run Cron Call</h2>
|
|
<pre>call_cron() : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_files"></a>
|
|
<div class="element clickable method public method_call_files inherited" data-toggle="collapse" data-target=".method_call_files .collapse">
|
|
<h2>System File Request Call</h2>
|
|
<pre>call_files(stringcat, stringid = null) : mixed</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>cat</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>File category</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>id</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>File name</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
|
|
mixed</code><p><p>Returns JSON result with failure status or streams the File</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_pages"></a>
|
|
<div class="element clickable method public method_call_pages inherited" data-toggle="collapse" data-target=".method_call_pages .collapse">
|
|
<h2>System State-Pages Request Call</h2>
|
|
<pre>call_pages(intgroup, stringstate) : mixed</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>group</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
|
|
int</code><p><p>Page Group for Statesystem</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>state</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>Full name of the State.</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
|
|
mixed</code><p><p>Returns JSON result with data/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_text"></a>
|
|
<div class="element clickable method public method_call_text inherited" data-toggle="collapse" data-target=".method_call_text .collapse">
|
|
<h2>System Text Request Call</h2>
|
|
<pre>call_text(mixedrequest, \SYSTEM\API\langlang) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>request</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
|
|
mixed</code><p><p>Request String for Text API</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>lang</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
|
|
\SYSTEM\API\lang</code><p><p>Request Language for given text</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with data/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_get_class"></a>
|
|
<div class="element clickable method public method_get_class" data-toggle="collapse" data-target=".method_get_class .collapse">
|
|
<h2>API Class function - implement this function and return the Classname</h2>
|
|
<pre>get_class() : 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 your API-Class name</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_static__"></a>
|
|
<div class="element clickable method public method_static__ inherited" data-toggle="collapse" data-target=".method_static__ .collapse">
|
|
<h2>Static Time-Parameter _ Call to avoid caching and API Errors for JS requests</h2>
|
|
<pre>static__(mixed_) : null</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>_</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
|
|
mixed</code><p><p>Anticaching Parameter of some Browsers</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 nothing</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_static__escaped_fragment_"></a>
|
|
<div class="element clickable method public method_static__escaped_fragment_" data-toggle="collapse" data-target=".method_static__escaped_fragment_ .collapse">
|
|
<h2>Static Call handler for Hashbang-Crawling Requests</h2>
|
|
<pre>static__escaped_fragment_(string_escaped_fragment_) : 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>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>_escaped_fragment_</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>Hashbang-Encoded State</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
|
|
string</code><p><p>Returns your API-HTML result as HTML-Snapshot</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_static__lang"></a>
|
|
<div class="element clickable method public method_static__lang inherited" data-toggle="collapse" data-target=".method_static__lang .collapse">
|
|
<h2>Static Call to change Language for the current Session/User</h2>
|
|
<pre>static__lang(\SYSTEM\API\langlang) : null</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>lang</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
|
|
\SYSTEM\API\lang</code><p><p>Language requested</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 nothing</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_static__result"></a>
|
|
<div class="element clickable method public method_static__result inherited" data-toggle="collapse" data-target=".method_static__result .collapse">
|
|
<h2>Static Call to change Result-Type for the current Session/User</h2>
|
|
<pre>static__result(\SYSTEM\API\resultresult) : null</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>result</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
|
|
\SYSTEM\API\result</code><p><p>Resulttype</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 nothing</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<a id="\SYSTEM\API\api_default"></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\API">API</a></li>
|
|
|
|
<li class="active"><span class="divider">\</span><a href="\SYSTEM\API\api_default">api_default</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:22 +0000.<br/>
|
|
</footer>
|
|
</body>
|
|
</html>
|