<!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\Book 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_1Book.html">Book</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\Book Class Reference</div> </div> </div><!--header--> <div class="contents"> <!-- doxytag: class="com::whitemagicsoftware::Book" --><!-- doxytag: inherits="com::whitemagicsoftware::BaseController" --> <p>Displays the book editing page and generates a PDF book. <a href="classcom_1_1whitemagicsoftware_1_1Book.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for com\whitemagicsoftware\Book:</div> <div class="dyncontent"> <div class="center"> <img src="classcom_1_1whitemagicsoftware_1_1Book.png" usemap="#com\whitemagicsoftware\Book_map" alt=""/> <map id="com\whitemagicsoftware\Book_map" name="com\whitemagicsoftware\Book_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_1Book-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Book.html#a34841dc51449b7d91267a7beb601df84">create</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Saves changes, requests a recipe book in XML format, and generates a PDF of the book using LaTeX. <a href="#a34841dc51449b7d91267a7beb601df84"></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_1Book.html#a8344eb7e478f77f927a42a95ee2fdb2e">exists</a> ($id)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true iff the given ID represents a valid book in the database. <a href="#a8344eb7e478f77f927a42a95ee2fdb2e"></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_1Book.html#ad394d111f7e81230af5bd589122d7151">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="#ad394d111f7e81230af5bd589122d7151"></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_1Book.html#a42814cc0a40fe6f62fd4df770e7f5596">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="#a42814cc0a40fe6f62fd4df770e7f5596"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c49033e89c5a04b484afd40f10a7627"></a><!-- doxytag: member="com::whitemagicsoftware::Book::getXhtml" ref="a5c49033e89c5a04b484afd40f10a7627" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Book.html#a5c49033e89c5a04b484afd40f10a7627">getXhtml</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns book information in XHTML format. <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_1Book.html#a6ae446c8fba48a78534446c8ca356bab">getAuthorizationFunctionName</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the function used to determine whether or not a given authentication ID can edit its associated books. <a href="#a6ae446c8fba48a78534446c8ca356bab"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc5b4afb20dda482e2685f0542fa633d"></a><!-- doxytag: member="com::whitemagicsoftware::Book::handleRequest" ref="abc5b4afb20dda482e2685f0542fa633d" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Book.html#abc5b4afb20dda482e2685f0542fa633d">handleRequest</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Parses the user parameters and executes the book creation request. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Displays the book editing page and generates a PDF book. </p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a34841dc51449b7d91267a7beb601df84"></a><!-- doxytag: member="com::whitemagicsoftware::Book::create" ref="a34841dc51449b7d91267a7beb601df84" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Book.html#a34841dc51449b7d91267a7beb601df84">Book::create</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Saves changes, requests a recipe book in XML format, and generates a PDF of the book using LaTeX. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>true if the book was created. </dd></dl> </div> </div> <a class="anchor" id="a8344eb7e478f77f927a42a95ee2fdb2e"></a><!-- doxytag: member="com::whitemagicsoftware::Book::exists" ref="a8344eb7e478f77f927a42a95ee2fdb2e" 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_1Book.html#a8344eb7e478f77f927a42a95ee2fdb2e">Book::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>Returns true iff the given ID represents a valid book in the database. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$id</td><td>The book ID to validate. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true The ID is related to an existing book. </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="a6ae446c8fba48a78534446c8ca356bab"></a><!-- doxytag: member="com::whitemagicsoftware::Book::getAuthorizationFunctionName" ref="a6ae446c8fba48a78534446c8ca356bab" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Book.html#a6ae446c8fba48a78534446c8ca356bab">Book::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 function used to determine whether or not a given authentication ID can edit its associated books. </p> <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#a77444f5f040b678256c657b71ca2f535">com\whitemagicsoftware\BaseController</a>.</p> </div> </div> <a class="anchor" id="ad394d111f7e81230af5bd589122d7151"></a><!-- doxytag: member="com::whitemagicsoftware::Book::getParameterIdName" ref="ad394d111f7e81230af5bd589122d7151" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Book.html#ad394d111f7e81230af5bd589122d7151">Book::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> <p>In this case, this method returns the identifier used to get the account, which is associated with books.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>"account-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="a42814cc0a40fe6f62fd4df770e7f5596"></a><!-- doxytag: member="com::whitemagicsoftware::Book::getStylesheetName" ref="a42814cc0a40fe6f62fd4df770e7f5596" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Book.html#a42814cc0a40fe6f62fd4df770e7f5596">Book::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/book.xsl" </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>class.Book.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>