Dave Jarvis' Repositories

git clone https://repo.autonoma.ca/repo/recipe-fiddle.git
recipe-fiddle / common / php / docs / html / classcom_1_1whitemagicsoftware_1_1AjaxActions.html
<!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\AjaxActions 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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</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_1AjaxActions.html">AjaxActions</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\AjaxActions Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="com::whitemagicsoftware::AjaxActions" --><!-- doxytag: inherits="com::whitemagicsoftware::Ajax" -->
<p>Handles <a class="el" href="classcom_1_1whitemagicsoftware_1_1Ajax.html" title="Superclass for all Ajax request handlers.">Ajax</a> requests for culinary action words.  
 <a href="classcom_1_1whitemagicsoftware_1_1AjaxActions.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for com\whitemagicsoftware\AjaxActions:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classcom_1_1whitemagicsoftware_1_1AjaxActions.png" usemap="#com\whitemagicsoftware\AjaxActions_map" alt=""/>
  <map id="com\whitemagicsoftware\AjaxActions_map" name="com\whitemagicsoftware\AjaxActions_map">
<area href="classcom_1_1whitemagicsoftware_1_1Ajax.html" title="Superclass for all Ajax request handlers." alt="com\whitemagicsoftware\Ajax" shape="rect" coords="0,112,237,136"/>
<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_1AjaxActions-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="a90a58b46da0f5463fee76b67a28548ff"></a><!-- doxytag: member="com::whitemagicsoftware::AjaxActions::__construct" ref="a90a58b46da0f5463fee76b67a28548ff" args="()" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1AjaxActions.html#a90a58b46da0f5463fee76b67a28548ff">__construct</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1AjaxActions.html#aaefcaf77df10e80fe10c8d54c513708f">handleAjaxRequest</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Subclasses must implement this method to return data based on some input parameters.  <a href="#aaefcaf77df10e80fe10c8d54c513708f"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Handles <a class="el" href="classcom_1_1whitemagicsoftware_1_1Ajax.html" title="Superclass for all Ajax request handlers.">Ajax</a> requests for culinary action words. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aaefcaf77df10e80fe10c8d54c513708f"></a><!-- doxytag: member="com::whitemagicsoftware::AjaxActions::handleAjaxRequest" ref="aaefcaf77df10e80fe10c8d54c513708f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1AjaxActions.html#aaefcaf77df10e80fe10c8d54c513708f">AjaxActions::handleAjaxRequest</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Subclasses must implement this method to return data based on some input parameters. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Content to encode using the json_encode function. </dd></dl>

<p>Reimplemented from <a class="el" href="classcom_1_1whitemagicsoftware_1_1Ajax.html#a1eb0d0c06d32e37ea708f4df9e75d071">com\whitemagicsoftware\Ajax</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>class.AjaxActions.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</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 &#160;<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>