695 lines
15 KiB
HTML
695 lines
15 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\Router | 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><a href="class-Slim.Middleware.html">Middleware</a></li>
|
|
<li><a href="class-Slim.Route.html">Route</a></li>
|
|
<li class="active"><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 Router</h1>
|
|
|
|
|
|
<div class="description">
|
|
|
|
<p>Router</p>
|
|
|
|
<p>This class organizes, iterates, and dispatches \Slim\Route objects.</p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="info">
|
|
|
|
|
|
<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.0.0<br />
|
|
<b>Located at</b> <a href="source-class-Slim.Router.html#35-235" title="Go to source code">thirdparty/Slim/Router.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.Router.html#66-72" title="Go to source code">__construct</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Constructor</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Constructor</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getCurrentRoute" id="_getCurrentRoute">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
<code><a href="class-Slim.Route.html">Slim\Route</a></code>|null
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getCurrentRoute">#</a>
|
|
<code><a href="source-class-Slim.Router.html#74-89" title="Go to source code">getCurrentRoute</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get Current Route object or the first matched one if matching has been
|
|
performed</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get Current Route object or the first matched one if matching has been
|
|
performed</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-Slim.Route.html">Slim\Route</a></code>|null</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getMatchedRoutes" id="_getMatchedRoutes">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array[\Slim\Route]
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getMatchedRoutes">#</a>
|
|
<code><a href="source-class-Slim.Router.html#91-114" title="Go to source code">getMatchedRoutes</a>( <span>string <var>$httpMethod</var></span>, <span>string <var>$resourceUri</var></span>, <span>boolean <var>$reload</var> = <span class="php-keyword1">false</span></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Return route objects that match the given HTTP method and URI</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Return route objects that match the given HTTP method and URI</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$httpMethod</var></dt>
|
|
<dd><code>string</code><br>$httpMethod The HTTP method to match against</dd>
|
|
<dt><var>$resourceUri</var></dt>
|
|
<dd><code>string</code><br>$resourceUri The resource URI to match against</dd>
|
|
<dt><var>$reload</var></dt>
|
|
<dd><code>boolean</code><br>$reload Should matching routes be re-parsed?</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>array[\Slim\Route]</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="map" id="_map">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
<code><a href="class-Slim.Route.html">Slim\Route</a></code>
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_map">#</a>
|
|
<code><a href="source-class-Slim.Router.html#116-128" title="Go to source code">map</a>( <span>string <var>$pattern</var></span>, <span>mixed <var>$callable</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Map a route object to a callback function</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Map a route object to a callback function</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$pattern</var></dt>
|
|
<dd><code>string</code><br>$pattern The URL pattern (ie. "/books/:id")</dd>
|
|
<dt><var>$callable</var></dt>
|
|
<dd><code>mixed</code><br>$callable Anything that returns TRUE for is_callable()</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-Slim.Route.html">Slim\Route</a></code></code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="urlFor" id="_urlFor">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_urlFor">#</a>
|
|
<code><a href="source-class-Slim.Router.html#130-150" title="Go to source code">urlFor</a>( <span>string <var>$name</var></span>, <span>array <var>$params</var> = <span class="php-keyword1">array</span>()</span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get URL for named route</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get URL for named route</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$name</var></dt>
|
|
<dd><code>string</code><br>$name The name of the route</dd>
|
|
<dt><var>$params</var></dt>
|
|
<dd><code>array</code><br>Associative array of URL parameter names and replacement values</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>string</code><br>The URL for the given route populated with provided replacement values<br />
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-RuntimeException.html">RuntimeException</a></code></code><br>If named route not found<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="dispatch" id="_dispatch">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
boolean
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_dispatch">#</a>
|
|
<code><a href="source-class-Slim.Router.html#152-175" title="Go to source code">dispatch</a>( <span><code><a href="class-Slim.Route.html">Slim\Route</a></code> <var>$route</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Dispatch route</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Dispatch route</p>
|
|
|
|
<p>This method invokes the route object's callable. If middleware is registered
|
|
for the route, each callable middleware is invoked in the order specified.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$route</var></dt>
|
|
<dd><code><code><a href="class-Slim.Route.html">Slim\Route</a></code></code><br>$route The route object</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>boolean</code><br>Was route callable invoked successfully?<br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="addNamedRoute" id="_addNamedRoute">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_addNamedRoute">#</a>
|
|
<code><a href="source-class-Slim.Router.html#177-189" title="Go to source code">addNamedRoute</a>( <span>string <var>$name</var></span>, <span><code><a href="class-Slim.Route.html">Slim\Route</a></code> <var>$route</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Add named route</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Add named route</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$name</var></dt>
|
|
<dd><code>string</code><br>$name The route name</dd>
|
|
<dt><var>$route</var></dt>
|
|
<dd><code><code><a href="class-Slim.Route.html">Slim\Route</a></code></code><br>$route The route object</dd>
|
|
</dl></div>
|
|
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-RuntimeException.html">RuntimeException</a></code></code><br>If a named route already exists with the same name<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="hasNamedRoute" id="_hasNamedRoute">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
boolean
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_hasNamedRoute">#</a>
|
|
<code><a href="source-class-Slim.Router.html#191-201" title="Go to source code">hasNamedRoute</a>( <span>string <var>$name</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Has named route</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Has named route</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$name</var></dt>
|
|
<dd><code>string</code><br>$name The route name</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>boolean</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getNamedRoute" id="_getNamedRoute">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
<code><a href="class-Slim.Route.html">Slim\Route</a></code>|null
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getNamedRoute">#</a>
|
|
<code><a href="source-class-Slim.Router.html#203-216" title="Go to source code">getNamedRoute</a>( <span>string <var>$name</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get named route</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get named route</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$name</var></dt>
|
|
<dd><code>string</code><br>$name</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-Slim.Route.html">Slim\Route</a></code>|null</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getNamedRoutes" id="_getNamedRoutes">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
<code><a href="class-ArrayIterator.html">ArrayIterator</a></code>
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getNamedRoutes">#</a>
|
|
<code><a href="source-class-Slim.Router.html#218-234" title="Go to source code">getNamedRoutes</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get named routes</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get named routes</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-ArrayIterator.html">ArrayIterator</a></code></code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<table class="summary" id="properties">
|
|
<caption>Properties summary</caption>
|
|
<tr data-order="currentRoute" id="$currentRoute">
|
|
<td class="attributes"><code>
|
|
protected
|
|
<code><a href="class-Slim.Route.html">Slim\Route</a></code>
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Router.html#46-49" title="Go to source code"><var>$currentRoute</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$currentRoute" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>The current route (most recently dispatched)</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>The current route (most recently dispatched)</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="routes" id="$routes">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Router.html#51-54" title="Go to source code"><var>$routes</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$routes" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Lookup hash of all route objects</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Lookup hash of all route objects</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="namedRoutes" id="$namedRoutes">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Router.html#56-59" title="Go to source code"><var>$namedRoutes</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$namedRoutes" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Lookup hash of named route objects, keyed by route name (lazy-loaded)</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Lookup hash of named route objects, keyed by route name (lazy-loaded)</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="matchedRoutes" id="$matchedRoutes">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Router.html#61-64" title="Go to source code"><var>$matchedRoutes</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$matchedRoutes" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Array of route objects that match the request URI (lazy-loaded)</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Array of route objects that match the request URI (lazy-loaded)</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>
|