phpdoc/Library/Router.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\Router | Library</title>
<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../css/sami.css">
<script src="../js/jquery-1.11.1.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script src="../js/typeahead.min.js"></script>
<script src="../sami.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="class" data-name="class:Library_Router" data-root-path="../">
<div id="content">
<div id="left-column">
<div id="control-panel">
<form id="search-form" action="../search.html" method="GET">
<span class="glyphicon glyphicon-search"></span>
<input name="search"
class="typeahead form-control"
type="search"
placeholder="Search">
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">Library</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../classes.html">Classes</a></li>
<li><a href="../namespaces.html">Namespaces</a></li>
<li><a href="../interfaces.html">Interfaces</a></li>
<li><a href="../traits.html">Traits</a></li>
<li><a href="../doc-index.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">class</span></li>
<li><a href="../Library.html">Library</a></li>
<li>Router</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Router</h1>
</div>
<p> class
<strong>Router</strong> implements
<abbr title="Patterns\Interfaces\RouterInterface">RouterInterface</abbr>
</p>
<div class="description">
<p>The global router class</p> </div>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method___construct">__construct</a>(
string $route = null,
array $routes_table = array(),
array $arguments_table = array(),
array $matchers_table = array())
<p>Construction</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Patterns\Commons\Collection">Collection</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_getCollection">getCollection</a>(
array $collection)
<p>Get a collection object if it was not</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setUrl">setUrl</a>(
string $url)
<p>Set the current URL</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getUrl">getUrl</a>()
<p>Get the current URL</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setRoute">setRoute</a>(
string $route)
<p>Set the current route</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getRoute">getRoute</a>()
<p>Get the current route</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setRouteParsed">setRouteParsed</a>(
array $infos)
<p>Set the current route parsed infos</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_getRouteParsed">getRouteParsed</a>()
<p>Get the current route parsed infos</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setRoutes">setRoutes</a>(
<abbr title="Library\Patterns\Commons\Collection">Collection</abbr> $collection)
<p>Set the routes collection</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Patterns\Commons\Collection">Collection</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_getRoutes">getRoutes</a>()
<p>Get the routes collection</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setArgumentsMap">setArgumentsMap</a>(
<abbr title="Library\Patterns\Commons\Collection">Collection</abbr> $collection)
<p>Set the arguments correspondances table like ( true arg in URL => true arg name in the app )</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Patterns\Commons\Collection">Collection</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_getArgumentsMap">getArgumentsMap</a>()
<p>Get the arguments table</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setMatchers">setMatchers</a>(
<abbr title="Library\Patterns\Commons\Collection">Collection</abbr> $collection)
<p>Set a collection of masks to parse and match a route URL</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Patterns\Commons\Collection">Collection</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_getMatchers">getMatchers</a>()
<p>Get the route matcher</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_routeExists">routeExists</a>(
string $route)
<p>Check if a route exists</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_generateUrl">generateUrl</a>(
mixed $route_infos,
string $base_uri = null,
string $hash = null,
string $separator = '&amp;')
<p>Build a new route URL</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\false">false</abbr>|mixed
</div>
<div class="col-md-8 type">
<a href="#method_matchUrl">matchUrl</a>(
mixed $pathinfo)
<p>Test if an URL has a corresponding route</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_distribute">distribute</a>()
<p>Actually dispatch the current route</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
void
</div>
<div class="col-md-8 type">
<a href="#method_forward">forward</a>(
mixed $pathinfo,
string $hash = null)
<p>Forward the application to a new route (no HTTP redirect)</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
void
</div>
<div class="col-md-8 type">
<a href="#method_redirect">redirect</a>(
mixed $pathinfo,
string $hash = null)
<p>Make a redirection to a new route (HTTP redirect)</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
string
</div>
<div class="col-md-8 type">
<a href="#method_urlEncode">urlEncode</a>(
string $str = null,
bool $keep_mask = true)
<p>Special 'urlencode' function to only encode strings and let any "%s" mask not encoded</p> </div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method___construct">
<div class="location">at line 78</div>
<code>
<strong>__construct</strong>(
string $route = null,
array $routes_table = array(),
array $arguments_table = array(),
array $matchers_table = array())</code>
</h3>
<div class="details">
<div class="method-description">
<p>Construction</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$route</td>
<td>
</td>
</tr>
<tr>
<td>
array</td>
<td>$routes_table</td>
<td>
</td>
</tr>
<tr>
<td>
array</td>
<td>$arguments_table</td>
<td>
</td>
</tr>
<tr>
<td>
array</td>
<td>$matchers_table</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getCollection">
<div class="location">at line 101</div>
<code>
<abbr title="Patterns\Commons\Collection">Collection</abbr>
<strong>getCollection</strong>(
array $collection)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get a collection object if it was not</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$collection</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Patterns\Commons\Collection">Collection</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setUrl">
<div class="location">at line 120</div>
<code>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
<strong>setUrl</strong>(
string $url)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the current URL</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$url</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getUrl">
<div class="location">at line 131</div>
<code>
string
<strong>getUrl</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the current URL</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setRoute">
<div class="location">at line 142</div>
<code>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
<strong>setRoute</strong>(
string $route)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the current route</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$route</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getRoute">
<div class="location">at line 153</div>
<code>
string
<strong>getRoute</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the current route</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setRouteParsed">
<div class="location">at line 164</div>
<code>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
<strong>setRouteParsed</strong>(
array $infos)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the current route parsed infos</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$infos</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getRouteParsed">
<div class="location">at line 175</div>
<code>
array
<strong>getRouteParsed</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the current route parsed infos</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setRoutes">
<div class="location">at line 186</div>
<code>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
<strong>setRoutes</strong>(
<abbr title="Library\Patterns\Commons\Collection">Collection</abbr> $collection)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the routes collection</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Patterns\Commons\Collection">Collection</abbr></td>
<td>$collection</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getRoutes">
<div class="location">at line 197</div>
<code>
<abbr title="Patterns\Commons\Collection">Collection</abbr>
<strong>getRoutes</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the routes collection</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Patterns\Commons\Collection">Collection</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setArgumentsMap">
<div class="location">at line 208</div>
<code>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
<strong>setArgumentsMap</strong>(
<abbr title="Library\Patterns\Commons\Collection">Collection</abbr> $collection)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the arguments correspondances table like ( true arg in URL => true arg name in the app )</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Patterns\Commons\Collection">Collection</abbr></td>
<td>$collection</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getArgumentsMap">
<div class="location">at line 219</div>
<code>
<abbr title="Patterns\Commons\Collection">Collection</abbr>
<strong>getArgumentsMap</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the arguments table</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Patterns\Commons\Collection">Collection</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setMatchers">
<div class="location">at line 230</div>
<code>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
<strong>setMatchers</strong>(
<abbr title="Library\Patterns\Commons\Collection">Collection</abbr> $collection)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set a collection of masks to parse and match a route URL</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\Patterns\Commons\Collection">Collection</abbr></td>
<td>$collection</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getMatchers">
<div class="location">at line 241</div>
<code>
<abbr title="Patterns\Commons\Collection">Collection</abbr>
<strong>getMatchers</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the route matcher</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Patterns\Commons\Collection">Collection</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_routeExists">
<div class="location">at line 252</div>
<code>
bool
<strong>routeExists</strong>(
string $route)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Check if a route exists</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$route</td>
<td>The route to test</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_generateUrl">
<div class="location">at line 317</div>
<code>
string
<strong>generateUrl</strong>(
mixed $route_infos,
string $base_uri = null,
string $hash = null,
string $separator = '&amp;')</code>
</h3>
<div class="details">
<div class="method-description">
<p>Build a new route URL</p> <p>The class will pass arguments values to any <code>$this->toUrlParam($value)</code> method for the
parameter named <code>param</code>.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$route_infos</td>
<td>The information about the route to analyze, can be a string route or an array
of arguments like <code>param => value</code></td>
</tr>
<tr>
<td>
string</td>
<td>$base_uri</td>
<td>The URI to add the new route to</td>
</tr>
<tr>
<td>
string</td>
<td>$hash</td>
<td>A hash tag to add to the generated URL</td>
</tr>
<tr>
<td>
string</td>
<td>$separator</td>
<td>The argument/value separator (default is escaped ampersand : '&')</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>The application valid URL for the route</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_matchUrl">
<div class="location">at line 354</div>
<code>
<abbr title="Library\false">false</abbr>|mixed
<strong>matchUrl</strong>(
mixed $pathinfo)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Test if an URL has a corresponding route</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$pathinfo</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\false">false</abbr>|mixed</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_distribute">
<div class="location">at line 369</div>
<code>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a>
<strong>distribute</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Actually dispatch the current route</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../Library/Router.html"><abbr title="Library\Router">Router</abbr></a></td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td>
<td>if no route has been found</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_forward">
<div class="location">at line 392</div>
<code>
void
<strong>forward</strong>(
mixed $pathinfo,
string $hash = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Forward the application to a new route (no HTTP redirect)</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$pathinfo</td>
<td>The path information to forward to</td>
</tr>
<tr>
<td>
string</td>
<td>$hash</td>
<td>A hash tag to add to the generated URL</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_redirect">
<div class="location">at line 403</div>
<code>
void
<strong>redirect</strong>(
mixed $pathinfo,
string $hash = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Make a redirection to a new route (HTTP redirect)</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$pathinfo</td>
<td>The path information to redirect to</td>
</tr>
<tr>
<td>
string</td>
<td>$hash</td>
<td>A hash tag to add to the generated URL</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_urlEncode">
<div class="location">at line 430</div>
<code> static
string
<strong>urlEncode</strong>(
string $str = null,
bool $keep_mask = true)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Special 'urlencode' function to only encode strings and let any "%s" mask not encoded</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$str</td>
<td>The URL or argument to encode</td>
</tr>
<tr>
<td>
bool</td>
<td>$keep_mask</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>The encoded URL if so</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
</div>
</div>
</div>
</body>
</html>