khanat-opennel-code/code/ryzom/tools/server/ryzom_ams_docs/html/classForwarded.html

416 lines
20 KiB
HTML
Raw Normal View 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: Forwarded 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 style="padding-left: 0.5em;">
<div id="projectname">Ryzom Account Management System
</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>Classes</span></a></li>
<li><a href="dirs.html"><span>Directories</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>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</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">Forwarded Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="Forwarded" -->
<p>Handles the forwarding of a ticket to a support_group.
<a href="classForwarded.html#details">More...</a></p>
<p><a href="classForwarded-members.html">List of all members.</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="classForwarded.html#a9650a496b9c85e29d543374185d7d602">__construct</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor. <a href="#a9650a496b9c85e29d543374185d7d602"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwarded.html#ab2dfe7ba68ff867277ce008027561b62">set</a> ($values)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">sets the object's attributes. <a href="#ab2dfe7ba68ff867277ce008027561b62"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwarded.html#abf271dbbb38d1be6df0a2e0fd0345c0c">create</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">creates a new 'forwarded' entry. <a href="#abf271dbbb38d1be6df0a2e0fd0345c0c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwarded.html#aa4aef6d29496ca0a802bf2398d7e6192">delete</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">deletes an existing 'forwarded' entry. <a href="#aa4aef6d29496ca0a802bf2398d7e6192"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwarded.html#a9ef9ba4dff566a32fb08fe1bb3e36740">load</a> ($ticket_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">loads the object's attributes. <a href="#a9ef9ba4dff566a32fb08fe1bb3e36740"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6269c9b2300e371234ed45b622125be5"></a><!-- doxytag: member="Forwarded::getGroup" ref="a6269c9b2300e371234ed45b622125be5" args="()" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwarded.html#a6269c9b2300e371234ed45b622125be5">getGroup</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get group attribute of the object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a842cd8941a2a80fe72eeb6086e88d9fa"></a><!-- doxytag: member="Forwarded::getTicket" ref="a842cd8941a2a80fe72eeb6086e88d9fa" args="()" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwarded.html#a842cd8941a2a80fe72eeb6086e88d9fa">getTicket</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get ticket attribute of the object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwarded.html#ae79dfb98cc8785d28ef4acff4ea3ddf2">setGroup</a> ($g)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set group attribute of the object. <a href="#ae79dfb98cc8785d28ef4acff4ea3ddf2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwarded.html#a8885583370e3d29c42bdd9332f7e0398">setTicket</a> ($t)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set ticket attribute of the object. <a href="#a8885583370e3d29c42bdd9332f7e0398"></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="classForwarded.html#a6e65be335e132dc4a2b06abc4815d730">forwardTicket</a> ($group_id, $ticket_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Forward a ticket to a group, also removes the previous group where it was forwarded to. <a href="#a6e65be335e132dc4a2b06abc4815d730"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwarded.html#a98de9698c91fbc552eba480f04c05db3">getSGroupOfTicket</a> ($ticket_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get the id of the group a ticket is forwarded to. <a href="#a98de9698c91fbc552eba480f04c05db3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwarded.html#a4d0bd0223c5655e8232a17e53a03cc80">isForwarded</a> ($ticket_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">check if the ticket is forwarded <a href="#a4d0bd0223c5655e8232a17e53a03cc80"></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"><a class="anchor" id="a66cff5a347920873ffe30f715065d340"></a><!-- doxytag: member="Forwarded::$group" ref="a66cff5a347920873ffe30f715065d340" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwarded.html#a66cff5a347920873ffe30f715065d340">$group</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The id of the group to which the ticket is being forwarded. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5345ede5ff6a41143a382ad0102958e"></a><!-- doxytag: member="Forwarded::$ticket" ref="ad5345ede5ff6a41143a382ad0102958e" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwarded.html#ad5345ede5ff6a41143a382ad0102958e">$ticket</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The id of the ticket being forwarded. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Handles the forwarding of a ticket to a support_group. </p>
<p>This is being used to transfer tickets to different groups (eg Developers, Website-Team, SupportGroup etc..) The idea is that someone can easily forward a ticket to a group and by doing that, the moderators that are in that group will receive the ticket in their todo queue. </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="a9650a496b9c85e29d543374185d7d602"></a><!-- doxytag: member="Forwarded::__construct" ref="a9650a496b9c85e29d543374185d7d602" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classForwarded.html#a9650a496b9c85e29d543374185d7d602">Forwarded::__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="abf271dbbb38d1be6df0a2e0fd0345c0c"></a><!-- doxytag: member="Forwarded::create" ref="abf271dbbb38d1be6df0a2e0fd0345c0c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classForwarded.html#abf271dbbb38d1be6df0a2e0fd0345c0c">Forwarded::create</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>creates a new 'forwarded' entry. </p>
<p>this method will use the object's attributes for creating a new 'forwarded' entry in the database. </p>
</div>
</div>
<a class="anchor" id="aa4aef6d29496ca0a802bf2398d7e6192"></a><!-- doxytag: member="Forwarded::delete" ref="aa4aef6d29496ca0a802bf2398d7e6192" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classForwarded.html#aa4aef6d29496ca0a802bf2398d7e6192">Forwarded::delete</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>deletes an existing 'forwarded' entry. </p>
<p>this method will use the object's attributes for deleting an existing 'forwarded' entry in the database. </p>
</div>
</div>
<a class="anchor" id="a6e65be335e132dc4a2b06abc4815d730"></a><!-- doxytag: member="Forwarded::forwardTicket" ref="a6e65be335e132dc4a2b06abc4815d730" args="($group_id, $ticket_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classForwarded.html#a6e65be335e132dc4a2b06abc4815d730">Forwarded::forwardTicket</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>group_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>Forward a ticket to a group, also removes the previous group where it was forwarded to. </p>
<p>It will first check if the ticket is already forwarded, if that's the case, it will delete that entry. Afterwards it creates the new forward entry </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$group_id</td><td>the id of the support group we want to forward the ticket to. </td></tr>
<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 string, if assigning succeedded "SUCCESS_FORWARDED" will be returned. </dd></dl>
</div>
</div>
<a class="anchor" id="a98de9698c91fbc552eba480f04c05db3"></a><!-- doxytag: member="Forwarded::getSGroupOfTicket" ref="a98de9698c91fbc552eba480f04c05db3" args="($ticket_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classForwarded.html#a98de9698c91fbc552eba480f04c05db3">Forwarded::getSGroupOfTicket</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>get the id of the group a ticket is forwarded to. </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>the id of the group </dd></dl>
</div>
</div>
<a class="anchor" id="a4d0bd0223c5655e8232a17e53a03cc80"></a><!-- doxytag: member="Forwarded::isForwarded" ref="a4d0bd0223c5655e8232a17e53a03cc80" args="($ticket_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classForwarded.html#a4d0bd0223c5655e8232a17e53a03cc80">Forwarded::isForwarded</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>check if the ticket is forwarded </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>returns true if the ticket is forwarded, else return false; </dd></dl>
</div>
</div>
<a class="anchor" id="a9ef9ba4dff566a32fb08fe1bb3e36740"></a><!-- doxytag: member="Forwarded::load" ref="a9ef9ba4dff566a32fb08fe1bb3e36740" args="($ticket_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classForwarded.html#a9ef9ba4dff566a32fb08fe1bb3e36740">Forwarded::load</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>ticket_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_id, it will put the matching group_id and the ticket_id into the attributes. </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 that should be loaded </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab2dfe7ba68ff867277ce008027561b62"></a><!-- doxytag: member="Forwarded::set" ref="ab2dfe7ba68ff867277ce008027561b62" args="($values)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classForwarded.html#ab2dfe7ba68ff867277ce008027561b62">Forwarded::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('Group' =&gt; group_id, '<a class="el" href="classTicket.html" title="class that handles most ticket related functions.">Ticket</a>' =&gt; ticket_id). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae79dfb98cc8785d28ef4acff4ea3ddf2"></a><!-- doxytag: member="Forwarded::setGroup" ref="ae79dfb98cc8785d28ef4acff4ea3ddf2" args="($g)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classForwarded.html#ae79dfb98cc8785d28ef4acff4ea3ddf2">Forwarded::setGroup</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>g</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set group attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$g</td><td>integer id of the group </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8885583370e3d29c42bdd9332f7e0398"></a><!-- doxytag: member="Forwarded::setTicket" ref="a8885583370e3d29c42bdd9332f7e0398" args="($t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classForwarded.html#a8885583370e3d29c42bdd9332f7e0398">Forwarded::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 the ticket </td></tr>
</table>
</dd>
</dl>
</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/forwarded.php</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>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><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 Fri Sep 13 2013 00:20: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>