1082 lines
52 KiB
HTML
1082 lines
52 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: Support_Group 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
|
|
 <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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Data 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 Structures</span></a></li>
|
|
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Data Fields</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Support_Group Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<!-- doxytag: class="Support_Group" -->
|
|
<p>groups moderators & admins together.
|
|
<a href="classSupport__Group.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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a095c5d389db211932136b53f25f39685">__construct</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">A constructor. <a href="#a095c5d389db211932136b53f25f39685"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a8bdfe0a5256e35367225bcd6d278ef21">set</a> ($values)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets the object's attributes. <a href="#a8bdfe0a5256e35367225bcd6d278ef21"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a435e7d7525d4bcd0ed5e34a469f3adf6">create</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">creates a new 'support_group' entry. <a href="#a435e7d7525d4bcd0ed5e34a469f3adf6"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a6beae177f45da42a57b100b5481f49bf">load_With_SGroupId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">loads the object's attributes. <a href="#a6beae177f45da42a57b100b5481f49bf"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a842e4774e3b3601a005b995c02f7e883">update</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a13bdffdd926f26b825ea57066334ff01">delete</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">deletes an existing 'support_group' entry. <a href="#a13bdffdd926f26b825ea57066334ff01"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a77d0961efe9609ebb268f8672e71bba4">getSGroupId</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get sGroupId attribute of the object. <a href="#a77d0961efe9609ebb268f8672e71bba4"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a3d0963e68bb313b163a73f2803c64600">getName</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get name attribute of the object. <a href="#a3d0963e68bb313b163a73f2803c64600"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#ab86ba36154b20e6bbfa3ba705f12f9d6">getTag</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get tag attribute of the object. <a href="#ab86ba36154b20e6bbfa3ba705f12f9d6"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a9d0f36a53db49c1f57e3cab8a61a7d90">getGroupEmail</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get groupEmail attribute of the object. <a href="#a9d0f36a53db49c1f57e3cab8a61a7d90"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a30d67354e52f95489b93923440ff0661">getIMAP_MailServer</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get iMAP_MailServer attribute of the object. <a href="#a30d67354e52f95489b93923440ff0661"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a0ace9f66f2541d29e060cb7728030e93">getIMAP_Username</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get iMAP_Username attribute of the object. <a href="#a0ace9f66f2541d29e060cb7728030e93"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a4983db184794db8f05ce93f5ba11ba7e">getIMAP_Password</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get iMAP_Password attribute of the object. <a href="#a4983db184794db8f05ce93f5ba11ba7e"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#aa49cb914be98fc354a45584c6f2b8be1">setSGroupId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set sGroupId attribute of the object. <a href="#aa49cb914be98fc354a45584c6f2b8be1"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#aa3dcc220094e19fef1f918a3a917dba7">setName</a> ($n)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set name attribute of the object. <a href="#aa3dcc220094e19fef1f918a3a917dba7"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a4de944a53debc51843530fe96296f220">setTag</a> ($t)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set tag attribute of the object. <a href="#a4de944a53debc51843530fe96296f220"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#abbb0e975fd21a42439970ebb3eba5fea">setGroupEmail</a> ($ge)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set groupEmail attribute of the object. <a href="#abbb0e975fd21a42439970ebb3eba5fea"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a71f266f2bba1fc4fb6df4cf083988938">setIMAP_MailServer</a> ($ms)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set iMAP_MailServer attribute of the object. <a href="#a71f266f2bba1fc4fb6df4cf083988938"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a6856519261b543f27bc001616c2881eb">setIMAP_Username</a> ($u)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set iMAP_Username attribute of the object. <a href="#a6856519261b543f27bc001616c2881eb"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#ad6fcb63d4ae129567e8bea8786a75d87">setIMAP_Password</a> ($p)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set iMAP_Password attribute of the object. <a href="#ad6fcb63d4ae129567e8bea8786a75d87"></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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#af6697615443145a2981e62aa741c3afa">getGroup</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a specific support_group object. <a href="#af6697615443145a2981e62aa741c3afa"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a562142b89699a1063ea9769030250365">getGroups</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return all support_group objects. <a href="#a562142b89699a1063ea9769030250365"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a31ee7c68c0ffb77438bb9ff095962568">createSupportGroup</a> ($name, $tag, $groupemail, $imap_mailserver, $imap_username, $imap_password)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for creating a support group. <a href="#a31ee7c68c0ffb77438bb9ff095962568"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#aa557f337f57a3bb530f1f04df78c0f1e">supportGroup_EntryNotExists</a> ($name, $tag)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">check if support group name/tag doesn't exist yet. <a href="#aa557f337f57a3bb530f1f04df78c0f1e"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#ac235662693dcc9c2be51e6f1a2c426b6">supportGroup_Exists</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">check if support group entry coupled to a given id exist or not. <a href="#ac235662693dcc9c2be51e6f1a2c426b6"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a873beb80bd0b5d572704cdb6d2ec34eb">constr_SGroupId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">construct an object based on the SGroupId. <a href="#a873beb80bd0b5d572704cdb6d2ec34eb"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a7f1662394a31e2a05e9863def178df12">getAllUsersOfSupportGroup</a> ($group_id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get list of all users that are enlisted to a support group. <a href="#a7f1662394a31e2a05e9863def178df12"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#ab4a7d3ba86333a058027c7d58b9137f1">deleteSupportGroup</a> ($group_id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">wrapper for deleting a support group. <a href="#ab4a7d3ba86333a058027c7d58b9137f1"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#ad2d1a010903640e39545085b93b9a4f1">deleteUserOfSupportGroup</a> ($user_id, $group_id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">wrapper for deleting a user that's in a specified support group. <a href="#ad2d1a010903640e39545085b93b9a4f1"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a4616317379ffef08dbaeea2a9dbba02c">addUserToSupportGroup</a> ($user_id, $group_id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">wrapper for adding a user to a specified support group. <a href="#a4616317379ffef08dbaeea2a9dbba02c"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#ad3fc18cb894f789d19a768ea63d9b673">getAllSupportGroups</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return all support_group objects. <a href="#ad3fc18cb894f789d19a768ea63d9b673"></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a23265908fce0f131e03ba1ede7f42647">$sGroupId</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The id of the support group. <a href="#a23265908fce0f131e03ba1ede7f42647"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#ab2fc40d43824ea3e1ce5d86dee0d763b">$name</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the support group. <a href="#ab2fc40d43824ea3e1ce5d86dee0d763b"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a81d5015d41ed8ec66e9db8cdc5db9555">$tag</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The tag of the support group, a tag is max 4 letters big, and will be used in the future as easy reference to indicate what group it is refered to (eg [DEV]) <a href="#a81d5015d41ed8ec66e9db8cdc5db9555"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#ab7ad611af238b28f1f65a32cb152acd1">$groupEmail</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The email address of the group. <a href="#ab7ad611af238b28f1f65a32cb152acd1"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#ad9f2ef2089fe446a9ac49a19a450d636">$iMAP_MailServer</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The imap server connection string. <a href="#ad9f2ef2089fe446a9ac49a19a450d636"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a2b549eb4d5773efd741a2990817af0ea">$iMAP_Username</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The imap username of the account. <a href="#a2b549eb4d5773efd741a2990817af0ea"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSupport__Group.html#a4166a2fc4b594ee425d7f40870e16455">$iMAP_Password</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The imap matching password. <a href="#a4166a2fc4b594ee425d7f40870e16455"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
|
<div class="textblock"><p>groups moderators & admins together. </p>
|
|
<p>A Support Group is a group of people with the same skills or knowledge. A typical example will be the (Developers group, webteam group, management, etc..) The idea is that tickets can be forwarded to a group of persons that might be able to answer that specific question. Support Groups are also the key of handling the emails, because the email addresses of the support groups will be used by the <a class="el" href="classMail__Handler.html" title="Handles the mailing functionality.">Mail_Handler</a> class. </p>
|
|
<dl class="author"><dt><b>Author:</b></dt><dd>Daan Janssens, mentored by Matthew Lagoe </dd></dl>
|
|
</div><hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a095c5d389db211932136b53f25f39685"></a><!-- doxytag: member="Support_Group::__construct" ref="a095c5d389db211932136b53f25f39685" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.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="a4616317379ffef08dbaeea2a9dbba02c"></a><!-- doxytag: member="Support_Group::addUserToSupportGroup" ref="a4616317379ffef08dbaeea2a9dbba02c" args="($user_id, $group_id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classSupport__Group.html#a4616317379ffef08dbaeea2a9dbba02c">addUserToSupportGroup</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>user_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>group_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>wrapper for adding a user to a specified support group. </p>
|
|
<p>We will first check if the group really exists, if not than "GROUP_NOT_EXISING" will be returned. Afterwards we will check if the user exists in the support group, if so "ALREADY_ADDED" will be returned. Else the user will be added to the in_support_group table and "SUCCESS" will be returned. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$user_id</td><td>the id of the user we want to add to the group. </td></tr>
|
|
<tr><td class="paramname">$group_id</td><td>the id of the group the user wants to be in </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>a string (SUCCESS, ALREADY_ADDED or GROUP_NOT_EXISTING) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a873beb80bd0b5d572704cdb6d2ec34eb"></a><!-- doxytag: member="Support_Group::constr_SGroupId" ref="a873beb80bd0b5d572704cdb6d2ec34eb" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classSupport__Group.html#a873beb80bd0b5d572704cdb6d2ec34eb">constr_SGroupId</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>construct an object based on the SGroupId. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$id</td><td>the id of the group we want to construct </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>the constructed support group object </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a435e7d7525d4bcd0ed5e34a469f3adf6"></a><!-- doxytag: member="Support_Group::create" ref="a435e7d7525d4bcd0ed5e34a469f3adf6" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.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 'support_group' entry. </p>
|
|
<p>this method will use the object's attributes for creating a new 'support_group' entry in the database. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a31ee7c68c0ffb77438bb9ff095962568"></a><!-- doxytag: member="Support_Group::createSupportGroup" ref="a31ee7c68c0ffb77438bb9ff095962568" args="($name, $tag, $groupemail, $imap_mailserver, $imap_username, $imap_password)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classSupport__Group.html#a31ee7c68c0ffb77438bb9ff095962568">createSupportGroup</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>tag</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>groupemail</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>imap_mailserver</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>imap_username</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>imap_password</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Wrapper for creating a support group. </p>
|
|
<p>It will check if the support group doesn't exist yet, if the tag or name already exists then NAME_TAKEN or TAG_TAKEN will be returned. If the name is bigger than 20 characters or smaller than 4 and the tag greater than 7 or smaller than 2 a SIZE_ERROR will be returned. Else it will return SUCCESS </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>a string that specifies if it was a success or not (SUCCESS, SIZE_ERROR, NAME_TAKEN or TAG_TAKEN ) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a13bdffdd926f26b825ea57066334ff01"></a><!-- doxytag: member="Support_Group::delete" ref="a13bdffdd926f26b825ea57066334ff01" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#a13bdffdd926f26b825ea57066334ff01">delete</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>deletes an existing 'support_group' entry. </p>
|
|
<p>this method will use the object's attributes for deleting an existing 'support_group' entry in the database. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab4a7d3ba86333a058027c7d58b9137f1"></a><!-- doxytag: member="Support_Group::deleteSupportGroup" ref="ab4a7d3ba86333a058027c7d58b9137f1" args="($group_id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classSupport__Group.html#ab4a7d3ba86333a058027c7d58b9137f1">deleteSupportGroup</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>group_id</em></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>wrapper for deleting a support group. </p>
|
|
<p>We will first check if the group really exists, if not than "GROUP_NOT_EXISING" will be returned. </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 group we want to delete </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>an array of ticket_user objects that are in the support group. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad2d1a010903640e39545085b93b9a4f1"></a><!-- doxytag: member="Support_Group::deleteUserOfSupportGroup" ref="ad2d1a010903640e39545085b93b9a4f1" args="($user_id, $group_id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classSupport__Group.html#ad2d1a010903640e39545085b93b9a4f1">deleteUserOfSupportGroup</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>user_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>group_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>wrapper for deleting a user that's in a specified support group. </p>
|
|
<p>We will first check if the group really exists, if not than "GROUP_NOT_EXISING" will be returned. Afterwards we will check if the user exists in the support group, if not "USER_NOT_IN_GROUP" will be returned. Else the users entry in the in_support_group table will be deleted and "SUCCESS" will be returned. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$user_id</td><td>the id of the user we want to remove out of the group. </td></tr>
|
|
<tr><td class="paramname">$group_id</td><td>the id of the group the user should be in </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>a string (SUCCESS, USER_NOT_IN_GROUP or GROUP_NOT_EXISTING) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad3fc18cb894f789d19a768ea63d9b673"></a><!-- doxytag: member="Support_Group::getAllSupportGroups" ref="ad3fc18cb894f789d19a768ea63d9b673" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classSupport__Group.html#ad3fc18cb894f789d19a768ea63d9b673">getAllSupportGroups</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>return all support_group objects. </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>an array containing all support_group objects. </dd></dl>
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>should be removed in the future, because getGroups does the same. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7f1662394a31e2a05e9863def178df12"></a><!-- doxytag: member="Support_Group::getAllUsersOfSupportGroup" ref="a7f1662394a31e2a05e9863def178df12" args="($group_id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classSupport__Group.html#a7f1662394a31e2a05e9863def178df12">getAllUsersOfSupportGroup</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>group_id</em></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get list of all users that are enlisted to a support group. </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 group we want to query </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>an array of ticket_user objects that are in the support group. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af6697615443145a2981e62aa741c3afa"></a><!-- doxytag: member="Support_Group::getGroup" ref="af6697615443145a2981e62aa741c3afa" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classSupport__Group.html#af6697615443145a2981e62aa741c3afa">getGroup</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>return a specific support_group object. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$id</td><td>the id of the support group that we want to return </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>a support_group object. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9d0f36a53db49c1f57e3cab8a61a7d90"></a><!-- doxytag: member="Support_Group::getGroupEmail" ref="a9d0f36a53db49c1f57e3cab8a61a7d90" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#a9d0f36a53db49c1f57e3cab8a61a7d90">getGroupEmail</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get groupEmail attribute of the object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a562142b89699a1063ea9769030250365"></a><!-- doxytag: member="Support_Group::getGroups" ref="a562142b89699a1063ea9769030250365" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classSupport__Group.html#a562142b89699a1063ea9769030250365">getGroups</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>return all support_group objects. </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>an array containing all support_group objects. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a30d67354e52f95489b93923440ff0661"></a><!-- doxytag: member="Support_Group::getIMAP_MailServer" ref="a30d67354e52f95489b93923440ff0661" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#a30d67354e52f95489b93923440ff0661">getIMAP_MailServer</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get iMAP_MailServer attribute of the object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4983db184794db8f05ce93f5ba11ba7e"></a><!-- doxytag: member="Support_Group::getIMAP_Password" ref="a4983db184794db8f05ce93f5ba11ba7e" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#a4983db184794db8f05ce93f5ba11ba7e">getIMAP_Password</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get iMAP_Password attribute of the object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0ace9f66f2541d29e060cb7728030e93"></a><!-- doxytag: member="Support_Group::getIMAP_Username" ref="a0ace9f66f2541d29e060cb7728030e93" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#a0ace9f66f2541d29e060cb7728030e93">getIMAP_Username</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get iMAP_Username attribute of the object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3d0963e68bb313b163a73f2803c64600"></a><!-- doxytag: member="Support_Group::getName" ref="a3d0963e68bb313b163a73f2803c64600" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#a3d0963e68bb313b163a73f2803c64600">getName</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get name attribute of the object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a77d0961efe9609ebb268f8672e71bba4"></a><!-- doxytag: member="Support_Group::getSGroupId" ref="a77d0961efe9609ebb268f8672e71bba4" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#a77d0961efe9609ebb268f8672e71bba4">getSGroupId</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get sGroupId attribute of the object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab86ba36154b20e6bbfa3ba705f12f9d6"></a><!-- doxytag: member="Support_Group::getTag" ref="ab86ba36154b20e6bbfa3ba705f12f9d6" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#ab86ba36154b20e6bbfa3ba705f12f9d6">getTag</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get tag attribute of the object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6beae177f45da42a57b100b5481f49bf"></a><!-- doxytag: member="Support_Group::load_With_SGroupId" ref="a6beae177f45da42a57b100b5481f49bf" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#a6beae177f45da42a57b100b5481f49bf">load_With_SGroupId</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </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 group id, it will put the matching groups attributes in the object. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$id</td><td>the id of the support group that should be loaded </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8bdfe0a5256e35367225bcd6d278ef21"></a><!-- doxytag: member="Support_Group::set" ref="a8bdfe0a5256e35367225bcd6d278ef21" args="($values)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#a8bdfe0a5256e35367225bcd6d278ef21">set</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </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('SGroupId' => groupid, 'Name' => name, 'Tag' => tag, 'GroupEmail' => mail, 'IMAP_MailServer' => server, 'IMAP_Username' => username,'IMAP_Password' => pass). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abbb0e975fd21a42439970ebb3eba5fea"></a><!-- doxytag: member="Support_Group::setGroupEmail" ref="abbb0e975fd21a42439970ebb3eba5fea" args="($ge)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#abbb0e975fd21a42439970ebb3eba5fea">setGroupEmail</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>ge</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>set groupEmail attribute of the object. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$ge</td><td>email of the group </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a71f266f2bba1fc4fb6df4cf083988938"></a><!-- doxytag: member="Support_Group::setIMAP_MailServer" ref="a71f266f2bba1fc4fb6df4cf083988938" args="($ms)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#a71f266f2bba1fc4fb6df4cf083988938">setIMAP_MailServer</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>ms</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>set iMAP_MailServer attribute of the object. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$ms</td><td>mailserver of the group </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad6fcb63d4ae129567e8bea8786a75d87"></a><!-- doxytag: member="Support_Group::setIMAP_Password" ref="ad6fcb63d4ae129567e8bea8786a75d87" args="($p)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#ad6fcb63d4ae129567e8bea8786a75d87">setIMAP_Password</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>p</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>set iMAP_Password attribute of the object. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$p</td><td>imap password of the group </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6856519261b543f27bc001616c2881eb"></a><!-- doxytag: member="Support_Group::setIMAP_Username" ref="a6856519261b543f27bc001616c2881eb" args="($u)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#a6856519261b543f27bc001616c2881eb">setIMAP_Username</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>u</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>set iMAP_Username attribute of the object. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$u</td><td>imap username of the group </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa3dcc220094e19fef1f918a3a917dba7"></a><!-- doxytag: member="Support_Group::setName" ref="aa3dcc220094e19fef1f918a3a917dba7" args="($n)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#aa3dcc220094e19fef1f918a3a917dba7">setName</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>n</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>set name attribute of the object. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$n</td><td>name of the group </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa49cb914be98fc354a45584c6f2b8be1"></a><!-- doxytag: member="Support_Group::setSGroupId" ref="aa49cb914be98fc354a45584c6f2b8be1" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#aa49cb914be98fc354a45584c6f2b8be1">setSGroupId</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>set sGroupId 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 group </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4de944a53debc51843530fe96296f220"></a><!-- doxytag: member="Support_Group::setTag" ref="a4de944a53debc51843530fe96296f220" args="($t)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.html#a4de944a53debc51843530fe96296f220">setTag</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>t</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>set tag attribute of the object. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$t</td><td>tag of the group </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa557f337f57a3bb530f1f04df78c0f1e"></a><!-- doxytag: member="Support_Group::supportGroup_EntryNotExists" ref="aa557f337f57a3bb530f1f04df78c0f1e" args="($name, $tag)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classSupport__Group.html#aa557f337f57a3bb530f1f04df78c0f1e">supportGroup_EntryNotExists</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>tag</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>check if support group name/tag doesn't exist yet. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$name</td><td>the name of the group we want to check </td></tr>
|
|
<tr><td class="paramname">$tag</td><td>the tag of the group we want to check </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>if name is already taken return NAME_TAKEN, else if tag is already taken return TAG_TAKEN, else return success. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac235662693dcc9c2be51e6f1a2c426b6"></a><!-- doxytag: member="Support_Group::supportGroup_Exists" ref="ac235662693dcc9c2be51e6f1a2c426b6" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classSupport__Group.html#ac235662693dcc9c2be51e6f1a2c426b6">supportGroup_Exists</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>check if support group entry coupled to a given id exist or not. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$id</td><td>the id of the group we want to check </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>true or false. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a842e4774e3b3601a005b995c02f7e883"></a><!-- doxytag: member="Support_Group::update" ref="a842e4774e3b3601a005b995c02f7e883" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSupport__Group.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>
|
|
<hr/><h2>Field Documentation</h2>
|
|
<a class="anchor" id="ab7ad611af238b28f1f65a32cb152acd1"></a><!-- doxytag: member="Support_Group::$groupEmail" ref="ab7ad611af238b28f1f65a32cb152acd1" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">$groupEmail<code> [private]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>The email address of the group. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad9f2ef2089fe446a9ac49a19a450d636"></a><!-- doxytag: member="Support_Group::$iMAP_MailServer" ref="ad9f2ef2089fe446a9ac49a19a450d636" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">$iMAP_MailServer<code> [private]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>The imap server connection string. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4166a2fc4b594ee425d7f40870e16455"></a><!-- doxytag: member="Support_Group::$iMAP_Password" ref="a4166a2fc4b594ee425d7f40870e16455" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">$iMAP_Password<code> [private]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>The imap matching password. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2b549eb4d5773efd741a2990817af0ea"></a><!-- doxytag: member="Support_Group::$iMAP_Username" ref="a2b549eb4d5773efd741a2990817af0ea" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">$iMAP_Username<code> [private]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>The imap username of the account. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab2fc40d43824ea3e1ce5d86dee0d763b"></a><!-- doxytag: member="Support_Group::$name" ref="ab2fc40d43824ea3e1ce5d86dee0d763b" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">$name<code> [private]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>The name of the support group. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a23265908fce0f131e03ba1ede7f42647"></a><!-- doxytag: member="Support_Group::$sGroupId" ref="a23265908fce0f131e03ba1ede7f42647" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">$sGroupId<code> [private]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>The id of the support group. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a81d5015d41ed8ec66e9db8cdc5db9555"></a><!-- doxytag: member="Support_Group::$tag" ref="a81d5015d41ed8ec66e9db8cdc5db9555" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">$tag<code> [private]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>The tag of the support group, a tag is max 4 letters big, and will be used in the future as easy reference to indicate what group it is refered to (eg [DEV]) </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="support__group_8php.html">support_group.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </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  <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>
|