Files
geodb/doc/class-Slim.Middleware.html
2013-06-20 12:05:04 +02:00

425 lines
8.6 KiB
HTML

<!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 Slim\Middleware | GeoApi</title>
<script type="text/javascript" src="resources/combined.js?112270826"></script>
<script type="text/javascript" src="elementlist.js?1501958955"></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><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 class="active"><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>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Slim.Environment.html">Environment</a></li>
<li><a href="class-Slim.Log.html">Log</a></li>
<li><a href="class-Slim.LogWriter.html">LogWriter</a></li>
<li class="active"><a href="class-Slim.Middleware.html">Middleware</a></li>
<li><a href="class-Slim.Route.html">Route</a></li>
<li><a href="class-Slim.Router.html">Router</a></li>
<li><a href="class-Slim.Slim.html">Slim</a></li>
<li><a href="class-Slim.View.html">View</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-Slim.html" title="Summary of Slim"><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 Middleware</h1>
<div class="description">
<p>Middleware</p>
</div>
<div>
<h4>Direct known subclasses</h4>
<a href="class-Slim.Middleware.ContentTypes.html">Slim\Middleware\ContentTypes</a>,
<a href="class-Slim.Middleware.Flash.html">Slim\Middleware\Flash</a>,
<a href="class-Slim.Middleware.MethodOverride.html">Slim\Middleware\MethodOverride</a>,
<a href="class-Slim.Middleware.PrettyExceptions.html">Slim\Middleware\PrettyExceptions</a>,
<a href="class-Slim.Middleware.SessionCookie.html">Slim\Middleware\SessionCookie</a>
</div>
<div class="info">
<b>Abstract</b><br />
<b>Namespace:</b> <a href="namespace-Slim.html">Slim</a><br />
<b>Package:</b> Slim<br />
<b>Author:</b>
Josh Lockhart<br />
<b>Since:</b>
1.6.0<br />
<b>Located at</b> <a href="source-class-Slim.Middleware.html#35-114" title="Go to source code">thirdparty/Slim/Middleware.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="setApplication" id="_setApplication">
<td class="attributes"><code>
final public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setApplication">#</a>
<code><a href="source-class-Slim.Middleware.html#54-65" title="Go to source code">setApplication</a>( <span>Slim <var>$application</var></span> )</code>
<div class="description short">
<p>Set application</p>
</div>
<div class="description detailed hidden">
<p>Set application</p>
<p>This method injects the primary Slim application instance into this
middleware.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$application</var></dt>
<dd><code>Slim</code><br>$application</dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="getApplication" id="_getApplication">
<td class="attributes"><code>
final public
Slim
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getApplication">#</a>
<code><a href="source-class-Slim.Middleware.html#67-78" title="Go to source code">getApplication</a>( )</code>
<div class="description short">
<p>Get application</p>
</div>
<div class="description detailed hidden">
<p>Get application</p>
<p>This method retrieves the application previously injected into this
middleware.</p>
<h4>Returns</h4>
<div class="list">
<code>Slim</code><br />
</div>
</div>
</div></td>
</tr>
<tr data-order="setNextMiddleware" id="_setNextMiddleware">
<td class="attributes"><code>
final public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setNextMiddleware">#</a>
<code><a href="source-class-Slim.Middleware.html#80-92" title="Go to source code">setNextMiddleware</a>( <span>Slim|<code><a href="class-Slim.Middleware.html">Slim\Middleware</a></code> <var>$nextMiddleware</var></span> )</code>
<div class="description short">
<p>Set next middleware</p>
</div>
<div class="description detailed hidden">
<p>Set next middleware</p>
<p>This method injects the next downstream middleware into this middleware so
that it may optionally be called when appropriate.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$nextMiddleware</var></dt>
<dd><code>Slim|<code><a href="class-Slim.Middleware.html">Slim\Middleware</a></code></code></dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="getNextMiddleware" id="_getNextMiddleware">
<td class="attributes"><code>
final public
Slim|<code><a href="class-Slim.Middleware.html">Slim\Middleware</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getNextMiddleware">#</a>
<code><a href="source-class-Slim.Middleware.html#94-105" title="Go to source code">getNextMiddleware</a>( )</code>
<div class="description short">
<p>Get next middleware</p>
</div>
<div class="description detailed hidden">
<p>Get next middleware</p>
<p>This method retrieves the next downstream middleware previously injected into
this middleware.</p>
<h4>Returns</h4>
<div class="list">
<code>Slim|<code><a href="class-Slim.Middleware.html">Slim\Middleware</a></code></code><br />
</div>
</div>
</div></td>
</tr>
<tr data-order="call" id="_call">
<td class="attributes"><code>
abstract public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_call">#</a>
<code><a href="source-class-Slim.Middleware.html#107-113" title="Go to source code">call</a>( )</code>
<div class="description short">
<p>Call</p>
</div>
<div class="description detailed hidden">
<p>Call</p>
<p>Perform actions specific to this middleware and optionally call the next
downstream middleware.</p>
</div>
</div></td>
</tr>
</table>
<table class="summary" id="properties">
<caption>Properties summary</caption>
<tr data-order="app" id="$app">
<td class="attributes"><code>
protected
Slim
</code></td>
<td class="name">
<a href="source-class-Slim.Middleware.html#44-47" title="Go to source code"><var>$app</var></a>
</td>
<td class="value"><code></code></td>
<td class="description"><div>
<a href="#$app" class="anchor">#</a>
<div class="description short">
<p>Reference to the primary application instance</p>
</div>
<div class="description detailed hidden">
<p>Reference to the primary application instance</p>
</div>
</div></td>
</tr>
<tr data-order="next" id="$next">
<td class="attributes"><code>
protected
mixed
</code></td>
<td class="name">
<a href="source-class-Slim.Middleware.html#49-52" title="Go to source code"><var>$next</var></a>
</td>
<td class="value"><code></code></td>
<td class="description"><div>
<a href="#$next" class="anchor">#</a>
<div class="description short">
<p>Reference to the next downstream middleware</p>
</div>
<div class="description detailed hidden">
<p>Reference to the next downstream middleware</p>
</div>
</div></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>