Location: PHPKode > projects > FOOWD > foowd/apidocs/Foowd/Input/input_cookie.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html>
<head>

<title>Input_cookie</title>

<link rel="stylesheet" type="text/css" href="../../stylesheet.css" />
<link rel="start" href="overview-summary.html" />

</head>

<body>

<table width="100%" cellpadding="0" class="header">
<tr><td class="header">
<a href="../../overview-summary.html">Overview</a>
<a href="package-summary.html">Package</a>
<a href="package-tree.html">Tree</a></td><td class="short_title">
FOOWD</td></tr>
</table>

<table width="100%" cellpadding="0" class="small_links">
<tr>
<td><a href="../../index.html" target="_top">FRAMES</a> <a href="input_cookie.html" target="_top">NO FRAMES</a></td>
</tr>
<tr>
<td>SUMMARY: <a href="#summary_field">FIELD</a> <a href="#summary_method">METHOD</a></td>
<td>DETAIL: <a href="#detail_field">FIELD</a> <a href="#detail_method">METHOD</a></td>
</tr>
</table>

<hr />

<h1>Class input_cookie</h1>

<pre><strong>input_cookie</strong><br /></pre>


<hr />

<p>
class <strong>input_cookie</strong><br />
</p>

<p>Input cookie class. </p><p>This class defines an input cookie, it handles input validation, and setting and retrieving the cookies value. </p><dl><dt>Author:</dt><dd>Paul James </dd></dl>
<hr />
<br />

<a name="summary_field"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th colspan="2" class="title">Field Summary</th></tr>
</table>

<table width="100%" cellspacing="0" class="body"><tr><td class="type">public str</td><td class="description"><a href="#$name">$name</a><br />The name of the cookie object. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$value">$value</a><br />The value of the cookie. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$regex">$regex</a><br />The regular expression used to validate the cookies value. </td></tr><tr><td class="type">public int</td><td class="description"><a href="#$expire">$expire</a><br />How long til the cookie expires in seconds. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$path">$path</a><br />The path the cookie is valid for. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$domain">$domain</a><br />The domain the cookie is valid for. </td></tr><tr><td class="type">public bool</td><td class="description"><a href="#$secure">$secure</a><br />Whether the cookie should only be sent over secure HTTP. </td></tr></table>
<br />
<a name="summary_method"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th colspan="2" class="title">Method Summary</th></tr>
</table>

<table width="100%" cellspacing="0" class="body"><tr><td class="type">public void</td><td class="description"><a href="#input_cookie">input_cookie</a><br />Constructs a new cookie object. </td></tr><tr><td class="type">public bool</td><td class="description"><a href="#set">set</a><br />Sets the value of the cookie object. </td></tr><tr><td class="type">public bool</td><td class="description"><a href="#delete">delete</a><br />Delete the cookie from the client. </td></tr></table>
<br />
<hr />
<br />


<a name="detail_field"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th class="title">Field Detail</th></tr>
</table>

<a name="$name"></a><h2>name</h2> <code>public str <strong>$name</strong></code><br /><p>The name of the cookie object. </p><p></p><hr /><a name="$value"></a><h2>value</h2> <code>public str <strong>$value</strong></code><br /><p>The value of the cookie. </p><p></p><hr /><a name="$regex"></a><h2>regex</h2> <code>public str <strong>$regex</strong></code><br /><p>The regular expression used to validate the cookies value. </p><p></p><hr /><a name="$expire"></a><h2>expire</h2> <code>public int <strong>$expire</strong></code><br /><p>How long til the cookie expires in seconds. </p><p></p><hr /><a name="$path"></a><h2>path</h2> <code>public str <strong>$path</strong></code><br /><p>The path the cookie is valid for. </p><p></p><hr /><a name="$domain"></a><h2>domain</h2> <code>public str <strong>$domain</strong></code><br /><p>The domain the cookie is valid for. </p><p></p><hr /><a name="$secure"></a><h2>secure</h2> <code>public bool <strong>$secure</strong></code><br /><p>Whether the cookie should only be sent over secure HTTP. </p><p></p><hr />
<a name="detail_method"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th class="title">Method Detail</th></tr>
</table>

<a name="input_cookie"></a><h2>input_cookie()</h2> <code>public void <strong>input_cookie</strong>(str name, str regex, str value, int expire, str path, str domain, bool secure)</code><br /><p>Constructs a new cookie object. </p><p></p><dl><dt>Parameters:</dt><dd><code>name</code> - The name of the querystring object. </dd><dd><code>regex</code> - The validation regular expression. </dd><dd><code>value</code> - The initial contents value. </dd><dd><code>expire</code> - How long til the cookie expires in seconds. </dd><dd><code>path</code> - The path the cookie is valid for. </dd><dd><code>domain</code> - The domain the cookie is valid for. </dd><dd><code>secure</code> - Whether the cookie should only be sent over secure HTTP. </dd></dl><hr /><a name="set"></a><h2>set()</h2> <code>public bool <strong>set</strong>(str value)</code><br /><p>Sets the value of the cookie object. </p><p></p><dl><dt>Parameters:</dt><dd><code>value</code> - The value to set the cookie to. </dd></dl><dl><dt>Returns:</dt><dd>TRUE on success. </dd></dl><hr /><a name="delete"></a><h2>delete()</h2> <code>public bool <strong>delete</strong>()</code><br /><p>Delete the cookie from the client. </p><p></p><dl><dt>Returns:</dt><dd>TRUE on success. </dd></dl><hr />
<table width="100%" cellpadding="0" class="header">
<tr><td class="header">
<a href="../../overview-summary.html">Overview</a>
<a href="package-summary.html">Package</a>
<a href="package-tree.html">Tree</a></td><td class="short_title">
FOOWD</td></tr>
</table>

<table width="100%" cellpadding="0" class="small_links">
<tr>
<td><a href="../../index.html" target="_top">FRAMES</a> <a href="input_cookie.html" target="_top">NO FRAMES</a></td>
</tr>
<tr>
<td>SUMMARY: <a href="#summary_field">FIELD</a> <a href="#summary_method">METHOD</a></td>
<td>DETAIL: <a href="#detail_field">FIELD</a> <a href="#detail_method">METHOD</a></td>
</tr>
</table>

<hr />

<p class="footer">This document was generated by <a href="http://phpdoctor.sourceforge.net/">PHPDoctor: The PHP Documentation Creator</a>.</p>
</body>
</html>
Return current item: FOOWD