BaguettePHP/mastodon-api

View on GitHub
docs/source-class-GuzzleHttp.Exception.RequestException.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <meta name="robots" content="noindex">

    <title>File Exception/RequestException.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 class="l"><a href="#6">  6: </a></span><span class="l"><a href="#7">  7: </a></span><span class="l"><a href="#8">  8: </a></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 class="l"><a href="#12"> 12: </a></span><span class="l"><a href="#13"> 13: </a></span><span class="l"><a href="#14"> 14: </a></span><span class="l"><a href="#15"> 15: </a></span><span class="l"><a href="#16"> 16: </a></span><span class="l"><a href="#17"> 17: </a></span><span class="l"><a href="#18"> 18: </a></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 class="l"><a href="#23"> 23: </a></span><span class="l"><a href="#24"> 24: </a></span><span class="l"><a href="#25"> 25: </a></span><span class="l"><a href="#26"> 26: </a></span><span class="l"><a href="#27"> 27: </a></span><span class="l"><a href="#28"> 28: </a></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 class="l"><a href="#33"> 33: </a></span><span class="l"><a href="#34"> 34: </a></span><span class="l"><a href="#35"> 35: </a></span><span class="l"><a href="#36"> 36: </a></span><span class="l"><a href="#37"> 37: </a></span><span class="l"><a href="#38"> 38: </a></span><span class="l"><a href="#39"> 39: </a></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 class="l"><a href="#48"> 48: </a></span><span class="l"><a href="#49"> 49: </a></span><span class="l"><a href="#50"> 50: </a></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 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 class="l"><a href="#65"> 65: </a></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><span class="l"><a href="#70"> 70: </a></span><span class="l"><a href="#71"> 71: </a></span><span class="l"><a href="#72"> 72: </a></span><span class="l"><a href="#73"> 73: </a></span><span class="l"><a href="#74"> 74: </a></span><span class="l"><a href="#75"> 75: </a></span><span class="l"><a href="#76"> 76: </a></span><span class="l"><a href="#77"> 77: </a></span><span class="l"><a href="#78"> 78: </a></span><span class="l"><a href="#79"> 79: </a></span><span class="l"><a href="#80"> 80: </a></span><span class="l"><a href="#81"> 81: </a></span><span class="l"><a href="#82"> 82: </a></span><span class="l"><a href="#83"> 83: </a></span><span class="l"><a href="#84"> 84: </a></span><span class="l"><a href="#85"> 85: </a></span><span class="l"><a href="#86"> 86: </a></span><span class="l"><a href="#87"> 87: </a></span><span class="l"><a href="#88"> 88: </a></span><span class="l"><a href="#89"> 89: </a></span><span class="l"><a href="#90"> 90: </a></span><span class="l"><a href="#91"> 91: </a></span><span class="l"><a href="#92"> 92: </a></span><span class="l"><a href="#93"> 93: </a></span><span class="l"><a href="#94"> 94: </a></span><span class="l"><a href="#95"> 95: </a></span><span class="l"><a href="#96"> 96: </a></span><span class="l"><a href="#97"> 97: </a></span><span class="l"><a href="#98"> 98: </a></span><span class="l"><a href="#99"> 99: </a></span><span class="l"><a href="#100">100: </a></span><span class="l"><a href="#101">101: </a></span><span class="l"><a href="#102">102: </a></span><span class="l"><a href="#103">103: </a></span><span class="l"><a href="#104">104: </a></span><span class="l"><a href="#105">105: </a></span><span class="l"><a href="#106">106: </a></span><span class="l"><a href="#107">107: </a></span><span class="l"><a href="#108">108: </a></span><span class="l"><a href="#109">109: </a></span><span class="l"><a href="#110">110: </a></span><span class="l"><a href="#111">111: </a></span><span class="l"><a href="#112">112: </a></span><span class="l"><a href="#113">113: </a></span><span class="l"><a href="#114">114: </a></span></span><span class="l"><a href="#115">115: </a></span></span><span class="l"><a href="#116">116: </a></span></span><span class="l"><a href="#117">117: </a></span></span><span class="l"><a href="#118">118: </a></span></span><span class="l"><a href="#119">119: </a></span></span><span class="l"><a href="#120">120: </a></span></span><span class="l"><a href="#121">121: </a></span></span><span class="l"><a href="#122">122: </a></span><span class="l"><a href="#123">123: </a></span><span class="l"><a href="#124">124: </a></span><span class="l"><a href="#125">125: </a></span><span class="l"><a href="#126">126: </a></span><span class="l"><a href="#127">127: </a></span><span class="l"><a href="#128">128: </a></span><span class="l"><a href="#129">129: </a></span><span class="l"><a href="#130">130: </a></span><span class="l"><a href="#131">131: </a></span><span class="l"><a href="#132">132: </a></span><span class="l"><a href="#133">133: </a></span><span class="l"><a href="#134">134: </a></span><span class="l"><a href="#135">135: </a></span><span class="l"><a href="#136">136: </a></span><span class="l"><a href="#137">137: </a></span><span class="l"><a href="#138">138: </a></span><span class="l"><a href="#139">139: </a></span><span class="l"><a href="#140">140: </a></span><span class="l"><a href="#141">141: </a></span><span class="l"><a href="#142">142: </a></span><span class="l"><a href="#143">143: </a></span><span class="l"><a href="#144">144: </a></span><span class="l"><a href="#145">145: </a></span><span class="l"><a href="#146">146: </a></span><span class="l"><a href="#147">147: </a></span><span class="l"><a href="#148">148: </a></span></span><span class="l"><a href="#149">149: </a></span></span><span class="l"><a href="#150">150: </a></span></span><span class="l"><a href="#151">151: </a></span></span><span class="l"><a href="#152">152: </a></span></span><span class="l"><a href="#153">153: </a></span></span><span class="l"><a href="#154">154: </a></span><span class="l"><a href="#155">155: </a></span><span class="l"><a href="#156">156: </a></span><span class="l"><a href="#157">157: </a></span><span class="l"><a href="#158">158: </a></span><span class="l"><a href="#159">159: </a></span><span class="l"><a href="#160">160: </a></span><span class="l"><a href="#161">161: </a></span><span class="l"><a href="#162">162: </a></span><span class="l"><a href="#163">163: </a></span><span class="l"><a href="#164">164: </a></span><span class="l"><a href="#165">165: </a></span><span class="l"><a href="#166">166: </a></span></span><span class="l"><a href="#167">167: </a></span></span><span class="l"><a href="#168">168: </a></span></span><span class="l"><a href="#169">169: </a></span></span><span class="l"><a href="#170">170: </a></span><span class="l"><a href="#171">171: </a></span><span class="l"><a href="#172">172: </a></span><span class="l"><a href="#173">173: </a></span><span class="l"><a href="#174">174: </a></span><span class="l"><a href="#175">175: </a></span><span class="l"><a href="#176">176: </a></span></span><span class="l"><a href="#177">177: </a></span></span><span class="l"><a href="#178">178: </a></span></span><span class="l"><a href="#179">179: </a></span></span><span class="l"><a href="#180">180: </a></span><span class="l"><a href="#181">181: </a></span><span class="l"><a href="#182">182: </a></span><span class="l"><a href="#183">183: </a></span><span class="l"><a href="#184">184: </a></span><span class="l"><a href="#185">185: </a></span><span class="l"><a href="#186">186: </a></span></span><span class="l"><a href="#187">187: </a></span></span><span class="l"><a href="#188">188: </a></span></span><span class="l"><a href="#189">189: </a></span></span><span class="l"><a href="#190">190: </a></span><span class="l"><a href="#191">191: </a></span><span class="l"><a href="#192">192: </a></span><span class="l"><a href="#193">193: </a></span><span class="l"><a href="#194">194: </a></span><span class="l"><a href="#195">195: </a></span><span class="l"><a href="#196">196: </a></span></span><span class="l"><a href="#197">197: </a></span></span><span class="l"><a href="#198">198: </a></span></span><span class="l"><a href="#199">199: </a></span></span><span class="l"><a href="#200">200: </a></span></span><span class="l"><a href="#201">201: </a></span></span><span class="l"><a href="#202">202: </a></span></span><span class="l"><a href="#203">203: </a></span></span><span class="l"><a href="#204">204: </a></span></span><span class="l"><a href="#205">205: </a></span><span class="l"><a href="#206">206: </a></span><span class="l"><a href="#207">207: </a></span><span class="l"><a href="#208">208: </a></span><span class="l"><a href="#209">209: </a></span><span class="l"><a href="#210">210: </a></span><span class="l"><a href="#211">211: </a></span></code></pre>
<pre class="code"><code><span id="1" class="l"><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><span class="php-keyword1">namespace</span> GuzzleHttp\Exception;
</span><span id="3" class="l">
</span><span id="4" class="l"><span class="php-keyword1">use</span> Psr\Http\Message\RequestInterface;
</span><span id="5" class="l"><span class="php-keyword1">use</span> Psr\Http\Message\ResponseInterface;
</span><span id="6" class="l"><span class="php-keyword1">use</span> GuzzleHttp\Promise\PromiseInterface;
</span><span id="7" class="l"><span class="php-keyword1">use</span> Psr\Http\Message\UriInterface;
</span><span id="8" class="l">
</span><span id="9" class="l"><span class="php-comment">/**
</span></span><span id="10" class="l"><span class="php-comment"> * HTTP Request exception
</span></span><span id="11" class="l"><span class="php-comment"> */</span>
</span><span id="12" class="l"><span class="php-keyword1">class</span> RequestException <span class="php-keyword1">extends</span> TransferException
</span><span id="13" class="l">{
</span><span id="14" class="l">    <span class="php-comment">/** @var RequestInterface */</span>
</span><span id="15" class="l">    <span class="php-keyword1">private</span> <span class="php-var">$request</span>;
</span><span id="16" class="l">
</span><span id="17" class="l">    <span class="php-comment">/** @var ResponseInterface */</span>
</span><span id="18" class="l">    <span class="php-keyword1">private</span> <span class="php-var">$response</span>;
</span><span id="19" class="l">
</span><span id="20" class="l">    <span class="php-comment">/** @var array */</span>
</span><span id="21" class="l">    <span class="php-keyword1">private</span> <span class="php-var">$handlerContext</span>;
</span><span id="22" class="l">
</span><span id="23" class="l">    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> __construct(
</span><span id="24" class="l">        <span class="php-var">$message</span>,
</span><span id="25" class="l">        RequestInterface <span class="php-var">$request</span>,
</span><span id="26" class="l">        ResponseInterface <span class="php-var">$response</span> = <span class="php-keyword1">null</span>,
</span><span id="27" class="l">        \Exception <span class="php-var">$previous</span> = <span class="php-keyword1">null</span>,
</span><span id="28" class="l">        <span class="php-keyword1">array</span> <span class="php-var">$handlerContext</span> = []
</span><span id="29" class="l">    ) {
</span><span id="30" class="l">        <span class="php-comment">// Set the code of the exception if the response is set and not future.</span>
</span><span id="31" class="l">        <span class="php-var">$code</span> = <span class="php-var">$response</span> &amp;&amp; !(<span class="php-var">$response</span> <span class="php-keyword1">instanceof</span> PromiseInterface)
</span><span id="32" class="l">            ? <span class="php-var">$response</span>-&gt;getStatusCode()
</span><span id="33" class="l">            : <span class="php-num">0</span>;
</span><span id="34" class="l">        parent::__construct(<span class="php-var">$message</span>, <span class="php-var">$code</span>, <span class="php-var">$previous</span>);
</span><span id="35" class="l">        <span class="php-var">$this</span>-&gt;request = <span class="php-var">$request</span>;
</span><span id="36" class="l">        <span class="php-var">$this</span>-&gt;response = <span class="php-var">$response</span>;
</span><span id="37" class="l">        <span class="php-var">$this</span>-&gt;handlerContext = <span class="php-var">$handlerContext</span>;
</span><span id="38" class="l">    }
</span><span id="39" class="l">
</span><span id="40" class="l">    <span class="php-comment">/**
</span></span><span id="41" class="l"><span class="php-comment">     * Wrap non-RequestExceptions with a RequestException
</span></span><span id="42" class="l"><span class="php-comment">     *
</span></span><span id="43" class="l"><span class="php-comment">     * @param RequestInterface $request
</span></span><span id="44" class="l"><span class="php-comment">     * @param \Exception       $e
</span></span><span id="45" class="l"><span class="php-comment">     *
</span></span><span id="46" class="l"><span class="php-comment">     * @return RequestException
</span></span><span id="47" class="l"><span class="php-comment">     */</span>
</span><span id="48" class="l">    <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> wrapException(RequestInterface <span class="php-var">$request</span>, \Exception <span class="php-var">$e</span>)
</span><span id="49" class="l">    {
</span><span id="50" class="l">        <span class="php-keyword1">return</span> <span class="php-var">$e</span> <span class="php-keyword1">instanceof</span> RequestException
</span><span id="51" class="l">            ? <span class="php-var">$e</span>
</span><span id="52" class="l">            : <span class="php-keyword1">new</span> RequestException(<span class="php-var">$e</span>-&gt;getMessage(), <span class="php-var">$request</span>, <span class="php-keyword1">null</span>, <span class="php-var">$e</span>);
</span><span id="53" class="l">    }
</span><span id="54" class="l">
</span><span id="55" class="l">    <span class="php-comment">/**
</span></span><span id="56" class="l"><span class="php-comment">     * Factory method to create a new exception with a normalized error message
</span></span><span id="57" class="l"><span class="php-comment">     *
</span></span><span id="58" class="l"><span class="php-comment">     * @param RequestInterface  $request  Request
</span></span><span id="59" class="l"><span class="php-comment">     * @param ResponseInterface $response Response received
</span></span><span id="60" class="l"><span class="php-comment">     * @param \Exception        $previous Previous exception
</span></span><span id="61" class="l"><span class="php-comment">     * @param array             $ctx      Optional handler context.
</span></span><span id="62" class="l"><span class="php-comment">     *
</span></span><span id="63" class="l"><span class="php-comment">     * @return self
</span></span><span id="64" class="l"><span class="php-comment">     */</span>
</span><span id="65" class="l">    <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> create(
</span><span id="66" class="l">        RequestInterface <span class="php-var">$request</span>,
</span><span id="67" class="l">        ResponseInterface <span class="php-var">$response</span> = <span class="php-keyword1">null</span>,
</span><span id="68" class="l">        \Exception <span class="php-var">$previous</span> = <span class="php-keyword1">null</span>,
</span><span id="69" class="l">        <span class="php-keyword1">array</span> <span class="php-var">$ctx</span> = []
</span><span id="70" class="l">    ) {
</span><span id="71" class="l">        <span class="php-keyword1">if</span> (!<span class="php-var">$response</span>) {
</span><span id="72" class="l">            <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> self(
</span><span id="73" class="l">                <span class="php-quote">'Error completing request'</span>,
</span><span id="74" class="l">                <span class="php-var">$request</span>,
</span><span id="75" class="l">                <span class="php-keyword1">null</span>,
</span><span id="76" class="l">                <span class="php-var">$previous</span>,
</span><span id="77" class="l">                <span class="php-var">$ctx</span>
</span><span id="78" class="l">            );
</span><span id="79" class="l">        }
</span><span id="80" class="l">
</span><span id="81" class="l">        <span class="php-var">$level</span> = (int) <span class="php-keyword2">floor</span>(<span class="php-var">$response</span>-&gt;getStatusCode() / <span class="php-num">100</span>);
</span><span id="82" class="l">        <span class="php-keyword1">if</span> (<span class="php-var">$level</span> === <span class="php-num">4</span>) {
</span><span id="83" class="l">            <span class="php-var">$label</span> = <span class="php-quote">'Client error'</span>;
</span><span id="84" class="l">            <span class="php-var">$className</span> = __NAMESPACE__ . <span class="php-quote">'\\ClientException'</span>;
</span><span id="85" class="l">        } <span class="php-keyword1">elseif</span> (<span class="php-var">$level</span> === <span class="php-num">5</span>) {
</span><span id="86" class="l">            <span class="php-var">$label</span> = <span class="php-quote">'Server error'</span>;
</span><span id="87" class="l">            <span class="php-var">$className</span> = __NAMESPACE__ . <span class="php-quote">'\\ServerException'</span>;
</span><span id="88" class="l">        } <span class="php-keyword1">else</span> {
</span><span id="89" class="l">            <span class="php-var">$label</span> = <span class="php-quote">'Unsuccessful request'</span>;
</span><span id="90" class="l">            <span class="php-var">$className</span> = __CLASS__;
</span><span id="91" class="l">        }
</span><span id="92" class="l">
</span><span id="93" class="l">        <span class="php-var">$uri</span> = <span class="php-var">$request</span>-&gt;getUri();
</span><span id="94" class="l">        <span class="php-var">$uri</span> = <span class="php-keyword1">static</span>::obfuscateUri(<span class="php-var">$uri</span>);
</span><span id="95" class="l">
</span><span id="96" class="l">        <span class="php-comment">// Server Error: `GET /` resulted in a `404 Not Found` response:</span>
</span><span id="97" class="l">        <span class="php-comment">// &lt;html&gt; ... (truncated)</span>
</span><span id="98" class="l">        <span class="php-var">$message</span> = <span class="php-keyword2">sprintf</span>(
</span><span id="99" class="l">            <span class="php-quote">'%s: `%s` resulted in a `%s` response'</span>,
</span><span id="100" class="l">            <span class="php-var">$label</span>,
</span><span id="101" class="l">            <span class="php-var">$request</span>-&gt;getMethod() . <span class="php-quote">' '</span> . <span class="php-var">$uri</span>,
</span><span id="102" class="l">            <span class="php-var">$response</span>-&gt;getStatusCode() . <span class="php-quote">' '</span> . <span class="php-var">$response</span>-&gt;getReasonPhrase()
</span><span id="103" class="l">        );
</span><span id="104" class="l">
</span><span id="105" class="l">        <span class="php-var">$summary</span> = <span class="php-keyword1">static</span>::getResponseBodySummary(<span class="php-var">$response</span>);
</span><span id="106" class="l">
</span><span id="107" class="l">        <span class="php-keyword1">if</span> (<span class="php-var">$summary</span> !== <span class="php-keyword1">null</span>) {
</span><span id="108" class="l">            <span class="php-var">$message</span> .= <span class="php-quote">&quot;:\n</span><span class="php-var">{$summary}</span><span class="php-quote">\n&quot;</span>;
</span><span id="109" class="l">        }
</span><span id="110" class="l">
</span><span id="111" class="l">        <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> <span class="php-var">$className</span>(<span class="php-var">$message</span>, <span class="php-var">$request</span>, <span class="php-var">$response</span>, <span class="php-var">$previous</span>, <span class="php-var">$ctx</span>);
</span><span id="112" class="l">    }
</span><span id="113" class="l">
</span><span id="114" class="l">    <span class="php-comment">/**
</span></span><span id="115" class="l"><span class="php-comment">     * Get a short summary of the response
</span></span><span id="116" class="l"><span class="php-comment">     *
</span></span><span id="117" class="l"><span class="php-comment">     * Will return `null` if the response is not printable.
</span></span><span id="118" class="l"><span class="php-comment">     *
</span></span><span id="119" class="l"><span class="php-comment">     * @param ResponseInterface $response
</span></span><span id="120" class="l"><span class="php-comment">     *
</span></span><span id="121" class="l"><span class="php-comment">     * @return string|null
</span></span><span id="122" class="l"><span class="php-comment">     */</span>
</span><span id="123" class="l">    <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> getResponseBodySummary(ResponseInterface <span class="php-var">$response</span>)
</span><span id="124" class="l">    {
</span><span id="125" class="l">        <span class="php-var">$body</span> = <span class="php-var">$response</span>-&gt;getBody();
</span><span id="126" class="l">
</span><span id="127" class="l">        <span class="php-keyword1">if</span> (!<span class="php-var">$body</span>-&gt;isSeekable()) {
</span><span id="128" class="l">            <span class="php-keyword1">return</span> <span class="php-keyword1">null</span>;
</span><span id="129" class="l">        }
</span><span id="130" class="l">
</span><span id="131" class="l">        <span class="php-var">$size</span> = <span class="php-var">$body</span>-&gt;getSize();
</span><span id="132" class="l">        <span class="php-var">$summary</span> = <span class="php-var">$body</span>-&gt;read(<span class="php-num">120</span>);
</span><span id="133" class="l">        <span class="php-var">$body</span>-&gt;<span class="php-keyword2">rewind</span>();
</span><span id="134" class="l">
</span><span id="135" class="l">        <span class="php-keyword1">if</span> (<span class="php-var">$size</span> &gt; <span class="php-num">120</span>) {
</span><span id="136" class="l">            <span class="php-var">$summary</span> .= <span class="php-quote">' (truncated...)'</span>;
</span><span id="137" class="l">        }
</span><span id="138" class="l">
</span><span id="139" class="l">        <span class="php-comment">// Matches any printable character, including unicode characters:</span>
</span><span id="140" class="l">        <span class="php-comment">// letters, marks, numbers, punctuation, spacing, and separators.</span>
</span><span id="141" class="l">        <span class="php-keyword1">if</span> (<span class="php-keyword2">preg_match</span>(<span class="php-quote">'/[^\pL\pM\pN\pP\pS\pZ\n\r\t]/'</span>, <span class="php-var">$summary</span>)) {
</span><span id="142" class="l">            <span class="php-keyword1">return</span> <span class="php-keyword1">null</span>;
</span><span id="143" class="l">        }
</span><span id="144" class="l">
</span><span id="145" class="l">        <span class="php-keyword1">return</span> <span class="php-var">$summary</span>;
</span><span id="146" class="l">    }
</span><span id="147" class="l">
</span><span id="148" class="l">    <span class="php-comment">/**
</span></span><span id="149" class="l"><span class="php-comment">     * Obfuscates URI if there is an username and a password present
</span></span><span id="150" class="l"><span class="php-comment">     *
</span></span><span id="151" class="l"><span class="php-comment">     * @param UriInterface $uri
</span></span><span id="152" class="l"><span class="php-comment">     *
</span></span><span id="153" class="l"><span class="php-comment">     * @return UriInterface
</span></span><span id="154" class="l"><span class="php-comment">     */</span>
</span><span id="155" class="l">    <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> obfuscateUri(<span class="php-var">$uri</span>)
</span><span id="156" class="l">    {
</span><span id="157" class="l">        <span class="php-var">$userInfo</span> = <span class="php-var">$uri</span>-&gt;getUserInfo();
</span><span id="158" class="l">
</span><span id="159" class="l">        <span class="php-keyword1">if</span> (<span class="php-keyword1">false</span> !== (<span class="php-var">$pos</span> = <span class="php-keyword2">strpos</span>(<span class="php-var">$userInfo</span>, <span class="php-quote">':'</span>))) {
</span><span id="160" class="l">            <span class="php-keyword1">return</span> <span class="php-var">$uri</span>-&gt;withUserInfo(<span class="php-keyword2">substr</span>(<span class="php-var">$userInfo</span>, <span class="php-num">0</span>, <span class="php-var">$pos</span>), <span class="php-quote">'***'</span>);
</span><span id="161" class="l">        }
</span><span id="162" class="l">
</span><span id="163" class="l">        <span class="php-keyword1">return</span> <span class="php-var">$uri</span>;
</span><span id="164" class="l">    }
</span><span id="165" class="l">
</span><span id="166" class="l">    <span class="php-comment">/**
</span></span><span id="167" class="l"><span class="php-comment">     * Get the request that caused the exception
</span></span><span id="168" class="l"><span class="php-comment">     *
</span></span><span id="169" class="l"><span class="php-comment">     * @return RequestInterface
</span></span><span id="170" class="l"><span class="php-comment">     */</span>
</span><span id="171" class="l">    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getRequest()
</span><span id="172" class="l">    {
</span><span id="173" class="l">        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;request;
</span><span id="174" class="l">    }
</span><span id="175" class="l">
</span><span id="176" class="l">    <span class="php-comment">/**
</span></span><span id="177" class="l"><span class="php-comment">     * Get the associated response
</span></span><span id="178" class="l"><span class="php-comment">     *
</span></span><span id="179" class="l"><span class="php-comment">     * @return ResponseInterface|null
</span></span><span id="180" class="l"><span class="php-comment">     */</span>
</span><span id="181" class="l">    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getResponse()
</span><span id="182" class="l">    {
</span><span id="183" class="l">        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;response;
</span><span id="184" class="l">    }
</span><span id="185" class="l">
</span><span id="186" class="l">    <span class="php-comment">/**
</span></span><span id="187" class="l"><span class="php-comment">     * Check if a response was received
</span></span><span id="188" class="l"><span class="php-comment">     *
</span></span><span id="189" class="l"><span class="php-comment">     * @return bool
</span></span><span id="190" class="l"><span class="php-comment">     */</span>
</span><span id="191" class="l">    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> hasResponse()
</span><span id="192" class="l">    {
</span><span id="193" class="l">        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;response !== <span class="php-keyword1">null</span>;
</span><span id="194" class="l">    }
</span><span id="195" class="l">
</span><span id="196" class="l">    <span class="php-comment">/**
</span></span><span id="197" class="l"><span class="php-comment">     * Get contextual information about the error from the underlying handler.
</span></span><span id="198" class="l"><span class="php-comment">     *
</span></span><span id="199" class="l"><span class="php-comment">     * The contents of this array will vary depending on which handler you are
</span></span><span id="200" class="l"><span class="php-comment">     * using. It may also be just an empty array. Relying on this data will
</span></span><span id="201" class="l"><span class="php-comment">     * couple you to a specific handler, but can give more debug information
</span></span><span id="202" class="l"><span class="php-comment">     * when needed.
</span></span><span id="203" class="l"><span class="php-comment">     *
</span></span><span id="204" class="l"><span class="php-comment">     * @return array
</span></span><span id="205" class="l"><span class="php-comment">     */</span>
</span><span id="206" class="l">    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getHandlerContext()
</span><span id="207" class="l">    {
</span><span id="208" class="l">        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;handlerContext;
</span><span id="209" class="l">    }
</span><span id="210" class="l">}
</span><span id="211" 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>