docs/class-GuzzleHttp.Cookie.CookieJarInterface.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Interface GuzzleHttp\Cookie\CookieJarInterface | ξ ^ω^)ξ 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 class="active">
<a href="namespace-GuzzleHttp.html">
GuzzleHttp<span></span>
</a>
<ul>
<li class="active">
<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-GuzzleHttp.Cookie.CookieJar.html">CookieJar</a></li>
<li><a href="class-GuzzleHttp.Cookie.FileCookieJar.html">FileCookieJar</a></li>
<li><a href="class-GuzzleHttp.Cookie.SessionCookieJar.html">SessionCookieJar</a></li>
<li><a href="class-GuzzleHttp.Cookie.SetCookie.html">SetCookie</a></li>
</ul>
<h3>Interfaces</h3>
<ul>
<li class="active"><a href="class-GuzzleHttp.Cookie.CookieJarInterface.html">CookieJarInterface</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>
<a href="namespace-GuzzleHttp.Cookie.html" title="Summary of GuzzleHttp\Cookie"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Interface CookieJarInterface</h1>
<div class="description">
<p>Stores HTTP cookies.</p>
<p>It extracts cookies from HTTP requests, and returns them in HTTP responses.
CookieJarInterface instances automatically expire contained cookies when
necessary. Subclasses are also responsible for storing and retrieving
cookies from a file, database, etc.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<b><span>GuzzleHttp\Cookie\CookieJarInterface</span></b>
implements
<span>Countable</span>,
<span>IteratorAggregate</span>
</dd>
</dl>
<div>
<h4>Direct known implementers</h4>
<a href="class-GuzzleHttp.Cookie.CookieJar.html">GuzzleHttp\Cookie\CookieJar</a>
</div>
<div>
<h4>Indirect known implementers</h4>
<a href="class-GuzzleHttp.Cookie.FileCookieJar.html">GuzzleHttp\Cookie\FileCookieJar</a>,
<a href="class-GuzzleHttp.Cookie.SessionCookieJar.html">GuzzleHttp\Cookie\SessionCookieJar</a>
</div>
<div class="info">
<b>Namespace:</b> <a href="namespace-GuzzleHttp.html">GuzzleHttp</a>\<a href="namespace-GuzzleHttp.Cookie.html">Cookie</a><br>
<b>Link:</b>
<a href="http://docs.python.org/2/library/cookielib.html">Inspiration</a><br>
<b>Located at</b> <a href="source-class-GuzzleHttp.Cookie.CookieJarInterface.html#7-84" title="Go to source code">Cookie/CookieJarInterface.php</a>
<br>
</div>
<table class="summary methods" id="methods">
<caption>Methods summary</caption>
<tr data-order="withCookieHeader" id="_withCookieHeader">
<td class="attributes"><code>
public
<code><a href="class-Psr.Http.Message.RequestInterface.html">Psr\Http\Message\RequestInterface</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_withCookieHeader">#</a>
<code><a href="source-class-GuzzleHttp.Cookie.CookieJarInterface.html#19-29" title="Go to source code">withCookieHeader</a>( <span><code><a href="class-Psr.Http.Message.RequestInterface.html">Psr\Http\Message\RequestInterface</a></code> <var>$request</var></span> )</code>
<div class="description short">
<p>Create a request with added cookie headers.</p>
</div>
<div class="description detailed hidden">
<p>Create a request with added cookie headers.</p>
<p>If no matching cookies are found in the cookie jar, then no Cookie
header is added to the request and the same request is returned.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$request</var></dt>
<dd>Request object to modify.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><a href="class-Psr.Http.Message.RequestInterface.html">Psr\Http\Message\RequestInterface</a></code><br>returns the modified request.
</div>
</div>
</div></td>
</tr>
<tr data-order="extractCookies" id="_extractCookies">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_extractCookies">#</a>
<code><a href="source-class-GuzzleHttp.Cookie.CookieJarInterface.html#31-40" title="Go to source code">extractCookies</a>( <span><code><a href="class-Psr.Http.Message.RequestInterface.html">Psr\Http\Message\RequestInterface</a></code> <var>$request</var></span>, <span><code><a href="class-Psr.Http.Message.ResponseInterface.html">Psr\Http\Message\ResponseInterface</a></code> <var>$response</var></span> )</code>
<div class="description short">
<p>Extract cookies from an HTTP response and store them in the CookieJar.</p>
</div>
<div class="description detailed hidden">
<p>Extract cookies from an HTTP response and store them in the CookieJar.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$request</var></dt>
<dd>Request that was sent</dd>
<dt><var>$response</var></dt>
<dd>Response that was received</dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="setCookie" id="_setCookie">
<td class="attributes"><code>
public
boolean
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setCookie">#</a>
<code><a href="source-class-GuzzleHttp.Cookie.CookieJarInterface.html#42-49" title="Go to source code">setCookie</a>( <span><code><a href="class-GuzzleHttp.Cookie.SetCookie.html">GuzzleHttp\Cookie\SetCookie</a></code> <var>$cookie</var></span> )</code>
<div class="description short">
<p>Sets a cookie in the cookie jar.</p>
</div>
<div class="description detailed hidden">
<p>Sets a cookie in the cookie jar.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$cookie</var></dt>
<dd>Cookie to set.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
boolean<br>Returns true on success or false on failure
</div>
</div>
</div></td>
</tr>
<tr data-order="clear" id="_clear">
<td class="attributes"><code>
public
<code><a href="class-GuzzleHttp.Cookie.CookieJarInterface.html">GuzzleHttp\Cookie\CookieJarInterface</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_clear">#</a>
<code><a href="source-class-GuzzleHttp.Cookie.CookieJarInterface.html#51-67" title="Go to source code">clear</a>( <span>string <var>$domain</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$path</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$name</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Remove cookies currently held in the cookie jar.</p>
</div>
<div class="description detailed hidden">
<p>Remove cookies currently held in the cookie jar.</p>
<p>Invoking this method without arguments will empty the whole cookie jar.
If given a $domain argument only cookies belonging to that domain will
be removed. If given a $domain and $path argument, cookies belonging to
the specified path within that domain are removed. If given all three
arguments, then the cookie with the specified name, path and domain is
removed.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$domain</var></dt>
<dd>Clears cookies matching a domain</dd>
<dt><var>$path</var></dt>
<dd>Clears cookies matching a domain and path</dd>
<dt><var>$name</var></dt>
<dd>Clears cookies matching a domain, path, and name</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><a href="class-GuzzleHttp.Cookie.CookieJarInterface.html">GuzzleHttp\Cookie\CookieJarInterface</a></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="clearSessionCookies" id="_clearSessionCookies">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_clearSessionCookies">#</a>
<code><a href="source-class-GuzzleHttp.Cookie.CookieJarInterface.html#69-76" title="Go to source code">clearSessionCookies</a>( )</code>
<div class="description short">
<p>Discard all sessions cookies.</p>
</div>
<div class="description detailed hidden">
<p>Discard all sessions cookies.</p>
<p>Removes cookies that don't have an expire field or a have a discard
field set to true. To be called when the user agent shuts down according
to RFC 2965.</p>
</div>
</div></td>
</tr>
<tr data-order="toArray" id="_toArray">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_toArray">#</a>
<code><a href="source-class-GuzzleHttp.Cookie.CookieJarInterface.html#78-83" title="Go to source code">toArray</a>( )</code>
<div class="description short">
<p>Converts the cookie jar to an array.</p>
</div>
<div class="description detailed hidden">
<p>Converts the cookie jar to an array.</p>
<h4>Returns</h4>
<div class="list">
array
</div>
</div>
</div></td>
</tr>
</table>
<table class="summary inherited">
<caption>Methods inherited from Countable</caption>
<tr>
<td><code>
count()
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Methods inherited from IteratorAggregate</caption>
<tr>
<td><code>
getIterator()
</code></td>
</tr>
</table>
</div>
<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"></script>
<script src="elementlist.js"></script>
</body>
</html>