aleajactaest/khanat-opennel-code
1
0
Fork 0
mirror of https://port.numenaute.org/aleajactaest/khanat-opennel-code.git synced 2024-12-30 12:50:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
khanat-opennel-code/code/ryzom/tools/server/ryzom_ams_docs/html/classQuerycache.html
Quitta a485382a47 updated the docs! 
--HG--
branch : quitta-gsoc-2013
2013-09-15 18:27:07 +02:00

485 lines
22 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: Querycache 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 id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Ryzom Account Management System
&#160;<span id="projectnumber">1.0</span>
</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>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</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>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</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">Querycache Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="Querycache" -->
<p>class for storing changes when shard is offline.
<a href="classQuerycache.html#details">More...</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="classQuerycache.html#a095c5d389db211932136b53f25f39685">__construct</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor. <a href="#a095c5d389db211932136b53f25f39685"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#a8bdfe0a5256e35367225bcd6d278ef21">set</a> ($values)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">sets the object's attributes. <a href="#a8bdfe0a5256e35367225bcd6d278ef21"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#ae960510ccb242704233c38d787242f53">load_With_SID</a> ($id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">loads the object's attributes. <a href="#ae960510ccb242704233c38d787242f53"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#a842e4774e3b3601a005b995c02f7e883">update</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">updates the entry. <a href="#a842e4774e3b3601a005b995c02f7e883"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#a5bac91964d19751986cccad6fad28dda">getSID</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get SID attribute of the object. <a href="#a5bac91964d19751986cccad6fad28dda"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#a830b5c75df72b32396701bc563fbe3c7">getType</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get type attribute of the object. <a href="#a830b5c75df72b32396701bc563fbe3c7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#a55f162785567258fe5138af282e588c2">getQuery</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get query attribute of the object. <a href="#a55f162785567258fe5138af282e588c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#aceb656ee5135578ab3a9947252caa772">getDb</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get db attribute of the object. <a href="#aceb656ee5135578ab3a9947252caa772"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#a2f536a1f8c8e463eb0346ac375f2a24d">setSID</a> ($s)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set SID attribute of the object. <a href="#a2f536a1f8c8e463eb0346ac375f2a24d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#a0f29af8d4b9fdd8959739727a33acee5">setType</a> ($t)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set type attribute of the object. <a href="#a0f29af8d4b9fdd8959739727a33acee5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#adbd6075ec5d3bd84122e52b0134ed8e7">setQuery</a> ($q)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set query attribute of the object. <a href="#adbd6075ec5d3bd84122e52b0134ed8e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#afa9c249972ca269a2b1a399ed2faf9b4">setDb</a> ($d)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set db attribute of the object. <a href="#afa9c249972ca269a2b1a399ed2faf9b4"></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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#a69c31f890638fa4930097cf55ae27995">$SID</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The queries ID. <a href="#a69c31f890638fa4930097cf55ae27995"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#a9a4a6fba2208984cabb3afacadf33919">$type</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of query. <a href="#a9a4a6fba2208984cabb3afacadf33919"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#af59a5f7cd609e592c41dc3643efd3c98">$query</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The query itself (json encoded) <a href="#af59a5f7cd609e592c41dc3643efd3c98"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQuerycache.html#a1fa3127fc82f96b1436d871ef02be319">$db</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the db where the query should be performed <a href="#a1fa3127fc82f96b1436d871ef02be319"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>class for storing changes when shard is offline. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>make sure that the querycache class is being used by the sync class and also for inserting the queries themselfs into it. Atm this class isn't used yet if I remember correctly </dd></dl>
<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="a095c5d389db211932136b53f25f39685"></a><!-- doxytag: member="Querycache::__construct" ref="a095c5d389db211932136b53f25f39685" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQuerycache.html#a095c5d389db211932136b53f25f39685">__construct</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A constructor. </p>
<p>Empty constructor </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aceb656ee5135578ab3a9947252caa772"></a><!-- doxytag: member="Querycache::getDb" ref="aceb656ee5135578ab3a9947252caa772" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQuerycache.html#aceb656ee5135578ab3a9947252caa772">getDb</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get db attribute of the object. </p>
</div>
</div>
<a class="anchor" id="a55f162785567258fe5138af282e588c2"></a><!-- doxytag: member="Querycache::getQuery" ref="a55f162785567258fe5138af282e588c2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQuerycache.html#a55f162785567258fe5138af282e588c2">getQuery</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get query attribute of the object. </p>
</div>
</div>
<a class="anchor" id="a5bac91964d19751986cccad6fad28dda"></a><!-- doxytag: member="Querycache::getSID" ref="a5bac91964d19751986cccad6fad28dda" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQuerycache.html#a5bac91964d19751986cccad6fad28dda">getSID</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get SID attribute of the object. </p>
</div>
</div>
<a class="anchor" id="a830b5c75df72b32396701bc563fbe3c7"></a><!-- doxytag: member="Querycache::getType" ref="a830b5c75df72b32396701bc563fbe3c7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQuerycache.html#a830b5c75df72b32396701bc563fbe3c7">getType</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get type attribute of the object. </p>
</div>
</div>
<a class="anchor" id="ae960510ccb242704233c38d787242f53"></a><!-- doxytag: member="Querycache::load_With_SID" ref="ae960510ccb242704233c38d787242f53" args="($id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQuerycache.html#ae960510ccb242704233c38d787242f53">load_With_SID</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>loads the object's attributes. </p>
<p>loads the object's attributes by giving a SID as parameter </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$id</td><td>the id of the querycaches row </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8bdfe0a5256e35367225bcd6d278ef21"></a><!-- doxytag: member="Querycache::set" ref="a8bdfe0a5256e35367225bcd6d278ef21" args="($values)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQuerycache.html#a8bdfe0a5256e35367225bcd6d278ef21">set</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>values</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sets the object's attributes. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$values</td><td>should be an array of the form array('SID' =&gt; sid, 'type' =&gt; type, 'query' =&gt; query, 'db' =&gt; db). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afa9c249972ca269a2b1a399ed2faf9b4"></a><!-- doxytag: member="Querycache::setDb" ref="afa9c249972ca269a2b1a399ed2faf9b4" args="($d)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQuerycache.html#afa9c249972ca269a2b1a399ed2faf9b4">setDb</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>d</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set db attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$d</td><td>the name of the database in the config global var that we want to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adbd6075ec5d3bd84122e52b0134ed8e7"></a><!-- doxytag: member="Querycache::setQuery" ref="adbd6075ec5d3bd84122e52b0134ed8e7" args="($q)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQuerycache.html#adbd6075ec5d3bd84122e52b0134ed8e7">setQuery</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>q</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set query attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$q</td><td>query string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2f536a1f8c8e463eb0346ac375f2a24d"></a><!-- doxytag: member="Querycache::setSID" ref="a2f536a1f8c8e463eb0346ac375f2a24d" args="($s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQuerycache.html#a2f536a1f8c8e463eb0346ac375f2a24d">setSID</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set SID attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$s</td><td>integer id </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0f29af8d4b9fdd8959739727a33acee5"></a><!-- doxytag: member="Querycache::setType" ref="a0f29af8d4b9fdd8959739727a33acee5" args="($t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQuerycache.html#a0f29af8d4b9fdd8959739727a33acee5">setType</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set type attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$t</td><td>type of the query, could be changePassword, changePermissions, changeEmail, createUser </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a842e4774e3b3601a005b995c02f7e883"></a><!-- doxytag: member="Querycache::update" ref="a842e4774e3b3601a005b995c02f7e883" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQuerycache.html#a842e4774e3b3601a005b995c02f7e883">update</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>updates the entry. </p>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a1fa3127fc82f96b1436d871ef02be319"></a><!-- doxytag: member="Querycache::$db" ref="a1fa3127fc82f96b1436d871ef02be319" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$db<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the db where the query should be performed </p>
</div>
</div>
<a class="anchor" id="af59a5f7cd609e592c41dc3643efd3c98"></a><!-- doxytag: member="Querycache::$query" ref="af59a5f7cd609e592c41dc3643efd3c98" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$query<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The query itself (json encoded) </p>
</div>
</div>
<a class="anchor" id="a69c31f890638fa4930097cf55ae27995"></a><!-- doxytag: member="Querycache::$SID" ref="a69c31f890638fa4930097cf55ae27995" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$SID<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The queries ID. </p>
</div>
</div>
<a class="anchor" id="a9a4a6fba2208984cabb3afacadf33919"></a><!-- doxytag: member="Querycache::$type" ref="a9a4a6fba2208984cabb3afacadf33919" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$type<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The type of query. </p>
</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/<a class="el" href="querycache_8php.html">querycache.php</a></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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><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 Sun Sep 15 2013 17:49: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