228 lines
17 KiB
HTML
228 lines
17 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" />
|
|
<meta name="robots" content="noindex" />
|
|
|
|
<title>File thirdparty/Slim/Middleware.php | GeoApi</title>
|
|
|
|
<script type="text/javascript" src="resources/combined.js?3762770784"></script>
|
|
<script type="text/javascript" src="elementlist.js?3400632557"></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-None.html">None</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>
|
|
<li><a href="namespace-utiliy.html">utiliy</a>
|
|
</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>
|
|
<a href="class-Slim.Middleware.html" title="Summary of Slim\Middleware"><span>Class</span></a>
|
|
</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>
|
|
|
|
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
|
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">/**
|
|
</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment"> * Slim - a micro PHP 5 framework
|
|
</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> *
|
|
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * @author Josh Lockhart <info@slimframework.com>
|
|
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * @copyright 2011 Josh Lockhart
|
|
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * @link http://www.slimframework.com
|
|
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * @license http://www.slimframework.com/license
|
|
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * @version 2.2.0
|
|
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @package Slim
|
|
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> *
|
|
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * MIT LICENSE
|
|
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> *
|
|
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * Permission is hereby granted, free of charge, to any person obtaining
|
|
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * a copy of this software and associated documentation files (the
|
|
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * "Software"), to deal in the Software without restriction, including
|
|
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * without limitation the rights to use, copy, modify, merge, publish,
|
|
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * distribute, sublicense, and/or sell copies of the Software, and to
|
|
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * permit persons to whom the Software is furnished to do so, subject to
|
|
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * the following conditions:
|
|
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> *
|
|
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The above copyright notice and this permission notice shall be
|
|
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * included in all copies or substantial portions of the Software.
|
|
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> *
|
|
</span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
</span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> */</span>
|
|
</span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-keyword1">namespace</span> Slim;
|
|
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a>
|
|
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment">/**
|
|
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * Middleware
|
|
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> *
|
|
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * @package Slim
|
|
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * @author Josh Lockhart
|
|
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * @since 1.6.0
|
|
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> */</span>
|
|
</span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-keyword1">abstract</span> <span class="php-keyword1">class</span> <a id="Middleware" href="#Middleware">Middleware</a>
|
|
</span><span id="43" class="l"><a class="l" href="#43"> 43: </a>{
|
|
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-comment">/**
|
|
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * @var \Slim Reference to the primary application instance
|
|
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> */</span>
|
|
</span><span id="47" class="l"><a class="l" href="#47"> 47: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$app" href="#$app">$app</a></span>;
|
|
</span><span id="48" class="l"><a class="l" href="#48"> 48: </a>
|
|
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a> <span class="php-comment">/**
|
|
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * @var mixed Reference to the next downstream middleware
|
|
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> */</span>
|
|
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$next" href="#$next">$next</a></span>;
|
|
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a>
|
|
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> <span class="php-comment">/**
|
|
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * Set application
|
|
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> *
|
|
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * This method injects the primary Slim application instance into
|
|
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> * this middleware.
|
|
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> *
|
|
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * @param \Slim $application
|
|
</span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> */</span>
|
|
</span><span id="62" class="l"><a class="l" href="#62"> 62: </a> <span class="php-keyword1">final</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setApplication" href="#_setApplication">setApplication</a>(<span class="php-var">$application</span>)
|
|
</span><span id="63" class="l"><a class="l" href="#63"> 63: </a> {
|
|
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a> <span class="php-var">$this</span>->app = <span class="php-var">$application</span>;
|
|
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a> }
|
|
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a>
|
|
</span><span id="67" class="l"><a class="l" href="#67"> 67: </a> <span class="php-comment">/**
|
|
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * Get application
|
|
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> *
|
|
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * This method retrieves the application previously injected
|
|
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * into this middleware.
|
|
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> *
|
|
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * @return \Slim
|
|
</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> */</span>
|
|
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-keyword1">final</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getApplication" href="#_getApplication">getApplication</a>()
|
|
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a> {
|
|
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->app;
|
|
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> }
|
|
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a>
|
|
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-comment">/**
|
|
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * Set next middleware
|
|
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> *
|
|
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> * This method injects the next downstream middleware into
|
|
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment"> * this middleware so that it may optionally be called
|
|
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment"> * when appropriate.
|
|
</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> *
|
|
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * @param \Slim|\Slim\Middleware
|
|
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
|
|
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-keyword1">final</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setNextMiddleware" href="#_setNextMiddleware">setNextMiddleware</a>(<span class="php-var">$nextMiddleware</span>)
|
|
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a> {
|
|
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a> <span class="php-var">$this</span>-><span class="php-keyword2">next</span> = <span class="php-var">$nextMiddleware</span>;
|
|
</span><span id="92" class="l"><a class="l" href="#92"> 92: </a> }
|
|
</span><span id="93" class="l"><a class="l" href="#93"> 93: </a>
|
|
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a> <span class="php-comment">/**
|
|
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * Get next middleware
|
|
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> *
|
|
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * This method retrieves the next downstream middleware
|
|
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * previously injected into this middleware.
|
|
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> *
|
|
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * @return \Slim|\Slim\Middleware
|
|
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> */</span>
|
|
</span><span id="102" class="l"><a class="l" href="#102">102: </a> <span class="php-keyword1">final</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getNextMiddleware" href="#_getNextMiddleware">getNextMiddleware</a>()
|
|
</span><span id="103" class="l"><a class="l" href="#103">103: </a> {
|
|
</span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-><span class="php-keyword2">next</span>;
|
|
</span><span id="105" class="l"><a class="l" href="#105">105: </a> }
|
|
</span><span id="106" class="l"><a class="l" href="#106">106: </a>
|
|
</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-comment">/**
|
|
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> * Call
|
|
</span></span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-comment"> *
|
|
</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * Perform actions specific to this middleware and optionally
|
|
</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * call the next downstream middleware.
|
|
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> */</span>
|
|
</span><span id="113" class="l"><a class="l" href="#113">113: </a> <span class="php-keyword1">abstract</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_call" href="#_call">call</a>();
|
|
</span><span id="114" class="l"><a class="l" href="#114">114: </a>}
|
|
</span><span id="115" class="l"><a class="l" href="#115">115: </a></span></code></pre>
|
|
|
|
<div id="footer">
|
|
GeoApi API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|