<!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>Parse HTTP cookie</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ob-inflatehandler.html">ob_inflatehandler</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.http-parse-headers.html">http_parse_headers</a></div>
<div class="up"><a href="ref.http.html">HTTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.http-parse-cookie" class="refentry">
<div class="refnamediv">
<h1 class="refname">http_parse_cookie</h1>
<p class="verinfo">(PECL pecl_http >= 0.20.0)</p><p class="refpurpose"><span class="refname">http_parse_cookie</span> — <span class="dc-title">Parse HTTP cookie</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.http-parse-cookie-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>http_parse_cookie</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$cookie</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$allowed_extras</code></span>
]] )</div>
<p class="para rdfs-comment">
Parses HTTP cookies like sent in a response into a struct.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.http-parse-cookie-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">cookie</code></em></span>
<dd>
<p class="para">
string containing the value of a <em>Set-Cookie</em> response header
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
parse flags (<a href="http.constants.html#http.constants.cookie" class="link"><strong><code>HTTP_COOKIE_PARSE_RAW</code></strong></a>)
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">allowed_extras</code></em></span>
<dd>
<p class="para">
array containing recognized <em class="emphasis">extra</em> keys;
by default all unknown keys will be treated as cookie names
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.http-parse-cookie-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a stdClass object on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.http-parse-cookie-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4365">
<p><strong>Example #1 Using <span class="function"><strong>http_parse_cookie()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">http_parse_cookie</span><span style="color: #007700">(</span><span style="color: #DD0000">"foo=bar; bar=baz; path=/; domain=example.com; comment=; secure"</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"comment"</span><span style="color: #007700">)));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
stdClass Object
(
[cookies] => Array
(
[foo] => bar
[bar] => baz
)
[extras] => Array
(
[comment] =>
)
[flags] => 16
[expires] => 0
[path] => /
[domain] => example.com
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.http-parse-cookie-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.http-parse-headers.html" class="function" rel="rdfs-seeAlso">http_parse_headers()</a> - Parse HTTP headers</span></li>
<li class="member"> <span class="function"><a href="function.http-parse-message.html" class="function" rel="rdfs-seeAlso">http_parse_message()</a> - Parse HTTP messages</span></li>
<li class="member"> <span class="function"><a href="function.http-build-cookie.html" class="function" rel="rdfs-seeAlso">http_build_cookie()</a> - Build cookie string</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="function.ob-inflatehandler.html">ob_inflatehandler</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.http-parse-headers.html">http_parse_headers</a></div>
<div class="up"><a href="ref.http.html">HTTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
