712 lines
36 KiB
HTML
712 lines
36 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: WebUsers 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="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">WebUsers Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<!-- doxytag: class="WebUsers" --><!-- doxytag: inherits="Users" -->
|
|
<p>handles CMS/WWW related functions regarding user management & registration.
|
|
<a href="classWebUsers.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for WebUsers:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classWebUsers.png" usemap="#WebUsers_map" alt=""/>
|
|
<map id="WebUsers_map" name="WebUsers_map">
|
|
<area href="classUsers.html" title="handles basic user registration & management functions (shard related)." alt="Users" shape="rect" coords="0,0,69,24"/>
|
|
</map>
|
|
</div></div>
|
|
|
|
<p><a href="classWebUsers-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="classWebUsers.html#a3402f45e3a0f54f9756d1054afef0716">__construct</a> ($UId=0)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">A constructor. <a href="#a3402f45e3a0f54f9756d1054afef0716"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a69330e33d34bc1f667644b5417999c8d">set</a> ($values)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets the object's attributes. <a href="#a69330e33d34bc1f667644b5417999c8d"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a488f20463bfac01871810fa5f7461e10">checkLoginMatch</a> ($username, $password)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">check if the login username and password match the db. <a href="#a488f20463bfac01871810fa5f7461e10"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38654984bdbf75178cd0277807d94bfe"></a><!-- doxytag: member="WebUsers::getUId" ref="a38654984bdbf75178cd0277807d94bfe" args="()" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a38654984bdbf75178cd0277807d94bfe">getUId</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get uId 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="classWebUsers.html#a6f9bc7fdf77969e857dcfd5c1f8fd9bc">getUsername</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get login attribute of the object. <a href="#a6f9bc7fdf77969e857dcfd5c1f8fd9bc"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c782c9dfcacbebb2deca789930849f3"></a><!-- doxytag: member="WebUsers::getEmail" ref="a8c782c9dfcacbebb2deca789930849f3" args="()" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a8c782c9dfcacbebb2deca789930849f3">getEmail</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get email 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="classWebUsers.html#a323844dc355f89ee9c81254cb15f8bd4">getInfo</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get basic info of the object. <a href="#a323844dc355f89ee9c81254cb15f8bd4"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46aa8f355529e73c680e2e85f6fb8d75"></a><!-- doxytag: member="WebUsers::getReceiveMail" ref="a46aa8f355529e73c680e2e85f6fb8d75" args="()" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a46aa8f355529e73c680e2e85f6fb8d75">getReceiveMail</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get receiveMail attribute of the object. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2f2d5c0335ecdd177f9db54150bcb2b"></a><!-- doxytag: member="WebUsers::getLanguage" ref="ac2f2d5c0335ecdd177f9db54150bcb2b" args="()" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#ac2f2d5c0335ecdd177f9db54150bcb2b">getLanguage</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get language 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="classWebUsers.html#a46665dd9dba9bd764837aad1bdec3774">isLoggedIn</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">check if the user is logged in. <a href="#a46665dd9dba9bd764837aad1bdec3774"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#abc9803620918174c45ebf4b1ee8b7b97">setPassword</a> ($user, $pass)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">update the password. <a href="#abc9803620918174c45ebf4b1ee8b7b97"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a687c7b5c20d9d2e10ac807e396eeaeca">setEmail</a> ($user, $mail)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">update the emailaddress. <a href="#a687c7b5c20d9d2e10ac807e396eeaeca"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a9c773c1cc57aaf3429b11fd127b01a70">getUsers</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return all users. <a href="#a9c773c1cc57aaf3429b11fd127b01a70"></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="classWebUsers.html#adfdf81197e5dd57e151e2faaa0f83480">getId</a> ($username)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns te id for a given username <a href="#adfdf81197e5dd57e151e2faaa0f83480"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a3d0ec30b9d7320e0a892a0e8f07ce243">getIdFromEmail</a> ($email)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns te id for a given emailaddress <a href="#a3d0ec30b9d7320e0a892a0e8f07ce243"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a5655d4bf05243a4e0ad2ffdc77ed02e2">setReceiveMail</a> ($user, $receivemail)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">update the setReceiveMail value in the db. <a href="#a5655d4bf05243a4e0ad2ffdc77ed02e2"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a44c8a46add7a525e8902a4e2a3a9f9d1">setLanguage</a> ($user, $language)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">update the language value in the db. <a href="#a44c8a46add7a525e8902a4e2a3a9f9d1"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#ab7901cc22a26dcff53de5257579bb7ea">getAllUsersQuery</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the query that should get all users. <a href="#ab7901cc22a26dcff53de5257579bb7ea"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#abb1b5f937d609c7bbf02710efdc49115">createWebuser</a> ($name, $pass, $mail)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">creates a webuser. <a href="#abb1b5f937d609c7bbf02710efdc49115"></a><br/></td></tr>
|
|
<tr><td colspan="2"><h2><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a717ecd295ccfcf9dfa9a9d6d84b97d3b">checkUserNameExists</a> ($username)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">function that checks if a username exists already or not. <a href="#a717ecd295ccfcf9dfa9a9d6d84b97d3b"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a2874604f0ac49c770bbbffef342466ff">checkEmailExists</a> ($email)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">function that checks if a email exists already or not. <a href="#a2874604f0ac49c770bbbffef342466ff"></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="a4c118152530d9b7a1aab240392b504b8"></a><!-- doxytag: member="WebUsers::$uId" ref="a4c118152530d9b7a1aab240392b504b8" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a4c118152530d9b7a1aab240392b504b8">$uId</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The user id. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b61ca04b134c0b5452fa2e61f4b36bd"></a><!-- doxytag: member="WebUsers::$login" ref="a7b61ca04b134c0b5452fa2e61f4b36bd" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a7b61ca04b134c0b5452fa2e61f4b36bd">$login</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The username. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a532667fc1fa71ee38f3b8a9a0bbb3991"></a><!-- doxytag: member="WebUsers::$email" ref="a532667fc1fa71ee38f3b8a9a0bbb3991" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a532667fc1fa71ee38f3b8a9a0bbb3991">$email</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The email address. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39d55355d537ad77e08f2c196b1b39b5"></a><!-- doxytag: member="WebUsers::$firstname" ref="a39d55355d537ad77e08f2c196b1b39b5" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a39d55355d537ad77e08f2c196b1b39b5">$firstname</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The users first name. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0122258b652e5629269ec98db168a44"></a><!-- doxytag: member="WebUsers::$lastname" ref="ac0122258b652e5629269ec98db168a44" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#ac0122258b652e5629269ec98db168a44">$lastname</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The users last name. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a101472ee52f1e37416b472fdd151a6b4"></a><!-- doxytag: member="WebUsers::$gender" ref="a101472ee52f1e37416b472fdd151a6b4" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a101472ee52f1e37416b472fdd151a6b4">$gender</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The gender. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0aeb933ed72691c038d40ffc57ec1504"></a><!-- doxytag: member="WebUsers::$country" ref="a0aeb933ed72691c038d40ffc57ec1504" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a0aeb933ed72691c038d40ffc57ec1504">$country</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">2 letter word matching the country of the user <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a7186a146bb276d51181b9e62ad0ed8c5">$receiveMail</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">configuration regarding if the user wants to receive email notifications or not. <a href="#a7186a146bb276d51181b9e62ad0ed8c5"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7e97cee72066f85737453d81c931550"></a><!-- doxytag: member="WebUsers::$language" ref="af7e97cee72066f85737453d81c931550" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#af7e97cee72066f85737453d81c931550">$language</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Language of the user. <br/></td></tr>
|
|
</table>
|
|
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
|
<div class="textblock"><p>handles CMS/WWW related functions regarding user management & registration. </p>
|
|
<p>inherits from the <a class="el" href="classUsers.html" title="handles basic user registration & management functions (shard related).">Users</a> class. The methods of this class have to be rewritten according to the CMS's functionality that you wish to use. The drupal_module has a webusers class of its own in the module itself. </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="a3402f45e3a0f54f9756d1054afef0716"></a><!-- doxytag: member="WebUsers::__construct" ref="a3402f45e3a0f54f9756d1054afef0716" args="($UId=0)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classWebUsers.html#a3402f45e3a0f54f9756d1054afef0716">WebUsers::__construct</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>UId</em> = <code>0</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>A constructor. </p>
|
|
<p>loads the object with the UID, if none is given it will use 0. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$UID</td><td>the UID of the user you want to instantiate. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a2874604f0ac49c770bbbffef342466ff"></a><!-- doxytag: member="WebUsers::checkEmailExists" ref="a2874604f0ac49c770bbbffef342466ff" args="($email)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classWebUsers.html#a2874604f0ac49c770bbbffef342466ff">WebUsers::checkEmailExists</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>email</em></td><td>)</td>
|
|
<td><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>function that checks if a email exists already or not. </p>
|
|
<p>This function overrides the function of the base class. $email the email address in question. </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>string Info: Returns 0 if the email address is not in the web db, else a positive number is returned. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classUsers.html#ab48b703be38135a0478aed6674a30fb0">Users</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a488f20463bfac01871810fa5f7461e10"></a><!-- doxytag: member="WebUsers::checkLoginMatch" ref="a488f20463bfac01871810fa5f7461e10" args="($username, $password)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classWebUsers.html#a488f20463bfac01871810fa5f7461e10">WebUsers::checkLoginMatch</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>username</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>password</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>check if the login username and password match the db. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$username</td><td>the inserted username </td></tr>
|
|
<tr><td class="paramname">$password</td><td>the inserted password (unhashed) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>the logged in user's db row as array if login was a success, else "fail" will be returned. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classUsers.html#a230235f569309159fb4b2b03956ebbd5">Users</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a717ecd295ccfcf9dfa9a9d6d84b97d3b"></a><!-- doxytag: member="WebUsers::checkUserNameExists" ref="a717ecd295ccfcf9dfa9a9d6d84b97d3b" args="($username)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classWebUsers.html#a717ecd295ccfcf9dfa9a9d6d84b97d3b">WebUsers::checkUserNameExists</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>username</em></td><td>)</td>
|
|
<td><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>function that checks if a username exists already or not. </p>
|
|
<p>This function overrides the function of the base class. $username the username in question </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>string Info: Returns 0 if the user is not in the web db, else a positive number is returned. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classUsers.html#a809c817e5f9d61f80b6c07aaf3882e2d">Users</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abb1b5f937d609c7bbf02710efdc49115"></a><!-- doxytag: member="WebUsers::createWebuser" ref="abb1b5f937d609c7bbf02710efdc49115" args="($name, $pass, $mail)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classWebUsers.html#abb1b5f937d609c7bbf02710efdc49115">WebUsers::createWebuser</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>pass</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>mail</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>creates a webuser. </p>
|
|
<p>it will set the language matching to the language cookie setting and add it to the www/CMS's DB. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$name</td><td>the username </td></tr>
|
|
<tr><td class="paramname">$pass</td><td>the unhashed password </td></tr>
|
|
<tr><td class="paramname">$mail</td><td>the email address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab7901cc22a26dcff53de5257579bb7ea"></a><!-- doxytag: member="WebUsers::getAllUsersQuery" ref="ab7901cc22a26dcff53de5257579bb7ea" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classWebUsers.html#ab7901cc22a26dcff53de5257579bb7ea">WebUsers::getAllUsersQuery</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>return the query that should get all users. </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>string: the query to receive all users. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adfdf81197e5dd57e151e2faaa0f83480"></a><!-- doxytag: member="WebUsers::getId" ref="adfdf81197e5dd57e151e2faaa0f83480" args="($username)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classWebUsers.html#adfdf81197e5dd57e151e2faaa0f83480">WebUsers::getId</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>returns te id for a given username </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$username</td><td>the username </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>the user's id linked to the username </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3d0ec30b9d7320e0a892a0e8f07ce243"></a><!-- doxytag: member="WebUsers::getIdFromEmail" ref="a3d0ec30b9d7320e0a892a0e8f07ce243" args="($email)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classWebUsers.html#a3d0ec30b9d7320e0a892a0e8f07ce243">WebUsers::getIdFromEmail</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>returns te id for a given emailaddress </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$email</td><td>the emailaddress </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>the user's id linked to the emailaddress </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a323844dc355f89ee9c81254cb15f8bd4"></a><!-- doxytag: member="WebUsers::getInfo" ref="a323844dc355f89ee9c81254cb15f8bd4" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classWebUsers.html#a323844dc355f89ee9c81254cb15f8bd4">WebUsers::getInfo</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get basic info of the object. </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>returns an array in the form of Array('FirstName' => $this->firstname, 'LastName' => $this->lastname, 'Gender' => $this->gender, 'Country' => $this->country, 'ReceiveMail' => $this->receiveMail) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6f9bc7fdf77969e857dcfd5c1f8fd9bc"></a><!-- doxytag: member="WebUsers::getUsername" ref="a6f9bc7fdf77969e857dcfd5c1f8fd9bc" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classWebUsers.html#a6f9bc7fdf77969e857dcfd5c1f8fd9bc">WebUsers::getUsername</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>get login attribute of the object. </p>
|
|
<p>(username) </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9c773c1cc57aaf3429b11fd127b01a70"></a><!-- doxytag: member="WebUsers::getUsers" ref="a9c773c1cc57aaf3429b11fd127b01a70" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classWebUsers.html#a9c773c1cc57aaf3429b11fd127b01a70">WebUsers::getUsers</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>return all users. </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>return an array of users </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a46665dd9dba9bd764837aad1bdec3774"></a><!-- doxytag: member="WebUsers::isLoggedIn" ref="a46665dd9dba9bd764837aad1bdec3774" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classWebUsers.html#a46665dd9dba9bd764837aad1bdec3774">WebUsers::isLoggedIn</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>check if the user is logged in. </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>true or false </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a69330e33d34bc1f667644b5417999c8d"></a><!-- doxytag: member="WebUsers::set" ref="a69330e33d34bc1f667644b5417999c8d" args="($values)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classWebUsers.html#a69330e33d34bc1f667644b5417999c8d">WebUsers::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. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a687c7b5c20d9d2e10ac807e396eeaeca"></a><!-- doxytag: member="WebUsers::setEmail" ref="a687c7b5c20d9d2e10ac807e396eeaeca" args="($user, $mail)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classWebUsers.html#a687c7b5c20d9d2e10ac807e396eeaeca">WebUsers::setEmail</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>user</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>mail</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>update the emailaddress. </p>
|
|
<p>update the emailaddress in the shard + update the emailaddress in the www/CMS version. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$user</td><td>the username </td></tr>
|
|
<tr><td class="paramname">$mail</td><td>the new emailaddress. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>ok if it worked, if the lib or shard is offline it will return liboffline or shardoffline. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a44c8a46add7a525e8902a4e2a3a9f9d1"></a><!-- doxytag: member="WebUsers::setLanguage" ref="a44c8a46add7a525e8902a4e2a3a9f9d1" args="($user, $language)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classWebUsers.html#a44c8a46add7a525e8902a4e2a3a9f9d1">WebUsers::setLanguage</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>user</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>language</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>update the language value in the db. </p>
|
|
<p>update the language in the www/CMS version. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$user</td><td>the username </td></tr>
|
|
<tr><td class="paramname">$language</td><td>the new language value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abc9803620918174c45ebf4b1ee8b7b97"></a><!-- doxytag: member="WebUsers::setPassword" ref="abc9803620918174c45ebf4b1ee8b7b97" args="($user, $pass)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classWebUsers.html#abc9803620918174c45ebf4b1ee8b7b97">WebUsers::setPassword</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>user</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>pass</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>update the password. </p>
|
|
<p>update the password in the shard + update the password in the www/CMS version. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$user</td><td>the username </td></tr>
|
|
<tr><td class="paramname">$pass</td><td>the new password. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>ok if it worked, if the lib or shard is offline it will return liboffline or shardoffline. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5655d4bf05243a4e0ad2ffdc77ed02e2"></a><!-- doxytag: member="WebUsers::setReceiveMail" ref="a5655d4bf05243a4e0ad2ffdc77ed02e2" args="($user, $receivemail)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classWebUsers.html#a5655d4bf05243a4e0ad2ffdc77ed02e2">WebUsers::setReceiveMail</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>user</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>receivemail</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>update the setReceiveMail value in the db. </p>
|
|
<p>update the receiveMail in the www/CMS version. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$user</td><td>the username </td></tr>
|
|
<tr><td class="paramname">$receivemail</td><td>the receivemail setting . </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Data Documentation</h2>
|
|
<a class="anchor" id="a7186a146bb276d51181b9e62ad0ed8c5"></a><!-- doxytag: member="WebUsers::$receiveMail" ref="a7186a146bb276d51181b9e62ad0ed8c5" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">WebUsers::$receiveMail<code> [private]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>configuration regarding if the user wants to receive email notifications or not. </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/www/html/autoload/webusers.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>
|