<!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\Search 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_1Search.html">Search</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\Search Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="com::whitemagicsoftware::Search" --><!-- doxytag: inherits="com::whitemagicsoftware::BaseController" -->
<p>Allows the user to search for recipes, taking into consideration a variety of aspects, including: potluck attendees, dietary preferences, etc.
<a href="classcom_1_1whitemagicsoftware_1_1Search.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for com\whitemagicsoftware\Search:</div>
<div class="dyncontent">
<div class="center">
<img src="classcom_1_1whitemagicsoftware_1_1Search.png" usemap="#com\whitemagicsoftware\Search_map" alt=""/>
<map id="com\whitemagicsoftware\Search_map" name="com\whitemagicsoftware\Search_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_1Search-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="ad2f14b05ddb7b0f807a58da5c515744f"></a><!-- doxytag: member="com::whitemagicsoftware::Search::__construct" ref="ad2f14b05ddb7b0f807a58da5c515744f" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#ad2f14b05ddb7b0f807a58da5c515744f">__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_1Search.html#af82bf793255683412d0d258cc5b61806">exists</a> ($id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unused. <a href="#af82bf793255683412d0d258cc5b61806"></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_1Search.html#ae62e36eeb7542473a43160f72b27cdfa">getLastResortId</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unused. <a href="#ae62e36eeb7542473a43160f72b27cdfa"></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_1Search.html#a40e092825d71d1488da0bb7f879b96eb">getParameterIdName</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unused? <a href="#a40e092825d71d1488da0bb7f879b96eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3a71c1e76eac62df2b6d229273b1f33"></a><!-- doxytag: member="com::whitemagicsoftware::Search::getAuthorizationFunctionName" ref="ab3a71c1e76eac62df2b6d229273b1f33" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#ab3a71c1e76eac62df2b6d229273b1f33">getAuthorizationFunctionName</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Probably shouldn't be called... <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_1Search.html#aef1e4dd7376404594415d55475d2a0fb">authorize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">No authorization is necessary. <a href="#aef1e4dd7376404594415d55475d2a0fb"></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_1Search.html#a61b855eaa92792aca2b6221d2269a787">getXhtml</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an XHTML version of the XML specified by $this->getXml(). <a href="#a61b855eaa92792aca2b6221d2269a787"></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_1Search.html#a40a3a5bf21d5774c4bc4d43ee820a847">isEditable</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets editable to true so that commands can be parsed. <a href="#a40a3a5bf21d5774c4bc4d43ee820a847"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af1cdd0482c29dbaa2639c3d5638a34a8"></a><!-- doxytag: member="com::whitemagicsoftware::Search::handleRequest" ref="af1cdd0482c29dbaa2639c3d5638a34a8" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#af1cdd0482c29dbaa2639c3d5638a34a8">handleRequest</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Executes database transactions related to 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 search for recipes, taking into consideration a variety of aspects, including: potluck attendees, dietary preferences, etc. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aef1e4dd7376404594415d55475d2a0fb"></a><!-- doxytag: member="com::whitemagicsoftware::Search::authorize" ref="aef1e4dd7376404594415d55475d2a0fb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#aef1e4dd7376404594415d55475d2a0fb">Search::authorize</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>No authorization is necessary. </p>
<p>This prevents the database call that uses the return value from <a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#ab3a71c1e76eac62df2b6d229273b1f33" title="Probably shouldn't be called...">getAuthorizationFunctionName()</a>. </p>
<p>Reimplemented from <a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#a495f1139fdff6a9718f9337e546e9f9c">com\whitemagicsoftware\BaseController</a>.</p>
</div>
</div>
<a class="anchor" id="af82bf793255683412d0d258cc5b61806"></a><!-- doxytag: member="com::whitemagicsoftware::Search::exists" ref="af82bf793255683412d0d258cc5b61806" 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_1Search.html#af82bf793255683412d0d258cc5b61806">Search::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>Unused. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$id</td><td>Unused </td></tr>
</table>
</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="ae62e36eeb7542473a43160f72b27cdfa"></a><!-- doxytag: member="com::whitemagicsoftware::Search::getLastResortId" ref="ae62e36eeb7542473a43160f72b27cdfa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#ae62e36eeb7542473a43160f72b27cdfa">Search::getLastResortId</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unused. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 No last resort ID required. </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="a40e092825d71d1488da0bb7f879b96eb"></a><!-- doxytag: member="com::whitemagicsoftware::Search::getParameterIdName" ref="a40e092825d71d1488da0bb7f879b96eb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#a40e092825d71d1488da0bb7f879b96eb">Search::getParameterIdName</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unused? </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>"search-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="a61b855eaa92792aca2b6221d2269a787"></a><!-- doxytag: member="com::whitemagicsoftware::Search::getXhtml" ref="a61b855eaa92792aca2b6221d2269a787" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#a61b855eaa92792aca2b6221d2269a787">Search::getXhtml</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns an XHTML version of the XML specified by $this->getXml(). </p>
<dl class="see"><dt><b>See also:</b></dt><dd>getXml </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>An XHTML document. </dd></dl>
<p>Reimplemented from <a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#ab130204a2cd40e60c3b7b56e8aed7cbc">com\whitemagicsoftware\BaseController</a>.</p>
</div>
</div>
<a class="anchor" id="a40a3a5bf21d5774c4bc4d43ee820a847"></a><!-- doxytag: member="com::whitemagicsoftware::Search::isEditable" ref="a40a3a5bf21d5774c4bc4d43ee820a847" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Search.html#a40a3a5bf21d5774c4bc4d43ee820a847">Search::isEditable</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets editable to true so that commands can be parsed. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000009">Todo:</a></b></dt><dd>Split this functionality into a canParseCommand method.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true Indicates that the content commands can be parsed. </dd></dl>
<p>Reimplemented from <a class="el" href="classcom_1_1whitemagicsoftware_1_1BaseController.html#ad545c0e34114c7a0c0375a73f0285228">com\whitemagicsoftware\BaseController</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>class.Search.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>