aleajactaest/khanat-opennel-code
1
0
Fork 0
mirror of https://port.numenaute.org/aleajactaest/khanat-opennel-code.git synced 2024-11-18 05:11:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
khanat-opennel-code/code/web/docs/ams/html/classTicket__Queue.html

401 lines
19 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: Ticket_Queue 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">Ticket_Queue Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="Ticket_Queue" -->
<p>Data class that holds a lot of queries that load specific tickets.
<a href="classTicket__Queue.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="classTicket__Queue.html#a771627a0bd387cd666474a6ef0d5eaaf">loadAllNotAssignedTickets</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">loads the not yet assigned tickets query into the objects attributes. <a href="#a771627a0bd387cd666474a6ef0d5eaaf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Queue.html#a80542bde30a8a589f1d088422cb7719b">loadAllTickets</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">loads the 'all' tickets query into the objects attributes. <a href="#a80542bde30a8a589f1d088422cb7719b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Queue.html#a3a1cf8a88a3604e093f7d276050f1c49">loadAllOpenTickets</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">loads the 'all open' tickets query into the objects attributes. <a href="#a3a1cf8a88a3604e093f7d276050f1c49"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Queue.html#af2a9b20ac9dc0e1992f717abbb418be7">loadAllClosedTickets</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">loads the 'closed' tickets query into the objects attributes. <a href="#af2a9b20ac9dc0e1992f717abbb418be7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Queue.html#ad88848edf9a9132eb0cfcac904a8459f">loadToDoTickets</a> ($user_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">loads the 'todo' tickets query &amp; params into the objects attributes. <a href="#ad88848edf9a9132eb0cfcac904a8459f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Queue.html#a348c76f7ae32437b7e91b57671d6f33d">loadAssignedandWaiting</a> ($user_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">loads the 'tickets asssigned to a user and waiting on support' query &amp; params into the objects attributes. <a href="#a348c76f7ae32437b7e91b57671d6f33d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Queue.html#af077496b6071af47c19a873bf025c1f3">createQueue</a> ($userid, $groupid, $what, $how, $who)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">loads the 'created' query &amp; params into the objects attributes. <a href="#af077496b6071af47c19a873bf025c1f3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Queue.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="classTicket__Queue.html#ae32cd7c32721b02d676bb63b4b1366db">getParams</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get params attribute of the object. <a href="#ae32cd7c32721b02d676bb63b4b1366db"></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="classTicket__Queue.html#af59a5f7cd609e592c41dc3643efd3c98">$query</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The query that loads specific tickets. <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="classTicket__Queue.html#afe68e6fbe7acfbffc0af0c84a1996466">$params</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The parameter array that's being needed by the query. <a href="#afe68e6fbe7acfbffc0af0c84a1996466"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Data class that holds a lot of queries that load specific tickets. </p>
<p>These queries are being used by the ticket_queue_handler class. An object of this class holds 2 attributes: the query and the params used for the query. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Daan Janssens, mentored by Matthew Lagoe </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af077496b6071af47c19a873bf025c1f3"></a><!-- doxytag: member="Ticket_Queue::createQueue" ref="af077496b6071af47c19a873bf025c1f3" args="($userid, $groupid, $what, $how, $who)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Queue.html#af077496b6071af47c19a873bf025c1f3">createQueue</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>userid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>groupid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>what</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>how</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>who</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>loads the 'created' query &amp; params into the objects attributes. </p>
<p>This function creates dynamically a query based on the selected features. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$who</td><td>specifies if we want to user the user_id or group_id to form the query. </td></tr>
<tr><td class="paramname">$userid</td><td>the user's id to whom the tickets should be assigned/not assigned </td></tr>
<tr><td class="paramname">$groupid</td><td>the group's id to whom the tickets should be forwarded/not forwarded </td></tr>
<tr><td class="paramname">$what</td><td>specifies what kind of tickets we want to return: waiting for support, waiting on user, closed </td></tr>
<tr><td class="paramname">$how</td><td>specifies if the tickets should be or shouldn't be assigned/forwarded to the group/user selected. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae32cd7c32721b02d676bb63b4b1366db"></a><!-- doxytag: member="Ticket_Queue::getParams" ref="ae32cd7c32721b02d676bb63b4b1366db" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Queue.html#ae32cd7c32721b02d676bb63b4b1366db">getParams</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get params attribute of the object. </p>
</div>
</div>
<a class="anchor" id="a55f162785567258fe5138af282e588c2"></a><!-- doxytag: member="Ticket_Queue::getQuery" ref="a55f162785567258fe5138af282e588c2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Queue.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="af2a9b20ac9dc0e1992f717abbb418be7"></a><!-- doxytag: member="Ticket_Queue::loadAllClosedTickets" ref="af2a9b20ac9dc0e1992f717abbb418be7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Queue.html#af2a9b20ac9dc0e1992f717abbb418be7">loadAllClosedTickets</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>loads the 'closed' tickets query into the objects attributes. </p>
</div>
</div>
<a class="anchor" id="a771627a0bd387cd666474a6ef0d5eaaf"></a><!-- doxytag: member="Ticket_Queue::loadAllNotAssignedTickets" ref="a771627a0bd387cd666474a6ef0d5eaaf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Queue.html#a771627a0bd387cd666474a6ef0d5eaaf">loadAllNotAssignedTickets</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>loads the not yet assigned tickets query into the objects attributes. </p>
</div>
</div>
<a class="anchor" id="a3a1cf8a88a3604e093f7d276050f1c49"></a><!-- doxytag: member="Ticket_Queue::loadAllOpenTickets" ref="a3a1cf8a88a3604e093f7d276050f1c49" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Queue.html#a3a1cf8a88a3604e093f7d276050f1c49">loadAllOpenTickets</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>loads the 'all open' tickets query into the objects attributes. </p>
</div>
</div>
<a class="anchor" id="a80542bde30a8a589f1d088422cb7719b"></a><!-- doxytag: member="Ticket_Queue::loadAllTickets" ref="a80542bde30a8a589f1d088422cb7719b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Queue.html#a80542bde30a8a589f1d088422cb7719b">loadAllTickets</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>loads the 'all' tickets query into the objects attributes. </p>
</div>
</div>
<a class="anchor" id="a348c76f7ae32437b7e91b57671d6f33d"></a><!-- doxytag: member="Ticket_Queue::loadAssignedandWaiting" ref="a348c76f7ae32437b7e91b57671d6f33d" args="($user_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Queue.html#a348c76f7ae32437b7e91b57671d6f33d">loadAssignedandWaiting</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>user_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>loads the 'tickets asssigned to a user and waiting on support' query &amp; params into the objects attributes. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$user_id</td><td>the user's id to whom the tickets should be assigned </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad88848edf9a9132eb0cfcac904a8459f"></a><!-- doxytag: member="Ticket_Queue::loadToDoTickets" ref="ad88848edf9a9132eb0cfcac904a8459f" args="($user_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Queue.html#ad88848edf9a9132eb0cfcac904a8459f">loadToDoTickets</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>user_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>loads the 'todo' tickets query &amp; params into the objects attributes. </p>
<p>first: find the tickets assigned to the user with status = waiting on support, second find all not assigned tickets that aren't forwarded yet. find all tickets assigned to someone else witht status waiting on support, with timestamp of last reply &gt; 1 day, find all non-assigned tickets forwarded to the support groups to which that user belongs </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$user_id</td><td>the user's id to whom the tickets should be assigned </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="afe68e6fbe7acfbffc0af0c84a1996466"></a><!-- doxytag: member="Ticket_Queue::$params" ref="afe68e6fbe7acfbffc0af0c84a1996466" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$params<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The parameter array that's being needed by the query. </p>
</div>
</div>
<a class="anchor" id="af59a5f7cd609e592c41dc3643efd3c98"></a><!-- doxytag: member="Ticket_Queue::$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 that loads specific tickets. </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="ticket__queue_8php.html">ticket_queue.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