728 lines
14 KiB
HTML
728 lines
14 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\Flash | 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 class="active"><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.Middleware.ContentTypes.html">ContentTypes</a></li>
|
|
<li class="active"><a href="class-Slim.Middleware.Flash.html">Flash</a></li>
|
|
<li><a href="class-Slim.Middleware.MethodOverride.html">MethodOverride</a></li>
|
|
<li><a href="class-Slim.Middleware.PrettyExceptions.html">PrettyExceptions</a></li>
|
|
<li><a href="class-Slim.Middleware.SessionCookie.html">SessionCookie</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.Middleware.html" title="Summary of Slim\Middleware"><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 Flash</h1>
|
|
|
|
|
|
<div class="description">
|
|
|
|
<p>Flash</p>
|
|
|
|
<p>This is middleware for a Slim application that enables Flash messaging
|
|
between HTTP requests. This allows you set Flash messages for the current
|
|
request, for the next request, or to retain messages from the previous request
|
|
through to the next request.</p>
|
|
|
|
</div>
|
|
|
|
<dl class="tree">
|
|
<dd style="padding-left:0px">
|
|
<a href="class-Slim.Middleware.html"><span>Slim\Middleware</span></a>
|
|
|
|
|
|
|
|
</dd>
|
|
<dd style="padding-left:30px">
|
|
<img src="resources/inherit.png" alt="Extended by" />
|
|
<b><span>Slim\Middleware\Flash</span></b>
|
|
implements
|
|
<a href="class-ArrayAccess.html"><span>ArrayAccess</span></a>,
|
|
|
|
<a href="class-IteratorAggregate.html"><span>IteratorAggregate</span></a>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="info">
|
|
|
|
|
|
<b>Namespace:</b> <a href="namespace-Slim.html">Slim</a>\<a href="namespace-Slim.Middleware.html">Middleware</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.Flash.html#35-202" title="Go to source code">thirdparty/Slim/Middleware/Flash.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-Slim.Middleware.Flash.html#60-73" title="Go to source code">__construct</a>( <span>Slim <var>$settings</var> = <span class="php-keyword1">array</span>()</span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Constructor</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Constructor</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$settings</var></dt>
|
|
<dd><code>Slim</code><br>$app</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="call" id="_call">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_call">#</a>
|
|
<code><a href="source-class-Slim.Middleware.Flash.html#75-88" title="Go to source code">call</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Call</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Call</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="now" id="_now">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_now">#</a>
|
|
<code><a href="source-class-Slim.Middleware.Flash.html#90-101" title="Go to source code">now</a>( <span>string <var>$key</var></span>, <span>string <var>$value</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Now</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Now</p>
|
|
|
|
<p>Specify a flash message for a given key to be shown for the current
|
|
request</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$key</var></dt>
|
|
<dd><code>string</code><br>$key</dd>
|
|
<dt><var>$value</var></dt>
|
|
<dd><code>string</code><br>$value</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="set" id="_set">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_set">#</a>
|
|
<code><a href="source-class-Slim.Middleware.Flash.html#103-114" title="Go to source code">set</a>( <span>string <var>$key</var></span>, <span>string <var>$value</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Set</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Set</p>
|
|
|
|
<p>Specify a flash message for a given key to be shown for the next request</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$key</var></dt>
|
|
<dd><code>string</code><br>$key</dd>
|
|
<dt><var>$value</var></dt>
|
|
<dd><code>string</code><br>$value</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="keep" id="_keep">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_keep">#</a>
|
|
<code><a href="source-class-Slim.Middleware.Flash.html#116-126" title="Go to source code">keep</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Keep</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Keep</p>
|
|
|
|
<p>Retain flash messages from the previous request for the next request</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="save" id="_save">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_save">#</a>
|
|
<code><a href="source-class-Slim.Middleware.Flash.html#128-134" title="Go to source code">save</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Save</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Save</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="loadMessages" id="_loadMessages">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_loadMessages">#</a>
|
|
<code><a href="source-class-Slim.Middleware.Flash.html#136-144" title="Go to source code">loadMessages</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Load messages from previous request if available</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Load messages from previous request if available</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getMessages" id="_getMessages">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getMessages">#</a>
|
|
<code><a href="source-class-Slim.Middleware.Flash.html#146-154" title="Go to source code">getMessages</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Return array of flash messages to be shown for the current request</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Return array of flash messages to be shown for the current request</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>array</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="offsetExists" id="_offsetExists">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_offsetExists">#</a>
|
|
<code><a href="source-class-Slim.Middleware.Flash.html#156-164" title="Go to source code">offsetExists</a>( <span>mixed <var>$offset</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Array Access: Offset Exists</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Array Access: Offset Exists</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Implementation of</h4>
|
|
<div class="list"><code><a href="class-ArrayAccess.html#_offsetExists">ArrayAccess::offsetExists()</a></code></div>
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="offsetGet" id="_offsetGet">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_offsetGet">#</a>
|
|
<code><a href="source-class-Slim.Middleware.Flash.html#166-174" title="Go to source code">offsetGet</a>( <span>mixed <var>$offset</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Array Access: Offset Get</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Array Access: Offset Get</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Implementation of</h4>
|
|
<div class="list"><code><a href="class-ArrayAccess.html#_offsetGet">ArrayAccess::offsetGet()</a></code></div>
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="offsetSet" id="_offsetSet">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_offsetSet">#</a>
|
|
<code><a href="source-class-Slim.Middleware.Flash.html#176-182" title="Go to source code">offsetSet</a>( <span>mixed <var>$offset</var></span>, <span>mixed <var>$value</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Array Access: Offset Set</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Array Access: Offset Set</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Implementation of</h4>
|
|
<div class="list"><code><a href="class-ArrayAccess.html#_offsetSet">ArrayAccess::offsetSet()</a></code></div>
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="offsetUnset" id="_offsetUnset">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_offsetUnset">#</a>
|
|
<code><a href="source-class-Slim.Middleware.Flash.html#184-190" title="Go to source code">offsetUnset</a>( <span>mixed <var>$offset</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Array Access: Offset Unset</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Array Access: Offset Unset</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Implementation of</h4>
|
|
<div class="list"><code><a href="class-ArrayAccess.html#_offsetUnset">ArrayAccess::offsetUnset()</a></code></div>
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getIterator" id="_getIterator">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
<code><a href="class-ArrayIterator.html">ArrayIterator</a></code>
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getIterator">#</a>
|
|
<code><a href="source-class-Slim.Middleware.Flash.html#192-201" title="Go to source code">getIterator</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Iterator Aggregate: Get Iterator</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Iterator Aggregate: Get Iterator</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-ArrayIterator.html">ArrayIterator</a></code></code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h4>Implementation of</h4>
|
|
<div class="list"><code><a href="class-IteratorAggregate.html#_getIterator">IteratorAggregate::getIterator()</a></code></div>
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table class="summary inherited">
|
|
<caption>Methods inherited from <a href="class-Slim.Middleware.html#methods">Slim\Middleware</a></caption>
|
|
<tr>
|
|
<td><code>
|
|
<a href="class-Slim.Middleware.html#_getApplication">getApplication()</a>,
|
|
<a href="class-Slim.Middleware.html#_getNextMiddleware">getNextMiddleware()</a>,
|
|
<a href="class-Slim.Middleware.html#_setApplication">setApplication()</a>,
|
|
<a href="class-Slim.Middleware.html#_setNextMiddleware">setNextMiddleware()</a>
|
|
</code></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<table class="summary" id="properties">
|
|
<caption>Properties summary</caption>
|
|
<tr data-order="settings" id="$settings">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Middleware.Flash.html#50-53" title="Go to source code"><var>$settings</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$settings" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="messages" id="$messages">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Middleware.Flash.html#55-58" title="Go to source code"><var>$messages</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$messages" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table class="summary inherited">
|
|
<caption>Properties inherited from <a href="class-Slim.Middleware.html#properties">Slim\Middleware</a></caption>
|
|
<tr>
|
|
<td><code>
|
|
<a href="class-Slim.Middleware.html#$app"><var>$app</var></a>,
|
|
<a href="class-Slim.Middleware.html#$next"><var>$next</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>
|