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

1429 lines
67 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 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 Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="Ticket" -->
<p>class that handles most ticket related functions.
<a href="classTicket.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.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.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="classTicket.html#a435e7d7525d4bcd0ed5e34a469f3adf6">create</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">creates a new 'ticket' entry. <a href="#a435e7d7525d4bcd0ed5e34a469f3adf6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#ac17d9e1158fb77707da1f6cd3e425d54">load_With_TId</a> ($id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">loads the object's attributes. <a href="#ac17d9e1158fb77707da1f6cd3e425d54"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a842e4774e3b3601a005b995c02f7e883">update</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">update the objects attributes to the db. <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="classTicket.html#afca07df3cc25a0e1a15d3f69bd6afa62">hasInfo</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">check if a ticket has a ticket_info page or not. <a href="#afca07df3cc25a0e1a15d3f69bd6afa62"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#aa7af74696d9898008992c494cec136dd">getTId</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get tId attribute of the object. <a href="#aa7af74696d9898008992c494cec136dd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a92aa1d82129ec8cd803d64c28efcb30f">getTimestamp</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get timestamp attribute of the object in the format defined in the outputTime function of the Helperclass. <a href="#a92aa1d82129ec8cd803d64c28efcb30f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a95e859a4588a39a1824b717378a84c29">getTitle</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get title attribute of the object. <a href="#a95e859a4588a39a1824b717378a84c29"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a9d21636071f529e2154051d3ea6e5921">getStatus</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get status attribute of the object. <a href="#a9d21636071f529e2154051d3ea6e5921"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#aab26af198dc3a59295747084b85435ff">getStatusText</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get status attribute of the object in the form of text (string). <a href="#aab26af198dc3a59295747084b85435ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a689e9d131777e7f1219ee0d65b088cb3">getCategoryName</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get category attribute of the object in the form of text (string). <a href="#a689e9d131777e7f1219ee0d65b088cb3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#aa7a8055e5ee1eb792f29443ddb79c4d3">getQueue</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get queue attribute of the object. <a href="#aa7a8055e5ee1eb792f29443ddb79c4d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#addff2fc457fe07664f4eb39efcea45f9">getTicket_Category</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get ticket_category attribute of the object (int). <a href="#addff2fc457fe07664f4eb39efcea45f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a5286e30390ae3e1b274940286493dd24">getAuthor</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get author attribute of the object (int). <a href="#a5286e30390ae3e1b274940286493dd24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a1e7a3c168dcd0901a0d2669c67575b55">getPriority</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get priority attribute of the object (int). <a href="#a1e7a3c168dcd0901a0d2669c67575b55"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#ae07f7808a12f2789593722f3293bd105">getPriorityText</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get priority attribute of the object in the form of text (string). <a href="#ae07f7808a12f2789593722f3293bd105"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a8234a4e23319778d234b3957f8b5d06c">getAssigned</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get the user assigned to the ticket. <a href="#a8234a4e23319778d234b3957f8b5d06c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a34e17d1cc053a7b86ce2b58a3a347c7e">getForwardedGroupName</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get the name of the support group to whom the ticket is forwarded or return 0 in case not forwarded. <a href="#a34e17d1cc053a7b86ce2b58a3a347c7e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#aedbfa4efd5aaa96ac713817d12156f7e">getForwardedGroupId</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get the id of the support group to whom the ticket is forwarded or return 0 in case not forwarded. <a href="#aedbfa4efd5aaa96ac713817d12156f7e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a8c72dc7b09645b390043f5a4664e7c7f">setTId</a> ($id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set tId attribute of the object. <a href="#a8c72dc7b09645b390043f5a4664e7c7f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a4e05995d5cc78cdc9ffe72d864811ac6">setTimestamp</a> ($ts)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set timestamp attribute of the object. <a href="#a4e05995d5cc78cdc9ffe72d864811ac6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#ac765da6fa83b06ea39c0edc9b3e6c6c0">setTitle</a> ($t)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set title attribute of the object. <a href="#ac765da6fa83b06ea39c0edc9b3e6c6c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a66605893c4afc9855f1e0cf8ccccac09">setStatus</a> ($s)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set status attribute of the object. <a href="#a66605893c4afc9855f1e0cf8ccccac09"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a1595d3fe708fe4f453922054407a1c03">setQueue</a> ($q)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set queue attribute of the object. <a href="#a1595d3fe708fe4f453922054407a1c03"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a4e38b2a263b5a934b76cd77f026308c3">setTicket_Category</a> ($tc)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set ticket_category attribute of the object. <a href="#a4e38b2a263b5a934b76cd77f026308c3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a0c8f116992af7c8737c70119dae00d45">setAuthor</a> ($a)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set author attribute of the object. <a href="#a0c8f116992af7c8737c70119dae00d45"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a3080d0b46978a8f82022bbb6e5fc0c1c">setPriority</a> ($p)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set priority attribute of the object. <a href="#a3080d0b46978a8f82022bbb6e5fc0c1c"></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.html#a091d7ec56d4dc4bf980b81e8069b76d0">ticketExists</a> ($id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">check if a ticket exists. <a href="#a091d7ec56d4dc4bf980b81e8069b76d0"></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.html#aa728c6a1f8ddd7030acbf5a4ca913b50">getStatusArray</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return an array of the possible statuses <a href="#aa728c6a1f8ddd7030acbf5a4ca913b50"></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.html#a509625cccc0b41f4ab3a658df705b3dc">getPriorityArray</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return an array of the possible priorities <a href="#a509625cccc0b41f4ab3a658df705b3dc"></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.html#a00572e06f01ae1cadb5949f1b45e8f04">getEntireTicket</a> ($id, $view_as_admin)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return an entire ticket. <a href="#a00572e06f01ae1cadb5949f1b45e8f04"></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.html#aa426904463cd0eb50d9b2f4becdd242f">getTicketsOf</a> ($author)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return all tickets of a specific user. <a href="#aa426904463cd0eb50d9b2f4becdd242f"></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.html#a81b3285033bc3c9e89adfa8da34d61de">create_Ticket</a> ($title, $content, $category, $author, $real_author, $for_support_group=0, $extra_info=0)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">function that creates a new ticket. <a href="#a81b3285033bc3c9e89adfa8da34d61de"></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.html#a6da2625040e9f06c583e9303082c556f">updateTicketStatus</a> ($ticket_id, $newStatus, $author)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">updates the ticket's status. <a href="#a6da2625040e9f06c583e9303082c556f"></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.html#a64f08c8987c9eb00d4bfc9ef94e45326">updateTicketStatusAndPriority</a> ($ticket_id, $newStatus, $newPriority, $author)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">updates the ticket's status &amp; priority. <a href="#a64f08c8987c9eb00d4bfc9ef94e45326"></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.html#a3a4ce7e9c445dd245b3370304d0afd92">getLatestReply</a> ($ticket_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return the latest reply of a ticket <a href="#a3a4ce7e9c445dd245b3370304d0afd92"></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.html#af6568341f5052034440f79c0e74707a3">createReply</a> ($content, $author, $ticket_id, $hidden)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">create a new reply for a ticket. <a href="#af6568341f5052034440f79c0e74707a3"></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.html#a51c3d5b6f78de455619581fd3e591f17">assignTicket</a> ($user_id, $ticket_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">assign a ticket to a user. <a href="#a51c3d5b6f78de455619581fd3e591f17"></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.html#a8263a9c223957bb558a2c16d4431ca29">unAssignTicket</a> ($user_id, $ticket_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">unassign a ticket of a user. <a href="#a8263a9c223957bb558a2c16d4431ca29"></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.html#a3fdc6def6a0feaf4c2458811b8c75050">forwardTicket</a> ($user_id, $ticket_id, $group_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">forward a ticket to a specific support group. <a href="#a3fdc6def6a0feaf4c2458811b8c75050"></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.html#a3eda2fecc2433b6b6b3b957110e937ca">$tId</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The id of ticket. <a href="#a3eda2fecc2433b6b6b3b957110e937ca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a2b69de9676dd97c675cd4d9bcceb684c">$timestamp</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Timestamp of the ticket. <a href="#a2b69de9676dd97c675cd4d9bcceb684c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#ada57e7bb7c152edad18fe2f166188691">$title</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Title of the ticket. <a href="#ada57e7bb7c152edad18fe2f166188691"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a58391ea75f2d29d5d708d7050b641c33">$status</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Status of the ticket (0 = waiting on user reply, 1 = waiting on support, (2= not used atm), 3 = closed. <a href="#a58391ea75f2d29d5d708d7050b641c33"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a4a0b48f6ae2fcb248a4f0288c7c344a6">$queue</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">(not in use atm) <a href="#a4a0b48f6ae2fcb248a4f0288c7c344a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a86e470072892575063c478122fb65184">$ticket_category</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the id of the category belonging to the ticket <a href="#a86e470072892575063c478122fb65184"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#ac35b828f7d4064a7c9f849c255468ee3">$author</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The ticket_users id. <a href="#ac35b828f7d4064a7c9f849c255468ee3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket.html#a2677e505e860db863720ac4e216fd3f2">$priority</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The priority of the ticket where 0 = low, 3= supadupahigh. <a href="#a2677e505e860db863720ac4e216fd3f2"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>class that handles most ticket related functions. </p>
<p>the ticket class is used for most ticketing related functions, it also holds some wrapper functions. </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::__construct" ref="a095c5d389db211932136b53f25f39685" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.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="a51c3d5b6f78de455619581fd3e591f17"></a><!-- doxytag: member="Ticket::assignTicket" ref="a51c3d5b6f78de455619581fd3e591f17" args="($user_id, $ticket_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#a51c3d5b6f78de455619581fd3e591f17">assignTicket</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>user_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>ticket_id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>assign a ticket to a user. </p>
<p>Checks if the ticket exists, if so then it will try to assign the user to it, a log entry will be written about this. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$user_id</td><td>the id of user trying to be assigned to the ticket. </td></tr>
<tr><td class="paramname">$ticket_id</td><td>the id of the ticket that we try to assign to the user. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>SUCCESS_ASSIGNED, TICKET_NOT_EXISTING or ALREADY_ASSIGNED </dd></dl>
</div>
</div>
<a class="anchor" id="a435e7d7525d4bcd0ed5e34a469f3adf6"></a><!-- doxytag: member="Ticket::create" ref="a435e7d7525d4bcd0ed5e34a469f3adf6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a435e7d7525d4bcd0ed5e34a469f3adf6">create</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>creates a new 'ticket' entry. </p>
<p>this method will use the object's attributes for creating a new 'ticket' entry in the database. </p>
</div>
</div>
<a class="anchor" id="a81b3285033bc3c9e89adfa8da34d61de"></a><!-- doxytag: member="Ticket::create_Ticket" ref="a81b3285033bc3c9e89adfa8da34d61de" args="($title, $content, $category, $author, $real_author, $for_support_group=0, $extra_info=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#a81b3285033bc3c9e89adfa8da34d61de">create_Ticket</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>title</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>content</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>author</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>real_author</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>for_support_group</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>extra_info</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>function that creates a new ticket. </p>
<p>A new ticket will be created, in case the extra_info != 0 and the http request came from ingame, then a ticket_info page will be created. A log entry will be written, depending on the $real_authors value. In case the for_support_group parameter is set, the ticket will be forwarded immediately. Also the mail handler will create a new email that will be sent to the author to notify him that his ticket is freshly created. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$title</td><td>the title we want to give to the ticket. </td></tr>
<tr><td class="paramname">$content</td><td>the content we want to give to the starting post of the ticket. </td></tr>
<tr><td class="paramname">$category</td><td>the id of the category that should be related to the ticket. </td></tr>
<tr><td class="paramname">$author</td><td>the person who's id will be stored in the database as creator of the ticket. </td></tr>
<tr><td class="paramname">$real_author</td><td>should be the same id, or a moderator/admin who creates a ticket for another user (this is used for logging purposes). </td></tr>
<tr><td class="paramname">$for_support_group</td><td>in case you directly want to forward the ticket after creating it. (default value = 0 = don't forward) </td></tr>
<tr><td class="paramname">$extra_info</td><td>used for creating an ticket_info page related to the ticket, this only happens when the ticket is made ingame. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the created tickets id. </dd></dl>
</div>
</div>
<a class="anchor" id="af6568341f5052034440f79c0e74707a3"></a><!-- doxytag: member="Ticket::createReply" ref="af6568341f5052034440f79c0e74707a3" args="($content, $author, $ticket_id, $hidden)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#af6568341f5052034440f79c0e74707a3">createReply</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>content</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>author</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>ticket_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>hidden</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>create a new reply for a ticket. </p>
<p>A reply will only be added if the content isn't empty and if the ticket isn't closed. The ticket creator will be notified by email that someone else replied on his ticket. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$content</td><td>the content of the reply </td></tr>
<tr><td class="paramname">$author</td><td>the author of the reply </td></tr>
<tr><td class="paramname">$ticket_id</td><td>the id of the ticket to which we want to add the reply. </td></tr>
<tr><td class="paramname">$hidden</td><td>boolean that specifies if the reply should only be shown to mods/admins or all users. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3fdc6def6a0feaf4c2458811b8c75050"></a><!-- doxytag: member="Ticket::forwardTicket" ref="a3fdc6def6a0feaf4c2458811b8c75050" args="($user_id, $ticket_id, $group_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#a3fdc6def6a0feaf4c2458811b8c75050">forwardTicket</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>user_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>ticket_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>group_id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>forward a ticket to a specific support group. </p>
<p>Checks if the ticket exists, if so then it will try to forward the ticket to the support group specified, a log entry will be written about this. if no log entry should be written then the user_id should be 0, else te $user_id will be used in the log to specify who forwarded it. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$user_id</td><td>the id of user trying to forward the ticket. </td></tr>
<tr><td class="paramname">$ticket_id</td><td>the id of the ticket that we try to forward to a support group. </td></tr>
<tr><td class="paramname">$group_id</td><td>the id of the support group. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>SUCCESS_FORWARDED, TICKET_NOT_EXISTING or INVALID_SGROUP </dd></dl>
</div>
</div>
<a class="anchor" id="a8234a4e23319778d234b3957f8b5d06c"></a><!-- doxytag: member="Ticket::getAssigned" ref="a8234a4e23319778d234b3957f8b5d06c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a8234a4e23319778d234b3957f8b5d06c">getAssigned</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the user assigned to the ticket. </p>
<p>or return 0 in case not assigned. </p>
</div>
</div>
<a class="anchor" id="a5286e30390ae3e1b274940286493dd24"></a><!-- doxytag: member="Ticket::getAuthor" ref="a5286e30390ae3e1b274940286493dd24" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a5286e30390ae3e1b274940286493dd24">getAuthor</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get author attribute of the object (int). </p>
</div>
</div>
<a class="anchor" id="a689e9d131777e7f1219ee0d65b088cb3"></a><!-- doxytag: member="Ticket::getCategoryName" ref="a689e9d131777e7f1219ee0d65b088cb3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a689e9d131777e7f1219ee0d65b088cb3">getCategoryName</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get category attribute of the object in the form of text (string). </p>
</div>
</div>
<a class="anchor" id="a00572e06f01ae1cadb5949f1b45e8f04"></a><!-- doxytag: member="Ticket::getEntireTicket" ref="a00572e06f01ae1cadb5949f1b45e8f04" args="($id, $view_as_admin)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#a00572e06f01ae1cadb5949f1b45e8f04">getEntireTicket</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>view_as_admin</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return an entire ticket. </p>
<p>returns the ticket object and an array of all replies to that ticket. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$id</td><td>the id of the ticket. </td></tr>
<tr><td class="paramname">$view_as_admin</td><td>true if the viewer of the ticket is a mod, else false (depending on this it will also show the hidden comments) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array containing the 'ticket_obj' and a 'reply_array', which is an array containing all replies to that ticket. </dd></dl>
</div>
</div>
<a class="anchor" id="aedbfa4efd5aaa96ac713817d12156f7e"></a><!-- doxytag: member="Ticket::getForwardedGroupId" ref="aedbfa4efd5aaa96ac713817d12156f7e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#aedbfa4efd5aaa96ac713817d12156f7e">getForwardedGroupId</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the id of the support group to whom the ticket is forwarded or return 0 in case not forwarded. </p>
</div>
</div>
<a class="anchor" id="a34e17d1cc053a7b86ce2b58a3a347c7e"></a><!-- doxytag: member="Ticket::getForwardedGroupName" ref="a34e17d1cc053a7b86ce2b58a3a347c7e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a34e17d1cc053a7b86ce2b58a3a347c7e">getForwardedGroupName</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the name of the support group to whom the ticket is forwarded or return 0 in case not forwarded. </p>
</div>
</div>
<a class="anchor" id="a3a4ce7e9c445dd245b3370304d0afd92"></a><!-- doxytag: member="Ticket::getLatestReply" ref="a3a4ce7e9c445dd245b3370304d0afd92" args="($ticket_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#a3a4ce7e9c445dd245b3370304d0afd92">getLatestReply</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>ticket_id</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the latest reply of a ticket </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$ticket_id</td><td>the id of the ticket. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a ticket_reply object. </dd></dl>
</div>
</div>
<a class="anchor" id="a1e7a3c168dcd0901a0d2669c67575b55"></a><!-- doxytag: member="Ticket::getPriority" ref="a1e7a3c168dcd0901a0d2669c67575b55" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a1e7a3c168dcd0901a0d2669c67575b55">getPriority</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get priority attribute of the object (int). </p>
</div>
</div>
<a class="anchor" id="a509625cccc0b41f4ab3a658df705b3dc"></a><!-- doxytag: member="Ticket::getPriorityArray" ref="a509625cccc0b41f4ab3a658df705b3dc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#a509625cccc0b41f4ab3a658df705b3dc">getPriorityArray</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return an array of the possible priorities </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array containing the string values that represent the different priorities. </dd></dl>
</div>
</div>
<a class="anchor" id="ae07f7808a12f2789593722f3293bd105"></a><!-- doxytag: member="Ticket::getPriorityText" ref="ae07f7808a12f2789593722f3293bd105" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#ae07f7808a12f2789593722f3293bd105">getPriorityText</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get priority attribute of the object in the form of text (string). </p>
</div>
</div>
<a class="anchor" id="aa7a8055e5ee1eb792f29443ddb79c4d3"></a><!-- doxytag: member="Ticket::getQueue" ref="aa7a8055e5ee1eb792f29443ddb79c4d3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#aa7a8055e5ee1eb792f29443ddb79c4d3">getQueue</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get queue attribute of the object. </p>
</div>
</div>
<a class="anchor" id="a9d21636071f529e2154051d3ea6e5921"></a><!-- doxytag: member="Ticket::getStatus" ref="a9d21636071f529e2154051d3ea6e5921" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a9d21636071f529e2154051d3ea6e5921">getStatus</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get status attribute of the object. </p>
</div>
</div>
<a class="anchor" id="aa728c6a1f8ddd7030acbf5a4ca913b50"></a><!-- doxytag: member="Ticket::getStatusArray" ref="aa728c6a1f8ddd7030acbf5a4ca913b50" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#aa728c6a1f8ddd7030acbf5a4ca913b50">getStatusArray</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return an array of the possible statuses </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array containing the string values that represent the different statuses. </dd></dl>
</div>
</div>
<a class="anchor" id="aab26af198dc3a59295747084b85435ff"></a><!-- doxytag: member="Ticket::getStatusText" ref="aab26af198dc3a59295747084b85435ff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#aab26af198dc3a59295747084b85435ff">getStatusText</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get status attribute of the object in the form of text (string). </p>
</div>
</div>
<a class="anchor" id="addff2fc457fe07664f4eb39efcea45f9"></a><!-- doxytag: member="Ticket::getTicket_Category" ref="addff2fc457fe07664f4eb39efcea45f9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#addff2fc457fe07664f4eb39efcea45f9">getTicket_Category</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get ticket_category attribute of the object (int). </p>
</div>
</div>
<a class="anchor" id="aa426904463cd0eb50d9b2f4becdd242f"></a><!-- doxytag: member="Ticket::getTicketsOf" ref="aa426904463cd0eb50d9b2f4becdd242f" args="($author)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#aa426904463cd0eb50d9b2f4becdd242f">getTicketsOf</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>author</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return all tickets of a specific user. </p>
<p>an array of all tickets created by a specific user are returned by this function. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$author</td><td>the id of the user of whom we want all tickets from. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array containing all ticket objects related to a user. </dd></dl>
</div>
</div>
<a class="anchor" id="aa7af74696d9898008992c494cec136dd"></a><!-- doxytag: member="Ticket::getTId" ref="aa7af74696d9898008992c494cec136dd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#aa7af74696d9898008992c494cec136dd">getTId</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get tId attribute of the object. </p>
</div>
</div>
<a class="anchor" id="a92aa1d82129ec8cd803d64c28efcb30f"></a><!-- doxytag: member="Ticket::getTimestamp" ref="a92aa1d82129ec8cd803d64c28efcb30f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a92aa1d82129ec8cd803d64c28efcb30f">getTimestamp</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get timestamp attribute of the object in the format defined in the outputTime function of the Helperclass. </p>
</div>
</div>
<a class="anchor" id="a95e859a4588a39a1824b717378a84c29"></a><!-- doxytag: member="Ticket::getTitle" ref="a95e859a4588a39a1824b717378a84c29" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a95e859a4588a39a1824b717378a84c29">getTitle</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get title attribute of the object. </p>
</div>
</div>
<a class="anchor" id="afca07df3cc25a0e1a15d3f69bd6afa62"></a><!-- doxytag: member="Ticket::hasInfo" ref="afca07df3cc25a0e1a15d3f69bd6afa62" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#afca07df3cc25a0e1a15d3f69bd6afa62">hasInfo</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>check if a ticket has a ticket_info page or not. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true or false </dd></dl>
</div>
</div>
<a class="anchor" id="ac17d9e1158fb77707da1f6cd3e425d54"></a><!-- doxytag: member="Ticket::load_With_TId" ref="ac17d9e1158fb77707da1f6cd3e425d54" args="($id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#ac17d9e1158fb77707da1f6cd3e425d54">load_With_TId</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 TId (ticket id). </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$id</td><td>the id of the ticket that should be loaded </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8bdfe0a5256e35367225bcd6d278ef21"></a><!-- doxytag: member="Ticket::set" ref="a8bdfe0a5256e35367225bcd6d278ef21" args="($values)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.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('TId' =&gt; ticket_id, 'Title' =&gt; title, 'Status'=&gt; status, 'Timestamp' =&gt; ts, 'Queue' =&gt; queue, '<a class="el" href="classTicket__Category.html" title="Class related to the ticket categories.">Ticket_Category</a>' =&gt; tc, 'Author' =&gt; author, 'Priority' =&gt; priority). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0c8f116992af7c8737c70119dae00d45"></a><!-- doxytag: member="Ticket::setAuthor" ref="a0c8f116992af7c8737c70119dae00d45" args="($a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a0c8f116992af7c8737c70119dae00d45">setAuthor</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>a</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set author attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$a</td><td>author of the ticket </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3080d0b46978a8f82022bbb6e5fc0c1c"></a><!-- doxytag: member="Ticket::setPriority" ref="a3080d0b46978a8f82022bbb6e5fc0c1c" args="($p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a3080d0b46978a8f82022bbb6e5fc0c1c">setPriority</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set priority attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$p</td><td>priority of the ticket </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1595d3fe708fe4f453922054407a1c03"></a><!-- doxytag: member="Ticket::setQueue" ref="a1595d3fe708fe4f453922054407a1c03" args="($q)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a1595d3fe708fe4f453922054407a1c03">setQueue</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 queue attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$q</td><td>queue of the ticket </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a66605893c4afc9855f1e0cf8ccccac09"></a><!-- doxytag: member="Ticket::setStatus" ref="a66605893c4afc9855f1e0cf8ccccac09" args="($s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a66605893c4afc9855f1e0cf8ccccac09">setStatus</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 status attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$s</td><td>status of the ticket(int) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4e38b2a263b5a934b76cd77f026308c3"></a><!-- doxytag: member="Ticket::setTicket_Category" ref="a4e38b2a263b5a934b76cd77f026308c3" args="($tc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a4e38b2a263b5a934b76cd77f026308c3">setTicket_Category</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>tc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set ticket_category attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$tc</td><td>ticket_category id of the ticket(int) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8c72dc7b09645b390043f5a4664e7c7f"></a><!-- doxytag: member="Ticket::setTId" ref="a8c72dc7b09645b390043f5a4664e7c7f" args="($id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a8c72dc7b09645b390043f5a4664e7c7f">setTId</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>set tId attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$id</td><td>integer id of the ticket </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4e05995d5cc78cdc9ffe72d864811ac6"></a><!-- doxytag: member="Ticket::setTimestamp" ref="a4e05995d5cc78cdc9ffe72d864811ac6" args="($ts)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a4e05995d5cc78cdc9ffe72d864811ac6">setTimestamp</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>ts</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set timestamp attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$ts</td><td>timestamp of the ticket </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac765da6fa83b06ea39c0edc9b3e6c6c0"></a><!-- doxytag: member="Ticket::setTitle" ref="ac765da6fa83b06ea39c0edc9b3e6c6c0" args="($t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#ac765da6fa83b06ea39c0edc9b3e6c6c0">setTitle</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 title attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$t</td><td>title of the ticket </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a091d7ec56d4dc4bf980b81e8069b76d0"></a><!-- doxytag: member="Ticket::ticketExists" ref="a091d7ec56d4dc4bf980b81e8069b76d0" args="($id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#a091d7ec56d4dc4bf980b81e8069b76d0">ticketExists</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>check if a ticket exists. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$id</td><td>the id of the ticket to be checked. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the ticket exists, else false. </dd></dl>
</div>
</div>
<a class="anchor" id="a8263a9c223957bb558a2c16d4431ca29"></a><!-- doxytag: member="Ticket::unAssignTicket" ref="a8263a9c223957bb558a2c16d4431ca29" args="($user_id, $ticket_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#a8263a9c223957bb558a2c16d4431ca29">unAssignTicket</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>user_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>ticket_id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>unassign a ticket of a user. </p>
<p>Checks if the ticket exists, if so then it will try to unassign the user of it, a log entry will be written about this. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$user_id</td><td>the id of user trying to be assigned to the ticket. </td></tr>
<tr><td class="paramname">$ticket_id</td><td>the id of the ticket that we try to assign to the user. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>SUCCESS_UNASSIGNED, TICKET_NOT_EXISTING or NOT_ASSIGNED </dd></dl>
</div>
</div>
<a class="anchor" id="a842e4774e3b3601a005b995c02f7e883"></a><!-- doxytag: member="Ticket::update" ref="a842e4774e3b3601a005b995c02f7e883" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket.html#a842e4774e3b3601a005b995c02f7e883">update</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>update the objects attributes to the db. </p>
</div>
</div>
<a class="anchor" id="a6da2625040e9f06c583e9303082c556f"></a><!-- doxytag: member="Ticket::updateTicketStatus" ref="a6da2625040e9f06c583e9303082c556f" args="($ticket_id, $newStatus, $author)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#a6da2625040e9f06c583e9303082c556f">updateTicketStatus</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>ticket_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>newStatus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>author</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>updates the ticket's status. </p>
<p>A log entry about this will be created only if the newStatus is different from the current status. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$ticket_id</td><td>the id of the ticket of which we want to change the status. </td></tr>
<tr><td class="paramname">$newStatus</td><td>the new status value (integer) </td></tr>
<tr><td class="paramname">$author</td><td>the user (id) that performed the update status action </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a64f08c8987c9eb00d4bfc9ef94e45326"></a><!-- doxytag: member="Ticket::updateTicketStatusAndPriority" ref="a64f08c8987c9eb00d4bfc9ef94e45326" args="($ticket_id, $newStatus, $newPriority, $author)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket.html#a64f08c8987c9eb00d4bfc9ef94e45326">updateTicketStatusAndPriority</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>ticket_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>newStatus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>newPriority</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>author</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>updates the ticket's status &amp; priority. </p>
<p>A log entry about this will be created only if the newStatus is different from the current status and also when the newPriority is different from the current priority. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>break this function up into a updateStatus (already exists) and updatePriority function and perhaps write a wrapper function for the combo. </dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$ticket_id</td><td>the id of the ticket of which we want to change the status &amp; priority </td></tr>
<tr><td class="paramname">$newStatus</td><td>the new status value (integer) </td></tr>
<tr><td class="paramname">$newPriority</td><td>the new priority value (integer) </td></tr>
<tr><td class="paramname">$author</td><td>the user (id) that performed the update </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="ac35b828f7d4064a7c9f849c255468ee3"></a><!-- doxytag: member="Ticket::$author" ref="ac35b828f7d4064a7c9f849c255468ee3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$author<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The ticket_users id. </p>
</div>
</div>
<a class="anchor" id="a2677e505e860db863720ac4e216fd3f2"></a><!-- doxytag: member="Ticket::$priority" ref="a2677e505e860db863720ac4e216fd3f2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$priority<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The priority of the ticket where 0 = low, 3= supadupahigh. </p>
</div>
</div>
<a class="anchor" id="a4a0b48f6ae2fcb248a4f0288c7c344a6"></a><!-- doxytag: member="Ticket::$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>(not in use atm) </p>
</div>
</div>
<a class="anchor" id="a58391ea75f2d29d5d708d7050b641c33"></a><!-- doxytag: member="Ticket::$status" ref="a58391ea75f2d29d5d708d7050b641c33" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$status<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Status of the ticket (0 = waiting on user reply, 1 = waiting on support, (2= not used atm), 3 = closed. </p>
</div>
</div>
<a class="anchor" id="a86e470072892575063c478122fb65184"></a><!-- doxytag: member="Ticket::$ticket_category" ref="a86e470072892575063c478122fb65184" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$ticket_category<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the id of the category belonging to the ticket </p>
</div>
</div>
<a class="anchor" id="a3eda2fecc2433b6b6b3b957110e937ca"></a><!-- doxytag: member="Ticket::$tId" ref="a3eda2fecc2433b6b6b3b957110e937ca" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$tId<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The id of ticket. </p>
</div>
</div>
<a class="anchor" id="a2b69de9676dd97c675cd4d9bcceb684c"></a><!-- doxytag: member="Ticket::$timestamp" ref="a2b69de9676dd97c675cd4d9bcceb684c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$timestamp<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Timestamp of the ticket. </p>
</div>
</div>
<a class="anchor" id="ada57e7bb7c152edad18fe2f166188691"></a><!-- doxytag: member="Ticket::$title" ref="ada57e7bb7c152edad18fe2f166188691" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$title<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Title of the ticket. </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_8php.html">ticket.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