<!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\BaseController 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">
<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>
<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>
<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>
<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_1BaseController.html">BaseController</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\BaseController Class Reference</div> </div>
</div>
<div class="contents">
<p>Used by all subclasses that interact with the end user.
<a href="classcom_1_1whitemagicsoftware_1_1BaseController.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for com\whitemagicsoftware\BaseController:</div>
<div class="dyncontent">
<div class="center">
<img src="classcom_1_1whitemagicsoftware_1_1BaseController.png" usemap="#com\whitemagicsoftware\BaseController_map" alt=""/>
<map id="com\whitemagicsoftware\BaseController_map" name="com\whitemagicsoftware\BaseController_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,237,24"/>
<area href="classcom_1_1whitemagicsoftware_1_1Account.html" title="Lists all the recipes associated with an account." alt="com\whitemagicsoftware\Account" shape="rect" coords="247,112,484,136"/>
<area href="classcom_1_1whitemagicsoftware_1_1Admin.html" title="Runs the ingredient category and name administration editor." alt="com\whitemagicsoftware\Admin" shape="rect" coords="247,168,484,192"/>
<area href="classcom_1_1whitemagicsoftware_1_1Ajax.html" title="Superclass for all Ajax request handlers." alt="com\whitemagicsoftware\Ajax" shape="rect" coords="247,224,484,248"/>
<area href="classcom_1_1whitemagicsoftware_1_1Book.html" title="Displays the book editing page and generates a PDF book." alt="com\whitemagicsoftware\Book" shape="rect" coords="247,280,484,304"/>
<area href="classcom_1_1whitemagicsoftware_1_1Diet.html" title="Allows the user to set their dietary preferences." alt="com\whitemagicsoftware\Diet" shape="rect" coords="247,336,484,360"/>
<area href="classcom_1_1whitemagicsoftware_1_1GroceryList.html" title="Allows the user to create a grocery list from recipes." alt="com\whitemagicsoftware\GroceryList" shape="rect" coords="247,392,484,416"/>
<area href="classcom_1_1whitemagicsoftware_1_1Potluck.html" title="Allows the user to either organize or add themselves to a potluck." alt="com\whitemagicsoftware\Potluck" shape="rect" coords="247,448,484,472"/>
<area href="classcom_1_1whitemagicsoftware_1_1Recipe.html" title="Provides recipe editing and viewing functionality." alt="com\whitemagicsoftware\Recipe" shape="rect" coords="247,504,484,528"/>
<area href="classcom_1_1whitemagicsoftware_1_1Search.html" title="Allows the user to search for recipes, taking into consideration a variety of aspects, including: potluck attendees, dietary preferences, etc." alt="com\whitemagicsoftware\Search" shape="rect" coords="247,560,484,584"/>
</map>
</div></div>
<p><a href="classcom_1_1whitemagicsoftware_1_1BaseController-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="ab63cf22555381e325265a44c1b5ecf57"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#ab63cf22555381e325265a44c1b5ecf57">__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 class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a4383dc9519b13ad97412eaac93f845bf">run</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Only handles requests from valid browsers (i.e., not robots). <a href="#a4383dc9519b13ad97412eaac93f845bf"></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_1BaseController.html#aea47afbeca025cd6a2162b578f57a4d3">isBrowser</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Answers whether the client connection is a browser (versus a robot). <a href="#aea47afbeca025cd6a2162b578f57a4d3"></a><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_1BaseController.html#a96a391e6330abdb1e8d53b0a474ee5f3">render</a> ($prg=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends HTTP headers, performs Post-Redirect-Get, and sends XHTML if required. <a href="#a96a391e6330abdb1e8d53b0a474ee5f3"></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_1BaseController.html#a7daa0e3ebddaae30b8f32f23b99c1c33">call</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delegates calling a database function to the database singleton. <a href="#a7daa0e3ebddaae30b8f32f23b99c1c33"></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_1BaseController.html#abf013434b57bd8d3b427f4f17678f3d3">json</a> ($results)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Performs a json_encode on the given results (converts an array to JSON data). <a href="#abf013434b57bd8d3b427f4f17678f3d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40b23b4e9a9f6630c7a2e6d247582e3b"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a40b23b4e9a9f6630c7a2e6d247582e3b">arrayToString</a> ($array)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delegates transforming a regular array into a string suitable for inserting into a PostgreSQL database. <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_1BaseController.html#ae975570ad4311a93d37461fabba56fec">redirect</a> ($BASE, $id, $title=null)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the client was redirected to a new URL. <a href="#ae975570ad4311a93d37461fabba56fec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3368314715f2425cbf5dd2c8af0fa9e8"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a3368314715f2425cbf5dd2c8af0fa9e8">sendHttpHeaders</a> ($contentType="text/html")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delegates sending HTTP headers via the <a class="el" href="classcom_1_1whitemagicsoftware_1_1Client.html" title="Represents a Client connection.">Client</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_1BaseController.html#a27368a7ac2d750762ffd45ec18772f3a">sendPDF</a> ($srcFilename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delegates sending a PDF via the <a class="el" href="classcom_1_1whitemagicsoftware_1_1Client.html" title="Represents a Client connection.">Client</a>. <a href="#a27368a7ac2d750762ffd45ec18772f3a"></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_1BaseController.html#a066da9ea83069334e0ba7bea3727f59d">setId</a> ($id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the ID for subsequent (editing) operations. <a href="#a066da9ea83069334e0ba7bea3727f59d"></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_1BaseController.html#a002cae515bb936b6c4d5ca9c347e7786">getId</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the ID of the object to edit. <a href="#a002cae515bb936b6c4d5ca9c347e7786"></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_1BaseController.html#aaff188359eb304e62c0dc7259d7e7942">setEditState</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines whether or not the user can edit this item. <a href="#aaff188359eb304e62c0dc7259d7e7942"></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_1BaseController.html#ad545c0e34114c7a0c0375a73f0285228">isEditable</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true to indicate whether the user may edit the content. <a href="#ad545c0e34114c7a0c0375a73f0285228"></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_1BaseController.html#a046b5a90a89f38ab756a766781a9f410">getParameterId</a> ($name, $v=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the identifier noted by the parameter name ($name). <a href="#a046b5a90a89f38ab756a766781a9f410"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a748a143c979b314b49c1f7fc602c858d"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a748a143c979b314b49c1f7fc602c858d">getParameter</a> ($name, $v=null)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delegates to the client instance. <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_1BaseController.html#a39667cfa7e49c1f0692cd0cab22d2a5d">getAuthenticationId</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delegates to the <a class="el" href="classcom_1_1whitemagicsoftware_1_1Client.html" title="Represents a Client connection.">Client</a> to return the authentication ID for the client's cookie (authentication token). <a href="#a39667cfa7e49c1f0692cd0cab22d2a5d"></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_1BaseController.html#ad41d1acf3899789e0a01952fa664a1fe">getAccountId</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delegates to the <a class="el" href="classcom_1_1whitemagicsoftware_1_1Client.html" title="Represents a Client connection.">Client</a> to return the account ID for the client's authentication ID. <a href="#ad41d1acf3899789e0a01952fa664a1fe"></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_1BaseController.html#a62c0de80368fcb1626fe9c7dc6bbc015">getAccountLabel</a> ($id=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the account name. <a href="#a62c0de80368fcb1626fe9c7dc6bbc015"></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_1BaseController.html#a3625b8502806df9fd2e57977c9243fcb">setAccountLabel</a> ($text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Changes the account name in the database. <a href="#a3625b8502806df9fd2e57977c9243fcb"></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_1BaseController.html#abf765e4f6fde4ddd2045e2b3accd832e">getUrlId</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the object identifier included as part of the URL. <a href="#abf765e4f6fde4ddd2045e2b3accd832e"></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_1BaseController.html#acfa0006f4c0f0a73a4bbb804caeb47f1">setCookieToken</a> ($cookieName, $cookieValue, $httpOnly)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delegates setting the cookie to the client, which delegates to its cookie class. <a href="#acfa0006f4c0f0a73a4bbb804caeb47f1"></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_1BaseController.html#a5e1fbde06b68ec5d2dd9b8d06697eabd">getCookieToken</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delegates retrieving the cookie for the connected browser to the <a class="el" href="classcom_1_1whitemagicsoftware_1_1Client.html" title="Represents a Client connection.">Client</a> class. <a href="#a5e1fbde06b68ec5d2dd9b8d06697eabd"></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_1BaseController.html#a454d7b43c1a826cab3269bc11c9054d0">getXsltEngine</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a handle to the XSLT engine. <a href="#a454d7b43c1a826cab3269bc11c9054d0"></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_1BaseController.html#a1211297c72ad8e35b9fb7c6a803e3003">getErrorXml</a> ($element="recipe")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an XML document with an empty recipe tag. <a href="#a1211297c72ad8e35b9fb7c6a803e3003"></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_1BaseController.html#a3bba4b60a2015f1218e0f5ef174f1713">getCommand</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the main command requested by the user. <a href="#a3bba4b60a2015f1218e0f5ef174f1713"></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_1BaseController.html#ab79eeac460e2efeceba017ee5823cd9a">getSubcommand</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the subcommand of an action requested by the user. <a href="#ab79eeac460e2efeceba017ee5823cd9a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a495f1139fdff6a9718f9337e546e9f9c"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a495f1139fdff6a9718f9337e546e9f9c">authorize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines whether or not authorization is required. <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_1BaseController.html#a651ebed023e094bd53ca4ea5a9a554ba">exists</a> ($id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the ID represents an existing object. <a href="#a651ebed023e094bd53ca4ea5a9a554ba"></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_1BaseController.html#a23ab3f53a3f9413c51751a9cec74f7b5">getParameterIdName</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the parameter used to obtain the identifier for objects to edit. <a href="#a23ab3f53a3f9413c51751a9cec74f7b5"></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_1BaseController.html#a7736b4d09221ab5d861a3ee37352d2fe">getLastResortId</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the most recently issued identifier for an action. <a href="#a7736b4d09221ab5d861a3ee37352d2fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe2ef8cbe87586419389efc7cbc747fd"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#abe2ef8cbe87586419389efc7cbc747fd">handleRequest</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to handle a request made to the site. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab130204a2cd40e60c3b7b56e8aed7cbc"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#ab130204a2cd40e60c3b7b56e8aed7cbc">getXhtml</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to generate an XHTML page. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77444f5f040b678256c657b71ca2f535"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a77444f5f040b678256c657b71ca2f535">getAuthorizationFunctionName</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the function that can be called to determine whether the user can perform edits on a given object. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Used by all subclasses that interact with the end user. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7daa0e3ebddaae30b8f32f23b99c1c33"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a7daa0e3ebddaae30b8f32f23b99c1c33">BaseController::call</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delegates calling a database function to the database singleton. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classcom_1_1whitemagicsoftware_1_1Database.html#a66433181410247ce2d3ed9bebc50c691" title="Call a database function and return the results.">Database::call</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a651ebed023e094bd53ca4ea5a9a554ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a651ebed023e094bd53ca4ea5a9a554ba">BaseController::exists</a> </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td><code> [abstract, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the ID represents an existing object. </p>
<p>This must evaluate the identifier independently of the ID attribute from this class. This method is used to determine whether a new object should be created. Subclasses must implement this method.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$id</td><td>The ID to check. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true iff the given ID represents a valid database object. </dd></dl>
<p>Reimplemented in <a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#af82bf793255683412d0d258cc5b61806">com\whitemagicsoftware\Search</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Ajax.html#a3ba0a095db7eb35958400e2a8fe8aae3">com\whitemagicsoftware\Ajax</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1GroceryList.html#a9e82515cf8dc1daa917f4b4978bfa424">com\whitemagicsoftware\GroceryList</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Recipe.html#a4c428b4b663ee0ee6562dbce75ef95ba">com\whitemagicsoftware\Recipe</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Account.html#a24f86919e045ea775a7b152a4a9790b4">com\whitemagicsoftware\Account</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Book.html#a8344eb7e478f77f927a42a95ee2fdb2e">com\whitemagicsoftware\Book</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Diet.html#a158effec2d22edcb9ba69c83ef27f0c7">com\whitemagicsoftware\Diet</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#aa4f31cc3cb9a3980e7df3123556863f6">com\whitemagicsoftware\Potluck</a>, and <a class="el" href="classcom_1_1whitemagicsoftware_1_1Admin.html#ab4510b657c86fd6a143fef42993bca8a">com\whitemagicsoftware\Admin</a>.</p>
</div>
</div>
<a class="anchor" id="ad41d1acf3899789e0a01952fa664a1fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#ad41d1acf3899789e0a01952fa664a1fe">BaseController::getAccountId</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delegates to the <a class="el" href="classcom_1_1whitemagicsoftware_1_1Client.html" title="Represents a Client connection.">Client</a> to return the account ID for the client's authentication ID. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if the account could not be authenticated. </dd></dl>
</div>
</div>
<a class="anchor" id="a62c0de80368fcb1626fe9c7dc6bbc015"></a><!-- doxytag: member="com::whitemagicsoftware::BaseController::getAccountLabel" ref="a62c0de80368fcb1626fe9c7dc6bbc015" args="($id=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a62c0de80368fcb1626fe9c7dc6bbc015">BaseController::getAccountLabel</a> </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"><em>id</em> = <code>0</code></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the account name. </p>
<p>This caches the account label for this request.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$id</td><td>The identifier for the account. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The account name, or $DEFAULT_USER_NAME if the account name could not be found (i.e., no settings). </dd></dl>
</div>
</div>
<a class="anchor" id="a39667cfa7e49c1f0692cd0cab22d2a5d"></a><!-- doxytag: member="com::whitemagicsoftware::BaseController::getAuthenticationId" ref="a39667cfa7e49c1f0692cd0cab22d2a5d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a39667cfa7e49c1f0692cd0cab22d2a5d">BaseController::getAuthenticationId</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delegates to the <a class="el" href="classcom_1_1whitemagicsoftware_1_1Client.html" title="Represents a Client connection.">Client</a> to return the authentication ID for the client's cookie (authentication token). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if the account could not be authenticated. </dd></dl>
</div>
</div>
<a class="anchor" id="a3bba4b60a2015f1218e0f5ef174f1713"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a3bba4b60a2015f1218e0f5ef174f1713">BaseController::getCommand</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the main command requested by the user. </p>
<p>This is often one of the standard database commands (create, update, or delete).</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A command that indicates how the user is updating the data. </dd></dl>
</div>
</div>
<a class="anchor" id="a5e1fbde06b68ec5d2dd9b8d06697eabd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a5e1fbde06b68ec5d2dd9b8d06697eabd">BaseController::getCookieToken</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delegates retrieving the cookie for the connected browser to the <a class="el" href="classcom_1_1whitemagicsoftware_1_1Client.html" title="Represents a Client connection.">Client</a> class. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classcom_1_1whitemagicsoftware_1_1Client.html#a7b9a38e55c5539f531bdb9894d499743" title="Returns the cookie token for this client browser.">Client::getCookieToken</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1211297c72ad8e35b9fb7c6a803e3003"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a1211297c72ad8e35b9fb7c6a803e3003">BaseController::getErrorXml</a> </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"><em>element</em> = <code>"recipe"</code></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns an XML document with an empty recipe tag. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A non-null string that can pass for an XML document. </dd></dl>
</div>
</div>
<a class="anchor" id="a002cae515bb936b6c4d5ca9c347e7786"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a002cae515bb936b6c4d5ca9c347e7786">BaseController::getId</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the ID of the object to edit. </p>
<p>If the ID has not already been set, this will attempt to get it from the HTTP request parameter value corresponding to the getParameterIdName requst variable.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if the ID could not be determined. </dd></dl>
</div>
</div>
<a class="anchor" id="a7736b4d09221ab5d861a3ee37352d2fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a7736b4d09221ab5d861a3ee37352d2fe">BaseController::getLastResortId</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the most recently issued identifier for an action. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 by default. </dd></dl>
<p>Reimplemented in <a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#a3c5e6d04b4d5dc22c4def0520e7078c0">com\whitemagicsoftware\Potluck</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#ae62e36eeb7542473a43160f72b27cdfa">com\whitemagicsoftware\Search</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Account.html#a5a6aa036b010a5481eae7ae91121dcf1">com\whitemagicsoftware\Account</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Recipe.html#a7053417a40f53906cf0d89acd00b8a32">com\whitemagicsoftware\Recipe</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Diet.html#a3d7a95c8df99410c8b5af716c1c88735">com\whitemagicsoftware\Diet</a>, and <a class="el" href="classcom_1_1whitemagicsoftware_1_1GroceryList.html#ad26affe29b2338b39a4c199a8757dcd1">com\whitemagicsoftware\GroceryList</a>.</p>
</div>
</div>
<a class="anchor" id="a046b5a90a89f38ab756a766781a9f410"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a046b5a90a89f38ab756a766781a9f410">BaseController::getParameterId</a> </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"><em>v</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the identifier noted by the parameter name ($name). </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>The name of the HTTP request parameter to retrieve. </td></tr>
<tr><td class="paramname">$v</td><td>The default value if the request parameter is not set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a23ab3f53a3f9413c51751a9cec74f7b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a23ab3f53a3f9413c51751a9cec74f7b5">BaseController::getParameterIdName</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [abstract, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the name of the parameter used to obtain the identifier for objects to edit. </p>
<p>For example, a POST or GET request would contain the parameter "recipe-id" that identifies the name of the identifier containing the recipe ID to edit. This method is used in conjunction with getParameterValue().</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>String containing the name of the "identifying" parameter. </dd></dl>
<p>Reimplemented in <a class="el" href="classcom_1_1whitemagicsoftware_1_1Book.html#ad394d111f7e81230af5bd589122d7151">com\whitemagicsoftware\Book</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Admin.html#a91978cba2b7a0bbb58a56b53842d8921">com\whitemagicsoftware\Admin</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#a40e092825d71d1488da0bb7f879b96eb">com\whitemagicsoftware\Search</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Recipe.html#a82f917adb933d38e9790eaeb9e8c5693">com\whitemagicsoftware\Recipe</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Diet.html#adc32292fb3f7f06c781a66271a423124">com\whitemagicsoftware\Diet</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1GroceryList.html#a76c1682f2aec52f839d07b3166867b69">com\whitemagicsoftware\GroceryList</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Account.html#a85330a9374ba3980493af3809cc28ed3">com\whitemagicsoftware\Account</a>, <a class="el" href="classcom_1_1whitemagicsoftware_1_1Potluck.html#a71935aa2d733df827ea42e2c71a2830f">com\whitemagicsoftware\Potluck</a>, and <a class="el" href="classcom_1_1whitemagicsoftware_1_1Ajax.html#a6b6c64a27e3a88f7cea3843a65150dfb">com\whitemagicsoftware\Ajax</a>.</p>
</div>
</div>
<a class="anchor" id="ab79eeac460e2efeceba017ee5823cd9a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#ab79eeac460e2efeceba017ee5823cd9a">BaseController::getSubcommand</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the subcommand of an action requested by the user. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A subcommand used to determine what database function to call. </dd></dl>
</div>
</div>
<a class="anchor" id="abf765e4f6fde4ddd2045e2b3accd832e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#abf765e4f6fde4ddd2045e2b3accd832e">BaseController::getUrlId</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the object identifier included as part of the URL. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A number, or 0 if no identifier could be determined. </dd></dl>
</div>
</div>
<a class="anchor" id="a454d7b43c1a826cab3269bc11c9054d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a454d7b43c1a826cab3269bc11c9054d0">BaseController::getXsltEngine</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a handle to the XSLT engine. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>An XSLTProcessor instance, never null. </dd></dl>
</div>
</div>
<a class="anchor" id="aea47afbeca025cd6a2162b578f57a4d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#aea47afbeca025cd6a2162b578f57a4d3">BaseController::isBrowser</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Answers whether the client connection is a browser (versus a robot). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true iff the client is not a robot (e.g., Googlebot). </dd></dl>
</div>
</div>
<a class="anchor" id="ad545c0e34114c7a0c0375a73f0285228"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#ad545c0e34114c7a0c0375a73f0285228">BaseController::isEditable</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true to indicate whether the user may edit the content. </p>
<p>This has a side-effect in that commands sent from the user are not parsed if this returns false.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>Split mixed functionality into isEditable and canParseCommand.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>false if the user cannot edit the content or commands should not be parsed. </dd></dl>
<p>Reimplemented in <a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#a40a3a5bf21d5774c4bc4d43ee820a847">com\whitemagicsoftware\Search</a>, and <a class="el" href="classcom_1_1whitemagicsoftware_1_1Diet.html#a10c2bcfe9a9eac8bc505072a1e23867d">com\whitemagicsoftware\Diet</a>.</p>
</div>
</div>
<a class="anchor" id="abf013434b57bd8d3b427f4f17678f3d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#abf013434b57bd8d3b427f4f17678f3d3">BaseController::json</a> </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"><em>results</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Performs a json_encode on the given results (converts an array to JSON data). </p>
<p>This is typically used for <a class="el" href="classcom_1_1whitemagicsoftware_1_1Ajax.html" title="Superclass for all Ajax request handlers.">Ajax</a> requests. </p>
</div>
</div>
<a class="anchor" id="ae975570ad4311a93d37461fabba56fec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#ae975570ad4311a93d37461fabba56fec">BaseController::redirect</a> </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"><em>BASE</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"><em>title</em> = <code>null</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the client was redirected to a new URL. </p>
<p>This causes the URL to synchronize with a title.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$BASE</td><td>The base path to the application. </td></tr>
<tr><td class="paramname">$id</td><td>The numeric identifier for the account. </td></tr>
<tr><td class="paramname">$title</td><td>The title to use; if null, determined by querying $id. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a96a391e6330abdb1e8d53b0a474ee5f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a96a391e6330abdb1e8d53b0a474ee5f3">BaseController::render</a> </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"><em>prg</em> = <code>true</code></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends HTTP headers, performs Post-Redirect-Get, and sends XHTML if required. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$prg</td><td>Set to false when PRG is not required. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4383dc9519b13ad97412eaac93f845bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a4383dc9519b13ad97412eaac93f845bf">BaseController::run</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Only handles requests from valid browsers (i.e., not robots). </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#aaff188359eb304e62c0dc7259d7e7942" title="Determines whether or not the user can edit this item.">setEditState</a> </dd>
<dd>
parseCommands </dd>
<dd>
<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#abe2ef8cbe87586419389efc7cbc747fd" title="Called to handle a request made to the site.">handleRequest</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a27368a7ac2d750762ffd45ec18772f3a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a27368a7ac2d750762ffd45ec18772f3a">BaseController::sendPDF</a> </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"><em>srcFilename</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delegates sending a PDF via the <a class="el" href="classcom_1_1whitemagicsoftware_1_1Client.html" title="Represents a Client connection.">Client</a>. </p>
<p>This will set all the required HTTP headers to handle the file upload. </p>
</div>
</div>
<a class="anchor" id="a3625b8502806df9fd2e57977c9243fcb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a3625b8502806df9fd2e57977c9243fcb">BaseController::setAccountLabel</a> </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Changes the account name in the database. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$text</td><td>The new account label. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The new account name, or $DEFAULT_USER_NAME if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="acfa0006f4c0f0a73a4bbb804caeb47f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#acfa0006f4c0f0a73a4bbb804caeb47f1">BaseController::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> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delegates setting the cookie to the client, which delegates to its cookie class. </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>false iff the cookie should be visible to JavaScript. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaff188359eb304e62c0dc7259d7e7942"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#aaff188359eb304e62c0dc7259d7e7942">BaseController::setEditState</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determines whether or not the user can edit this item. </p>
<p>This is only called if the <a class="el" href="classcom_1_1whitemagicsoftware_1_1Client.html" title="Represents a Client connection.">Client</a> instance is not a robot. </p>
</div>
</div>
<a class="anchor" id="a066da9ea83069334e0ba7bea3727f59d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a066da9ea83069334e0ba7bea3727f59d">BaseController::setId</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>Sets the ID for subsequent (editing) operations. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$id</td><td>The identifier used by user-requested commands. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>class.BaseController.php</li>
</ul>
</div>
<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>
<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>