634 lines
32 KiB
HTML
634 lines
32 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 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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</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>
|
|
|
|
<p><a href="classTicket__User-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a7581ea4400e1a8f0824598a1e0e038b3">__construct</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">A constructor. <a href="#a7581ea4400e1a8f0824598a1e0e038b3"></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#af038656737c0518eab287ef4098d37e7">set</a> ($values)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets the object's attributes. <a href="#af038656737c0518eab287ef4098d37e7"></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#a982f1e0aa98f3abb6451772ceac74708">load_With_TUserId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">loads the object's attributes. <a href="#a982f1e0aa98f3abb6451772ceac74708"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68c6a834f65de5fbdddaa9818cf4842d"></a><!-- doxytag: member="Ticket_User::update" ref="a68c6a834f65de5fbdddaa9818cf4842d" args="()" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a68c6a834f65de5fbdddaa9818cf4842d">update</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">update the object's attributes to the db. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f28fd031679b16d4a80653754f179eb"></a><!-- doxytag: member="Ticket_User::getPermission" ref="a3f28fd031679b16d4a80653754f179eb" args="()" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a3f28fd031679b16d4a80653754f179eb">getPermission</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get permission attribute of the object. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45675149ecaa6bbabd8673823437b1ea"></a><!-- doxytag: member="Ticket_User::getExternId" ref="a45675149ecaa6bbabd8673823437b1ea" args="()" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a45675149ecaa6bbabd8673823437b1ea">getExternId</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get externId attribute of the object. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4df262f17c5e543842e5f49db1970280"></a><!-- doxytag: member="Ticket_User::getTUserId" ref="a4df262f17c5e543842e5f49db1970280" args="()" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a4df262f17c5e543842e5f49db1970280">getTUserId</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get tUserId attribute of the object. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a3a35f8730a62f8bc527fda697a520df6">setPermission</a> ($perm)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set permission attribute of the object. <a href="#a3a35f8730a62f8bc527fda697a520df6"></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#af62595ffa430126baa9cb965174486f0">setExternId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set externId attribute of the object. <a href="#af62595ffa430126baa9cb965174486f0"></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#a3dd334c95ac15ccbc49c8971fab95b35">setTUserId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set tUserId attribute of the object. <a href="#a3dd334c95ac15ccbc49c8971fab95b35"></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#a531f0c78a90cb284e81bc1a9651d808d">createTicketUser</a> ($extern_id, $permission)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">create a new ticket user. <a href="#a531f0c78a90cb284e81bc1a9651d808d"></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#ab0badcae4b662e589f2eab4124a2adf7">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="#ab0badcae4b662e589f2eab4124a2adf7"></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#a30a17880b9ad06c7d5c3e7a8f2fb5d9c">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="#a30a17880b9ad06c7d5c3e7a8f2fb5d9c"></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#a43c21d6bdccb68a79677eb41291b3082">constr_TUserId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return constructed ticket_user object based on TUserId. <a href="#a43c21d6bdccb68a79677eb41291b3082"></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#af988917dc55b56b71764e0bb79075e97">getModsAndAdmins</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a list of all mods/admins. <a href="#af988917dc55b56b71764e0bb79075e97"></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#ab61b472135a3b4cc4c24481de6bd90cc">constr_ExternId</a> ($id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return constructed ticket_user object based on ExternId. <a href="#ab61b472135a3b4cc4c24481de6bd90cc"></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#aa3123d101bc451c3d2911263e10a4464">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="#aa3123d101bc451c3d2911263e10a4464"></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#ac9233453c39a9193993baa30711f1856">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="#ac9233453c39a9193993baa30711f1856"></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#a550d9a436e4820854d7fd3d998a2cb7c">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="#a550d9a436e4820854d7fd3d998a2cb7c"></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#a7e8ec955186676aff3f3b7757841962c">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="#a7e8ec955186676aff3f3b7757841962c"></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#ad74a6cb7ac2f021ff70cf8bcb43b1cba">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="#ad74a6cb7ac2f021ff70cf8bcb43b1cba"></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="ab017c0eab7b6083b3de58c8388251b50"></a><!-- doxytag: member="Ticket_User::$tUserId" ref="ab017c0eab7b6083b3de58c8388251b50" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#ab017c0eab7b6083b3de58c8388251b50">$tUserId</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The id of the user inside the ticket system. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a3f7ae998f3926ab666167c9f63bcfc"></a><!-- doxytag: member="Ticket_User::$permission" ref="a2a3f7ae998f3926ab666167c9f63bcfc" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#a2a3f7ae998f3926ab666167c9f63bcfc">$permission</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The permission of the user. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abee3b416d7f7db5bf23ed39a095c36c6"></a><!-- doxytag: member="Ticket_User::$externId" ref="abee3b416d7f7db5bf23ed39a095c36c6" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__User.html#abee3b416d7f7db5bf23ed39a095c36c6">$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. <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="a7581ea4400e1a8f0824598a1e0e038b3"></a><!-- doxytag: member="Ticket_User::__construct" ref="a7581ea4400e1a8f0824598a1e0e038b3" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#a7581ea4400e1a8f0824598a1e0e038b3">Ticket_User::__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="aa3123d101bc451c3d2911263e10a4464"></a><!-- doxytag: member="Ticket_User::change_permission" ref="aa3123d101bc451c3d2911263e10a4464" 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#aa3123d101bc451c3d2911263e10a4464">Ticket_User::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="ab61b472135a3b4cc4c24481de6bd90cc"></a><!-- doxytag: member="Ticket_User::constr_ExternId" ref="ab61b472135a3b4cc4c24481de6bd90cc" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#ab61b472135a3b4cc4c24481de6bd90cc">Ticket_User::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="a43c21d6bdccb68a79677eb41291b3082"></a><!-- doxytag: member="Ticket_User::constr_TUserId" ref="a43c21d6bdccb68a79677eb41291b3082" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a43c21d6bdccb68a79677eb41291b3082">Ticket_User::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="a531f0c78a90cb284e81bc1a9651d808d"></a><!-- doxytag: member="Ticket_User::createTicketUser" ref="a531f0c78a90cb284e81bc1a9651d808d" 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#a531f0c78a90cb284e81bc1a9651d808d">Ticket_User::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="ac9233453c39a9193993baa30711f1856"></a><!-- doxytag: member="Ticket_User::get_email_by_user_id" ref="ac9233453c39a9193993baa30711f1856" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#ac9233453c39a9193993baa30711f1856">Ticket_User::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="ad74a6cb7ac2f021ff70cf8bcb43b1cba"></a><!-- doxytag: member="Ticket_User::get_id_from_email" ref="ad74a6cb7ac2f021ff70cf8bcb43b1cba" args="($email)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#ad74a6cb7ac2f021ff70cf8bcb43b1cba">Ticket_User::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="a7e8ec955186676aff3f3b7757841962c"></a><!-- doxytag: member="Ticket_User::get_id_from_username" ref="a7e8ec955186676aff3f3b7757841962c" args="($username)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a7e8ec955186676aff3f3b7757841962c">Ticket_User::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="a550d9a436e4820854d7fd3d998a2cb7c"></a><!-- doxytag: member="Ticket_User::get_username_from_id" ref="a550d9a436e4820854d7fd3d998a2cb7c" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a550d9a436e4820854d7fd3d998a2cb7c">Ticket_User::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="af988917dc55b56b71764e0bb79075e97"></a><!-- doxytag: member="Ticket_User::getModsAndAdmins" ref="af988917dc55b56b71764e0bb79075e97" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#af988917dc55b56b71764e0bb79075e97">Ticket_User::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="a30a17880b9ad06c7d5c3e7a8f2fb5d9c"></a><!-- doxytag: member="Ticket_User::isAdmin" ref="a30a17880b9ad06c7d5c3e7a8f2fb5d9c" args="($user)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#a30a17880b9ad06c7d5c3e7a8f2fb5d9c">Ticket_User::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="ab0badcae4b662e589f2eab4124a2adf7"></a><!-- doxytag: member="Ticket_User::isMod" ref="ab0badcae4b662e589f2eab4124a2adf7" args="($user)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classTicket__User.html#ab0badcae4b662e589f2eab4124a2adf7">Ticket_User::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="a982f1e0aa98f3abb6451772ceac74708"></a><!-- doxytag: member="Ticket_User::load_With_TUserId" ref="a982f1e0aa98f3abb6451772ceac74708" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#a982f1e0aa98f3abb6451772ceac74708">Ticket_User::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="af038656737c0518eab287ef4098d37e7"></a><!-- doxytag: member="Ticket_User::set" ref="af038656737c0518eab287ef4098d37e7" args="($values)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#af038656737c0518eab287ef4098d37e7">Ticket_User::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="af62595ffa430126baa9cb965174486f0"></a><!-- doxytag: member="Ticket_User::setExternId" ref="af62595ffa430126baa9cb965174486f0" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#af62595ffa430126baa9cb965174486f0">Ticket_User::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="a3a35f8730a62f8bc527fda697a520df6"></a><!-- doxytag: member="Ticket_User::setPermission" ref="a3a35f8730a62f8bc527fda697a520df6" args="($perm)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#a3a35f8730a62f8bc527fda697a520df6">Ticket_User::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="a3dd334c95ac15ccbc49c8971fab95b35"></a><!-- doxytag: member="Ticket_User::setTUserId" ref="a3dd334c95ac15ccbc49c8971fab95b35" args="($id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTicket__User.html#a3dd334c95ac15ccbc49c8971fab95b35">Ticket_User::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>
|
|
<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/ticket_user.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><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 Fri Sep 13 2013 00:20: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>
|