<!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\Potluck 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_1Potluck.html">Potluck</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> </div> <div class="headertitle"> <div class="title">com\whitemagicsoftware\Potluck Class Reference</div> </div> </div><!--header--> <div class="contents"> <!-- doxytag: class="com::whitemagicsoftware::Potluck" --><!-- doxytag: inherits="com::whitemagicsoftware::BaseController" --> <p>Allows the user to either organize or add themselves to a potluck. <a href="classcom_1_1whitemagicsoftware_1_1Potluck.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for com\whitemagicsoftware\Potluck:</div> <div class="dyncontent"> <div class="center"> <img src="classcom_1_1whitemagicsoftware_1_1Potluck.png" usemap="#com\whitemagicsoftware\Potluck_map" alt=""/> <map id="com\whitemagicsoftware\Potluck_map" name="com\whitemagicsoftware\Potluck_map"> <area href="classcom_1_1whitemagicsoftware_1_1BaseController.html" title="Used by all subclasses that interact with the end user." alt="com\whitemagicsoftware\BaseController" shape="rect" coords="0,56,237,80"/> <area href="classcom_1_1whitemagicsoftware_1_1Obj.html" title="Superclass that abstracts the common functionality." alt="com\whitemagicsoftware\Obj" shape="rect" coords="0,0,237,24"/> </map> </div></div> <p><a href="classcom_1_1whitemagicsoftware_1_1Potluck-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="a035a5ed99e9b8b4c5c6a5fba2603c230"></a><!-- doxytag: member="com::whitemagicsoftware::Potluck::__construct" ref="a035a5ed99e9b8b4c5c6a5fba2603c230" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#a035a5ed99e9b8b4c5c6a5fba2603c230">__construct</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the connection that this class uses for database transactions. <br/></td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#aa4f31cc3cb9a3980e7df3123556863f6">exists</a> ($id)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Checks to see if the given account ID exists. <a href="#aa4f31cc3cb9a3980e7df3123556863f6"></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_1Potluck.html#a71935aa2d733df827ea42e2c71a2830f">getParameterIdName</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the parameter used to obtain the identifier for the object to edit. <a href="#a71935aa2d733df827ea42e2c71a2830f"></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_1Potluck.html#a898bebe052910eefeeed36ad46f9730d">getAuthorizationFunctionName</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the database function to call to verify that this authentication token is allowed to modify a given potluck. <a href="#a898bebe052910eefeeed36ad46f9730d"></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_1Potluck.html#a88ab8c0d092e438a2e05b7710ee51a99">getPotluckId</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the default potluck ID to use. <a href="#a88ab8c0d092e438a2e05b7710ee51a99"></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_1Potluck.html#a3c5e6d04b4d5dc22c4def0520e7078c0">getLastResortId</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Overrides the default behaviour (return 0) to return the account ID. <a href="#a3c5e6d04b4d5dc22c4def0520e7078c0"></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_1Potluck.html#ac8630a728ffc543fed7cb862c78b186c">getStylesheetName</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the stylesheet to use for transforming the recipe from XML to XHTML. <a href="#ac8630a728ffc543fed7cb862c78b186c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebc5bb8c3d2f353c69046567aec5a837"></a><!-- doxytag: member="com::whitemagicsoftware::Potluck::getXhtml" ref="aebc5bb8c3d2f353c69046567aec5a837" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#aebc5bb8c3d2f353c69046567aec5a837">getXhtml</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns account information in XHTML format. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2668be6a1a0e200757c43b7e1926fdac"></a><!-- doxytag: member="com::whitemagicsoftware::Potluck::handleRequest" ref="a2668be6a1a0e200757c43b7e1926fdac" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#a2668be6a1a0e200757c43b7e1926fdac">handleRequest</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Executes database transactions depending on the supplied commands. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Allows the user to either organize or add themselves to a potluck. </p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aa4f31cc3cb9a3980e7df3123556863f6"></a><!-- doxytag: member="com::whitemagicsoftware::Potluck::exists" ref="aa4f31cc3cb9a3980e7df3123556863f6" args="($id)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#aa4f31cc3cb9a3980e7df3123556863f6">Potluck::exists</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>id</em></td><td>)</td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Checks to see if the given account ID exists. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">id</td><td>The identifier for an existing account. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true </dd></dl> <p>Reimplemented from <a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a651ebed023e094bd53ca4ea5a9a554ba">com\whitemagicsoftware\BaseController</a>.</p> </div> </div> <a class="anchor" id="a898bebe052910eefeeed36ad46f9730d"></a><!-- doxytag: member="com::whitemagicsoftware::Potluck::getAuthorizationFunctionName" ref="a898bebe052910eefeeed36ad46f9730d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#a898bebe052910eefeeed36ad46f9730d">Potluck::getAuthorizationFunctionName</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the name of the database function to call to verify that this authentication token is allowed to modify a given potluck. </p> <p>Note that the authentication token (ID) is associated with the browser cookie.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>true iff the potluck ID can be modified by the authentication ID. </dd></dl> <p>Reimplemented from <a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a77444f5f040b678256c657b71ca2f535">com\whitemagicsoftware\BaseController</a>.</p> </div> </div> <a class="anchor" id="a3c5e6d04b4d5dc22c4def0520e7078c0"></a><!-- doxytag: member="com::whitemagicsoftware::Potluck::getLastResortId" ref="a3c5e6d04b4d5dc22c4def0520e7078c0" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#a3c5e6d04b4d5dc22c4def0520e7078c0">Potluck::getLastResortId</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Overrides the default behaviour (return 0) to return the account ID. </p> <p>This should only get called when all other means to determine the ID for this request have failed.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>$this-><a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#a88ab8c0d092e438a2e05b7710ee51a99" title="Returns the default potluck ID to use.">getPotluckId()</a> </dd></dl> <p>Reimplemented from <a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a7736b4d09221ab5d861a3ee37352d2fe">com\whitemagicsoftware\BaseController</a>.</p> </div> </div> <a class="anchor" id="a71935aa2d733df827ea42e2c71a2830f"></a><!-- doxytag: member="com::whitemagicsoftware::Potluck::getParameterIdName" ref="a71935aa2d733df827ea42e2c71a2830f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#a71935aa2d733df827ea42e2c71a2830f">Potluck::getParameterIdName</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the name of the parameter used to obtain the identifier for the object to edit. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>"potluck-id" </dd></dl> <p>Reimplemented from <a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a23ab3f53a3f9413c51751a9cec74f7b5">com\whitemagicsoftware\BaseController</a>.</p> </div> </div> <a class="anchor" id="a88ab8c0d092e438a2e05b7710ee51a99"></a><!-- doxytag: member="com::whitemagicsoftware::Potluck::getPotluckId" ref="a88ab8c0d092e438a2e05b7710ee51a99" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#a88ab8c0d092e438a2e05b7710ee51a99">Potluck::getPotluckId</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the default potluck ID to use. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>0 </dd></dl> </div> </div> <a class="anchor" id="ac8630a728ffc543fed7cb862c78b186c"></a><!-- doxytag: member="com::whitemagicsoftware::Potluck::getStylesheetName" ref="ac8630a728ffc543fed7cb862c78b186c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#ac8630a728ffc543fed7cb862c78b186c">Potluck::getStylesheetName</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the name of the stylesheet to use for transforming the recipe from XML to XHTML. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>"xsl/potluck.xsl" </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>class.Potluck.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>