mirror of
https://port.numenaute.org/aleajactaest/khanat-opennel-code.git
synced 2024-12-22 00:48:44 +00:00
745 lines
35 KiB
HTML
745 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_User 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">Ticket_User Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<!-- doxytag: class="Ticket_User" -->
|
|
<p>user entry point in the ticket system.
|
|
<a href="classTicket__User.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="classTicket__User.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="classTicket__User.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="classTicket__User.html#af43df1ba39e073e4b3a0120e6e4d3140">load_With_TUserId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">loads the object's attributes. <a href="#af43df1ba39e073e4b3a0120e6e4d3140"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a842e4774e3b3601a005b995c02f7e883">update</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">update the object's 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="classTicket__User.html#a478067ecf173884c2ee3e5b94e746200">getPermission</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get permission attribute of the object. <a href="#a478067ecf173884c2ee3e5b94e746200"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#ace230deb485c9f115f7fea4ce92442a3">getExternId</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get externId attribute of the object. <a href="#ace230deb485c9f115f7fea4ce92442a3"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a4a31c27c61f9794200b647bf810461f5">getTUserId</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get tUserId attribute of the object. <a href="#a4a31c27c61f9794200b647bf810461f5"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#adf7c497fb026ee6e05f6ece91f541839">setPermission</a> ($perm)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set permission attribute of the object. <a href="#adf7c497fb026ee6e05f6ece91f541839"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#ad38846bb954052a5293ae2d26cf810d2">setExternId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set externId attribute of the object. <a href="#ad38846bb954052a5293ae2d26cf810d2"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a0faf8954e86346e7b566870b1a3c0a4a">setTUserId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set tUserId attribute of the object. <a href="#a0faf8954e86346e7b566870b1a3c0a4a"></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="classTicket__User.html#a37c416f7d3723874f3ac49c7f9f5a21c">createTicketUser</a> ($extern_id, $permission)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">create a new ticket user. <a href="#a37c416f7d3723874f3ac49c7f9f5a21c"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a8d88cdbf205bf7d24be03157d25bb7d8">isMod</a> ($user)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">check if a ticket_user object is a mod or not. <a href="#a8d88cdbf205bf7d24be03157d25bb7d8"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#ae8a7d91474cde916fced2127fab426d2">isAdmin</a> ($user)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">check if a ticket_user object is an admin or not. <a href="#ae8a7d91474cde916fced2127fab426d2"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a10939bce9b667f26d3827993b4e3df1d">constr_TUserId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return constructed ticket_user object based on TUserId. <a href="#a10939bce9b667f26d3827993b4e3df1d"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a71099747902fb7e064ec1d4128ea4576">getModsAndAdmins</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a list of all mods/admins. <a href="#a71099747902fb7e064ec1d4128ea4576"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a4e5c577ed0a9da4b1c56397912f02ba0">constr_ExternId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return constructed ticket_user object based on ExternId. <a href="#a4e5c577ed0a9da4b1c56397912f02ba0"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a78d4d6de74b1ee26cb9192f36e022416">change_permission</a> ($user_id, $perm)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">change the permission of a ticket_user. <a href="#a78d4d6de74b1ee26cb9192f36e022416"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a7274bc305ccce731091c68d1607cb6e9">get_email_by_user_id</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the email address of a ticket_user. <a href="#a7274bc305ccce731091c68d1607cb6e9"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a266ff1e60e08dcd8c7e70f22f5a33e93">get_username_from_id</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the username of a ticket_user. <a href="#a266ff1e60e08dcd8c7e70f22f5a33e93"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a0bcfa281f41b948eb42dd18992724543">get_id_from_username</a> ($username)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the TUserId of a ticket_user by giving a username. <a href="#a0bcfa281f41b948eb42dd18992724543"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a7feeb7a909bf6733de21300d0ea0e1bd">get_id_from_email</a> ($email)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the ticket_user id from an email address. <a href="#a7feeb7a909bf6733de21300d0ea0e1bd"></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="classTicket__User.html#a2f1828693b198682ae3e926e63a4c110">$tUserId</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The id of the user inside the ticket system. <a href="#a2f1828693b198682ae3e926e63a4c110"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#aad04b6f3304fe6a13d5be37f7cd28938">$permission</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The permission of the user. <a href="#aad04b6f3304fe6a13d5be37f7cd28938"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#af51400fe5820e964cb38fcc60b3afd84">$externId</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The id of the user account in the www (could be drupal,...) that is linked to the ticket_user. <a href="#af51400fe5820e964cb38fcc60b3afd84"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
|
<div class="textblock"><p>user entry point in the ticket system. </p>
|
|
<p>The ticket_user makes a link between the entire ticket system's lib db and the www user, which is stored in another db (this is the external ID). The externalID could be the ID of a drupal user or wordpress user,.. The ticket_user also stores the permission of that user, this way the permission system is inside the lib itself and can be used in any www version that you like. permission 1 = user, 2 = mod, 3 = admin. </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="Ticket_User::__construct" ref="a095c5d389db211932136b53f25f39685" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.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="a78d4d6de74b1ee26cb9192f36e022416"></a><!-- doxytag: member="Ticket_User::change_permission" ref="a78d4d6de74b1ee26cb9192f36e022416" args="($user_id, $perm)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a78d4d6de74b1ee26cb9192f36e022416">change_permission</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>perm</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>change the permission of a ticket_user. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$user_id</td><td>the TUserId of the entry. </td></tr>
|
|
<tr><td class="paramname">$perm</td><td>the new permission value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4e5c577ed0a9da4b1c56397912f02ba0"></a><!-- doxytag: member="Ticket_User::constr_ExternId" ref="a4e5c577ed0a9da4b1c56397912f02ba0" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a4e5c577ed0a9da4b1c56397912f02ba0">constr_ExternId</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 constructed ticket_user object based on ExternId. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$id</td><td>the ExternId of the entry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>constructed ticket_user object </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a10939bce9b667f26d3827993b4e3df1d"></a><!-- doxytag: member="Ticket_User::constr_TUserId" ref="a10939bce9b667f26d3827993b4e3df1d" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a10939bce9b667f26d3827993b4e3df1d">constr_TUserId</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 constructed ticket_user object based on TUserId. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$id</td><td>the TUserId of the entry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>constructed ticket_user object </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a37c416f7d3723874f3ac49c7f9f5a21c"></a><!-- doxytag: member="Ticket_User::createTicketUser" ref="a37c416f7d3723874f3ac49c7f9f5a21c" args="($extern_id, $permission)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a37c416f7d3723874f3ac49c7f9f5a21c">createTicketUser</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>extern_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>permission</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>create a new ticket user. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$extern_id</td><td>the id of the user account in the www version (drupal,...) </td></tr>
|
|
<tr><td class="paramname">$permission</td><td>the permission that will be given to the user. 1=user, 2=mod, 3=admin </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7274bc305ccce731091c68d1607cb6e9"></a><!-- doxytag: member="Ticket_User::get_email_by_user_id" ref="a7274bc305ccce731091c68d1607cb6e9" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a7274bc305ccce731091c68d1607cb6e9">get_email_by_user_id</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 the email address of a ticket_user. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$id</td><td>the TUserId of the entry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>string containing the email address of that user. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7feeb7a909bf6733de21300d0ea0e1bd"></a><!-- doxytag: member="Ticket_User::get_id_from_email" ref="a7feeb7a909bf6733de21300d0ea0e1bd" args="($email)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a7feeb7a909bf6733de21300d0ea0e1bd">get_id_from_email</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>email</em></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>return the ticket_user id from an email address. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$email</td><td>the emailaddress of a user. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>the ticket_user id related to that email address, in case none, return "FALSE". </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0bcfa281f41b948eb42dd18992724543"></a><!-- doxytag: member="Ticket_User::get_id_from_username" ref="a0bcfa281f41b948eb42dd18992724543" args="($username)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a0bcfa281f41b948eb42dd18992724543">get_id_from_username</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>username</em></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>return the TUserId of a ticket_user by giving a username. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$username</td><td>the username of a user. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>the TUserId related to that username. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a266ff1e60e08dcd8c7e70f22f5a33e93"></a><!-- doxytag: member="Ticket_User::get_username_from_id" ref="a266ff1e60e08dcd8c7e70f22f5a33e93" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a266ff1e60e08dcd8c7e70f22f5a33e93">get_username_from_id</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 the username of a ticket_user. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$id</td><td>the TUserId of the entry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>string containing username of that user. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ace230deb485c9f115f7fea4ce92442a3"></a><!-- doxytag: member="Ticket_User::getExternId" ref="ace230deb485c9f115f7fea4ce92442a3" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#ace230deb485c9f115f7fea4ce92442a3">getExternId</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get externId attribute of the object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a71099747902fb7e064ec1d4128ea4576"></a><!-- doxytag: member="Ticket_User::getModsAndAdmins" ref="a71099747902fb7e064ec1d4128ea4576" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a71099747902fb7e064ec1d4128ea4576">getModsAndAdmins</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>return a list of all mods/admins. </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>an array consisting of ticket_user objects that are mods & admins. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a478067ecf173884c2ee3e5b94e746200"></a><!-- doxytag: member="Ticket_User::getPermission" ref="a478067ecf173884c2ee3e5b94e746200" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#a478067ecf173884c2ee3e5b94e746200">getPermission</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get permission attribute of the object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4a31c27c61f9794200b647bf810461f5"></a><!-- doxytag: member="Ticket_User::getTUserId" ref="a4a31c27c61f9794200b647bf810461f5" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#a4a31c27c61f9794200b647bf810461f5">getTUserId</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get tUserId attribute of the object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae8a7d91474cde916fced2127fab426d2"></a><!-- doxytag: member="Ticket_User::isAdmin" ref="ae8a7d91474cde916fced2127fab426d2" args="($user)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#ae8a7d91474cde916fced2127fab426d2">isAdmin</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>user</em></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>check if a ticket_user object is an admin or not. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$user</td><td>the ticket_user object itself </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="a8d88cdbf205bf7d24be03157d25bb7d8"></a><!-- doxytag: member="Ticket_User::isMod" ref="a8d88cdbf205bf7d24be03157d25bb7d8" args="($user)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a8d88cdbf205bf7d24be03157d25bb7d8">isMod</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>user</em></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>check if a ticket_user object is a mod or not. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$user</td><td>the ticket_user object itself </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="af43df1ba39e073e4b3a0120e6e4d3140"></a><!-- doxytag: member="Ticket_User::load_With_TUserId" ref="af43df1ba39e073e4b3a0120e6e4d3140" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#af43df1ba39e073e4b3a0120e6e4d3140">load_With_TUserId</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 TUserId. </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_user that should be loaded </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8bdfe0a5256e35367225bcd6d278ef21"></a><!-- doxytag: member="Ticket_User::set" ref="a8bdfe0a5256e35367225bcd6d278ef21" args="($values)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.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('TUserId' => id, 'Permission' => perm, 'ExternId' => ext_id). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad38846bb954052a5293ae2d26cf810d2"></a><!-- doxytag: member="Ticket_User::setExternId" ref="ad38846bb954052a5293ae2d26cf810d2" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#ad38846bb954052a5293ae2d26cf810d2">setExternId</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 externId attribute of the object. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$id</td><td>the external id. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adf7c497fb026ee6e05f6ece91f541839"></a><!-- doxytag: member="Ticket_User::setPermission" ref="adf7c497fb026ee6e05f6ece91f541839" args="($perm)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#adf7c497fb026ee6e05f6ece91f541839">setPermission</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>perm</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>set permission attribute of the object. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$perm</td><td>integer that indicates the permission level. (1= user, 2= mod, 3= admin) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0faf8954e86346e7b566870b1a3c0a4a"></a><!-- doxytag: member="Ticket_User::setTUserId" ref="a0faf8954e86346e7b566870b1a3c0a4a" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#a0faf8954e86346e7b566870b1a3c0a4a">setTUserId</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 tUserId attribute of the object. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$id</td><td>the ticket_user id </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a842e4774e3b3601a005b995c02f7e883"></a><!-- doxytag: member="Ticket_User::update" ref="a842e4774e3b3601a005b995c02f7e883" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#a842e4774e3b3601a005b995c02f7e883">update</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>update the object's attributes to the db. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Field Documentation</h2>
|
|
<a class="anchor" id="af51400fe5820e964cb38fcc60b3afd84"></a><!-- doxytag: member="Ticket_User::$externId" ref="af51400fe5820e964cb38fcc60b3afd84" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">$externId<code> [private]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>The id of the user account in the www (could be drupal,...) that is linked to the ticket_user. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aad04b6f3304fe6a13d5be37f7cd28938"></a><!-- doxytag: member="Ticket_User::$permission" ref="aad04b6f3304fe6a13d5be37f7cd28938" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">$permission<code> [private]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>The permission of the user. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2f1828693b198682ae3e926e63a4c110"></a><!-- doxytag: member="Ticket_User::$tUserId" ref="a2f1828693b198682ae3e926e63a4c110" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">$tUserId<code> [private]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>The id of the user inside the ticket system. </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__user_8php.html">ticket_user.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>
|