docs/source-class-GuzzleHttp.Cookie.CookieJarInterface.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="robots" content="noindex">
<title>File Cookie/CookieJarInterface.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><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 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><span class="l"><a href="#20">20: </a></span></span><span class="l"><a href="#21">21: </a></span></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 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><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 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 class="l"><a href="#41">41: </a></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 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><span class="l"><a href="#52">52: </a></span></span><span class="l"><a href="#53">53: </a></span></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></span><span class="l"><a href="#70">70: </a></span></span><span class="l"><a href="#71">71: </a></span></span><span class="l"><a href="#72">72: </a></span></span><span class="l"><a href="#73">73: </a></span></span><span class="l"><a href="#74">74: </a></span></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><span class="l"><a href="#79">79: </a></span></span><span class="l"><a href="#80">80: </a></span></span><span class="l"><a href="#81">81: </a></span></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></code></pre>
<pre class="code"><code><span id="1" class="l"><span class="xlang"><?php</span>
</span><span id="2" class="l"><span class="php-keyword1">namespace</span> GuzzleHttp\Cookie;
</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><span id="7" class="l"><span class="php-comment">/**
</span></span><span id="8" class="l"><span class="php-comment"> * Stores HTTP cookies.
</span></span><span id="9" class="l"><span class="php-comment"> *
</span></span><span id="10" class="l"><span class="php-comment"> * It extracts cookies from HTTP requests, and returns them in HTTP responses.
</span></span><span id="11" class="l"><span class="php-comment"> * CookieJarInterface instances automatically expire contained cookies when
</span></span><span id="12" class="l"><span class="php-comment"> * necessary. Subclasses are also responsible for storing and retrieving
</span></span><span id="13" class="l"><span class="php-comment"> * cookies from a file, database, etc.
</span></span><span id="14" class="l"><span class="php-comment"> *
</span></span><span id="15" class="l"><span class="php-comment"> * @link http://docs.python.org/2/library/cookielib.html Inspiration
</span></span><span id="16" class="l"><span class="php-comment"> */</span>
</span><span id="17" class="l"><span class="php-keyword1">interface</span> CookieJarInterface <span class="php-keyword1">extends</span> \Countable, \IteratorAggregate
</span><span id="18" class="l">{
</span><span id="19" class="l"> <span class="php-comment">/**
</span></span><span id="20" class="l"><span class="php-comment"> * Create a request with added cookie headers.
</span></span><span id="21" class="l"><span class="php-comment"> *
</span></span><span id="22" class="l"><span class="php-comment"> * If no matching cookies are found in the cookie jar, then no Cookie
</span></span><span id="23" class="l"><span class="php-comment"> * header is added to the request and the same request is returned.
</span></span><span id="24" class="l"><span class="php-comment"> *
</span></span><span id="25" class="l"><span class="php-comment"> * @param RequestInterface $request Request object to modify.
</span></span><span id="26" class="l"><span class="php-comment"> *
</span></span><span id="27" class="l"><span class="php-comment"> * @return RequestInterface returns the modified request.
</span></span><span id="28" class="l"><span class="php-comment"> */</span>
</span><span id="29" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> withCookieHeader(RequestInterface <span class="php-var">$request</span>);
</span><span id="30" class="l">
</span><span id="31" class="l"> <span class="php-comment">/**
</span></span><span id="32" class="l"><span class="php-comment"> * Extract cookies from an HTTP response and store them in the CookieJar.
</span></span><span id="33" class="l"><span class="php-comment"> *
</span></span><span id="34" class="l"><span class="php-comment"> * @param RequestInterface $request Request that was sent
</span></span><span id="35" class="l"><span class="php-comment"> * @param ResponseInterface $response Response that was received
</span></span><span id="36" class="l"><span class="php-comment"> */</span>
</span><span id="37" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> extractCookies(
</span><span id="38" class="l"> RequestInterface <span class="php-var">$request</span>,
</span><span id="39" class="l"> ResponseInterface <span class="php-var">$response</span>
</span><span id="40" class="l"> );
</span><span id="41" class="l">
</span><span id="42" class="l"> <span class="php-comment">/**
</span></span><span id="43" class="l"><span class="php-comment"> * Sets a cookie in the cookie jar.
</span></span><span id="44" class="l"><span class="php-comment"> *
</span></span><span id="45" class="l"><span class="php-comment"> * @param SetCookie $cookie Cookie to set.
</span></span><span id="46" class="l"><span class="php-comment"> *
</span></span><span id="47" class="l"><span class="php-comment"> * @return bool Returns true on success or false on failure
</span></span><span id="48" class="l"><span class="php-comment"> */</span>
</span><span id="49" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">setCookie</span>(<span class="php-keyword2">SetCookie</span> <span class="php-var">$cookie</span>);
</span><span id="50" class="l">
</span><span id="51" class="l"> <span class="php-comment">/**
</span></span><span id="52" class="l"><span class="php-comment"> * Remove cookies currently held in the cookie jar.
</span></span><span id="53" class="l"><span class="php-comment"> *
</span></span><span id="54" class="l"><span class="php-comment"> * Invoking this method without arguments will empty the whole cookie jar.
</span></span><span id="55" class="l"><span class="php-comment"> * If given a $domain argument only cookies belonging to that domain will
</span></span><span id="56" class="l"><span class="php-comment"> * be removed. If given a $domain and $path argument, cookies belonging to
</span></span><span id="57" class="l"><span class="php-comment"> * the specified path within that domain are removed. If given all three
</span></span><span id="58" class="l"><span class="php-comment"> * arguments, then the cookie with the specified name, path and domain is
</span></span><span id="59" class="l"><span class="php-comment"> * removed.
</span></span><span id="60" class="l"><span class="php-comment"> *
</span></span><span id="61" class="l"><span class="php-comment"> * @param string $domain Clears cookies matching a domain
</span></span><span id="62" class="l"><span class="php-comment"> * @param string $path Clears cookies matching a domain and path
</span></span><span id="63" class="l"><span class="php-comment"> * @param string $name Clears cookies matching a domain, path, and name
</span></span><span id="64" class="l"><span class="php-comment"> *
</span></span><span id="65" class="l"><span class="php-comment"> * @return CookieJarInterface
</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> clear(<span class="php-var">$domain</span> = <span class="php-keyword1">null</span>, <span class="php-var">$path</span> = <span class="php-keyword1">null</span>, <span class="php-var">$name</span> = <span class="php-keyword1">null</span>);
</span><span id="68" class="l">
</span><span id="69" class="l"> <span class="php-comment">/**
</span></span><span id="70" class="l"><span class="php-comment"> * Discard all sessions cookies.
</span></span><span id="71" class="l"><span class="php-comment"> *
</span></span><span id="72" class="l"><span class="php-comment"> * Removes cookies that don't have an expire field or a have a discard
</span></span><span id="73" class="l"><span class="php-comment"> * field set to true. To be called when the user agent shuts down according
</span></span><span id="74" class="l"><span class="php-comment"> * to RFC 2965.
</span></span><span id="75" class="l"><span class="php-comment"> */</span>
</span><span id="76" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> clearSessionCookies();
</span><span id="77" class="l">
</span><span id="78" class="l"> <span class="php-comment">/**
</span></span><span id="79" class="l"><span class="php-comment"> * Converts the cookie jar to an array.
</span></span><span id="80" class="l"><span class="php-comment"> *
</span></span><span id="81" class="l"><span class="php-comment"> * @return array
</span></span><span id="82" class="l"><span class="php-comment"> */</span>
</span><span id="83" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> toArray();
</span><span id="84" class="l">}
</span><span id="85" 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>