707 lines
13 KiB
HTML
707 lines
13 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\Http\Headers | 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 class="active"><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 class="active"><a href="class-Slim.Http.Headers.html">Headers</a></li>
|
|
<li><a href="class-Slim.Http.Request.html">Request</a></li>
|
|
<li><a href="class-Slim.Http.Response.html">Response</a></li>
|
|
<li><a href="class-Slim.Http.Util.html">Util</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.Http.html" title="Summary of Slim\Http"><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 Headers</h1>
|
|
|
|
|
|
<div class="description">
|
|
|
|
<p>HTTP Headers</p>
|
|
|
|
<p>This class is an abstraction of the HTTP response headers and provides array
|
|
access to the header list while automatically stores and retrieves headers with
|
|
lowercase canonical keys regardless of the input format.</p>
|
|
|
|
<p>This class also implements the <code>Iterator</code> and
|
|
<code>Countable</code> interfaces for even more convenient usage.</p>
|
|
|
|
</div>
|
|
|
|
<dl class="tree">
|
|
<dd style="padding-left:0px">
|
|
<b><span>Slim\Http\Headers</span></b>
|
|
implements
|
|
<a href="class-ArrayAccess.html"><span>ArrayAccess</span></a>,
|
|
|
|
<a href="class-Iterator.html"><span>Iterator</span></a>,
|
|
|
|
<a href="class-Countable.html"><span>Countable</span></a>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="info">
|
|
|
|
|
|
<b>Namespace:</b> <a href="namespace-Slim.html">Slim</a>\<a href="namespace-Slim.Http.html">Http</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.Http.Headers.html#35-181" title="Go to source code">thirdparty/Slim/Http/Headers.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.Http.Headers.html#62-69" title="Go to source code">__construct</a>( <span>array <var>$headers</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>$headers</var></dt>
|
|
<dd><code>array</code><br>$headers</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="merge" id="_merge">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_merge">#</a>
|
|
<code><a href="source-class-Slim.Http.Headers.html#71-80" title="Go to source code">merge</a>( <span>array <var>$headers</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Merge Headers</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Merge Headers</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$headers</var></dt>
|
|
<dd><code>array</code><br>$headers</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="canonical" id="_canonical">
|
|
|
|
<td class="attributes"><code>
|
|
protected
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_canonical">#</a>
|
|
<code><a href="source-class-Slim.Http.Headers.html#82-90" title="Go to source code">canonical</a>( <span>string <var>$name</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Transform header name into canonical form</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Transform header name into canonical form</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>string</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.Http.Headers.html#92-98" 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.Http.Headers.html#100-111" 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.Http.Headers.html#113-121" 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.Http.Headers.html#123-130" 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="count" id="_count">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_count">#</a>
|
|
<code><a href="source-class-Slim.Http.Headers.html#132-138" title="Go to source code">count</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Countable: Count</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Countable: Count</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Implementation of</h4>
|
|
<div class="list"><code><a href="class-Countable.html#_count">Countable::count()</a></code></div>
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="rewind" id="_rewind">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_rewind">#</a>
|
|
<code><a href="source-class-Slim.Http.Headers.html#140-146" title="Go to source code">rewind</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Iterator: Rewind</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Iterator: Rewind</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Implementation of</h4>
|
|
<div class="list"><code><a href="class-Iterator.html#_rewind">Iterator::rewind()</a></code></div>
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="current" id="_current">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_current">#</a>
|
|
<code><a href="source-class-Slim.Http.Headers.html#148-154" title="Go to source code">current</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Iterator: Current</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Iterator: Current</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Implementation of</h4>
|
|
<div class="list"><code><a href="class-Iterator.html#_current">Iterator::current()</a></code></div>
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="key" id="_key">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_key">#</a>
|
|
<code><a href="source-class-Slim.Http.Headers.html#156-164" title="Go to source code">key</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Iterator: Key</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Iterator: Key</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Implementation of</h4>
|
|
<div class="list"><code><a href="class-Iterator.html#_key">Iterator::key()</a></code></div>
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="next" id="_next">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_next">#</a>
|
|
<code><a href="source-class-Slim.Http.Headers.html#166-172" title="Go to source code">next</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Iterator: Next</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Iterator: Next</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Implementation of</h4>
|
|
<div class="list"><code><a href="class-Iterator.html#_next">Iterator::next()</a></code></div>
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="valid" id="_valid">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_valid">#</a>
|
|
<code><a href="source-class-Slim.Http.Headers.html#174-180" title="Go to source code">valid</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Iterator: Valid</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Iterator: Valid</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Implementation of</h4>
|
|
<div class="list"><code><a href="class-Iterator.html#_valid">Iterator::valid()</a></code></div>
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<table class="summary" id="properties">
|
|
<caption>Properties summary</caption>
|
|
<tr data-order="headers" id="$headers">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Http.Headers.html#52-55" title="Go to source code"><var>$headers</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$headers" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>HTTP headers</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>HTTP headers</p>
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="map" id="$map">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Http.Headers.html#57-60" title="Go to source code"><var>$map</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$map" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Map canonical header name to original header name</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Map canonical header name to original header name</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>
|