add doku
This commit is contained in:
stubbfel
430
doc/class-api.PssApi.html
Normal file
430
doc/class-api.PssApi.html
Normal file
@@ -0,0 +1,430 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="ApiGen 2.8.0" />
|
||||
|
||||
<title>Class api\PssApi | GeoApi</title>
|
||||
|
||||
<script type="text/javascript" src="resources/combined.js?112270826"></script>
|
||||
<script type="text/javascript" src="elementlist.js?4049399837"></script>
|
||||
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div id="left">
|
||||
<div id="menu">
|
||||
<a href="index.html" title="Overview"><span>Overview</span></a>
|
||||
|
||||
|
||||
<div id="groups">
|
||||
<h3>Namespaces</h3>
|
||||
<ul>
|
||||
<li class="active"><a href="namespace-api.html">api</a>
|
||||
</li>
|
||||
<li><a href="namespace-config.html">config</a>
|
||||
</li>
|
||||
<li><a href="namespace-database.html">database</a>
|
||||
</li>
|
||||
<li><a href="namespace-PHP.html">PHP</a>
|
||||
</li>
|
||||
<li><a href="namespace-Slim.html">Slim<span></span></a>
|
||||
<ul>
|
||||
<li><a href="namespace-Slim.Exception.html">Exception</a>
|
||||
</li>
|
||||
<li><a href="namespace-Slim.Http.html">Http</a>
|
||||
</li>
|
||||
<li><a href="namespace-Slim.Middleware.html">Middleware</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="namespace-utiliy.html">utiliy</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
<div id="elements">
|
||||
<h3>Classes</h3>
|
||||
<ul>
|
||||
<li><a href="class-api.Api.html">Api</a></li>
|
||||
<li><a href="class-api.PisApi.html">PisApi</a></li>
|
||||
<li class="active"><a href="class-api.PssApi.html">PssApi</a></li>
|
||||
<li><a href="class-api.SpsApi.html">SpsApi</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="splitter"></div>
|
||||
|
||||
<div id="right">
|
||||
<div id="rightInner">
|
||||
<form id="search">
|
||||
<input type="hidden" name="cx" value="" />
|
||||
<input type="hidden" name="ie" value="UTF-8" />
|
||||
<input type="text" name="q" class="text" />
|
||||
<input type="submit" value="Search" />
|
||||
</form>
|
||||
|
||||
<div id="navigation">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="index.html" title="Overview"><span>Overview</span></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="namespace-api.html" title="Summary of api"><span>Namespace</span></a>
|
||||
</li>
|
||||
<li class="active">
|
||||
<span>Class</span> </li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="content" class="class">
|
||||
<h1>Class PssApi</h1>
|
||||
|
||||
|
||||
<div class="description">
|
||||
|
||||
<p>This class provides some spezial PssAPI methods</p>
|
||||
|
||||
</div>
|
||||
|
||||
<dl class="tree">
|
||||
<dd style="padding-left:0px">
|
||||
<a href="class-Slim.Slim.html"><span>Slim\Slim</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:30px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<a href="class-api.Api.html"><span>api\Api</span></a>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dd style="padding-left:60px">
|
||||
<img src="resources/inherit.png" alt="Extended by" />
|
||||
<b><span>api\PssApi</span></b>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="info">
|
||||
|
||||
|
||||
<b>Namespace:</b> <a href="namespace-api.html">api</a><br />
|
||||
|
||||
|
||||
<b>Author:</b>
|
||||
stubbfel<br />
|
||||
<b>Since:</b>
|
||||
20.06.2013<br />
|
||||
<b>Located at</b> <a href="source-class-api.PssApi.html#11-60" title="Go to source code">api/PssApi.php</a><br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="methods">
|
||||
<caption>Methods summary</caption>
|
||||
<tr data-order="__construct" id="___construct">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#___construct">#</a>
|
||||
<code><a href="source-class-api.PssApi.html#30-36" title="Go to source code">__construct</a>( )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>Default-Constructor</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>Default-Constructor</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Overrides</h4>
|
||||
<div class="list"><code><a href="class-api.Api.html#___construct">api\Api::__construct()</a></code></div>
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="__destruct" id="___destruct">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#___destruct">#</a>
|
||||
<code><a href="source-class-api.PssApi.html#38-43" title="Go to source code">__destruct</a>( )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>Default-DeConstructor</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>Default-DeConstructor</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Overrides</h4>
|
||||
<div class="list"><code><a href="class-api.Api.html#___destruct">api\Api::__destruct()</a></code></div>
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr data-order="sendPssQuery" id="_sendPssQuery">
|
||||
|
||||
<td class="attributes"><code>
|
||||
public
|
||||
query
|
||||
|
||||
</code>
|
||||
</td>
|
||||
|
||||
<td class="name"><div>
|
||||
<a class="anchor" href="#_sendPssQuery">#</a>
|
||||
<code><a href="source-class-api.PssApi.html#45-58" title="Go to source code">sendPssQuery</a>( <span>array <var>$queryArgs</var></span> )</code>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>Method start a pis-query</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>Method start a pis-query</p>
|
||||
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<div class="list"><dl>
|
||||
<dt><var>$queryArgs</var></dt>
|
||||
<dd><code>array</code><br>$queryArgs</dd>
|
||||
</dl></div>
|
||||
|
||||
<h4>Returns</h4>
|
||||
<div class="list">
|
||||
<code>query</code><br>result as xml<br />
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Methods inherited from <a href="class-api.Api.html#methods">api\Api</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-api.Api.html#_connect">connect()</a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
<table class="summary inherited">
|
||||
<caption>Methods inherited from <a href="class-Slim.Slim.html#methods">Slim\Slim</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Slim.Slim.html#_add">add()</a>,
|
||||
<a href="class-Slim.Slim.html#_applyHook">applyHook()</a>,
|
||||
<a href="class-Slim.Slim.html#_autoload">autoload()</a>,
|
||||
<a href="class-Slim.Slim.html#_call">call()</a>,
|
||||
<a href="class-Slim.Slim.html#_callErrorHandler">callErrorHandler()</a>,
|
||||
<a href="class-Slim.Slim.html#_cleanBuffer">cleanBuffer()</a>,
|
||||
<a href="class-Slim.Slim.html#_clearHooks">clearHooks()</a>,
|
||||
<a href="class-Slim.Slim.html#_config">config()</a>,
|
||||
<a href="class-Slim.Slim.html#_configureMode">configureMode()</a>,
|
||||
<a href="class-Slim.Slim.html#_contentType">contentType()</a>,
|
||||
<a href="class-Slim.Slim.html#_defaultError">defaultError()</a>,
|
||||
<a href="class-Slim.Slim.html#_defaultNotFound">defaultNotFound()</a>,
|
||||
<a href="class-Slim.Slim.html#_delete">delete()</a>,
|
||||
<a href="class-Slim.Slim.html#_deleteCookie">deleteCookie()</a>,
|
||||
<a href="class-Slim.Slim.html#_environment">environment()</a>,
|
||||
<a href="class-Slim.Slim.html#_error">error()</a>,
|
||||
<a href="class-Slim.Slim.html#_etag">etag()</a>,
|
||||
<a href="class-Slim.Slim.html#_expires">expires()</a>,
|
||||
<a href="class-Slim.Slim.html#_flash">flash()</a>,
|
||||
<a href="class-Slim.Slim.html#_flashKeep">flashKeep()</a>,
|
||||
<a href="class-Slim.Slim.html#_flashNow">flashNow()</a>,
|
||||
<a href="class-Slim.Slim.html#_generateTemplateMarkup">generateTemplateMarkup()</a>,
|
||||
<a href="class-Slim.Slim.html#_get">get()</a>,
|
||||
<a href="class-Slim.Slim.html#_getCookie">getCookie()</a>,
|
||||
<a href="class-Slim.Slim.html#_getDefaultSettings">getDefaultSettings()</a>,
|
||||
<a href="class-Slim.Slim.html#_getEncryptedCookie">getEncryptedCookie()</a>,
|
||||
<a href="class-Slim.Slim.html#_getHooks">getHooks()</a>,
|
||||
<a href="class-Slim.Slim.html#_getInstance">getInstance()</a>,
|
||||
<a href="class-Slim.Slim.html#_getLog">getLog()</a>,
|
||||
<a href="class-Slim.Slim.html#_getMode">getMode()</a>,
|
||||
<a href="class-Slim.Slim.html#_getName">getName()</a>,
|
||||
<a href="class-Slim.Slim.html#_halt">halt()</a>,
|
||||
<a href="class-Slim.Slim.html#_handleErrors">handleErrors()</a>,
|
||||
<a href="class-Slim.Slim.html#_hook">hook()</a>,
|
||||
<a href="class-Slim.Slim.html#_lastModified">lastModified()</a>,
|
||||
<a href="class-Slim.Slim.html#_map">map()</a>,
|
||||
<a href="class-Slim.Slim.html#_mapRoute">mapRoute()</a>,
|
||||
<a href="class-Slim.Slim.html#_notFound">notFound()</a>,
|
||||
<a href="class-Slim.Slim.html#_options">options()</a>,
|
||||
<a href="class-Slim.Slim.html#_pass">pass()</a>,
|
||||
<a href="class-Slim.Slim.html#_post">post()</a>,
|
||||
<a href="class-Slim.Slim.html#_put">put()</a>,
|
||||
<a href="class-Slim.Slim.html#_redirect">redirect()</a>,
|
||||
<a href="class-Slim.Slim.html#_registerAutoloader">registerAutoloader()</a>,
|
||||
<a href="class-Slim.Slim.html#_render">render()</a>,
|
||||
<a href="class-Slim.Slim.html#_request">request()</a>,
|
||||
<a href="class-Slim.Slim.html#_response">response()</a>,
|
||||
<a href="class-Slim.Slim.html#_root">root()</a>,
|
||||
<a href="class-Slim.Slim.html#_router">router()</a>,
|
||||
<a href="class-Slim.Slim.html#_run">run()</a>,
|
||||
<a href="class-Slim.Slim.html#_setCookie">setCookie()</a>,
|
||||
<a href="class-Slim.Slim.html#_setEncryptedCookie">setEncryptedCookie()</a>,
|
||||
<a href="class-Slim.Slim.html#_setName">setName()</a>,
|
||||
<a href="class-Slim.Slim.html#_status">status()</a>,
|
||||
<a href="class-Slim.Slim.html#_stop">stop()</a>,
|
||||
<a href="class-Slim.Slim.html#_urlFor">urlFor()</a>,
|
||||
<a href="class-Slim.Slim.html#_view">view()</a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Constants inherited from <a href="class-Slim.Slim.html#constants">Slim\Slim</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Slim.Slim.html#VERSION"><b>VERSION</b></a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
<table class="summary" id="properties">
|
||||
<caption>Properties summary</caption>
|
||||
<tr data-order="routeParameterPids" id="$routeParameterPids">
|
||||
<td class="attributes"><code>
|
||||
public static
|
||||
string
|
||||
</code></td>
|
||||
|
||||
<td class="name">
|
||||
<a href="source-class-api.PssApi.html#18-22" title="Go to source code"><var>$routeParameterPids</var></a>
|
||||
</td>
|
||||
<td class="value"><code><span class="php-quote">"/pid/:pid+"</span></code></td>
|
||||
<td class="description"><div>
|
||||
<a href="#$routeParameterPids" class="anchor">#</a>
|
||||
|
||||
<div class="description short">
|
||||
|
||||
<p>Route string for the alias paramter</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description detailed hidden">
|
||||
|
||||
<p>Route string for the alias paramter</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table class="summary inherited">
|
||||
<caption>Properties inherited from <a href="class-api.Api.html#properties">api\Api</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-api.Api.html#$sqlManager"><var>$sqlManager</var></a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
<table class="summary inherited">
|
||||
<caption>Properties inherited from <a href="class-Slim.Slim.html#properties">Slim\Slim</a></caption>
|
||||
<tr>
|
||||
<td><code>
|
||||
<a href="class-Slim.Slim.html#$apps"><var>$apps</var></a>,
|
||||
<a href="class-Slim.Slim.html#$environment"><var>$environment</var></a>,
|
||||
<a href="class-Slim.Slim.html#$error"><var>$error</var></a>,
|
||||
<a href="class-Slim.Slim.html#$hooks"><var>$hooks</var></a>,
|
||||
<a href="class-Slim.Slim.html#$middleware"><var>$middleware</var></a>,
|
||||
<a href="class-Slim.Slim.html#$mode"><var>$mode</var></a>,
|
||||
<a href="class-Slim.Slim.html#$name"><var>$name</var></a>,
|
||||
<a href="class-Slim.Slim.html#$notFound"><var>$notFound</var></a>,
|
||||
<a href="class-Slim.Slim.html#$request"><var>$request</var></a>,
|
||||
<a href="class-Slim.Slim.html#$response"><var>$response</var></a>,
|
||||
<a href="class-Slim.Slim.html#$router"><var>$router</var></a>,
|
||||
<a href="class-Slim.Slim.html#$settings"><var>$settings</var></a>,
|
||||
<a href="class-Slim.Slim.html#$view"><var>$view</var></a>
|
||||
</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
GeoApi API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user