722 lines
49 KiB
HTML
722 lines
49 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
|
|
</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_run" title="run :: Run the API Mechanism with your Data.">
|
|
<span class="description">Run the API Mechanism with your Data.</span><pre>run</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_do_commands" title="do_commands :: Internal API function to parse commands for requested API">
|
|
<span class="description">Internal API function to parse commands for requested API</span><pre>do_commands</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_do_default" title="do_default :: Internal API function to parse default redirect for requested API">
|
|
<span class="description">Internal API function to parse default redirect for requested API</span><pre>do_default</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_do_func_name" title="do_func_name :: Internal API function to build function name for requested API">
|
|
<span class="description">Internal API function to build function name for requested API</span><pre>do_func_name</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_do_func_params" title="do_func_params :: Internal API function to build function paramters for requested API">
|
|
<span class="description">Internal API function to build function paramters for requested API</span><pre>do_func_params</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_do_parameters" title="do_parameters :: Internal API function to parse parameters for requested API">
|
|
<span class="description">Internal API function to parse parameters for requested API</span><pre>do_parameters</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_do_parameters_opt" title="do_parameters_opt :: Internal API function to parse optional parameters for requested API">
|
|
<span class="description">Internal API function to parse optional parameters for requested API</span><pre>do_parameters_opt</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_do_statics" title="do_statics :: Internal API function to parse statics for requested API">
|
|
<span class="description">Internal API function to parse statics for requested API</span><pre>do_statics</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_do_strict" title="do_strict :: Internal API function to strict parse the API">
|
|
<span class="description">Internal API function to strict parse the API</span><pre>do_strict</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_getApiTree" title="getApiTree :: Internal API function to retrive the Databasetree for requested API">
|
|
<span class="description">Internal API function to retrive the Databasetree for requested API</span><pre>getApiTree</pre>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header">
|
|
<i class="icon-custom icon-constant"></i> Constants
|
|
<ul>
|
|
<li class="constant ">
|
|
<a href="#constant_DEFAULT_DEFAULT" title="DEFAULT_DEFAULT :: bool Default parse to default setting">
|
|
<span class="description">bool Default parse to default setting</span><pre>DEFAULT_DEFAULT</pre>
|
|
</a>
|
|
</li>
|
|
<li class="constant ">
|
|
<a href="#constant_DEFAULT_GROUP" title="DEFAULT_GROUP :: int Default API Group">
|
|
<span class="description">int Default API Group</span><pre>DEFAULT_GROUP</pre>
|
|
</a>
|
|
</li>
|
|
<li class="constant ">
|
|
<a href="#constant_DEFAULT_STRICT" title="DEFAULT_STRICT :: bool Default parse strict setting">
|
|
<span class="description">bool Default parse strict setting</span><pre>DEFAULT_STRICT</pre>
|
|
</a>
|
|
</li>
|
|
<li class="constant ">
|
|
<a href="#constant_ROOT_PARENTID" title="ROOT_PARENTID :: int Root Node ID">
|
|
<span class="description">int Root Node ID</span><pre>ROOT_PARENTID</pre>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="span8">
|
|
<div class="element class">
|
|
<h1>api</h1>
|
|
<small style="display: block; text-align: right">
|
|
</small>
|
|
<p class="short_description">API Class provided by System for Smart API's.</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_do_commands"></a>
|
|
<div class="element clickable method private method_do_commands" data-toggle="collapse" data-target=".method_do_commands .collapse">
|
|
<h2>Internal API function to parse commands for requested API</h2>
|
|
<pre>do_commands(array $params, array $tree) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$params</h4>
|
|
<code>array</code><p><p>Parameters given to the API</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$tree</h4>
|
|
<code>array</code><p><p>Array with API rules</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Returns array with parsed Commands</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_do_default"></a>
|
|
<div class="element clickable method private method_do_default" data-toggle="collapse" data-target=".method_do_default .collapse">
|
|
<h2>Internal API function to parse default redirect for requested API</h2>
|
|
<pre>do_default(boolean $default, string $apiclassname, string $call_funcname = null) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$default</h4>
|
|
<code>boolean</code><p><p>Defaulting to default_page setting</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$apiclassname</h4>
|
|
<code>string</code><p><p>Classname of the users API class</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$call_funcname</h4>
|
|
<code>string</code><p><p>Functionname which was called</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Array of static API rules</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_do_func_name"></a>
|
|
<div class="element clickable method private method_do_func_name" data-toggle="collapse" data-target=".method_do_func_name .collapse">
|
|
<h2>Internal API function to build function name for requested API</h2>
|
|
<pre>do_func_name(array $commands) : 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>$commands</h4>
|
|
<code>array</code><p><p>Array of all Commands for the given API call</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>string</code><p><p>Returns Function name</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_do_func_params"></a>
|
|
<div class="element clickable method private method_do_func_params" data-toggle="collapse" data-target=".method_do_func_params .collapse">
|
|
<h2>Internal API function to build function paramters for requested API</h2>
|
|
<pre>do_func_params(array $parameters, array $parameters_opt) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$parameters</h4>
|
|
<code>array</code><p><p>Array of all Paramters for the given API call</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$parameters_opt</h4>
|
|
<code>array</code><p><p>Array of all optional Paramters for the given API call</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Returns array with Paramters</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_do_parameters"></a>
|
|
<div class="element clickable method private method_do_parameters" data-toggle="collapse" data-target=".method_do_parameters .collapse">
|
|
<h2>Internal API function to parse parameters for requested API</h2>
|
|
<pre>do_parameters(array $params, array $tree, integer $parentid, string $lastcommandvalue, string $verifyclassname) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$params</h4>
|
|
<code>array</code><p><p>Parameters given to the API</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$tree</h4>
|
|
<code>array</code><p><p>Array with API rules</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$parentid</h4>
|
|
<code>integer</code><p><p>Parentid of last Tree Element</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$lastcommandvalue</h4>
|
|
<code>string</code><p><p>Last value of last Command</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$verifyclassname</h4>
|
|
<code>string</code><p><p>Verify Class given to the API</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Returns array with parsed Parameters</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_do_parameters_opt"></a>
|
|
<div class="element clickable method private method_do_parameters_opt" data-toggle="collapse" data-target=".method_do_parameters_opt .collapse">
|
|
<h2>Internal API function to parse optional parameters for requested API</h2>
|
|
<pre>do_parameters_opt(array $params, array $tree, integer $parentid, string $lastcommandvalue, string $verifyclassname) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$params</h4>
|
|
<code>array</code><p><p>Parameters given to the API</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$tree</h4>
|
|
<code>array</code><p><p>Array with API rules</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$parentid</h4>
|
|
<code>integer</code><p><p>Parentid of last Tree Element</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$lastcommandvalue</h4>
|
|
<code>string</code><p><p>Last value of last Command</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$verifyclassname</h4>
|
|
<code>string</code><p><p>Verify Class given to the API</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Returns array with parsed optional Parameters</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_do_statics"></a>
|
|
<div class="element clickable method private method_do_statics" data-toggle="collapse" data-target=".method_do_statics .collapse">
|
|
<h2>Internal API function to parse statics for requested API</h2>
|
|
<pre>do_statics(array $params, array $tree, string $apiclassname, string $verifyclassname, boolean $default) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$params</h4>
|
|
<code>array</code><p><p>Array of Params given to the API</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$tree</h4>
|
|
<code>array</code><p><p>Array of Rules for given API</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$apiclassname</h4>
|
|
<code>string</code><p><p>Classname of the users API class</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$verifyclassname</h4>
|
|
<code>string</code><p><p>Classname of the users Verify Class</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$default</h4>
|
|
<code>boolean</code><p><p>Defaulting to default_page setting</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Array of static API rules</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_do_strict"></a>
|
|
<div class="element clickable method private method_do_strict" data-toggle="collapse" data-target=".method_do_strict .collapse">
|
|
<h2>Internal API function to strict parse the API</h2>
|
|
<pre>do_strict(boolean $strict, array $params, array $statics, array $commands, array $parameters, array $parameters_opt) : 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>$strict</h4>
|
|
<code>boolean</code><p><p>Strict settings</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$params</h4>
|
|
<code>array</code><p><p>Parameters given to the API</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$statics</h4>
|
|
<code>array</code><p><p>Array with API statics</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$commands</h4>
|
|
<code>array</code><p><p>Array with API commands</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$parameters</h4>
|
|
<code>array</code><p><p>Array with API parameters</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$parameters_opt</h4>
|
|
<code>array</code><p><p>Array with API optional parameters</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>null</code><p><p>Returns nothing or throws an Strict Error</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getApiTree"></a>
|
|
<div class="element clickable method private method_getApiTree" data-toggle="collapse" data-target=".method_getApiTree .collapse">
|
|
<h2>Internal API function to retrive the Databasetree for requested API</h2>
|
|
<pre>getApiTree(integer $group) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$group</h4>
|
|
<code>integer</code><p><p>API Group to be read</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Array of API rules</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_run"></a>
|
|
<div class="element clickable method public method_run" data-toggle="collapse" data-target=".method_run .collapse">
|
|
<h2>Run the API Mechanism with your Data.</h2>
|
|
<pre>run(string $verifyclassname, string $apiclassname, array $params, integer $group = self::DEFAULT_GROUP, boolean $strict = self::DEFAULT_STRICT, boolean $default = self::DEFAULT_DEFAULT) : mixed</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>$verifyclassname</h4>
|
|
<code>string</code><p><p>Your class on which the parameter restriction is parsed upon</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$apiclassname</h4>
|
|
<code>string</code><p><p>Your class which provides your API</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$params</h4>
|
|
<code>array</code><p><p>Parameters given to the API</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$group</h4>
|
|
<code>integer</code><p><p>API Group to be used to parse Call</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$strict</h4>
|
|
<code>boolean</code><p><p>Parse the API in a strict way</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$default</h4>
|
|
<code>boolean</code><p><p>Defaulting to default_page setting</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>mixed</code><p><p>Returns your API result or an JSON Error</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<h3><i class="icon-custom icon-constant"></i> Constants</h3>
|
|
<a id="constant_ROOT_PARENTID"> </a>
|
|
<div class="element clickable constant constant_ROOT_PARENTID" data-toggle="collapse" data-target=".constant_ROOT_PARENTID .collapse">
|
|
<h2>int Root Node ID</h2>
|
|
<pre>ROOT_PARENTID</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>
|
|
<a id="constant_DEFAULT_GROUP"> </a>
|
|
<div class="element clickable constant constant_DEFAULT_GROUP" data-toggle="collapse" data-target=".constant_DEFAULT_GROUP .collapse">
|
|
<h2>int Default API Group</h2>
|
|
<pre>DEFAULT_GROUP</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>
|
|
<a id="constant_DEFAULT_STRICT"> </a>
|
|
<div class="element clickable constant constant_DEFAULT_STRICT" data-toggle="collapse" data-target=".constant_DEFAULT_STRICT .collapse">
|
|
<h2>bool Default parse strict setting</h2>
|
|
<pre>DEFAULT_STRICT</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>
|
|
<a id="constant_DEFAULT_DEFAULT"> </a>
|
|
<div class="element clickable constant constant_DEFAULT_DEFAULT" data-toggle="collapse" data-target=".constant_DEFAULT_DEFAULT .collapse">
|
|
<h2>bool Default parse to default setting</h2>
|
|
<pre>DEFAULT_DEFAULT</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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="\SYSTEM\API\api"></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.API.html">API</a></li>
|
|
|
|
<li class="active"><span class="divider">\</span><a href="../classes/SYSTEM.API.api.html">api</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:09 +0200.<br/>
|
|
</footer>
|
|
</body>
|
|
</html>
|