docs/source-class-Psr.Http.Message.ResponseInterface.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="robots" content="noindex">
<title>File ResponseInterface.php | ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK</title>
<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
</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-Baguette.html">
Baguette<span></span>
</a>
<ul>
<li>
<a href="namespace-Baguette.Mastodon.html">
Mastodon<span></span>
</a>
<ul>
<li class="main">
<a href="namespace-Baguette.Mastodon.Config.html">
Config </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Entity.html">
Entity </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Grant.html">
Grant </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Service.html">
Service </a>
</li>
</ul></li></ul></li>
<li>
<a href="namespace-GuzzleHttp.html">
GuzzleHttp<span></span>
</a>
<ul>
<li>
<a href="namespace-GuzzleHttp.Cookie.html">
Cookie </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Exception.html">
Exception </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Handler.html">
Handler </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Promise.html">
Promise </a>
</li>
</ul></li>
<li>
<a href="namespace-Psr.html">
Psr<span></span>
</a>
<ul>
<li>
<a href="namespace-Psr.Http.html">
Http<span></span>
</a>
<ul>
<li>
<a href="namespace-Psr.Http.Message.html">
Message </a>
</li>
</ul></li></ul></li>
<li>
<a href="namespace-Teto.html">
Teto<span></span>
</a>
<ul>
<li>
<a href="namespace-Teto.Object.html">
Object </a>
</li>
</ul></li>
</ul>
</div>
<hr>
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Baguette.Mastodon.Client.html">Baguette\Mastodon\Client</a></li>
<li><a href="class-Baguette.Mastodon.Config.DotEnvStorage.html">Baguette\Mastodon\Config\DotEnvStorage</a></li>
<li><a href="class-Baguette.Mastodon.Entity.Account.html">Baguette\Mastodon\Entity\Account</a></li>
<li><a href="class-Baguette.Mastodon.Entity.Application.html">Baguette\Mastodon\Entity\Application</a></li>
<li><a href="class-Baguette.Mastodon.Entity.Attachment.html">Baguette\Mastodon\Entity\Attachment</a></li>
<li><a href="class-Baguette.Mastodon.Entity.Card.html">Baguette\Mastodon\Entity\Card</a></li>
<li><a href="class-Baguette.Mastodon.Entity.Context.html">Baguette\Mastodon\Entity\Context</a></li>
<li><a href="class-Baguette.Mastodon.Entity.Entity.html">Baguette\Mastodon\Entity\Entity</a></li>
<li><a href="class-Baguette.Mastodon.Entity.Error_.html">Baguette\Mastodon\Entity\Error_</a></li>
<li><a href="class-Baguette.Mastodon.Entity.Instance.html">Baguette\Mastodon\Entity\Instance</a></li>
<li><a href="class-Baguette.Mastodon.Entity.Mention.html">Baguette\Mastodon\Entity\Mention</a></li>
<li><a href="class-Baguette.Mastodon.Entity.Notification.html">Baguette\Mastodon\Entity\Notification</a></li>
<li><a href="class-Baguette.Mastodon.Entity.Status.html">Baguette\Mastodon\Entity\Status</a></li>
<li><a href="class-Baguette.Mastodon.Entity.Tag.html">Baguette\Mastodon\Entity\Tag</a></li>
<li><a href="class-Baguette.Mastodon.EntityCaster.html">Baguette\Mastodon\EntityCaster</a></li>
<li><a href="class-Baguette.Mastodon.Grant.CodeGrant.html">Baguette\Mastodon\Grant\CodeGrant</a></li>
<li><a href="class-Baguette.Mastodon.Grant.Grant.html">Baguette\Mastodon\Grant\Grant</a></li>
<li><a href="class-Baguette.Mastodon.Grant.NoopGrant.html">Baguette\Mastodon\Grant\NoopGrant</a></li>
<li><a href="class-Baguette.Mastodon.Grant.PasswordCredential.html">Baguette\Mastodon\Grant\PasswordCredential</a></li>
<li><a href="class-Baguette.Mastodon.Mastodon.html">Baguette\Mastodon\Mastodon</a></li>
<li><a href="class-Baguette.Mastodon.Requester.html">Baguette\Mastodon\Requester</a></li>
<li><a href="class-Baguette.Mastodon.Service.AuthFactory.html">Baguette\Mastodon\Service\AuthFactory</a></li>
<li><a href="class-Baguette.Mastodon.Service.Authorization.html">Baguette\Mastodon\Service\Authorization</a></li>
<li><a href="class-Baguette.Mastodon.Service.Scope.html">Baguette\Mastodon\Service\Scope</a></li>
<li><a href="class-Baguette.Mastodon.Service.SessionStorage.html">Baguette\Mastodon\Service\SessionStorage</a></li>
<li><a href="class-Baguette.Mastodon.Service.Toot.html">Baguette\Mastodon\Service\Toot</a></li>
</ul>
<h3>Interfaces</h3>
<ul>
<li><a href="class-Baguette.Mastodon.Config.Storage.html">Baguette\Mastodon\Config\Storage</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Baguette.Mastodon.Service.AuthorizationException.html">Baguette\Mastodon\Service\AuthorizationException</a></li>
</ul>
<h3>Constants</h3>
<ul>
<li><a href="constant-Baguette.Mastodon.Entity.DATETIME_FORMAT.html">Baguette\Mastodon\Entity\DATETIME_FORMAT</a></li>
</ul>
<h3>Functions</h3>
<ul>
<li><a href="function-Baguette.Mastodon.authorization.html">Baguette\Mastodon\authorization</a></li>
<li><a href="function-Baguette.Mastodon.credential.html" class="deprecated">Baguette\Mastodon\credential</a></li>
<li><a href="function-Baguette.Mastodon.Entity.map.html">Baguette\Mastodon\Entity\map</a></li>
<li><a href="function-Baguette.Mastodon.Entity.mapValues.html">Baguette\Mastodon\Entity\mapValues</a></li>
<li><a href="function-Baguette.Mastodon.Entity.toArrayValue.html">Baguette\Mastodon\Entity\toArrayValue</a></li>
<li><a href="function-Baguette.Mastodon.grant.html">Baguette\Mastodon\grant</a></li>
<li><a href="function-Baguette.Mastodon.http.html">Baguette\Mastodon\http</a></li>
<li><a href="function-Baguette.Mastodon.request.html">Baguette\Mastodon\request</a></li>
<li><a href="function-Baguette.Mastodon.scope.html">Baguette\Mastodon\scope</a></li>
<li><a href="function-Baguette.Mastodon.session.html">Baguette\Mastodon\session</a></li>
<li><a href="function-Baguette.Mastodon.toot.html">Baguette\Mastodon\toot</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" placeholder="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<span>Namespace</span> </li>
<li>
<span>Class</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>
<pre class="numbers"><code><span class="l"><a href="#1"> 1: </a></span><span class="l"><a href="#2"> 2: </a></span><span class="l"><a href="#3"> 3: </a></span><span class="l"><a href="#4"> 4: </a></span><span class="l"><a href="#5"> 5: </a></span></span><span class="l"><a href="#6"> 6: </a></span></span><span class="l"><a href="#7"> 7: </a></span></span><span class="l"><a href="#8"> 8: </a></span></span><span class="l"><a href="#9"> 9: </a></span></span><span class="l"><a href="#10">10: </a></span></span><span class="l"><a href="#11">11: </a></span></span><span class="l"><a href="#12">12: </a></span></span><span class="l"><a href="#13">13: </a></span></span><span class="l"><a href="#14">14: </a></span></span><span class="l"><a href="#15">15: </a></span></span><span class="l"><a href="#16">16: </a></span></span><span class="l"><a href="#17">17: </a></span></span><span class="l"><a href="#18">18: </a></span></span><span class="l"><a href="#19">19: </a></span><span class="l"><a href="#20">20: </a></span><span class="l"><a href="#21">21: </a></span><span class="l"><a href="#22">22: </a></span></span><span class="l"><a href="#23">23: </a></span></span><span class="l"><a href="#24">24: </a></span></span><span class="l"><a href="#25">25: </a></span></span><span class="l"><a href="#26">26: </a></span></span><span class="l"><a href="#27">27: </a></span></span><span class="l"><a href="#28">28: </a></span></span><span class="l"><a href="#29">29: </a></span><span class="l"><a href="#30">30: </a></span><span class="l"><a href="#31">31: </a></span><span class="l"><a href="#32">32: </a></span></span><span class="l"><a href="#33">33: </a></span></span><span class="l"><a href="#34">34: </a></span></span><span class="l"><a href="#35">35: </a></span></span><span class="l"><a href="#36">36: </a></span></span><span class="l"><a href="#37">37: </a></span></span><span class="l"><a href="#38">38: </a></span></span><span class="l"><a href="#39">39: </a></span></span><span class="l"><a href="#40">40: </a></span></span><span class="l"><a href="#41">41: </a></span></span><span class="l"><a href="#42">42: </a></span></span><span class="l"><a href="#43">43: </a></span></span><span class="l"><a href="#44">44: </a></span></span><span class="l"><a href="#45">45: </a></span></span><span class="l"><a href="#46">46: </a></span></span><span class="l"><a href="#47">47: </a></span></span><span class="l"><a href="#48">48: </a></span></span><span class="l"><a href="#49">49: </a></span></span><span class="l"><a href="#50">50: </a></span></span><span class="l"><a href="#51">51: </a></span><span class="l"><a href="#52">52: </a></span><span class="l"><a href="#53">53: </a></span><span class="l"><a href="#54">54: </a></span></span><span class="l"><a href="#55">55: </a></span></span><span class="l"><a href="#56">56: </a></span></span><span class="l"><a href="#57">57: </a></span></span><span class="l"><a href="#58">58: </a></span></span><span class="l"><a href="#59">59: </a></span></span><span class="l"><a href="#60">60: </a></span></span><span class="l"><a href="#61">61: </a></span></span><span class="l"><a href="#62">62: </a></span></span><span class="l"><a href="#63">63: </a></span></span><span class="l"><a href="#64">64: </a></span></span><span class="l"><a href="#65">65: </a></span></span><span class="l"><a href="#66">66: </a></span><span class="l"><a href="#67">67: </a></span><span class="l"><a href="#68">68: </a></span><span class="l"><a href="#69">69: </a></span></code></pre>
<pre class="code"><code><span id="1" class="l"><span class="xlang"><?php</span>
</span><span id="2" class="l">
</span><span id="3" class="l"><span class="php-keyword1">namespace</span> Psr\Http\Message;
</span><span id="4" class="l">
</span><span id="5" class="l"><span class="php-comment">/**
</span></span><span id="6" class="l"><span class="php-comment"> * Representation of an outgoing, server-side response.
</span></span><span id="7" class="l"><span class="php-comment"> *
</span></span><span id="8" class="l"><span class="php-comment"> * Per the HTTP specification, this interface includes properties for
</span></span><span id="9" class="l"><span class="php-comment"> * each of the following:
</span></span><span id="10" class="l"><span class="php-comment"> *
</span></span><span id="11" class="l"><span class="php-comment"> * - Protocol version
</span></span><span id="12" class="l"><span class="php-comment"> * - Status code and reason phrase
</span></span><span id="13" class="l"><span class="php-comment"> * - Headers
</span></span><span id="14" class="l"><span class="php-comment"> * - Message body
</span></span><span id="15" class="l"><span class="php-comment"> *
</span></span><span id="16" class="l"><span class="php-comment"> * Responses are considered immutable; all methods that might change state MUST
</span></span><span id="17" class="l"><span class="php-comment"> * be implemented such that they retain the internal state of the current
</span></span><span id="18" class="l"><span class="php-comment"> * message and return an instance that contains the changed state.
</span></span><span id="19" class="l"><span class="php-comment"> */</span>
</span><span id="20" class="l"><span class="php-keyword1">interface</span> ResponseInterface <span class="php-keyword1">extends</span> MessageInterface
</span><span id="21" class="l">{
</span><span id="22" class="l"> <span class="php-comment">/**
</span></span><span id="23" class="l"><span class="php-comment"> * Gets the response status code.
</span></span><span id="24" class="l"><span class="php-comment"> *
</span></span><span id="25" class="l"><span class="php-comment"> * The status code is a 3-digit integer result code of the server's attempt
</span></span><span id="26" class="l"><span class="php-comment"> * to understand and satisfy the request.
</span></span><span id="27" class="l"><span class="php-comment"> *
</span></span><span id="28" class="l"><span class="php-comment"> * @return int Status code.
</span></span><span id="29" class="l"><span class="php-comment"> */</span>
</span><span id="30" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getStatusCode();
</span><span id="31" class="l">
</span><span id="32" class="l"> <span class="php-comment">/**
</span></span><span id="33" class="l"><span class="php-comment"> * Return an instance with the specified status code and, optionally, reason phrase.
</span></span><span id="34" class="l"><span class="php-comment"> *
</span></span><span id="35" class="l"><span class="php-comment"> * If no reason phrase is specified, implementations MAY choose to default
</span></span><span id="36" class="l"><span class="php-comment"> * to the RFC 7231 or IANA recommended reason phrase for the response's
</span></span><span id="37" class="l"><span class="php-comment"> * status code.
</span></span><span id="38" class="l"><span class="php-comment"> *
</span></span><span id="39" class="l"><span class="php-comment"> * This method MUST be implemented in such a way as to retain the
</span></span><span id="40" class="l"><span class="php-comment"> * immutability of the message, and MUST return an instance that has the
</span></span><span id="41" class="l"><span class="php-comment"> * updated status and reason phrase.
</span></span><span id="42" class="l"><span class="php-comment"> *
</span></span><span id="43" class="l"><span class="php-comment"> * @link http://tools.ietf.org/html/rfc7231#section-6
</span></span><span id="44" class="l"><span class="php-comment"> * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
</span></span><span id="45" class="l"><span class="php-comment"> * @param int $code The 3-digit integer result code to set.
</span></span><span id="46" class="l"><span class="php-comment"> * @param string $reasonPhrase The reason phrase to use with the
</span></span><span id="47" class="l"><span class="php-comment"> * provided status code; if none is provided, implementations MAY
</span></span><span id="48" class="l"><span class="php-comment"> * use the defaults as suggested in the HTTP specification.
</span></span><span id="49" class="l"><span class="php-comment"> * @return static
</span></span><span id="50" class="l"><span class="php-comment"> * @throws \InvalidArgumentException For invalid status code arguments.
</span></span><span id="51" class="l"><span class="php-comment"> */</span>
</span><span id="52" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> withStatus(<span class="php-var">$code</span>, <span class="php-var">$reasonPhrase</span> = <span class="php-quote">''</span>);
</span><span id="53" class="l">
</span><span id="54" class="l"> <span class="php-comment">/**
</span></span><span id="55" class="l"><span class="php-comment"> * Gets the response reason phrase associated with the status code.
</span></span><span id="56" class="l"><span class="php-comment"> *
</span></span><span id="57" class="l"><span class="php-comment"> * Because a reason phrase is not a required element in a response
</span></span><span id="58" class="l"><span class="php-comment"> * status line, the reason phrase value MAY be null. Implementations MAY
</span></span><span id="59" class="l"><span class="php-comment"> * choose to return the default RFC 7231 recommended reason phrase (or those
</span></span><span id="60" class="l"><span class="php-comment"> * listed in the IANA HTTP Status Code Registry) for the response's
</span></span><span id="61" class="l"><span class="php-comment"> * status code.
</span></span><span id="62" class="l"><span class="php-comment"> *
</span></span><span id="63" class="l"><span class="php-comment"> * @link http://tools.ietf.org/html/rfc7231#section-6
</span></span><span id="64" class="l"><span class="php-comment"> * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
</span></span><span id="65" class="l"><span class="php-comment"> * @return string Reason phrase; must return an empty string if none present.
</span></span><span id="66" class="l"><span class="php-comment"> */</span>
</span><span id="67" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getReasonPhrase();
</span><span id="68" class="l">}
</span><span id="69" class="l"></span></code></pre>
<div id="footer">
ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
</div>
<script src="resources/combined.js?a0a1caea7753954992695e0e57bff2e63fa15823"></script>
<script src="elementlist.js?bfca39af442ee2772f4953470c68e31ee57b2cd9"></script>
</body>
</html>