aleajactaest/khanat-opennel-code
1
0
Fork 0
mirror of https://port.numenaute.org/aleajactaest/khanat-opennel-code.git synced 2024-12-23 17:38:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
khanat-opennel-code/code/web/docs/ams/html/classTicket__Queue__Handler.html

395 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_Handler 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="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">Ticket_Queue_Handler Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="Ticket_Queue_Handler" -->
<p>returns tickets (queues) that are related in some way.
<a href="classTicket__Queue__Handler.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__Handler.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="classTicket__Queue__Handler.html#a45e8c11ba9485041fa92c7c470a8f9f9">getTickets</a> ($input, $user_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the tickets that are related in someway defined by $input. <a href="#a45e8c11ba9485041fa92c7c470a8f9f9"></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__Handler.html#ab45a102a508e9727b108e8f24486c464">getPagination</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get pagination attribute of the object. <a href="#ab45a102a508e9727b108e8f24486c464"></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__Handler.html#af077496b6071af47c19a873bf025c1f3">createQueue</a> ($userid, $groupid, $what, $how, $who)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">creates the queue. <a href="#af077496b6071af47c19a873bf025c1f3"></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">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Queue__Handler.html#ae8d1a2a66991583c05c173147e8dc657">getNrOfTicketsToDo</a> ($user_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get the number of tickets in the todo queue for a specific user. <a href="#ae8d1a2a66991583c05c173147e8dc657"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Queue__Handler.html#a0d3daaaf5c79188eb62bb3adda11fa2a">getNrOfTicketsAssignedWaiting</a> ($user_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get the number of tickets assigned to a specific user and waiting for support. <a href="#a0d3daaaf5c79188eb62bb3adda11fa2a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Queue__Handler.html#ada8f87ed8466c5e0477fa20359c3c8ad">getNrOfTickets</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get the total number of tickets. <a href="#ada8f87ed8466c5e0477fa20359c3c8ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Queue__Handler.html#ab5a79318a0c771083f03400093b3b2ec">getNewestTicket</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get the ticket object of the latest added ticket. <a href="#ab5a79318a0c771083f03400093b3b2ec"></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__Handler.html#a388a4a950e936f746d3b9c1b56450ce7">$pagination</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classPagination.html" title="Handles returning arrays based on a given pagenumber.">Pagination</a> object, this way only a few tickets (related to that pagenumber) will be shown. <a href="#a388a4a950e936f746d3b9c1b56450ce7"></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__Handler.html#a4a0b48f6ae2fcb248a4f0288c7c344a6">$queue</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The queue object, being used to get the queries and parameters. <a href="#a4a0b48f6ae2fcb248a4f0288c7c344a6"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>returns tickets (queues) that are related in some way. </p>
<p>This class handles the creation and returning of existing ticket queues. Normally a $_GET['get'] parameter is being used to identify what kind of tickets should be shown. the <a class="el" href="classTicket__Queue__Handler.html#a45e8c11ba9485041fa92c7c470a8f9f9" title="returns the tickets that are related in someway defined by $input.">getTickets()</a> function uses this parameter($input) and uses the ticket_queue class to load the specific query. </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="a095c5d389db211932136b53f25f39685"></a><!-- doxytag: member="Ticket_Queue_Handler::__construct" ref="a095c5d389db211932136b53f25f39685" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Queue__Handler.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>Instantiates the queue object. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af077496b6071af47c19a873bf025c1f3"></a><!-- doxytag: member="Ticket_Queue_Handler::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__Handler.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>creates the queue. </p>
<p>afterwards the getTickets function should be called, else a lot of extra parameters had to be added to the getTickets function.. </p>
</div>
</div>
<a class="anchor" id="ab5a79318a0c771083f03400093b3b2ec"></a><!-- doxytag: member="Ticket_Queue_Handler::getNewestTicket" ref="ab5a79318a0c771083f03400093b3b2ec" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket__Queue__Handler.html#ab5a79318a0c771083f03400093b3b2ec">getNewestTicket</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the ticket object of the latest added ticket. </p>
</div>
</div>
<a class="anchor" id="ada8f87ed8466c5e0477fa20359c3c8ad"></a><!-- doxytag: member="Ticket_Queue_Handler::getNrOfTickets" ref="ada8f87ed8466c5e0477fa20359c3c8ad" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket__Queue__Handler.html#ada8f87ed8466c5e0477fa20359c3c8ad">getNrOfTickets</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the total number of tickets. </p>
</div>
</div>
<a class="anchor" id="a0d3daaaf5c79188eb62bb3adda11fa2a"></a><!-- doxytag: member="Ticket_Queue_Handler::getNrOfTicketsAssignedWaiting" ref="a0d3daaaf5c79188eb62bb3adda11fa2a" args="($user_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket__Queue__Handler.html#a0d3daaaf5c79188eb62bb3adda11fa2a">getNrOfTicketsAssignedWaiting</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>user_id</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the number of tickets assigned to a specific user and waiting for support. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$user_id</td><td>the user being queried </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae8d1a2a66991583c05c173147e8dc657"></a><!-- doxytag: member="Ticket_Queue_Handler::getNrOfTicketsToDo" ref="ae8d1a2a66991583c05c173147e8dc657" args="($user_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket__Queue__Handler.html#ae8d1a2a66991583c05c173147e8dc657">getNrOfTicketsToDo</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>user_id</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the number of tickets in the todo queue for a specific user. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$user_id</td><td>the user being queried </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab45a102a508e9727b108e8f24486c464"></a><!-- doxytag: member="Ticket_Queue_Handler::getPagination" ref="ab45a102a508e9727b108e8f24486c464" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Queue__Handler.html#ab45a102a508e9727b108e8f24486c464">getPagination</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get pagination attribute of the object. </p>
</div>
</div>
<a class="anchor" id="a45e8c11ba9485041fa92c7c470a8f9f9"></a><!-- doxytag: member="Ticket_Queue_Handler::getTickets" ref="a45e8c11ba9485041fa92c7c470a8f9f9" args="($input, $user_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Queue__Handler.html#a45e8c11ba9485041fa92c7c470a8f9f9">getTickets</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>user_id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns the tickets that are related in someway defined by $input. </p>
<p>The $input parameter should be a string that defines what kind of queue should be loaded. A new pagination object will be instantiated and will load 10 entries, related to the $_GET['pagenum'] variable. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$input</td><td>identifier that defines what queue to load. </td></tr>
<tr><td class="paramname">$user_id</td><td>the id of the user that browses the queues, some queues can be depending on this. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array consisting of ticket objects, beware, the author &amp; category of a ticket, are objects on their own (no integers are used this time). </dd></dl>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a388a4a950e936f746d3b9c1b56450ce7"></a><!-- doxytag: member="Ticket_Queue_Handler::$pagination" ref="a388a4a950e936f746d3b9c1b56450ce7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$pagination<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classPagination.html" title="Handles returning arrays based on a given pagenumber.">Pagination</a> object, this way only a few tickets (related to that pagenumber) will be shown. </p>
</div>
</div>
<a class="anchor" id="a4a0b48f6ae2fcb248a4f0288c7c344a6"></a><!-- doxytag: member="Ticket_Queue_Handler::$queue" ref="a4a0b48f6ae2fcb248a4f0288c7c344a6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$queue<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The queue object, being used to get the queries and parameters. </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__handler_8php.html">ticket_queue_handler.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