<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Add cookies</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.httprequest.html">HttpRequest</a></div>
<div class="next" style="text-align: right; float: right;"><a href="httprequest.addheaders.html">HttpRequest::addHeaders</a></div>
<div class="up"><a href="class.httprequest.html">HttpRequest</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="httprequest.addcookies" class="refentry">
<div class="refnamediv">
<h1 class="refname">HttpRequest::addCookies</h1>
<p class="verinfo">(PECL pecl_http >= 0.10.0)</p><p class="refpurpose"><span class="refname">HttpRequest::addCookies</span> — <span class="dc-title">Add cookies</span></p>
</div>
<div class="refsect1 description" id="refsect1-httprequest.addcookies-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">bool</span> <span class="methodname"><strong>HttpRequest::addCookies</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$cookies</code></span>
)</div>
<p class="para rdfs-comment">
Add custom cookies.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">The <a href="http.request.options.html" class="link">request option</a> <em>encodecookies</em> controls
whether the cookie values should be <span class="function"><a href="function.urlencode.html" class="function">urlencode()</a></span>d.</span></p></blockquote>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">Affects any request method.</span></p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-httprequest.addcookies-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">cookies</code></em></span>
<dd>
<p class="para">
an associative array containing any cookie name/value pairs to add
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-httprequest.addcookies-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-httprequest.addcookies-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4351">
<p><strong>Example #1 A <span class="function"><strong>HttpRequest::addCookies()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$r </span><span style="color: #007700">= new </span><span style="color: #0000BB">HttpRequest</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">addCookies</span><span style="color: #007700">(<br /> array(<br /> </span><span style="color: #DD0000">"cookie_name" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"cookie value"</span><span style="color: #007700">,<br /> )<br />);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-httprequest.addcookies-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="httprequest.setcookies.html" class="function" rel="rdfs-seeAlso">HttpRequest::setCookies()</a> - Set cookies</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.httprequest.html">HttpRequest</a></div>
<div class="next" style="text-align: right; float: right;"><a href="httprequest.addheaders.html">HttpRequest::addHeaders</a></div>
<div class="up"><a href="class.httprequest.html">HttpRequest</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
