1464 lines
29 KiB
HTML
1464 lines
29 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\Route | 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><a href="class-Slim.Middleware.html">Middleware</a></li>
|
|
<li class="active"><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 Route</h1>
|
|
|
|
|
|
<div class="description">
|
|
|
|
<p>Route</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, Thomas Bley<br />
|
|
<b>Since:</b>
|
|
1.0.0<br />
|
|
<b>Located at</b> <a href="source-class-Slim.Route.html#35-416" title="Go to source code">thirdparty/Slim/Route.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.Route.html#93-103" title="Go to source code">__construct</a>( <span>string <var>$pattern</var></span>, <span>mixed <var>$callable</var></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>$pattern</var></dt>
|
|
<dd><code>string</code><br>$pattern The URL pattern (e.g. "/books/:id")</dd>
|
|
<dt><var>$callable</var></dt>
|
|
<dd><code>mixed</code><br>$callable Anything that returns TRUE for is_callable()</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setDefaultConditions" id="_setDefaultConditions">
|
|
|
|
<td class="attributes"><code>
|
|
public static
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setDefaultConditions">#</a>
|
|
<code><a href="source-class-Slim.Route.html#105-112" title="Go to source code">setDefaultConditions</a>( <span>array <var>$defaultConditions</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Set default route conditions for all instances</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Set default route conditions for all instances</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$defaultConditions</var></dt>
|
|
<dd><code>array</code><br>$defaultConditions</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getDefaultConditions" id="_getDefaultConditions">
|
|
|
|
<td class="attributes"><code>
|
|
public static
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getDefaultConditions">#</a>
|
|
<code><a href="source-class-Slim.Route.html#114-121" title="Go to source code">getDefaultConditions</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get default route conditions for all instances</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get default route conditions for all instances</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>array</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getPattern" id="_getPattern">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getPattern">#</a>
|
|
<code><a href="source-class-Slim.Route.html#123-130" title="Go to source code">getPattern</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get route pattern</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get route pattern</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>string</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setPattern" id="_setPattern">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setPattern">#</a>
|
|
<code><a href="source-class-Slim.Route.html#132-139" title="Go to source code">setPattern</a>( <span>string <var>$pattern</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Set route pattern</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Set route pattern</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$pattern</var></dt>
|
|
<dd><code>string</code><br>$pattern</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getCallable" id="_getCallable">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
mixed
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getCallable">#</a>
|
|
<code><a href="source-class-Slim.Route.html#141-148" title="Go to source code">getCallable</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get route callable</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get route callable</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>mixed</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setCallable" id="_setCallable">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setCallable">#</a>
|
|
<code><a href="source-class-Slim.Route.html#150-162" title="Go to source code">setCallable</a>( <span>mixed <var>$callable</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Set route callable</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Set route callable</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$callable</var></dt>
|
|
<dd><code>mixed</code><br>$callable</dd>
|
|
</dl></div>
|
|
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-InvalidArgumentException.html">InvalidArgumentException</a></code></code><br>If argument is not callable<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getConditions" id="_getConditions">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getConditions">#</a>
|
|
<code><a href="source-class-Slim.Route.html#164-171" title="Go to source code">getConditions</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get route conditions</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get route conditions</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>array</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setConditions" id="_setConditions">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setConditions">#</a>
|
|
<code><a href="source-class-Slim.Route.html#173-180" title="Go to source code">setConditions</a>( <span>array <var>$conditions</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Set route conditions</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Set route conditions</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$conditions</var></dt>
|
|
<dd><code>array</code><br>$conditions</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getName" id="_getName">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
string|null
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getName">#</a>
|
|
<code><a href="source-class-Slim.Route.html#182-189" title="Go to source code">getName</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get route name</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get route name</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>string|null</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setName" id="_setName">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setName">#</a>
|
|
<code><a href="source-class-Slim.Route.html#191-198" title="Go to source code">setName</a>( <span>string <var>$name</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Set route name</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Set route name</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$name</var></dt>
|
|
<dd><code>string</code><br>$name</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getParams" id="_getParams">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getParams">#</a>
|
|
<code><a href="source-class-Slim.Route.html#200-207" title="Go to source code">getParams</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get route parameters</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get route parameters</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>array</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setParams" id="_setParams">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setParams">#</a>
|
|
<code><a href="source-class-Slim.Route.html#209-216" title="Go to source code">setParams</a>( <span>array <var>$params</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Set route parameters</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Set route parameters</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$params</var></dt>
|
|
<dd><code>array</code><br>$params</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getParam" id="_getParam">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getParam">#</a>
|
|
<code><a href="source-class-Slim.Route.html#218-231" title="Go to source code">getParam</a>( <span>string <var>$index</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get route parameter value</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get route parameter value</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$index</var></dt>
|
|
<dd><code>string</code><br>$index Name of URL parameter</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>string</code><br />
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-InvalidArgumentException.html">InvalidArgumentException</a></code></code><br>If route parameter does not exist at index<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setParam" id="_setParam">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setParam">#</a>
|
|
<code><a href="source-class-Slim.Route.html#233-245" title="Go to source code">setParam</a>( <span>string <var>$index</var></span>, <span>mixed <var>$value</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Set route parameter value</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Set route parameter value</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$index</var></dt>
|
|
<dd><code>string</code><br>$index Name of URL parameter</dd>
|
|
<dt><var>$value</var></dt>
|
|
<dd><code>mixed</code><br>$value The new parameter value</dd>
|
|
</dl></div>
|
|
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-InvalidArgumentException.html">InvalidArgumentException</a></code></code><br>If route parameter does not exist at index<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setHttpMethods" id="_setHttpMethods">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setHttpMethods">#</a>
|
|
<code><a href="source-class-Slim.Route.html#247-254" title="Go to source code">setHttpMethods</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Add supported HTTP method(s)</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Add supported HTTP method(s)</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getHttpMethods" id="_getHttpMethods">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getHttpMethods">#</a>
|
|
<code><a href="source-class-Slim.Route.html#256-263" title="Go to source code">getHttpMethods</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get supported HTTP methods</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get supported HTTP methods</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>array</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="appendHttpMethods" id="_appendHttpMethods">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_appendHttpMethods">#</a>
|
|
<code><a href="source-class-Slim.Route.html#265-272" title="Go to source code">appendHttpMethods</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Append supported HTTP methods</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Append supported HTTP methods</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="via" id="_via">
|
|
|
|
<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="#_via">#</a>
|
|
<code><a href="source-class-Slim.Route.html#274-284" title="Go to source code">via</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Append supported HTTP methods (alias for Route::appendHttpMethods)</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Append supported HTTP methods (alias for Route::appendHttpMethods)</p>
|
|
|
|
|
|
|
|
|
|
<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="supportsHttpMethod" id="_supportsHttpMethod">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
boolean
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_supportsHttpMethod">#</a>
|
|
<code><a href="source-class-Slim.Route.html#286-293" title="Go to source code">supportsHttpMethod</a>( <span>mixed <var>$method</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Detect support for an HTTP method</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Detect support for an HTTP method</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>boolean</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getMiddleware" id="_getMiddleware">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array[Callable]
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getMiddleware">#</a>
|
|
<code><a href="source-class-Slim.Route.html#295-302" title="Go to source code">getMiddleware</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get middleware</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get middleware</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>array[Callable]</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setMiddleware" id="_setMiddleware">
|
|
|
|
<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="#_setMiddleware">#</a>
|
|
<code><a href="source-class-Slim.Route.html#304-334" title="Go to source code">setMiddleware</a>( <span>Callable|array[Callable] <var>$middleware</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Set middleware</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Set middleware</p>
|
|
|
|
<p>This method allows middleware to be assigned to a specific Route. If the
|
|
method argument <code>is_callable</code> (including callable arrays!), we
|
|
directly append the argument to <code>$this->middleware</code>. Else, we
|
|
assume the argument is an array of callables and merge the array with
|
|
<code>$this->middleware</code>. Each middleware is checked for is_callable()
|
|
and an InvalidArgumentException is thrown immediately if it isn't.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$middleware</var></dt>
|
|
<dd><code>Callable|array[Callable]</code></dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-Slim.Route.html">Slim\Route</a></code></code><br />
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-InvalidArgumentException.html">InvalidArgumentException</a></code></code><br>If argument is not callable or not an array of callables.<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="matches" id="_matches">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
boolean
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_matches">#</a>
|
|
<code><a href="source-class-Slim.Route.html#336-371" title="Go to source code">matches</a>( <span>string <var>$resourceUri</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Matches URI?</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Matches URI?</p>
|
|
|
|
<p>Parse this route's pattern, and then compare it to an HTTP resource URI This
|
|
method was modeled after the techniques demonstrated by Dan Sosedoff at:</p>
|
|
|
|
<p><a
|
|
href="http://blog.sosedoff.com/2009/09/20/rails-like-php-url-router/">http://blog.sosedoff.com/2009/09/20/rails-like-php-url-router/</a></p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$resourceUri</var></dt>
|
|
<dd><code>string</code><br>$resourceUri A Request URI</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>boolean</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="matchesCallback" id="_matchesCallback">
|
|
|
|
<td class="attributes"><code>
|
|
protected
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_matchesCallback">#</a>
|
|
<code><a href="source-class-Slim.Route.html#373-391" title="Go to source code">matchesCallback</a>( <span>array <var>$m</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Convert a URL parameter (e.g. ":id", ":id+") into a regular expression</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Convert a URL parameter (e.g. ":id", ":id+") into a regular expression</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$m</var></dt>
|
|
<dd><code>array</code><br>URL parameters</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>string</code><br>Regular expression for URL parameter<br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="name" id="_name">
|
|
|
|
<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="#_name">#</a>
|
|
<code><a href="source-class-Slim.Route.html#393-403" title="Go to source code">name</a>( <span>string <var>$name</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Set route name</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Set route name</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>
|
|
</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="conditions" id="_conditions">
|
|
|
|
<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="#_conditions">#</a>
|
|
<code><a href="source-class-Slim.Route.html#405-415" title="Go to source code">conditions</a>( <span>array <var>$conditions</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Merge route conditions</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Merge route conditions</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$conditions</var></dt>
|
|
<dd><code>array</code><br>$conditions Key-value array of URL parameter conditions</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>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<table class="summary" id="properties">
|
|
<caption>Properties summary</caption>
|
|
<tr data-order="pattern" id="$pattern">
|
|
<td class="attributes"><code>
|
|
protected
|
|
string
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Route.html#43-46" title="Go to source code"><var>$pattern</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$pattern" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>The route pattern (e.g. "/books/:id")</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>The route pattern (e.g. "/books/:id")</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="callable" id="$callable">
|
|
<td class="attributes"><code>
|
|
protected
|
|
mixed
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Route.html#48-51" title="Go to source code"><var>$callable</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$callable" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>The route callable</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>The route callable</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="conditions" id="$conditions">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Route.html#53-56" title="Go to source code"><var>$conditions</var></a>
|
|
</td>
|
|
<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
|
|
<td class="description"><div>
|
|
<a href="#$conditions" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Conditions for this route's URL parameters</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Conditions for this route's URL parameters</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="defaultConditions" id="$defaultConditions">
|
|
<td class="attributes"><code>
|
|
protected static
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Route.html#58-61" title="Go to source code"><var>$defaultConditions</var></a>
|
|
</td>
|
|
<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
|
|
<td class="description"><div>
|
|
<a href="#$defaultConditions" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Default conditions applied to all route instances</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Default conditions applied to all route instances</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="name" id="$name">
|
|
<td class="attributes"><code>
|
|
protected
|
|
string
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Route.html#63-66" title="Go to source code"><var>$name</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$name" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>The name of this route (optional)</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>The name of this route (optional)</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="params" id="$params">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Route.html#68-71" title="Go to source code"><var>$params</var></a>
|
|
</td>
|
|
<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
|
|
<td class="description"><div>
|
|
<a href="#$params" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Key-value array of URL parameters</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Key-value array of URL parameters</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="paramNames" id="$paramNames">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Route.html#73-76" title="Go to source code"><var>$paramNames</var></a>
|
|
</td>
|
|
<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
|
|
<td class="description"><div>
|
|
<a href="#$paramNames" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>value array of URL parameter names</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>value array of URL parameter names</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="paramNamesPath" id="$paramNamesPath">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Route.html#78-81" title="Go to source code"><var>$paramNamesPath</var></a>
|
|
</td>
|
|
<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
|
|
<td class="description"><div>
|
|
<a href="#$paramNamesPath" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>key array of URL parameter names with + at the end</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>key array of URL parameter names with + at the end</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="methods" id="$methods">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Route.html#83-86" title="Go to source code"><var>$methods</var></a>
|
|
</td>
|
|
<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
|
|
<td class="description"><div>
|
|
<a href="#$methods" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>HTTP methods supported by this Route</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>HTTP methods supported by this Route</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="middleware" id="$middleware">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array[Callable]
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Route.html#88-91" title="Go to source code"><var>$middleware</var></a>
|
|
</td>
|
|
<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
|
|
<td class="description"><div>
|
|
<a href="#$middleware" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Middleware to be run before only this route instance</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Middleware to be run before only this route instance</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>
|