561 lines
65 KiB
HTML
561 lines
65 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" />
|
|
<meta name="robots" content="noindex" />
|
|
|
|
<title>File thirdparty/Slim/Http/Response.php | GeoApi</title>
|
|
|
|
<script type="text/javascript" src="resources/combined.js?112270826"></script>
|
|
<script type="text/javascript" src="elementlist.js?4049681226"></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-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>
|
|
</ul>
|
|
</div>
|
|
|
|
<hr />
|
|
|
|
|
|
<div id="elements">
|
|
<h3>Classes</h3>
|
|
<ul>
|
|
<li><a href="class-Slim.Http.Headers.html">Headers</a></li>
|
|
<li><a href="class-Slim.Http.Request.html">Request</a></li>
|
|
<li class="active"><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>
|
|
<a href="class-Slim.Http.Response.html" title="Summary of Slim\Http\Response"><span>Class</span></a>
|
|
</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>
|
|
|
|
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
|
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">/**
|
|
</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment"> * Slim - a micro PHP 5 framework
|
|
</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> *
|
|
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * @author Josh Lockhart <info@slimframework.com>
|
|
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * @copyright 2011 Josh Lockhart
|
|
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * @link http://www.slimframework.com
|
|
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * @license http://www.slimframework.com/license
|
|
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * @version 2.2.0
|
|
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @package Slim
|
|
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> *
|
|
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * MIT LICENSE
|
|
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> *
|
|
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * Permission is hereby granted, free of charge, to any person obtaining
|
|
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * a copy of this software and associated documentation files (the
|
|
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * "Software"), to deal in the Software without restriction, including
|
|
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * without limitation the rights to use, copy, modify, merge, publish,
|
|
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * distribute, sublicense, and/or sell copies of the Software, and to
|
|
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * permit persons to whom the Software is furnished to do so, subject to
|
|
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * the following conditions:
|
|
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> *
|
|
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The above copyright notice and this permission notice shall be
|
|
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * included in all copies or substantial portions of the Software.
|
|
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> *
|
|
</span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
</span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> */</span>
|
|
</span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-keyword1">namespace</span> Slim\Http;
|
|
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a>
|
|
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment">/**
|
|
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * Response
|
|
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> *
|
|
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * This is a simple abstraction over top an HTTP response. This
|
|
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * provides methods to set the HTTP status, the HTTP headers,
|
|
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * and the HTTP body.
|
|
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> *
|
|
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * @package Slim
|
|
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * @author Josh Lockhart
|
|
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * @since 1.0.0
|
|
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> */</span>
|
|
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-keyword1">class</span> <a id="Response" href="#Response">Response</a> <span class="php-keyword1">implements</span> \ArrayAccess, \Countable, \IteratorAggregate
|
|
</span><span id="47" class="l"><a class="l" href="#47"> 47: </a>{
|
|
</span><span id="48" class="l"><a class="l" href="#48"> 48: </a> <span class="php-comment">/**
|
|
</span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * @var int HTTP status code
|
|
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> */</span>
|
|
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$status" href="#$status">$status</a></span>;
|
|
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a>
|
|
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a> <span class="php-comment">/**
|
|
</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * @var \Slim\Http\Headers List of HTTP response headers
|
|
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> */</span>
|
|
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$header" href="#$header">$header</a></span>;
|
|
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a>
|
|
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a> <span class="php-comment">/**
|
|
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * @var string HTTP response body
|
|
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> */</span>
|
|
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$body" href="#$body">$body</a></span>;
|
|
</span><span id="62" class="l"><a class="l" href="#62"> 62: </a>
|
|
</span><span id="63" class="l"><a class="l" href="#63"> 63: </a> <span class="php-comment">/**
|
|
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> * @var int Length of HTTP response body
|
|
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> */</span>
|
|
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$length" href="#$length">$length</a></span>;
|
|
</span><span id="67" class="l"><a class="l" href="#67"> 67: </a>
|
|
</span><span id="68" class="l"><a class="l" href="#68"> 68: </a> <span class="php-comment">/**
|
|
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * @var array HTTP response codes and messages
|
|
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> */</span>
|
|
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$messages" href="#$messages">$messages</a></span> = <span class="php-keyword1">array</span>(
|
|
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a> <span class="php-comment">//Informational 1xx</span>
|
|
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a> <span class="php-num">100</span> => <span class="php-quote">'100 Continue'</span>,
|
|
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a> <span class="php-num">101</span> => <span class="php-quote">'101 Switching Protocols'</span>,
|
|
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-comment">//Successful 2xx</span>
|
|
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a> <span class="php-num">200</span> => <span class="php-quote">'200 OK'</span>,
|
|
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-num">201</span> => <span class="php-quote">'201 Created'</span>,
|
|
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-num">202</span> => <span class="php-quote">'202 Accepted'</span>,
|
|
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-num">203</span> => <span class="php-quote">'203 Non-Authoritative Information'</span>,
|
|
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-num">204</span> => <span class="php-quote">'204 No Content'</span>,
|
|
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-num">205</span> => <span class="php-quote">'205 Reset Content'</span>,
|
|
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-num">206</span> => <span class="php-quote">'206 Partial Content'</span>,
|
|
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> <span class="php-comment">//Redirection 3xx</span>
|
|
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a> <span class="php-num">300</span> => <span class="php-quote">'300 Multiple Choices'</span>,
|
|
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-num">301</span> => <span class="php-quote">'301 Moved Permanently'</span>,
|
|
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a> <span class="php-num">302</span> => <span class="php-quote">'302 Found'</span>,
|
|
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> <span class="php-num">303</span> => <span class="php-quote">'303 See Other'</span>,
|
|
</span><span id="88" class="l"><a class="l" href="#88"> 88: </a> <span class="php-num">304</span> => <span class="php-quote">'304 Not Modified'</span>,
|
|
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-num">305</span> => <span class="php-quote">'305 Use Proxy'</span>,
|
|
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-num">306</span> => <span class="php-quote">'306 (Unused)'</span>,
|
|
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a> <span class="php-num">307</span> => <span class="php-quote">'307 Temporary Redirect'</span>,
|
|
</span><span id="92" class="l"><a class="l" href="#92"> 92: </a> <span class="php-comment">//Client Error 4xx</span>
|
|
</span><span id="93" class="l"><a class="l" href="#93"> 93: </a> <span class="php-num">400</span> => <span class="php-quote">'400 Bad Request'</span>,
|
|
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a> <span class="php-num">401</span> => <span class="php-quote">'401 Unauthorized'</span>,
|
|
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a> <span class="php-num">402</span> => <span class="php-quote">'402 Payment Required'</span>,
|
|
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a> <span class="php-num">403</span> => <span class="php-quote">'403 Forbidden'</span>,
|
|
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a> <span class="php-num">404</span> => <span class="php-quote">'404 Not Found'</span>,
|
|
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a> <span class="php-num">405</span> => <span class="php-quote">'405 Method Not Allowed'</span>,
|
|
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a> <span class="php-num">406</span> => <span class="php-quote">'406 Not Acceptable'</span>,
|
|
</span><span id="100" class="l"><a class="l" href="#100">100: </a> <span class="php-num">407</span> => <span class="php-quote">'407 Proxy Authentication Required'</span>,
|
|
</span><span id="101" class="l"><a class="l" href="#101">101: </a> <span class="php-num">408</span> => <span class="php-quote">'408 Request Timeout'</span>,
|
|
</span><span id="102" class="l"><a class="l" href="#102">102: </a> <span class="php-num">409</span> => <span class="php-quote">'409 Conflict'</span>,
|
|
</span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-num">410</span> => <span class="php-quote">'410 Gone'</span>,
|
|
</span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-num">411</span> => <span class="php-quote">'411 Length Required'</span>,
|
|
</span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-num">412</span> => <span class="php-quote">'412 Precondition Failed'</span>,
|
|
</span><span id="106" class="l"><a class="l" href="#106">106: </a> <span class="php-num">413</span> => <span class="php-quote">'413 Request Entity Too Large'</span>,
|
|
</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-num">414</span> => <span class="php-quote">'414 Request-URI Too Long'</span>,
|
|
</span><span id="108" class="l"><a class="l" href="#108">108: </a> <span class="php-num">415</span> => <span class="php-quote">'415 Unsupported Media Type'</span>,
|
|
</span><span id="109" class="l"><a class="l" href="#109">109: </a> <span class="php-num">416</span> => <span class="php-quote">'416 Requested Range Not Satisfiable'</span>,
|
|
</span><span id="110" class="l"><a class="l" href="#110">110: </a> <span class="php-num">417</span> => <span class="php-quote">'417 Expectation Failed'</span>,
|
|
</span><span id="111" class="l"><a class="l" href="#111">111: </a> <span class="php-num">422</span> => <span class="php-quote">'422 Unprocessable Entity'</span>,
|
|
</span><span id="112" class="l"><a class="l" href="#112">112: </a> <span class="php-num">423</span> => <span class="php-quote">'423 Locked'</span>,
|
|
</span><span id="113" class="l"><a class="l" href="#113">113: </a> <span class="php-comment">//Server Error 5xx</span>
|
|
</span><span id="114" class="l"><a class="l" href="#114">114: </a> <span class="php-num">500</span> => <span class="php-quote">'500 Internal Server Error'</span>,
|
|
</span><span id="115" class="l"><a class="l" href="#115">115: </a> <span class="php-num">501</span> => <span class="php-quote">'501 Not Implemented'</span>,
|
|
</span><span id="116" class="l"><a class="l" href="#116">116: </a> <span class="php-num">502</span> => <span class="php-quote">'502 Bad Gateway'</span>,
|
|
</span><span id="117" class="l"><a class="l" href="#117">117: </a> <span class="php-num">503</span> => <span class="php-quote">'503 Service Unavailable'</span>,
|
|
</span><span id="118" class="l"><a class="l" href="#118">118: </a> <span class="php-num">504</span> => <span class="php-quote">'504 Gateway Timeout'</span>,
|
|
</span><span id="119" class="l"><a class="l" href="#119">119: </a> <span class="php-num">505</span> => <span class="php-quote">'505 HTTP Version Not Supported'</span>
|
|
</span><span id="120" class="l"><a class="l" href="#120">120: </a> );
|
|
</span><span id="121" class="l"><a class="l" href="#121">121: </a>
|
|
</span><span id="122" class="l"><a class="l" href="#122">122: </a> <span class="php-comment">/**
|
|
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> * Constructor
|
|
</span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment"> * @param string $body The HTTP response body
|
|
</span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment"> * @param int $status The HTTP response status
|
|
</span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment"> * @param \Slim\Http\Headers|array $header The HTTP response headers
|
|
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> */</span>
|
|
</span><span id="128" class="l"><a class="l" href="#128">128: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$body</span> = <span class="php-quote">''</span>, <span class="php-var">$status</span> = <span class="php-num">200</span>, <span class="php-var">$header</span> = <span class="php-keyword1">array</span>())
|
|
</span><span id="129" class="l"><a class="l" href="#129">129: </a> {
|
|
</span><span id="130" class="l"><a class="l" href="#130">130: </a> <span class="php-var">$this</span>->status = (int) <span class="php-var">$status</span>;
|
|
</span><span id="131" class="l"><a class="l" href="#131">131: </a> <span class="php-var">$headers</span> = <span class="php-keyword1">array</span>();
|
|
</span><span id="132" class="l"><a class="l" href="#132">132: </a> <span class="php-keyword1">foreach</span> (<span class="php-var">$header</span> <span class="php-keyword1">as</span> <span class="php-var">$key</span> => <span class="php-var">$value</span>) {
|
|
</span><span id="133" class="l"><a class="l" href="#133">133: </a> <span class="php-var">$headers</span>[<span class="php-var">$key</span>] = <span class="php-var">$value</span>;
|
|
</span><span id="134" class="l"><a class="l" href="#134">134: </a> }
|
|
</span><span id="135" class="l"><a class="l" href="#135">135: </a> <span class="php-var">$this</span>-><span class="php-keyword2">header</span> = <span class="php-keyword1">new</span> Headers(<span class="php-keyword2">array_merge</span>(<span class="php-keyword1">array</span>(<span class="php-quote">'Content-Type'</span> => <span class="php-quote">'text/html'</span>), <span class="php-var">$headers</span>));
|
|
</span><span id="136" class="l"><a class="l" href="#136">136: </a> <span class="php-var">$this</span>->body = <span class="php-quote">''</span>;
|
|
</span><span id="137" class="l"><a class="l" href="#137">137: </a> <span class="php-var">$this</span>->write(<span class="php-var">$body</span>);
|
|
</span><span id="138" class="l"><a class="l" href="#138">138: </a> }
|
|
</span><span id="139" class="l"><a class="l" href="#139">139: </a>
|
|
</span><span id="140" class="l"><a class="l" href="#140">140: </a> <span class="php-comment">/**
|
|
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment"> * Get and set status
|
|
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * @param int|null $status
|
|
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> * @return int
|
|
</span></span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-comment"> */</span>
|
|
</span><span id="145" class="l"><a class="l" href="#145">145: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_status" href="#_status">status</a>(<span class="php-var">$status</span> = <span class="php-keyword1">null</span>)
|
|
</span><span id="146" class="l"><a class="l" href="#146">146: </a> {
|
|
</span><span id="147" class="l"><a class="l" href="#147">147: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_null</span>(<span class="php-var">$status</span>)) {
|
|
</span><span id="148" class="l"><a class="l" href="#148">148: </a> <span class="php-var">$this</span>->status = (int) <span class="php-var">$status</span>;
|
|
</span><span id="149" class="l"><a class="l" href="#149">149: </a> }
|
|
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
|
|
</span><span id="151" class="l"><a class="l" href="#151">151: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->status;
|
|
</span><span id="152" class="l"><a class="l" href="#152">152: </a> }
|
|
</span><span id="153" class="l"><a class="l" href="#153">153: </a>
|
|
</span><span id="154" class="l"><a class="l" href="#154">154: </a> <span class="php-comment">/**
|
|
</span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment"> * Get and set header
|
|
</span></span><span id="156" class="l"><a class="l" href="#156">156: </a><span class="php-comment"> * @param string $name Header name
|
|
</span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment"> * @param string|null $value Header value
|
|
</span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment"> * @return string Header value
|
|
</span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment"> */</span>
|
|
</span><span id="160" class="l"><a class="l" href="#160">160: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">header</span>(<span class="php-var">$name</span>, <span class="php-var">$value</span> = <span class="php-keyword1">null</span>)
|
|
</span><span id="161" class="l"><a class="l" href="#161">161: </a> {
|
|
</span><span id="162" class="l"><a class="l" href="#162">162: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_null</span>(<span class="php-var">$value</span>)) {
|
|
</span><span id="163" class="l"><a class="l" href="#163">163: </a> <span class="php-var">$this</span>[<span class="php-var">$name</span>] = <span class="php-var">$value</span>;
|
|
</span><span id="164" class="l"><a class="l" href="#164">164: </a> }
|
|
</span><span id="165" class="l"><a class="l" href="#165">165: </a>
|
|
</span><span id="166" class="l"><a class="l" href="#166">166: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>[<span class="php-var">$name</span>];
|
|
</span><span id="167" class="l"><a class="l" href="#167">167: </a> }
|
|
</span><span id="168" class="l"><a class="l" href="#168">168: </a>
|
|
</span><span id="169" class="l"><a class="l" href="#169">169: </a> <span class="php-comment">/**
|
|
</span></span><span id="170" class="l"><a class="l" href="#170">170: </a><span class="php-comment"> * Get headers
|
|
</span></span><span id="171" class="l"><a class="l" href="#171">171: </a><span class="php-comment"> * @return \Slim\Http\Headers
|
|
</span></span><span id="172" class="l"><a class="l" href="#172">172: </a><span class="php-comment"> */</span>
|
|
</span><span id="173" class="l"><a class="l" href="#173">173: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_headers" href="#_headers">headers</a>()
|
|
</span><span id="174" class="l"><a class="l" href="#174">174: </a> {
|
|
</span><span id="175" class="l"><a class="l" href="#175">175: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-><span class="php-keyword2">header</span>;
|
|
</span><span id="176" class="l"><a class="l" href="#176">176: </a> }
|
|
</span><span id="177" class="l"><a class="l" href="#177">177: </a>
|
|
</span><span id="178" class="l"><a class="l" href="#178">178: </a> <span class="php-comment">/**
|
|
</span></span><span id="179" class="l"><a class="l" href="#179">179: </a><span class="php-comment"> * Get and set body
|
|
</span></span><span id="180" class="l"><a class="l" href="#180">180: </a><span class="php-comment"> * @param string|null $body Content of HTTP response body
|
|
</span></span><span id="181" class="l"><a class="l" href="#181">181: </a><span class="php-comment"> * @return string
|
|
</span></span><span id="182" class="l"><a class="l" href="#182">182: </a><span class="php-comment"> */</span>
|
|
</span><span id="183" class="l"><a class="l" href="#183">183: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_body" href="#_body">body</a>(<span class="php-var">$body</span> = <span class="php-keyword1">null</span>)
|
|
</span><span id="184" class="l"><a class="l" href="#184">184: </a> {
|
|
</span><span id="185" class="l"><a class="l" href="#185">185: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_null</span>(<span class="php-var">$body</span>)) {
|
|
</span><span id="186" class="l"><a class="l" href="#186">186: </a> <span class="php-var">$this</span>->write(<span class="php-var">$body</span>, <span class="php-keyword1">true</span>);
|
|
</span><span id="187" class="l"><a class="l" href="#187">187: </a> }
|
|
</span><span id="188" class="l"><a class="l" href="#188">188: </a>
|
|
</span><span id="189" class="l"><a class="l" href="#189">189: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->body;
|
|
</span><span id="190" class="l"><a class="l" href="#190">190: </a> }
|
|
</span><span id="191" class="l"><a class="l" href="#191">191: </a>
|
|
</span><span id="192" class="l"><a class="l" href="#192">192: </a> <span class="php-comment">/**
|
|
</span></span><span id="193" class="l"><a class="l" href="#193">193: </a><span class="php-comment"> * Get and set length
|
|
</span></span><span id="194" class="l"><a class="l" href="#194">194: </a><span class="php-comment"> * @param int|null $length
|
|
</span></span><span id="195" class="l"><a class="l" href="#195">195: </a><span class="php-comment"> * @return int
|
|
</span></span><span id="196" class="l"><a class="l" href="#196">196: </a><span class="php-comment"> */</span>
|
|
</span><span id="197" class="l"><a class="l" href="#197">197: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_length" href="#_length">length</a>(<span class="php-var">$length</span> = <span class="php-keyword1">null</span>)
|
|
</span><span id="198" class="l"><a class="l" href="#198">198: </a> {
|
|
</span><span id="199" class="l"><a class="l" href="#199">199: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_null</span>(<span class="php-var">$length</span>)) {
|
|
</span><span id="200" class="l"><a class="l" href="#200">200: </a> <span class="php-var">$this</span>->length = (int) <span class="php-var">$length</span>;
|
|
</span><span id="201" class="l"><a class="l" href="#201">201: </a> }
|
|
</span><span id="202" class="l"><a class="l" href="#202">202: </a>
|
|
</span><span id="203" class="l"><a class="l" href="#203">203: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->length;
|
|
</span><span id="204" class="l"><a class="l" href="#204">204: </a> }
|
|
</span><span id="205" class="l"><a class="l" href="#205">205: </a>
|
|
</span><span id="206" class="l"><a class="l" href="#206">206: </a> <span class="php-comment">/**
|
|
</span></span><span id="207" class="l"><a class="l" href="#207">207: </a><span class="php-comment"> * Append HTTP response body
|
|
</span></span><span id="208" class="l"><a class="l" href="#208">208: </a><span class="php-comment"> * @param string $body Content to append to the current HTTP response body
|
|
</span></span><span id="209" class="l"><a class="l" href="#209">209: </a><span class="php-comment"> * @param bool $replace Overwrite existing response body?
|
|
</span></span><span id="210" class="l"><a class="l" href="#210">210: </a><span class="php-comment"> * @return string The updated HTTP response body
|
|
</span></span><span id="211" class="l"><a class="l" href="#211">211: </a><span class="php-comment"> */</span>
|
|
</span><span id="212" class="l"><a class="l" href="#212">212: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_write" href="#_write">write</a>(<span class="php-var">$body</span>, <span class="php-var">$replace</span> = <span class="php-keyword1">false</span>)
|
|
</span><span id="213" class="l"><a class="l" href="#213">213: </a> {
|
|
</span><span id="214" class="l"><a class="l" href="#214">214: </a> <span class="php-keyword1">if</span> (<span class="php-var">$replace</span>) {
|
|
</span><span id="215" class="l"><a class="l" href="#215">215: </a> <span class="php-var">$this</span>->body = <span class="php-var">$body</span>;
|
|
</span><span id="216" class="l"><a class="l" href="#216">216: </a> } <span class="php-keyword1">else</span> {
|
|
</span><span id="217" class="l"><a class="l" href="#217">217: </a> <span class="php-var">$this</span>->body .= (string) <span class="php-var">$body</span>;
|
|
</span><span id="218" class="l"><a class="l" href="#218">218: </a> }
|
|
</span><span id="219" class="l"><a class="l" href="#219">219: </a> <span class="php-var">$this</span>->length = <span class="php-keyword2">strlen</span>(<span class="php-var">$this</span>->body);
|
|
</span><span id="220" class="l"><a class="l" href="#220">220: </a>
|
|
</span><span id="221" class="l"><a class="l" href="#221">221: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->body;
|
|
</span><span id="222" class="l"><a class="l" href="#222">222: </a> }
|
|
</span><span id="223" class="l"><a class="l" href="#223">223: </a>
|
|
</span><span id="224" class="l"><a class="l" href="#224">224: </a> <span class="php-comment">/**
|
|
</span></span><span id="225" class="l"><a class="l" href="#225">225: </a><span class="php-comment"> * Finalize
|
|
</span></span><span id="226" class="l"><a class="l" href="#226">226: </a><span class="php-comment"> *
|
|
</span></span><span id="227" class="l"><a class="l" href="#227">227: </a><span class="php-comment"> * This prepares this response and returns an array
|
|
</span></span><span id="228" class="l"><a class="l" href="#228">228: </a><span class="php-comment"> * of [status, headers, body]. This array is passed to outer middleware
|
|
</span></span><span id="229" class="l"><a class="l" href="#229">229: </a><span class="php-comment"> * if available or directly to the Slim run method.
|
|
</span></span><span id="230" class="l"><a class="l" href="#230">230: </a><span class="php-comment"> *
|
|
</span></span><span id="231" class="l"><a class="l" href="#231">231: </a><span class="php-comment"> * @return array[int status, array headers, string body]
|
|
</span></span><span id="232" class="l"><a class="l" href="#232">232: </a><span class="php-comment"> */</span>
|
|
</span><span id="233" class="l"><a class="l" href="#233">233: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_finalize" href="#_finalize">finalize</a>()
|
|
</span><span id="234" class="l"><a class="l" href="#234">234: </a> {
|
|
</span><span id="235" class="l"><a class="l" href="#235">235: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">in_array</span>(<span class="php-var">$this</span>->status, <span class="php-keyword1">array</span>(<span class="php-num">204</span>, <span class="php-num">304</span>))) {
|
|
</span><span id="236" class="l"><a class="l" href="#236">236: </a> <span class="php-keyword1">unset</span>(<span class="php-var">$this</span>[<span class="php-quote">'Content-Type'</span>], <span class="php-var">$this</span>[<span class="php-quote">'Content-Length'</span>]);
|
|
</span><span id="237" class="l"><a class="l" href="#237">237: </a>
|
|
</span><span id="238" class="l"><a class="l" href="#238">238: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">array</span>(<span class="php-var">$this</span>->status, <span class="php-var">$this</span>-><span class="php-keyword2">header</span>, <span class="php-quote">''</span>);
|
|
</span><span id="239" class="l"><a class="l" href="#239">239: </a> } <span class="php-keyword1">else</span> {
|
|
</span><span id="240" class="l"><a class="l" href="#240">240: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">array</span>(<span class="php-var">$this</span>->status, <span class="php-var">$this</span>-><span class="php-keyword2">header</span>, <span class="php-var">$this</span>->body);
|
|
</span><span id="241" class="l"><a class="l" href="#241">241: </a> }
|
|
</span><span id="242" class="l"><a class="l" href="#242">242: </a> }
|
|
</span><span id="243" class="l"><a class="l" href="#243">243: </a>
|
|
</span><span id="244" class="l"><a class="l" href="#244">244: </a> <span class="php-comment">/**
|
|
</span></span><span id="245" class="l"><a class="l" href="#245">245: </a><span class="php-comment"> * Set cookie
|
|
</span></span><span id="246" class="l"><a class="l" href="#246">246: </a><span class="php-comment"> *
|
|
</span></span><span id="247" class="l"><a class="l" href="#247">247: </a><span class="php-comment"> * Instead of using PHP's `setcookie()` function, Slim manually constructs the HTTP `Set-Cookie`
|
|
</span></span><span id="248" class="l"><a class="l" href="#248">248: </a><span class="php-comment"> * header on its own and delegates this responsibility to the `Slim_Http_Util` class. This
|
|
</span></span><span id="249" class="l"><a class="l" href="#249">249: </a><span class="php-comment"> * response's header is passed by reference to the utility class and is directly modified. By not
|
|
</span></span><span id="250" class="l"><a class="l" href="#250">250: </a><span class="php-comment"> * relying on PHP's native implementation, Slim allows middleware the opportunity to massage or
|
|
</span></span><span id="251" class="l"><a class="l" href="#251">251: </a><span class="php-comment"> * analyze the raw header before the response is ultimately delivered to the HTTP client.
|
|
</span></span><span id="252" class="l"><a class="l" href="#252">252: </a><span class="php-comment"> *
|
|
</span></span><span id="253" class="l"><a class="l" href="#253">253: </a><span class="php-comment"> * @param string $name The name of the cookie
|
|
</span></span><span id="254" class="l"><a class="l" href="#254">254: </a><span class="php-comment"> * @param string|array $value If string, the value of cookie; if array, properties for
|
|
</span></span><span id="255" class="l"><a class="l" href="#255">255: </a><span class="php-comment"> * cookie including: value, expire, path, domain, secure, httponly
|
|
</span></span><span id="256" class="l"><a class="l" href="#256">256: </a><span class="php-comment"> */</span>
|
|
</span><span id="257" class="l"><a class="l" href="#257">257: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">setCookie</span>(<span class="php-var">$name</span>, <span class="php-var">$value</span>)
|
|
</span><span id="258" class="l"><a class="l" href="#258">258: </a> {
|
|
</span><span id="259" class="l"><a class="l" href="#259">259: </a> Util::setCookieHeader(<span class="php-var">$this</span>-><span class="php-keyword2">header</span>, <span class="php-var">$name</span>, <span class="php-var">$value</span>);
|
|
</span><span id="260" class="l"><a class="l" href="#260">260: </a> }
|
|
</span><span id="261" class="l"><a class="l" href="#261">261: </a>
|
|
</span><span id="262" class="l"><a class="l" href="#262">262: </a> <span class="php-comment">/**
|
|
</span></span><span id="263" class="l"><a class="l" href="#263">263: </a><span class="php-comment"> * Delete cookie
|
|
</span></span><span id="264" class="l"><a class="l" href="#264">264: </a><span class="php-comment"> *
|
|
</span></span><span id="265" class="l"><a class="l" href="#265">265: </a><span class="php-comment"> * Instead of using PHP's `setcookie()` function, Slim manually constructs the HTTP `Set-Cookie`
|
|
</span></span><span id="266" class="l"><a class="l" href="#266">266: </a><span class="php-comment"> * header on its own and delegates this responsibility to the `Slim_Http_Util` class. This
|
|
</span></span><span id="267" class="l"><a class="l" href="#267">267: </a><span class="php-comment"> * response's header is passed by reference to the utility class and is directly modified. By not
|
|
</span></span><span id="268" class="l"><a class="l" href="#268">268: </a><span class="php-comment"> * relying on PHP's native implementation, Slim allows middleware the opportunity to massage or
|
|
</span></span><span id="269" class="l"><a class="l" href="#269">269: </a><span class="php-comment"> * analyze the raw header before the response is ultimately delivered to the HTTP client.
|
|
</span></span><span id="270" class="l"><a class="l" href="#270">270: </a><span class="php-comment"> *
|
|
</span></span><span id="271" class="l"><a class="l" href="#271">271: </a><span class="php-comment"> * This method will set a cookie with the given name that has an expiration time in the past; this will
|
|
</span></span><span id="272" class="l"><a class="l" href="#272">272: </a><span class="php-comment"> * prompt the HTTP client to invalidate and remove the client-side cookie. Optionally, you may
|
|
</span></span><span id="273" class="l"><a class="l" href="#273">273: </a><span class="php-comment"> * also pass a key/value array as the second argument. If the "domain" key is present in this
|
|
</span></span><span id="274" class="l"><a class="l" href="#274">274: </a><span class="php-comment"> * array, only the Cookie with the given name AND domain will be removed. The invalidating cookie
|
|
</span></span><span id="275" class="l"><a class="l" href="#275">275: </a><span class="php-comment"> * sent with this response will adopt all properties of the second argument.
|
|
</span></span><span id="276" class="l"><a class="l" href="#276">276: </a><span class="php-comment"> *
|
|
</span></span><span id="277" class="l"><a class="l" href="#277">277: </a><span class="php-comment"> * @param string $name The name of the cookie
|
|
</span></span><span id="278" class="l"><a class="l" href="#278">278: </a><span class="php-comment"> * @param array $value Properties for cookie including: value, expire, path, domain, secure, httponly
|
|
</span></span><span id="279" class="l"><a class="l" href="#279">279: </a><span class="php-comment"> */</span>
|
|
</span><span id="280" class="l"><a class="l" href="#280">280: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_deleteCookie" href="#_deleteCookie">deleteCookie</a>(<span class="php-var">$name</span>, <span class="php-var">$value</span> = <span class="php-keyword1">array</span>())
|
|
</span><span id="281" class="l"><a class="l" href="#281">281: </a> {
|
|
</span><span id="282" class="l"><a class="l" href="#282">282: </a> Util::deleteCookieHeader(<span class="php-var">$this</span>-><span class="php-keyword2">header</span>, <span class="php-var">$name</span>, <span class="php-var">$value</span>);
|
|
</span><span id="283" class="l"><a class="l" href="#283">283: </a> }
|
|
</span><span id="284" class="l"><a class="l" href="#284">284: </a>
|
|
</span><span id="285" class="l"><a class="l" href="#285">285: </a> <span class="php-comment">/**
|
|
</span></span><span id="286" class="l"><a class="l" href="#286">286: </a><span class="php-comment"> * Redirect
|
|
</span></span><span id="287" class="l"><a class="l" href="#287">287: </a><span class="php-comment"> *
|
|
</span></span><span id="288" class="l"><a class="l" href="#288">288: </a><span class="php-comment"> * This method prepares this response to return an HTTP Redirect response
|
|
</span></span><span id="289" class="l"><a class="l" href="#289">289: </a><span class="php-comment"> * to the HTTP client.
|
|
</span></span><span id="290" class="l"><a class="l" href="#290">290: </a><span class="php-comment"> *
|
|
</span></span><span id="291" class="l"><a class="l" href="#291">291: </a><span class="php-comment"> * @param string $url The redirect destination
|
|
</span></span><span id="292" class="l"><a class="l" href="#292">292: </a><span class="php-comment"> * @param int $status The redirect HTTP status code
|
|
</span></span><span id="293" class="l"><a class="l" href="#293">293: </a><span class="php-comment"> */</span>
|
|
</span><span id="294" class="l"><a class="l" href="#294">294: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_redirect" href="#_redirect">redirect</a> (<span class="php-var">$url</span>, <span class="php-var">$status</span> = <span class="php-num">302</span>)
|
|
</span><span id="295" class="l"><a class="l" href="#295">295: </a> {
|
|
</span><span id="296" class="l"><a class="l" href="#296">296: </a> <span class="php-var">$this</span>->status = <span class="php-var">$status</span>;
|
|
</span><span id="297" class="l"><a class="l" href="#297">297: </a> <span class="php-var">$this</span>[<span class="php-quote">'Location'</span>] = <span class="php-var">$url</span>;
|
|
</span><span id="298" class="l"><a class="l" href="#298">298: </a> }
|
|
</span><span id="299" class="l"><a class="l" href="#299">299: </a>
|
|
</span><span id="300" class="l"><a class="l" href="#300">300: </a> <span class="php-comment">/**
|
|
</span></span><span id="301" class="l"><a class="l" href="#301">301: </a><span class="php-comment"> * Helpers: Empty?
|
|
</span></span><span id="302" class="l"><a class="l" href="#302">302: </a><span class="php-comment"> * @return bool
|
|
</span></span><span id="303" class="l"><a class="l" href="#303">303: </a><span class="php-comment"> */</span>
|
|
</span><span id="304" class="l"><a class="l" href="#304">304: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isEmpty" href="#_isEmpty">isEmpty</a>()
|
|
</span><span id="305" class="l"><a class="l" href="#305">305: </a> {
|
|
</span><span id="306" class="l"><a class="l" href="#306">306: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">in_array</span>(<span class="php-var">$this</span>->status, <span class="php-keyword1">array</span>(<span class="php-num">201</span>, <span class="php-num">204</span>, <span class="php-num">304</span>));
|
|
</span><span id="307" class="l"><a class="l" href="#307">307: </a> }
|
|
</span><span id="308" class="l"><a class="l" href="#308">308: </a>
|
|
</span><span id="309" class="l"><a class="l" href="#309">309: </a> <span class="php-comment">/**
|
|
</span></span><span id="310" class="l"><a class="l" href="#310">310: </a><span class="php-comment"> * Helpers: Informational?
|
|
</span></span><span id="311" class="l"><a class="l" href="#311">311: </a><span class="php-comment"> * @return bool
|
|
</span></span><span id="312" class="l"><a class="l" href="#312">312: </a><span class="php-comment"> */</span>
|
|
</span><span id="313" class="l"><a class="l" href="#313">313: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isInformational" href="#_isInformational">isInformational</a>()
|
|
</span><span id="314" class="l"><a class="l" href="#314">314: </a> {
|
|
</span><span id="315" class="l"><a class="l" href="#315">315: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->status >= <span class="php-num">100</span> && <span class="php-var">$this</span>->status < <span class="php-num">200</span>;
|
|
</span><span id="316" class="l"><a class="l" href="#316">316: </a> }
|
|
</span><span id="317" class="l"><a class="l" href="#317">317: </a>
|
|
</span><span id="318" class="l"><a class="l" href="#318">318: </a> <span class="php-comment">/**
|
|
</span></span><span id="319" class="l"><a class="l" href="#319">319: </a><span class="php-comment"> * Helpers: OK?
|
|
</span></span><span id="320" class="l"><a class="l" href="#320">320: </a><span class="php-comment"> * @return bool
|
|
</span></span><span id="321" class="l"><a class="l" href="#321">321: </a><span class="php-comment"> */</span>
|
|
</span><span id="322" class="l"><a class="l" href="#322">322: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isOk" href="#_isOk">isOk</a>()
|
|
</span><span id="323" class="l"><a class="l" href="#323">323: </a> {
|
|
</span><span id="324" class="l"><a class="l" href="#324">324: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->status === <span class="php-num">200</span>;
|
|
</span><span id="325" class="l"><a class="l" href="#325">325: </a> }
|
|
</span><span id="326" class="l"><a class="l" href="#326">326: </a>
|
|
</span><span id="327" class="l"><a class="l" href="#327">327: </a> <span class="php-comment">/**
|
|
</span></span><span id="328" class="l"><a class="l" href="#328">328: </a><span class="php-comment"> * Helpers: Successful?
|
|
</span></span><span id="329" class="l"><a class="l" href="#329">329: </a><span class="php-comment"> * @return bool
|
|
</span></span><span id="330" class="l"><a class="l" href="#330">330: </a><span class="php-comment"> */</span>
|
|
</span><span id="331" class="l"><a class="l" href="#331">331: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isSuccessful" href="#_isSuccessful">isSuccessful</a>()
|
|
</span><span id="332" class="l"><a class="l" href="#332">332: </a> {
|
|
</span><span id="333" class="l"><a class="l" href="#333">333: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->status >= <span class="php-num">200</span> && <span class="php-var">$this</span>->status < <span class="php-num">300</span>;
|
|
</span><span id="334" class="l"><a class="l" href="#334">334: </a> }
|
|
</span><span id="335" class="l"><a class="l" href="#335">335: </a>
|
|
</span><span id="336" class="l"><a class="l" href="#336">336: </a> <span class="php-comment">/**
|
|
</span></span><span id="337" class="l"><a class="l" href="#337">337: </a><span class="php-comment"> * Helpers: Redirect?
|
|
</span></span><span id="338" class="l"><a class="l" href="#338">338: </a><span class="php-comment"> * @return bool
|
|
</span></span><span id="339" class="l"><a class="l" href="#339">339: </a><span class="php-comment"> */</span>
|
|
</span><span id="340" class="l"><a class="l" href="#340">340: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isRedirect" href="#_isRedirect">isRedirect</a>()
|
|
</span><span id="341" class="l"><a class="l" href="#341">341: </a> {
|
|
</span><span id="342" class="l"><a class="l" href="#342">342: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">in_array</span>(<span class="php-var">$this</span>->status, <span class="php-keyword1">array</span>(<span class="php-num">301</span>, <span class="php-num">302</span>, <span class="php-num">303</span>, <span class="php-num">307</span>));
|
|
</span><span id="343" class="l"><a class="l" href="#343">343: </a> }
|
|
</span><span id="344" class="l"><a class="l" href="#344">344: </a>
|
|
</span><span id="345" class="l"><a class="l" href="#345">345: </a> <span class="php-comment">/**
|
|
</span></span><span id="346" class="l"><a class="l" href="#346">346: </a><span class="php-comment"> * Helpers: Redirection?
|
|
</span></span><span id="347" class="l"><a class="l" href="#347">347: </a><span class="php-comment"> * @return bool
|
|
</span></span><span id="348" class="l"><a class="l" href="#348">348: </a><span class="php-comment"> */</span>
|
|
</span><span id="349" class="l"><a class="l" href="#349">349: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isRedirection" href="#_isRedirection">isRedirection</a>()
|
|
</span><span id="350" class="l"><a class="l" href="#350">350: </a> {
|
|
</span><span id="351" class="l"><a class="l" href="#351">351: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->status >= <span class="php-num">300</span> && <span class="php-var">$this</span>->status < <span class="php-num">400</span>;
|
|
</span><span id="352" class="l"><a class="l" href="#352">352: </a> }
|
|
</span><span id="353" class="l"><a class="l" href="#353">353: </a>
|
|
</span><span id="354" class="l"><a class="l" href="#354">354: </a> <span class="php-comment">/**
|
|
</span></span><span id="355" class="l"><a class="l" href="#355">355: </a><span class="php-comment"> * Helpers: Forbidden?
|
|
</span></span><span id="356" class="l"><a class="l" href="#356">356: </a><span class="php-comment"> * @return bool
|
|
</span></span><span id="357" class="l"><a class="l" href="#357">357: </a><span class="php-comment"> */</span>
|
|
</span><span id="358" class="l"><a class="l" href="#358">358: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isForbidden" href="#_isForbidden">isForbidden</a>()
|
|
</span><span id="359" class="l"><a class="l" href="#359">359: </a> {
|
|
</span><span id="360" class="l"><a class="l" href="#360">360: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->status === <span class="php-num">403</span>;
|
|
</span><span id="361" class="l"><a class="l" href="#361">361: </a> }
|
|
</span><span id="362" class="l"><a class="l" href="#362">362: </a>
|
|
</span><span id="363" class="l"><a class="l" href="#363">363: </a> <span class="php-comment">/**
|
|
</span></span><span id="364" class="l"><a class="l" href="#364">364: </a><span class="php-comment"> * Helpers: Not Found?
|
|
</span></span><span id="365" class="l"><a class="l" href="#365">365: </a><span class="php-comment"> * @return bool
|
|
</span></span><span id="366" class="l"><a class="l" href="#366">366: </a><span class="php-comment"> */</span>
|
|
</span><span id="367" class="l"><a class="l" href="#367">367: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isNotFound" href="#_isNotFound">isNotFound</a>()
|
|
</span><span id="368" class="l"><a class="l" href="#368">368: </a> {
|
|
</span><span id="369" class="l"><a class="l" href="#369">369: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->status === <span class="php-num">404</span>;
|
|
</span><span id="370" class="l"><a class="l" href="#370">370: </a> }
|
|
</span><span id="371" class="l"><a class="l" href="#371">371: </a>
|
|
</span><span id="372" class="l"><a class="l" href="#372">372: </a> <span class="php-comment">/**
|
|
</span></span><span id="373" class="l"><a class="l" href="#373">373: </a><span class="php-comment"> * Helpers: Client error?
|
|
</span></span><span id="374" class="l"><a class="l" href="#374">374: </a><span class="php-comment"> * @return bool
|
|
</span></span><span id="375" class="l"><a class="l" href="#375">375: </a><span class="php-comment"> */</span>
|
|
</span><span id="376" class="l"><a class="l" href="#376">376: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isClientError" href="#_isClientError">isClientError</a>()
|
|
</span><span id="377" class="l"><a class="l" href="#377">377: </a> {
|
|
</span><span id="378" class="l"><a class="l" href="#378">378: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->status >= <span class="php-num">400</span> && <span class="php-var">$this</span>->status < <span class="php-num">500</span>;
|
|
</span><span id="379" class="l"><a class="l" href="#379">379: </a> }
|
|
</span><span id="380" class="l"><a class="l" href="#380">380: </a>
|
|
</span><span id="381" class="l"><a class="l" href="#381">381: </a> <span class="php-comment">/**
|
|
</span></span><span id="382" class="l"><a class="l" href="#382">382: </a><span class="php-comment"> * Helpers: Server Error?
|
|
</span></span><span id="383" class="l"><a class="l" href="#383">383: </a><span class="php-comment"> * @return bool
|
|
</span></span><span id="384" class="l"><a class="l" href="#384">384: </a><span class="php-comment"> */</span>
|
|
</span><span id="385" class="l"><a class="l" href="#385">385: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isServerError" href="#_isServerError">isServerError</a>()
|
|
</span><span id="386" class="l"><a class="l" href="#386">386: </a> {
|
|
</span><span id="387" class="l"><a class="l" href="#387">387: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->status >= <span class="php-num">500</span> && <span class="php-var">$this</span>->status < <span class="php-num">600</span>;
|
|
</span><span id="388" class="l"><a class="l" href="#388">388: </a> }
|
|
</span><span id="389" class="l"><a class="l" href="#389">389: </a>
|
|
</span><span id="390" class="l"><a class="l" href="#390">390: </a> <span class="php-comment">/**
|
|
</span></span><span id="391" class="l"><a class="l" href="#391">391: </a><span class="php-comment"> * Array Access: Offset Exists
|
|
</span></span><span id="392" class="l"><a class="l" href="#392">392: </a><span class="php-comment"> */</span>
|
|
</span><span id="393" class="l"><a class="l" href="#393">393: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_offsetExists" href="#_offsetExists">offsetExists</a>( <span class="php-var">$offset</span> )
|
|
</span><span id="394" class="l"><a class="l" href="#394">394: </a> {
|
|
</span><span id="395" class="l"><a class="l" href="#395">395: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">isset</span>(<span class="php-var">$this</span>-><span class="php-keyword2">header</span>[<span class="php-var">$offset</span>]);
|
|
</span><span id="396" class="l"><a class="l" href="#396">396: </a> }
|
|
</span><span id="397" class="l"><a class="l" href="#397">397: </a>
|
|
</span><span id="398" class="l"><a class="l" href="#398">398: </a> <span class="php-comment">/**
|
|
</span></span><span id="399" class="l"><a class="l" href="#399">399: </a><span class="php-comment"> * Array Access: Offset Get
|
|
</span></span><span id="400" class="l"><a class="l" href="#400">400: </a><span class="php-comment"> */</span>
|
|
</span><span id="401" class="l"><a class="l" href="#401">401: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_offsetGet" href="#_offsetGet">offsetGet</a>( <span class="php-var">$offset</span> )
|
|
</span><span id="402" class="l"><a class="l" href="#402">402: </a> {
|
|
</span><span id="403" class="l"><a class="l" href="#403">403: </a> <span class="php-keyword1">if</span> (<span class="php-keyword1">isset</span>(<span class="php-var">$this</span>-><span class="php-keyword2">header</span>[<span class="php-var">$offset</span>])) {
|
|
</span><span id="404" class="l"><a class="l" href="#404">404: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-><span class="php-keyword2">header</span>[<span class="php-var">$offset</span>];
|
|
</span><span id="405" class="l"><a class="l" href="#405">405: </a> } <span class="php-keyword1">else</span> {
|
|
</span><span id="406" class="l"><a class="l" href="#406">406: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">null</span>;
|
|
</span><span id="407" class="l"><a class="l" href="#407">407: </a> }
|
|
</span><span id="408" class="l"><a class="l" href="#408">408: </a> }
|
|
</span><span id="409" class="l"><a class="l" href="#409">409: </a>
|
|
</span><span id="410" class="l"><a class="l" href="#410">410: </a> <span class="php-comment">/**
|
|
</span></span><span id="411" class="l"><a class="l" href="#411">411: </a><span class="php-comment"> * Array Access: Offset Set
|
|
</span></span><span id="412" class="l"><a class="l" href="#412">412: </a><span class="php-comment"> */</span>
|
|
</span><span id="413" class="l"><a class="l" href="#413">413: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_offsetSet" href="#_offsetSet">offsetSet</a>(<span class="php-var">$offset</span>, <span class="php-var">$value</span>)
|
|
</span><span id="414" class="l"><a class="l" href="#414">414: </a> {
|
|
</span><span id="415" class="l"><a class="l" href="#415">415: </a> <span class="php-var">$this</span>-><span class="php-keyword2">header</span>[<span class="php-var">$offset</span>] = <span class="php-var">$value</span>;
|
|
</span><span id="416" class="l"><a class="l" href="#416">416: </a> }
|
|
</span><span id="417" class="l"><a class="l" href="#417">417: </a>
|
|
</span><span id="418" class="l"><a class="l" href="#418">418: </a> <span class="php-comment">/**
|
|
</span></span><span id="419" class="l"><a class="l" href="#419">419: </a><span class="php-comment"> * Array Access: Offset Unset
|
|
</span></span><span id="420" class="l"><a class="l" href="#420">420: </a><span class="php-comment"> */</span>
|
|
</span><span id="421" class="l"><a class="l" href="#421">421: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_offsetUnset" href="#_offsetUnset">offsetUnset</a>(<span class="php-var">$offset</span>)
|
|
</span><span id="422" class="l"><a class="l" href="#422">422: </a> {
|
|
</span><span id="423" class="l"><a class="l" href="#423">423: </a> <span class="php-keyword1">unset</span>(<span class="php-var">$this</span>-><span class="php-keyword2">header</span>[<span class="php-var">$offset</span>]);
|
|
</span><span id="424" class="l"><a class="l" href="#424">424: </a> }
|
|
</span><span id="425" class="l"><a class="l" href="#425">425: </a>
|
|
</span><span id="426" class="l"><a class="l" href="#426">426: </a> <span class="php-comment">/**
|
|
</span></span><span id="427" class="l"><a class="l" href="#427">427: </a><span class="php-comment"> * Countable: Count
|
|
</span></span><span id="428" class="l"><a class="l" href="#428">428: </a><span class="php-comment"> */</span>
|
|
</span><span id="429" class="l"><a class="l" href="#429">429: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">count</span>()
|
|
</span><span id="430" class="l"><a class="l" href="#430">430: </a> {
|
|
</span><span id="431" class="l"><a class="l" href="#431">431: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">count</span>(<span class="php-var">$this</span>-><span class="php-keyword2">header</span>);
|
|
</span><span id="432" class="l"><a class="l" href="#432">432: </a> }
|
|
</span><span id="433" class="l"><a class="l" href="#433">433: </a>
|
|
</span><span id="434" class="l"><a class="l" href="#434">434: </a> <span class="php-comment">/**
|
|
</span></span><span id="435" class="l"><a class="l" href="#435">435: </a><span class="php-comment"> * Get Iterator
|
|
</span></span><span id="436" class="l"><a class="l" href="#436">436: </a><span class="php-comment"> *
|
|
</span></span><span id="437" class="l"><a class="l" href="#437">437: </a><span class="php-comment"> * This returns the contained `\Slim\Http\Headers` instance which
|
|
</span></span><span id="438" class="l"><a class="l" href="#438">438: </a><span class="php-comment"> * is itself iterable.
|
|
</span></span><span id="439" class="l"><a class="l" href="#439">439: </a><span class="php-comment"> *
|
|
</span></span><span id="440" class="l"><a class="l" href="#440">440: </a><span class="php-comment"> * @return \Slim\Http\Headers
|
|
</span></span><span id="441" class="l"><a class="l" href="#441">441: </a><span class="php-comment"> */</span>
|
|
</span><span id="442" class="l"><a class="l" href="#442">442: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getIterator" href="#_getIterator">getIterator</a>()
|
|
</span><span id="443" class="l"><a class="l" href="#443">443: </a> {
|
|
</span><span id="444" class="l"><a class="l" href="#444">444: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-><span class="php-keyword2">header</span>;
|
|
</span><span id="445" class="l"><a class="l" href="#445">445: </a> }
|
|
</span><span id="446" class="l"><a class="l" href="#446">446: </a>
|
|
</span><span id="447" class="l"><a class="l" href="#447">447: </a> <span class="php-comment">/**
|
|
</span></span><span id="448" class="l"><a class="l" href="#448">448: </a><span class="php-comment"> * Get message for HTTP status code
|
|
</span></span><span id="449" class="l"><a class="l" href="#449">449: </a><span class="php-comment"> * @return string|null
|
|
</span></span><span id="450" class="l"><a class="l" href="#450">450: </a><span class="php-comment"> */</span>
|
|
</span><span id="451" class="l"><a class="l" href="#451">451: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getMessageForCode" href="#_getMessageForCode">getMessageForCode</a>(<span class="php-var">$status</span>)
|
|
</span><span id="452" class="l"><a class="l" href="#452">452: </a> {
|
|
</span><span id="453" class="l"><a class="l" href="#453">453: </a> <span class="php-keyword1">if</span> (<span class="php-keyword1">isset</span>(self::<span class="php-var">$messages</span>[<span class="php-var">$status</span>])) {
|
|
</span><span id="454" class="l"><a class="l" href="#454">454: </a> <span class="php-keyword1">return</span> self::<span class="php-var">$messages</span>[<span class="php-var">$status</span>];
|
|
</span><span id="455" class="l"><a class="l" href="#455">455: </a> } <span class="php-keyword1">else</span> {
|
|
</span><span id="456" class="l"><a class="l" href="#456">456: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">null</span>;
|
|
</span><span id="457" class="l"><a class="l" href="#457">457: </a> }
|
|
</span><span id="458" class="l"><a class="l" href="#458">458: </a> }
|
|
</span><span id="459" class="l"><a class="l" href="#459">459: </a>}
|
|
</span><span id="460" class="l"><a class="l" href="#460">460: </a></span></code></pre>
|
|
|
|
<div id="footer">
|
|
GeoApi API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|