<!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\Database 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_1Database.html">Database</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> </div> <div class="headertitle"> <div class="title">com\whitemagicsoftware\Database Class Reference</div> </div> </div><!--header--> <div class="contents"> <!-- doxytag: class="com::whitemagicsoftware::Database" --><!-- doxytag: inherits="com::whitemagicsoftware::Obj" --> <p>Used for interacting with the database. <a href="classcom_1_1whitemagicsoftware_1_1Database.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for com\whitemagicsoftware\Database:</div> <div class="dyncontent"> <div class="center"> <img src="classcom_1_1whitemagicsoftware_1_1Database.png" usemap="#com\whitemagicsoftware\Database_map" alt=""/> <map id="com\whitemagicsoftware\Database_map" name="com\whitemagicsoftware\Database_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,206,24"/> </map> </div></div> <p><a href="classcom_1_1whitemagicsoftware_1_1Database-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="a21e4d8044c23cf2eab6b50d65e08e0e5"></a><!-- doxytag: member="com::whitemagicsoftware::Database::__construct" ref="a21e4d8044c23cf2eab6b50d65e08e0e5" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Database.html#a21e4d8044c23cf2eab6b50d65e08e0e5">__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_1Database.html#a66433181410247ce2d3ed9bebc50c691">call</a> ($proc, $params="")</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Call a database function and return the results. <a href="#a66433181410247ce2d3ed9bebc50c691"></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_1Database.html#af8359c824e2d85c14ac357581affb1e3">arrayToString</a> ($array)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Converts an array of numbers into an array suitable for usage with PostgreSQL. <a href="#af8359c824e2d85c14ac357581affb1e3"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab23c556cedc779744f44a4536569086a"></a><!-- doxytag: member="com::whitemagicsoftware::Database::get" ref="ab23c556cedc779744f44a4536569086a" args="()" --> static </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Database.html#ab23c556cedc779744f44a4536569086a">get</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the singleton database instance. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Used for interacting with the database. </p> <p>Usage: </p> <pre> $db = <a class="el" href="classcom_1_1whitemagicsoftware_1_1Database.html#ab23c556cedc779744f44a4536569086a" title="Returns the singleton database instance.">Database::get()</a>; $db->call( ... ); </pre> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="af8359c824e2d85c14ac357581affb1e3"></a><!-- doxytag: member="com::whitemagicsoftware::Database::arrayToString" ref="af8359c824e2d85c14ac357581affb1e3" args="($array)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Database.html#af8359c824e2d85c14ac357581affb1e3">Database::arrayToString</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>array</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Converts an array of numbers into an array suitable for usage with PostgreSQL. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$array</td><td>An array of integers. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a66433181410247ce2d3ed9bebc50c691"></a><!-- doxytag: member="com::whitemagicsoftware::Database::call" ref="a66433181410247ce2d3ed9bebc50c691" args="($proc, $params="")" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Database.html#a66433181410247ce2d3ed9bebc50c691">Database::call</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>proc</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>params</em> = <code>""</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Call a database function and return the results. </p> <p>If there are multiple columns to return, then the value for $params must contain a comma; otherwise, without a comma, the value for $params is used as the return column name. For example:</p> <ul> <li>SELECT $params FROM $proc( ?, ? ); -- with comma</li> <li>SELECT $proc( ?, ? ) AS $params; -- without comma</li> <li>SELECT $proc( ?, ? ); -- empty</li> </ul> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$proc</td><td>Name of the function or stored procedure to call. </td></tr> <tr><td class="paramname">$params</td><td>Name of parameters to use as return columns. </td></tr> </table> </dd> </dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>class.Database.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>