<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>Recipe Fiddle: com\whitemagicsoftware\Cookie Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Recipe Fiddle </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.6.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><b>com</b> </li> <li class="navelem"><b>whitemagicsoftware</b> </li> <li class="navelem"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Cookie.html">Cookie</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">com\whitemagicsoftware\Cookie Class Reference</div> </div> </div><!--header--> <div class="contents"> <!-- doxytag: class="com::whitemagicsoftware::Cookie" --><!-- doxytag: inherits="com::whitemagicsoftware::Obj" --> <p>Responsible for setting and retrieving the value of the cookie for a given IP address. <a href="classcom_1_1whitemagicsoftware_1_1Cookie.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for com\whitemagicsoftware\Cookie:</div> <div class="dyncontent"> <div class="center"> <img src="classcom_1_1whitemagicsoftware_1_1Cookie.png" usemap="#com\whitemagicsoftware\Cookie_map" alt=""/> <map id="com\whitemagicsoftware\Cookie_map" name="com\whitemagicsoftware\Cookie_map"> <area href="classcom_1_1whitemagicsoftware_1_1Obj.html" title="Superclass that abstracts the common functionality." alt="com\whitemagicsoftware\Obj" shape="rect" coords="0,0,192,24"/> </map> </div></div> <p><a href="classcom_1_1whitemagicsoftware_1_1Cookie-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a6cbb71a6d4246e7f77baa1fe274231"></a><!-- doxytag: member="com::whitemagicsoftware::Cookie::__construct" ref="a8a6cbb71a6d4246e7f77baa1fe274231" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Cookie.html#a8a6cbb71a6d4246e7f77baa1fe274231">__construct</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default (empty) constructor. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Cookie.html#aeea85ce2a747cd85b5a21d1e19c25d23">getCookieToken</a> ($ip)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">If there is a cookie set, but it doesn't exist in the database, then generate and set a new cookie. <a href="#aeea85ce2a747cd85b5a21d1e19c25d23"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Cookie.html#a5b7a1dd7b9b9b28a4963da20a7df5fed">setCookieToken</a> ($cookieName, $cookieValue, $httpOnly=true, $secure=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a cookie based on the given name and value. <a href="#a5b7a1dd7b9b9b28a4963da20a7df5fed"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Cookie.html#a05828eab8efbfe3be27ace9bc1eb585c">isSecure</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the cookie will be transmitted using HTTPS. <a href="#a05828eab8efbfe3be27ace9bc1eb585c"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Responsible for setting and retrieving the value of the cookie for a given IP address. </p> <p>This will also obtain an authentication ID for a given cookie value. </p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aeea85ce2a747cd85b5a21d1e19c25d23"></a><!-- doxytag: member="com::whitemagicsoftware::Cookie::getCookieToken" ref="aeea85ce2a747cd85b5a21d1e19c25d23" args="($ip)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Cookie.html#aeea85ce2a747cd85b5a21d1e19c25d23">Cookie::getCookieToken</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>ip</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>If there is a cookie set, but it doesn't exist in the database, then generate and set a new cookie. </p> <p>This will set the browser cookie if required.</p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$ip</td><td>The IP address of the client that requires a cookie. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a05828eab8efbfe3be27ace9bc1eb585c"></a><!-- doxytag: member="com::whitemagicsoftware::Cookie::isSecure" ref="a05828eab8efbfe3be27ace9bc1eb585c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Cookie.html#a05828eab8efbfe3be27ace9bc1eb585c">Cookie::isSecure</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Returns true if the cookie will be transmitted using HTTPS. </p> <p>This checks the default port of 443 (if SSL is on another port, this must be reconfigured).</p> <dl class="return"><dt><b>Returns:</b></dt><dd>true The client is using a secure connection. </dd></dl> </div> </div> <a class="anchor" id="a5b7a1dd7b9b9b28a4963da20a7df5fed"></a><!-- doxytag: member="com::whitemagicsoftware::Cookie::setCookieToken" ref="a5b7a1dd7b9b9b28a4963da20a7df5fed" args="($cookieName, $cookieValue, $httpOnly=true, $secure=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Cookie.html#a5b7a1dd7b9b9b28a4963da20a7df5fed">Cookie::setCookieToken</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>cookieName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>cookieValue</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>httpOnly</em> = <code>true</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>secure</em> = <code>false</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Sets a cookie based on the given name and value. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$cookieName</td><td>The name of the cookie to set. </td></tr> <tr><td class="paramname">$cookieValue</td><td>The value for the given cookie name. </td></tr> <tr><td class="paramname">$httpOnly</td><td>Whether the cookie should not be exposed to JavaScript (true default). </td></tr> <tr><td class="paramname">$secure</td><td>Whether the client connection is secure (false default). </td></tr> </table> </dd> </dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>class.Cookie.php</li> </ul> </div><!-- contents --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small> Generated on Tue Jul 30 2013 22:06:29 for Recipe Fiddle by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.7.6.1 </small></address> </body> </html>