phpdoc/Library/HttpFundamental/Cookie.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\HttpFundamental\Cookie | Library</title>
<link rel="stylesheet" type="text/css" href="../../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../../css/sami.css">
<script src="../../js/jquery-1.11.1.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script src="../../js/typeahead.min.js"></script>
<script src="../../sami.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="class" data-name="class:Library_HttpFundamental_Cookie" data-root-path="../../">
<div id="content">
<div id="left-column">
<div id="control-panel">
<form id="search-form" action="../../search.html" method="GET">
<span class="glyphicon glyphicon-search"></span>
<input name="search"
class="typeahead form-control"
type="search"
placeholder="Search">
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">Library</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../../classes.html">Classes</a></li>
<li><a href="../../namespaces.html">Namespaces</a></li>
<li><a href="../../interfaces.html">Interfaces</a></li>
<li><a href="../../traits.html">Traits</a></li>
<li><a href="../../doc-index.html">Index</a></li>
<li><a href="../../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">class</span></li>
<li><a href="../../Library.html">Library</a></li>
<li><a href="../../Library/HttpFundamental.html">HttpFundamental</a></li>
<li>Cookie</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Cookie</h1>
</div>
<p> class
<strong>Cookie</strong>
</p>
<h2>Constants</h2>
<table class="table table-condensed">
<tr>
<td>FLATNESS_ARRAY</td>
<td class="last">
<p><em>Transform array values as flatten string (<code>serialize</code> like)</em></p>
<p>
</p>
</td>
</tr>
<tr>
<td>INDEXED_COOKIES_ARRAY</td>
<td class="last">
<p><em>Transform array values as array cookies, named like <code>cookie_name[array_index]</code></em></p>
<p>
</p>
</td>
</tr>
</table>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method___construct">__construct</a>(
string $cookie_name = null,
string|array $cookie_value = null,
int $flag = self::FLATNESS_ARRAY)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setFlag">setFlag</a>(
int $flag)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
int
</div>
<div class="col-md-8 type">
<a href="#method_getFlag">getFlag</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setName">setName</a>(
string $name)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getName">getName</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setValue">setValue</a>(
string $value)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getValue">getValue</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getSafeValue">getSafeValue</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setExpire">setExpire</a>(
int $expire)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
int
</div>
<div class="col-md-8 type">
<a href="#method_getExpire">getExpire</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
int
</div>
<div class="col-md-8 type">
<a href="#method_getSafeExpire">getSafeExpire</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setPath">setPath</a>(
string $path)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getPath">getPath</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getSafePath">getSafePath</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setDomain">setDomain</a>(
string $domain)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getDomain">getDomain</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getSafeDomain">getSafeDomain</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setSecure">setSecure</a>(
string $secure)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_getSecure">getSecure</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_getSafeSecure">getSafeSecure</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setHttponly">setHttponly</a>(
string $https)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_getHttponly">getHttponly</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_getSafeHttponly">getSafeHttponly</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_sendAsRaw">sendAsRaw</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_sendAsEncoded">sendAsEncoded</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setCookieFuncArguments">setCookieFuncArguments</a>(
array $args)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_getCookieFuncArguments">getCookieFuncArguments</a>(
bool $organize = true)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
mixed
</div>
<div class="col-md-8 type">
<a href="#method_getCookieFuncArgument">getCookieFuncArgument</a>(
string $var)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_addCookieFuncArgument">addCookieFuncArgument</a>(
string $var,
mixed $val)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_clearCookieFuncArgument">clearCookieFuncArgument</a>(
string $var)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_exists">exists</a>(
string $cookie_name = null)
<p>Test if a cookie exists</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string|array
</div>
<div class="col-md-8 type">
<a href="#method_read">read</a>(
string $cookie_name = null)
<p>Get a cookie value</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_send">send</a>(
string $cookie_name = null,
string|array $cookie_value = null)
<p>Set a cookie value</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_addInCookie">addInCookie</a>(
string $variable_name,
string $variable_value,
string $cookie_name = null)
<p>Add a variable value in a cookie</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_clear">clear</a>(
string $cookie_name = null)
<p>Clear a cookie</p> </div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method___construct">
<div class="location">at line 105</div>
<code>
<strong>__construct</strong>(
string $cookie_name = null,
string|array $cookie_value = null,
int $flag = self::FLATNESS_ARRAY)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$cookie_name</td>
<td>
</td>
</tr>
<tr>
<td>
string|array</td>
<td>$cookie_value</td>
<td>
</td>
</tr>
<tr>
<td>
int</td>
<td>$flag</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setFlag">
<div class="location">at line 126</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>setFlag</strong>(
int $flag)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>$flag</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getFlag">
<div class="location">at line 135</div>
<code>
int
<strong>getFlag</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setName">
<div class="location">at line 144</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>setName</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getName">
<div class="location">at line 153</div>
<code>
string
<strong>getName</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setValue">
<div class="location">at line 162</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>setValue</strong>(
string $value)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$value</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getValue">
<div class="location">at line 171</div>
<code>
string
<strong>getValue</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getSafeValue">
<div class="location">at line 179</div>
<code>
string
<strong>getSafeValue</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setExpire">
<div class="location">at line 188</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>setExpire</strong>(
int $expire)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>$expire</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getExpire">
<div class="location">at line 197</div>
<code>
int
<strong>getExpire</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getSafeExpire">
<div class="location">at line 205</div>
<code>
int
<strong>getSafeExpire</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setPath">
<div class="location">at line 214</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>setPath</strong>(
string $path)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$path</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getPath">
<div class="location">at line 223</div>
<code>
string
<strong>getPath</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getSafePath">
<div class="location">at line 231</div>
<code>
string
<strong>getSafePath</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setDomain">
<div class="location">at line 240</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>setDomain</strong>(
string $domain)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$domain</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getDomain">
<div class="location">at line 249</div>
<code>
string
<strong>getDomain</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getSafeDomain">
<div class="location">at line 257</div>
<code>
string
<strong>getSafeDomain</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setSecure">
<div class="location">at line 266</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>setSecure</strong>(
string $secure)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$secure</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getSecure">
<div class="location">at line 275</div>
<code>
bool
<strong>getSecure</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getSafeSecure">
<div class="location">at line 283</div>
<code>
bool
<strong>getSafeSecure</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setHttponly">
<div class="location">at line 292</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>setHttponly</strong>(
string $https)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$https</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getHttponly">
<div class="location">at line 301</div>
<code>
bool
<strong>getHttponly</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getSafeHttponly">
<div class="location">at line 309</div>
<code>
bool
<strong>getSafeHttponly</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_sendAsRaw">
<div class="location">at line 317</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>sendAsRaw</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_sendAsEncoded">
<div class="location">at line 326</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>sendAsEncoded</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setCookieFuncArguments">
<div class="location">at line 336</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>setCookieFuncArguments</strong>(
array $args)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$args</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getCookieFuncArguments">
<div class="location">at line 346</div>
<code>
array
<strong>getCookieFuncArguments</strong>(
bool $organize = true)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>$organize</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getCookieFuncArgument">
<div class="location">at line 358</div>
<code>
mixed
<strong>getCookieFuncArgument</strong>(
string $var)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$var</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_addCookieFuncArgument">
<div class="location">at line 368</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>addCookieFuncArgument</strong>(
string $var,
mixed $val)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$var</td>
<td>
</td>
</tr>
<tr>
<td>
mixed</td>
<td>$val</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_clearCookieFuncArgument">
<div class="location">at line 378</div>
<code>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a>
<strong>clearCookieFuncArgument</strong>(
string $var)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$var</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/HttpFundamental/Cookie.html"><abbr title="Library\HttpFundamental\Cookie">Cookie</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_exists">
<div class="location">at line 441</div>
<code>
bool
<strong>exists</strong>(
string $cookie_name = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Test if a cookie exists</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$cookie_name</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_read">
<div class="location">at line 455</div>
<code>
string|array
<strong>read</strong>(
string $cookie_name = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get a cookie value</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$cookie_name</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string|array</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_send">
<div class="location">at line 478</div>
<code>
bool
<strong>send</strong>(
string $cookie_name = null,
string|array $cookie_value = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set a cookie value</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$cookie_name</td>
<td>
</td>
</tr>
<tr>
<td>
string|array</td>
<td>$cookie_value</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_addInCookie">
<div class="location">at line 509</div>
<code>
bool
<strong>addInCookie</strong>(
string $variable_name,
string $variable_value,
string $cookie_name = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Add a variable value in a cookie</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$variable_name</td>
<td>
</td>
</tr>
<tr>
<td>
string</td>
<td>$variable_value</td>
<td>
</td>
</tr>
<tr>
<td>
string</td>
<td>$cookie_name</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_clear">
<div class="location">at line 528</div>
<code>
bool
<strong>clear</strong>(
string $cookie_name = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Clear a cookie</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$cookie_name</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
</div>
</div>
</div>
</body>
</html>