aleajactaest/khanat-opennel-code
1
0
Fork 0
mirror of https://port.numenaute.org/aleajactaest/khanat-opennel-code.git synced 2024-12-22 17:08:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
khanat-opennel-code/code/ryzom/tools/server/ryzom_ams_docs/html/classDBLayer.html

269 lines
12 KiB
HTML
Raw Blame History

<!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>Ryzom Account Management System: DBLayer 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">Ryzom Account Management System
</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><a href="dirs.html"><span>Directories</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>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">DBLayer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="DBLayer" -->
<p>Handles the database connections.
<a href="classDBLayer.html#details">More...</a></p>
<p><a href="classDBLayer-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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDBLayer.html#ad1d7f86c8854cb42b51849de74fe2ad6">__construct</a> ($db)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The constructor. <a href="#ad1d7f86c8854cb42b51849de74fe2ad6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDBLayer.html#a6831a10286b2f8795bb27dcea4b6edfe">executeWithoutParams</a> ($query)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">execute a query that doesn't have any parameters <a href="#a6831a10286b2f8795bb27dcea4b6edfe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDBLayer.html#ad3ebb9fd7b55f2f597bb20e12602d6f4">execute</a> ($query, $params)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">execute a query that has parameters <a href="#ad3ebb9fd7b55f2f597bb20e12602d6f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDBLayer.html#a82c63e5aa7205b3f54a4766427ab51f9">executeReturnId</a> ($query, $params)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">execute a query (an insertion query) that has parameters and return the id of it's insertion <a href="#a82c63e5aa7205b3f54a4766427ab51f9"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0019ba4102cd0e107fbe91bd5cc43425"></a><!-- doxytag: member="DBLayer::$PDO" ref="a0019ba4102cd0e107fbe91bd5cc43425" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDBLayer.html#a0019ba4102cd0e107fbe91bd5cc43425">$PDO</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The PDO object, instantiated by the constructor. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Handles the database connections. </p>
<p>It uses PDO to connect to the different databases. It will use the argument of the constructor to setup a connection to the database with the matching entry in the $cfg global variable. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Daan Janssens, mentored by Matthew Lagoe </dd></dl>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad1d7f86c8854cb42b51849de74fe2ad6"></a><!-- doxytag: member="DBLayer::__construct" ref="ad1d7f86c8854cb42b51849de74fe2ad6" args="($db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classDBLayer.html#ad1d7f86c8854cb42b51849de74fe2ad6">DBLayer::__construct</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>db</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The constructor. </p>
<p>Instantiates the PDO object attribute by connecting to the arguments matching database(the db info is stored in the $cfg global var) </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">String,the</td><td>name of the databases entry in the $cfg global var. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad3ebb9fd7b55f2f597bb20e12602d6f4"></a><!-- doxytag: member="DBLayer::execute" ref="ad3ebb9fd7b55f2f597bb20e12602d6f4" args="($query, $params)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classDBLayer.html#ad3ebb9fd7b55f2f597bb20e12602d6f4">DBLayer::execute</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>params</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>execute a query that has parameters </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$query</td><td>the mysql query </td></tr>
<tr><td class="paramname">$params</td><td>the parameters that are being used by the query </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns a PDOStatement object </dd></dl>
</div>
</div>
<a class="anchor" id="a82c63e5aa7205b3f54a4766427ab51f9"></a><!-- doxytag: member="DBLayer::executeReturnId" ref="a82c63e5aa7205b3f54a4766427ab51f9" args="($query, $params)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classDBLayer.html#a82c63e5aa7205b3f54a4766427ab51f9">DBLayer::executeReturnId</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>params</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>execute a query (an insertion query) that has parameters and return the id of it's insertion </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$query</td><td>the mysql query </td></tr>
<tr><td class="paramname">$params</td><td>the parameters that are being used by the query </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns the id of the last inserted element. </dd></dl>
</div>
</div>
<a class="anchor" id="a6831a10286b2f8795bb27dcea4b6edfe"></a><!-- doxytag: member="DBLayer::executeWithoutParams" ref="a6831a10286b2f8795bb27dcea4b6edfe" args="($query)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classDBLayer.html#a6831a10286b2f8795bb27dcea4b6edfe">DBLayer::executeWithoutParams</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>query</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>execute a query that doesn't have any parameters </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$query</td><td>the mysql query </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns a PDOStatement object </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/daan/ryzom/ryzomcore/code/ryzom/tools/server/ryzom_ams/ams_lib/autoload/dblayer.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 Fri Sep 13 2013 00:20:37 for Ryzom Account Management System 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>
Reference in a new issue View git blame Copy permalink