khanat-opennel-code/code/web/docs/ams/html/classTicket__Log.html

763 lines
35 KiB
HTML

<!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_Log 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_Log Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="Ticket_Log" -->
<p>Class that handles the logging.
<a href="classTicket__Log.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__Log.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__Log.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__Log.html#a76e8e991002c7e408f7b182556cdeade">load_With_TLogId</a> ($id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">loads the object's attributes. <a href="#a76e8e991002c7e408f7b182556cdeade"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Log.html#a842e4774e3b3601a005b995c02f7e883">update</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">update attributes of the object 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__Log.html#ab174d340ee116d8cc3aa377003421fc5">getTLogId</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get tLogId attribute of the object. <a href="#ab174d340ee116d8cc3aa377003421fc5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Log.html#a92aa1d82129ec8cd803d64c28efcb30f">getTimestamp</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get timestamp attribute of the object. <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__Log.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__Log.html#a5286e30390ae3e1b274940286493dd24">getAuthor</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get author attribute of the object. <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__Log.html#a42ddf34a72af750b7013fa309b67e46c">getTicket</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get ticket attribute of the object. <a href="#a42ddf34a72af750b7013fa309b67e46c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Log.html#a189a4abe5faf11f4320d5d3f1d3d1715">getAction</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get the action id out of the query by decoding it. <a href="#a189a4abe5faf11f4320d5d3f1d3d1715"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Log.html#a88ec9370bcbdb60301f89e401c9e64e1">getArgument</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get the argument out of the query by decoding it. <a href="#a88ec9370bcbdb60301f89e401c9e64e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Log.html#ac760071c0ce36337c16d8146fcb3bade">getActionTextArray</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get the action text(string) array. <a href="#ac760071c0ce36337c16d8146fcb3bade"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Log.html#aca708aae8c7320e11d9e08936ec74dec">setTLogId</a> ($id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set tLogId attribute of the object. <a href="#aca708aae8c7320e11d9e08936ec74dec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Log.html#aa8903a0020a17d745524806f4e751f4c">setTimestamp</a> ($t)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set timestamp attribute of the object. <a href="#aa8903a0020a17d745524806f4e751f4c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Log.html#adbd6075ec5d3bd84122e52b0134ed8e7">setQuery</a> ($q)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set query attribute of the object. <a href="#adbd6075ec5d3bd84122e52b0134ed8e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Log.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__Log.html#a47c6ae5b3cd713fdbf0a7f4d568b7c27">setTicket</a> ($t)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set ticket attribute of the object. <a href="#a47c6ae5b3cd713fdbf0a7f4d568b7c27"></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__Log.html#a37ad4d95b0bb2d5a6dfc2dd7c3744292">getLogsOfTicket</a> ($ticket_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return all log entries related to a ticket. <a href="#a37ad4d95b0bb2d5a6dfc2dd7c3744292"></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__Log.html#a345a2da9c23780c7e6aef7134baa1749">createLogEntry</a> ($ticket_id, $author_id, $action, $arg=-1)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">create a new log entry. <a href="#a345a2da9c23780c7e6aef7134baa1749"></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__Log.html#a001ec13f64bb026b1c8a3b3bd02ee22b">constr_TLogId</a> ($id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return constructed element based on TLogId <a href="#a001ec13f64bb026b1c8a3b3bd02ee22b"></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__Log.html#aeaf1c995cc807afe241f6e7bdc684921">getAllLogs</a> ($ticket_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return all log entries related to a ticket. <a href="#aeaf1c995cc807afe241f6e7bdc684921"></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__Log.html#a734657bd8aac85b5a33e03646c17eb65">$tLogId</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The id of the log entry. <a href="#a734657bd8aac85b5a33e03646c17eb65"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Log.html#a2b69de9676dd97c675cd4d9bcceb684c">$timestamp</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The timestamp of the log entry. <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__Log.html#af59a5f7cd609e592c41dc3643efd3c98">$query</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The query (json encoded array containing action id &amp; argument) <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__Log.html#ac35b828f7d4064a7c9f849c255468ee3">$author</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">author of the log <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__Log.html#abf7832c7c53a3be2ca8a8fc305006bb0">$ticket</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the id of the ticket related to the log entry <a href="#abf7832c7c53a3be2ca8a8fc305006bb0"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that handles the logging. </p>
<p>The logging will be used when a ticket is created, a reply is added, if someone views a ticket, if someone assigns a ticket to him or if someone forwards a ticket. This class provides functions to get retrieve those logs and also make them.</p>
<p>-the Action IDs being used are:</p>
<ol type="1">
<li>User X Created ticket</li>
<li>Admin X created ticket for arg</li>
<li>Read ticket</li>
<li>Added Reply ID: arg to ticket</li>
<li>Changed status to arg</li>
<li>Changed Priority to arg</li>
<li>assigned to the ticket</li>
<li>forwarded ticket to support group arg</li>
<li>unassigned to the ticket</li>
</ol>
<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_Log::__construct" ref="a095c5d389db211932136b53f25f39685" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.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="a001ec13f64bb026b1c8a3b3bd02ee22b"></a><!-- doxytag: member="Ticket_Log::constr_TLogId" ref="a001ec13f64bb026b1c8a3b3bd02ee22b" args="($id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket__Log.html#a001ec13f64bb026b1c8a3b3bd02ee22b">constr_TLogId</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>return constructed element based on TLogId </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$id</td><td>ticket_log id of the entry that we want to load into our object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>constructed ticket_log object. </dd></dl>
</div>
</div>
<a class="anchor" id="a345a2da9c23780c7e6aef7134baa1749"></a><!-- doxytag: member="Ticket_Log::createLogEntry" ref="a345a2da9c23780c7e6aef7134baa1749" args="($ticket_id, $author_id, $action, $arg=&#45;1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket__Log.html#a345a2da9c23780c7e6aef7134baa1749">createLogEntry</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>author_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>action</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>arg</em> = <code>-1</code>&#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 log entry. </p>
<p>It will check if the $TICKET_LOGGING global var is true, this var is used to turn logging on and off. In case it's on, the log message will be stored. the action id and argument (which is -1 by default), will be json encoded and stored in the query field in the db. </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 related to the new log entry </td></tr>
<tr><td class="paramname">$author_id</td><td>the id of the user that instantiated the logging. </td></tr>
<tr><td class="paramname">$action</td><td>the action id (see the list in the class description) </td></tr>
<tr><td class="paramname">$arg</td><td>argument for the action (default = -1) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a189a4abe5faf11f4320d5d3f1d3d1715"></a><!-- doxytag: member="Ticket_Log::getAction" ref="a189a4abe5faf11f4320d5d3f1d3d1715" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.html#a189a4abe5faf11f4320d5d3f1d3d1715">getAction</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the action id out of the query by decoding it. </p>
</div>
</div>
<a class="anchor" id="ac760071c0ce36337c16d8146fcb3bade"></a><!-- doxytag: member="Ticket_Log::getActionTextArray" ref="ac760071c0ce36337c16d8146fcb3bade" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.html#ac760071c0ce36337c16d8146fcb3bade">getActionTextArray</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the action text(string) array. </p>
<p>this is being read from the language .ini files. </p>
</div>
</div>
<a class="anchor" id="aeaf1c995cc807afe241f6e7bdc684921"></a><!-- doxytag: member="Ticket_Log::getAllLogs" ref="aeaf1c995cc807afe241f6e7bdc684921" args="($ticket_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket__Log.html#aeaf1c995cc807afe241f6e7bdc684921">getAllLogs</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 all log entries related to 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 of which we want all related log entries returned. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array of ticket_log objects, here the author is an integer. </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000005">Todo:</a></b></dt><dd>only use one of the 2 comparable functions in the future and make the other depricated. </dd></dl>
</div>
</div>
<a class="anchor" id="a88ec9370bcbdb60301f89e401c9e64e1"></a><!-- doxytag: member="Ticket_Log::getArgument" ref="a88ec9370bcbdb60301f89e401c9e64e1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.html#a88ec9370bcbdb60301f89e401c9e64e1">getArgument</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the argument out of the query by decoding it. </p>
</div>
</div>
<a class="anchor" id="a5286e30390ae3e1b274940286493dd24"></a><!-- doxytag: member="Ticket_Log::getAuthor" ref="a5286e30390ae3e1b274940286493dd24" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.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. </p>
</div>
</div>
<a class="anchor" id="a37ad4d95b0bb2d5a6dfc2dd7c3744292"></a><!-- doxytag: member="Ticket_Log::getLogsOfTicket" ref="a37ad4d95b0bb2d5a6dfc2dd7c3744292" args="($ticket_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket__Log.html#a37ad4d95b0bb2d5a6dfc2dd7c3744292">getLogsOfTicket</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 all log entries related to 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 of which we want all related log entries returned. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array of ticket_log objects, be aware that the author in the ticket_log object is a ticket_user object on its own (so not a simple integer). </dd></dl>
</div>
</div>
<a class="anchor" id="a55f162785567258fe5138af282e588c2"></a><!-- doxytag: member="Ticket_Log::getQuery" ref="a55f162785567258fe5138af282e588c2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.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="a42ddf34a72af750b7013fa309b67e46c"></a><!-- doxytag: member="Ticket_Log::getTicket" ref="a42ddf34a72af750b7013fa309b67e46c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.html#a42ddf34a72af750b7013fa309b67e46c">getTicket</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get ticket attribute of the object. </p>
</div>
</div>
<a class="anchor" id="a92aa1d82129ec8cd803d64c28efcb30f"></a><!-- doxytag: member="Ticket_Log::getTimestamp" ref="a92aa1d82129ec8cd803d64c28efcb30f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.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. </p>
</div>
</div>
<a class="anchor" id="ab174d340ee116d8cc3aa377003421fc5"></a><!-- doxytag: member="Ticket_Log::getTLogId" ref="ab174d340ee116d8cc3aa377003421fc5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.html#ab174d340ee116d8cc3aa377003421fc5">getTLogId</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get tLogId attribute of the object. </p>
</div>
</div>
<a class="anchor" id="a76e8e991002c7e408f7b182556cdeade"></a><!-- doxytag: member="Ticket_Log::load_With_TLogId" ref="a76e8e991002c7e408f7b182556cdeade" args="($id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.html#a76e8e991002c7e408f7b182556cdeade">load_With_TLogId</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 ticket_log entries ID (TLogId). </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_log entry that should be loaded </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8bdfe0a5256e35367225bcd6d278ef21"></a><!-- doxytag: member="Ticket_Log::set" ref="a8bdfe0a5256e35367225bcd6d278ef21" args="($values)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.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. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0c8f116992af7c8737c70119dae00d45"></a><!-- doxytag: member="Ticket_Log::setAuthor" ref="a0c8f116992af7c8737c70119dae00d45" args="($a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.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>integer id of the user who created the log entry </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adbd6075ec5d3bd84122e52b0134ed8e7"></a><!-- doxytag: member="Ticket_Log::setQuery" ref="adbd6075ec5d3bd84122e52b0134ed8e7" args="($q)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.html#adbd6075ec5d3bd84122e52b0134ed8e7">setQuery</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>q</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set query attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$q</td><td>the encoded query </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a47c6ae5b3cd713fdbf0a7f4d568b7c27"></a><!-- doxytag: member="Ticket_Log::setTicket" ref="a47c6ae5b3cd713fdbf0a7f4d568b7c27" args="($t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.html#a47c6ae5b3cd713fdbf0a7f4d568b7c27">setTicket</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 ticket attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$t</td><td>integer id of ticket of which the log entry is related to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa8903a0020a17d745524806f4e751f4c"></a><!-- doxytag: member="Ticket_Log::setTimestamp" ref="aa8903a0020a17d745524806f4e751f4c" args="($t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.html#aa8903a0020a17d745524806f4e751f4c">setTimestamp</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 timestamp attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$t</td><td>timestamp of the log entry </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aca708aae8c7320e11d9e08936ec74dec"></a><!-- doxytag: member="Ticket_Log::setTLogId" ref="aca708aae8c7320e11d9e08936ec74dec" args="($id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.html#aca708aae8c7320e11d9e08936ec74dec">setTLogId</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 tLogId 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 log entry </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a842e4774e3b3601a005b995c02f7e883"></a><!-- doxytag: member="Ticket_Log::update" ref="a842e4774e3b3601a005b995c02f7e883" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Log.html#a842e4774e3b3601a005b995c02f7e883">update</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>update attributes of the object to the DB. </p>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="ac35b828f7d4064a7c9f849c255468ee3"></a><!-- doxytag: member="Ticket_Log::$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>author of the log </p>
</div>
</div>
<a class="anchor" id="af59a5f7cd609e592c41dc3643efd3c98"></a><!-- doxytag: member="Ticket_Log::$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 (json encoded array containing action id &amp; argument) </p>
</div>
</div>
<a class="anchor" id="abf7832c7c53a3be2ca8a8fc305006bb0"></a><!-- doxytag: member="Ticket_Log::$ticket" ref="abf7832c7c53a3be2ca8a8fc305006bb0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$ticket<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the id of the ticket related to the log entry </p>
</div>
</div>
<a class="anchor" id="a2b69de9676dd97c675cd4d9bcceb684c"></a><!-- doxytag: member="Ticket_Log::$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>The timestamp of the log entry. </p>
</div>
</div>
<a class="anchor" id="a734657bd8aac85b5a33e03646c17eb65"></a><!-- doxytag: member="Ticket_Log::$tLogId" ref="a734657bd8aac85b5a33e03646c17eb65" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$tLogId<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The id of the log entry. </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__log_8php.html">ticket_log.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>