479 lines
10 KiB
HTML
479 lines
10 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\ContentTypes | GeoApi</title>
|
|
|
|
<script type="text/javascript" src="resources/combined.js?112270826"></script>
|
|
<script type="text/javascript" src="elementlist.js?4049399837"></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 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 class="active"><a href="class-Slim.Middleware.ContentTypes.html">ContentTypes</a></li>
|
|
<li><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 ContentTypes</h1>
|
|
|
|
|
|
<div class="description">
|
|
|
|
<p>Content Types</p>
|
|
|
|
<p>This is middleware for a Slim application that intercepts the HTTP request
|
|
body and parses it into the appropriate PHP data structure if possible; else it
|
|
returns the HTTP request body unchanged. This is particularly useful for
|
|
preparing the HTTP request body for an XML or JSON API.</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\ContentTypes</span></b>
|
|
|
|
|
|
</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.ContentTypes.html#35-170" title="Go to source code">thirdparty/Slim/Middleware/ContentTypes.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.ContentTypes.html#55-67" title="Go to source code">__construct</a>( <span>array <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>array</code><br>$settings</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.ContentTypes.html#69-81" 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="parse" id="_parse">
|
|
|
|
<td class="attributes"><code>
|
|
protected
|
|
mixed
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_parse">#</a>
|
|
<code><a href="source-class-Slim.Middleware.ContentTypes.html#83-103" title="Go to source code">parse</a>( <span>string <var>$input</var></span>, <span>string <var>$contentType</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Parse input</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Parse input</p>
|
|
|
|
<p>This method will attempt to parse the request body based on its content type
|
|
if available.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$input</var></dt>
|
|
<dd><code>string</code><br>$input</dd>
|
|
<dt><var>$contentType</var></dt>
|
|
<dd><code>string</code><br>$contentType</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>mixed</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="parseJson" id="_parseJson">
|
|
|
|
<td class="attributes"><code>
|
|
protected
|
|
array|string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_parseJson">#</a>
|
|
<code><a href="source-class-Slim.Middleware.ContentTypes.html#105-122" title="Go to source code">parseJson</a>( <span>string <var>$input</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Parse JSON</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Parse JSON</p>
|
|
|
|
<p>This method converts the raw JSON input into an associative array.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$input</var></dt>
|
|
<dd><code>string</code><br>$input</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>array|string</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="parseXml" id="_parseXml">
|
|
|
|
<td class="attributes"><code>
|
|
protected
|
|
<code><a href="class-SimpleXMLElement.html">SimpleXMLElement</a></code>|string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_parseXml">#</a>
|
|
<code><a href="source-class-Slim.Middleware.ContentTypes.html#124-146" title="Go to source code">parseXml</a>( <span>string <var>$input</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Parse XML</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Parse XML</p>
|
|
|
|
<p>This method creates a SimpleXMLElement based upon the XML input. If the
|
|
SimpleXML extension is not available, the raw input will be returned
|
|
unchanged.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$input</var></dt>
|
|
<dd><code>string</code><br>$input</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-SimpleXMLElement.html">SimpleXMLElement</a></code>|string</code><br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="parseCsv" id="_parseCsv">
|
|
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_parseCsv">#</a>
|
|
<code><a href="source-class-Slim.Middleware.ContentTypes.html#148-169" title="Go to source code">parseCsv</a>( <span>string <var>$input</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Parse CSV</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Parse CSV</p>
|
|
|
|
<p>This method parses CSV content into a numeric array containing an array of
|
|
data for each CSV line.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$input</var></dt>
|
|
<dd><code>string</code><br>$input</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>array</code><br />
|
|
</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="contentTypes" id="$contentTypes">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Middleware.ContentTypes.html#50-53" title="Go to source code"><var>$contentTypes</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$contentTypes" 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>
|