<!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 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="#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,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"/> <area href="classUsers.html" title="handles basic user registration & management functions (shard related)." alt="Users" shape="rect" coords="79,0,148,24"/> </map> </div></div> <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#a4e63742e531873e01e1e97dd7530539b">__construct</a> ($UId=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A constructor. <a href="#a4e63742e531873e01e1e97dd7530539b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.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="classWebUsers.html#a11894eb69bb2f172baf5186e8f92246d">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="#a11894eb69bb2f172baf5186e8f92246d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#aa36a98da4146d85e7813e99df7d97497">getUId</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get uId attribute of the object. <a href="#aa36a98da4146d85e7813e99df7d97497"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a81b37a3c9d639574e394f80c1138c75e">getUsername</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get login attribute of the object. <a href="#a81b37a3c9d639574e394f80c1138c75e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a02a01849f28e2535e888ae4ec87b20f2">getEmail</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get email attribute of the object. <a href="#a02a01849f28e2535e888ae4ec87b20f2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a164026f74736817927e1cacd282a2e28">getInfo</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get basic info of the object. <a href="#a164026f74736817927e1cacd282a2e28"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#ae4680f622bd8d571530615fb616d37e7">getReceiveMail</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get receiveMail attribute of the object. <a href="#ae4680f622bd8d571530615fb616d37e7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#afcef2403c4111bc44ef0530f1e493909">getLanguage</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get language attribute of the object. <a href="#afcef2403c4111bc44ef0530f1e493909"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a33bdd79e5da367ebddd4cfbdbbfc7cff">isLoggedIn</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">check if the user is logged in. <a href="#a33bdd79e5da367ebddd4cfbdbbfc7cff"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a91506e5f74c9884045e865ef7c314fed">setPassword</a> ($user, $pass)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">update the password. <a href="#a91506e5f74c9884045e865ef7c314fed"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a0cd214763f395718db166fbd598689f4">setEmail</a> ($user, $mail)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">update the emailaddress. <a href="#a0cd214763f395718db166fbd598689f4"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a0fc10b64683021b70c7eb95fb514c119">getUsers</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">return all users. <a href="#a0fc10b64683021b70c7eb95fb514c119"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a4e63742e531873e01e1e97dd7530539b">__construct</a> ($UId=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A constructor. <a href="#a4e63742e531873e01e1e97dd7530539b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.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="classWebUsers.html#a11894eb69bb2f172baf5186e8f92246d">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="#a11894eb69bb2f172baf5186e8f92246d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#aa36a98da4146d85e7813e99df7d97497">getUId</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get uId attribute of the object. <a href="#aa36a98da4146d85e7813e99df7d97497"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a81b37a3c9d639574e394f80c1138c75e">getUsername</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get login attribute of the object. <a href="#a81b37a3c9d639574e394f80c1138c75e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a02a01849f28e2535e888ae4ec87b20f2">getEmail</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get email attribute of the object. <a href="#a02a01849f28e2535e888ae4ec87b20f2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a164026f74736817927e1cacd282a2e28">getInfo</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get basic info of the object. <a href="#a164026f74736817927e1cacd282a2e28"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#ae4680f622bd8d571530615fb616d37e7">getReceiveMail</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get receiveMail attribute of the object. <a href="#ae4680f622bd8d571530615fb616d37e7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#afcef2403c4111bc44ef0530f1e493909">getLanguage</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get language attribute of the object. <a href="#afcef2403c4111bc44ef0530f1e493909"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a33bdd79e5da367ebddd4cfbdbbfc7cff">isLoggedIn</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">check if the user is logged in. <a href="#a33bdd79e5da367ebddd4cfbdbbfc7cff"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a91506e5f74c9884045e865ef7c314fed">setPassword</a> ($user, $pass)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">update the password. <a href="#a91506e5f74c9884045e865ef7c314fed"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a0cd214763f395718db166fbd598689f4">setEmail</a> ($user, $mail)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">update the emailaddress. <a href="#a0cd214763f395718db166fbd598689f4"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a0fc10b64683021b70c7eb95fb514c119">getUsers</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">return all users. <a href="#a0fc10b64683021b70c7eb95fb514c119"></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#a585ef354b38d0fad9d92f45e183b639f">getId</a> ($username)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">returns te id for a given username <a href="#a585ef354b38d0fad9d92f45e183b639f"></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#aee8d6b322defc5dfe8e47f382becca62">getIdFromEmail</a> ($email)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">returns te id for a given emailaddress <a href="#aee8d6b322defc5dfe8e47f382becca62"></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#aa0f439ff7a5cd6377a557f545fbeb45c">setReceiveMail</a> ($user, $receivemail)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">update the setReceiveMail value in the db. <a href="#aa0f439ff7a5cd6377a557f545fbeb45c"></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#a5ab1bd5f0959a3c33a46c176d9412c80">setLanguage</a> ($user, $language)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">update the language value in the db. <a href="#a5ab1bd5f0959a3c33a46c176d9412c80"></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#a2f8e928ed02e462b40e909965250fb7d">getAllUsersQuery</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">return the query that should get all users. <a href="#a2f8e928ed02e462b40e909965250fb7d"></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#a0cb7168a6b8358106512804ff28cea17">createWebuser</a> ($name, $pass, $mail)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">creates a webuser. <a href="#a0cb7168a6b8358106512804ff28cea17"></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#a585ef354b38d0fad9d92f45e183b639f">getId</a> ($username)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">returns te id for a given username <a href="#a585ef354b38d0fad9d92f45e183b639f"></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#aee8d6b322defc5dfe8e47f382becca62">getIdFromEmail</a> ($email)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">returns te id for a given emailaddress <a href="#aee8d6b322defc5dfe8e47f382becca62"></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#aa0f439ff7a5cd6377a557f545fbeb45c">setReceiveMail</a> ($user, $receivemail)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">update the setReceiveMail value in the db. <a href="#aa0f439ff7a5cd6377a557f545fbeb45c"></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#a5ab1bd5f0959a3c33a46c176d9412c80">setLanguage</a> ($user, $language)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">update the language value in the db. <a href="#a5ab1bd5f0959a3c33a46c176d9412c80"></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#a2f8e928ed02e462b40e909965250fb7d">getAllUsersQuery</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">return the query that should get all users. <a href="#a2f8e928ed02e462b40e909965250fb7d"></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#a0cb7168a6b8358106512804ff28cea17">createWebuser</a> ($name, $pass, $mail)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">creates a webuser. <a href="#a0cb7168a6b8358106512804ff28cea17"></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#ac3a8cb9a038f6aef0bd98be091274122">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="#ac3a8cb9a038f6aef0bd98be091274122"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a37275e677004927b6b1a30e16c5b5b38">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="#a37275e677004927b6b1a30e16c5b5b38"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#ac3a8cb9a038f6aef0bd98be091274122">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="#ac3a8cb9a038f6aef0bd98be091274122"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a37275e677004927b6b1a30e16c5b5b38">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="#a37275e677004927b6b1a30e16c5b5b38"></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="classWebUsers.html#a8f11c60ae8f70a5059b97bc0ea9d0de5">$uId</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The user id. <a href="#a8f11c60ae8f70a5059b97bc0ea9d0de5"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#afc31993e855f9631572adfedcfe6f34b">$login</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The username. <a href="#afc31993e855f9631572adfedcfe6f34b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#ad634f418b20382e2802f80532d76d3cd">$email</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The email address. <a href="#ad634f418b20382e2802f80532d76d3cd"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a55793c72c535d153ffd3f0e43377898b">$firstname</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The users first name. <a href="#a55793c72c535d153ffd3f0e43377898b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a1d2ddb6354180329b59e8b90ed94dc7f">$lastname</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The users last name. <a href="#a1d2ddb6354180329b59e8b90ed94dc7f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a0f1d7cfb9dc6f494b9014885205fc47e">$gender</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The gender. <a href="#a0f1d7cfb9dc6f494b9014885205fc47e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a1437a5f6eb157f0eb267a26e0ad4f1ba">$country</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">2 letter word matching the country of the user <a href="#a1437a5f6eb157f0eb267a26e0ad4f1ba"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a3c74ba660e348124f36d978b137f691d">$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="#a3c74ba660e348124f36d978b137f691d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWebUsers.html#a83170d318260a5a2e2a79dccdd371b10">$language</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Language of the user. <a href="#a83170d318260a5a2e2a79dccdd371b10"></a><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="a4e63742e531873e01e1e97dd7530539b"></a><!-- doxytag: member="WebUsers::__construct" ref="a4e63742e531873e01e1e97dd7530539b" args="($UId=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a4e63742e531873e01e1e97dd7530539b">__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> <a class="anchor" id="a4e63742e531873e01e1e97dd7530539b"></a><!-- doxytag: member="WebUsers::__construct" ref="a4e63742e531873e01e1e97dd7530539b" args="($UId=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a4e63742e531873e01e1e97dd7530539b">__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="a37275e677004927b6b1a30e16c5b5b38"></a><!-- doxytag: member="WebUsers::checkEmailExists" ref="a37275e677004927b6b1a30e16c5b5b38" args="($email)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a37275e677004927b6b1a30e16c5b5b38">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. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$email</td><td>the email address in question. </td></tr> </table> </dd> </dl> <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#a37275e677004927b6b1a30e16c5b5b38">Users</a>.</p> </div> </div> <a class="anchor" id="a37275e677004927b6b1a30e16c5b5b38"></a><!-- doxytag: member="WebUsers::checkEmailExists" ref="a37275e677004927b6b1a30e16c5b5b38" args="($email)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a37275e677004927b6b1a30e16c5b5b38">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. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$email</td><td>the email address in question. </td></tr> </table> </dd> </dl> <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#a37275e677004927b6b1a30e16c5b5b38">Users</a>.</p> </div> </div> <a class="anchor" id="a11894eb69bb2f172baf5186e8f92246d"></a><!-- doxytag: member="WebUsers::checkLoginMatch" ref="a11894eb69bb2f172baf5186e8f92246d" args="($username, $password)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a11894eb69bb2f172baf5186e8f92246d">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#af0b98012abb190cf4617999f008de27e">Users</a>.</p> </div> </div> <a class="anchor" id="a11894eb69bb2f172baf5186e8f92246d"></a><!-- doxytag: member="WebUsers::checkLoginMatch" ref="a11894eb69bb2f172baf5186e8f92246d" args="($username, $password)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a11894eb69bb2f172baf5186e8f92246d">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#af0b98012abb190cf4617999f008de27e">Users</a>.</p> </div> </div> <a class="anchor" id="ac3a8cb9a038f6aef0bd98be091274122"></a><!-- doxytag: member="WebUsers::checkUserNameExists" ref="ac3a8cb9a038f6aef0bd98be091274122" args="($username)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#ac3a8cb9a038f6aef0bd98be091274122">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. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$username</td><td>the username in question </td></tr> </table> </dd> </dl> <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#ac3a8cb9a038f6aef0bd98be091274122">Users</a>.</p> </div> </div> <a class="anchor" id="ac3a8cb9a038f6aef0bd98be091274122"></a><!-- doxytag: member="WebUsers::checkUserNameExists" ref="ac3a8cb9a038f6aef0bd98be091274122" args="($username)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#ac3a8cb9a038f6aef0bd98be091274122">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. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$username</td><td>the username in question </td></tr> </table> </dd> </dl> <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#ac3a8cb9a038f6aef0bd98be091274122">Users</a>.</p> </div> </div> <a class="anchor" id="a0cb7168a6b8358106512804ff28cea17"></a><!-- doxytag: member="WebUsers::createWebuser" ref="a0cb7168a6b8358106512804ff28cea17" args="($name, $pass, $mail)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classWebUsers.html#a0cb7168a6b8358106512804ff28cea17">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="a0cb7168a6b8358106512804ff28cea17"></a><!-- doxytag: member="WebUsers::createWebuser" ref="a0cb7168a6b8358106512804ff28cea17" args="($name, $pass, $mail)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classWebUsers.html#a0cb7168a6b8358106512804ff28cea17">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="a2f8e928ed02e462b40e909965250fb7d"></a><!-- doxytag: member="WebUsers::getAllUsersQuery" ref="a2f8e928ed02e462b40e909965250fb7d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classWebUsers.html#a2f8e928ed02e462b40e909965250fb7d">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="a2f8e928ed02e462b40e909965250fb7d"></a><!-- doxytag: member="WebUsers::getAllUsersQuery" ref="a2f8e928ed02e462b40e909965250fb7d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classWebUsers.html#a2f8e928ed02e462b40e909965250fb7d">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="a02a01849f28e2535e888ae4ec87b20f2"></a><!-- doxytag: member="WebUsers::getEmail" ref="a02a01849f28e2535e888ae4ec87b20f2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a02a01849f28e2535e888ae4ec87b20f2">getEmail</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>get email attribute of the object. </p> </div> </div> <a class="anchor" id="a02a01849f28e2535e888ae4ec87b20f2"></a><!-- doxytag: member="WebUsers::getEmail" ref="a02a01849f28e2535e888ae4ec87b20f2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a02a01849f28e2535e888ae4ec87b20f2">getEmail</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>get email attribute of the object. </p> </div> </div> <a class="anchor" id="a585ef354b38d0fad9d92f45e183b639f"></a><!-- doxytag: member="WebUsers::getId" ref="a585ef354b38d0fad9d92f45e183b639f" args="($username)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classWebUsers.html#a585ef354b38d0fad9d92f45e183b639f">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="a585ef354b38d0fad9d92f45e183b639f"></a><!-- doxytag: member="WebUsers::getId" ref="a585ef354b38d0fad9d92f45e183b639f" args="($username)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classWebUsers.html#a585ef354b38d0fad9d92f45e183b639f">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="aee8d6b322defc5dfe8e47f382becca62"></a><!-- doxytag: member="WebUsers::getIdFromEmail" ref="aee8d6b322defc5dfe8e47f382becca62" args="($email)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classWebUsers.html#aee8d6b322defc5dfe8e47f382becca62">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="aee8d6b322defc5dfe8e47f382becca62"></a><!-- doxytag: member="WebUsers::getIdFromEmail" ref="aee8d6b322defc5dfe8e47f382becca62" args="($email)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classWebUsers.html#aee8d6b322defc5dfe8e47f382becca62">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="a164026f74736817927e1cacd282a2e28"></a><!-- doxytag: member="WebUsers::getInfo" ref="a164026f74736817927e1cacd282a2e28" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a164026f74736817927e1cacd282a2e28">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="a164026f74736817927e1cacd282a2e28"></a><!-- doxytag: member="WebUsers::getInfo" ref="a164026f74736817927e1cacd282a2e28" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a164026f74736817927e1cacd282a2e28">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="afcef2403c4111bc44ef0530f1e493909"></a><!-- doxytag: member="WebUsers::getLanguage" ref="afcef2403c4111bc44ef0530f1e493909" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#afcef2403c4111bc44ef0530f1e493909">getLanguage</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>get language attribute of the object. </p> </div> </div> <a class="anchor" id="afcef2403c4111bc44ef0530f1e493909"></a><!-- doxytag: member="WebUsers::getLanguage" ref="afcef2403c4111bc44ef0530f1e493909" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#afcef2403c4111bc44ef0530f1e493909">getLanguage</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>get language attribute of the object. </p> </div> </div> <a class="anchor" id="ae4680f622bd8d571530615fb616d37e7"></a><!-- doxytag: member="WebUsers::getReceiveMail" ref="ae4680f622bd8d571530615fb616d37e7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#ae4680f622bd8d571530615fb616d37e7">getReceiveMail</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>get receiveMail attribute of the object. </p> </div> </div> <a class="anchor" id="ae4680f622bd8d571530615fb616d37e7"></a><!-- doxytag: member="WebUsers::getReceiveMail" ref="ae4680f622bd8d571530615fb616d37e7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#ae4680f622bd8d571530615fb616d37e7">getReceiveMail</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>get receiveMail attribute of the object. </p> </div> </div> <a class="anchor" id="aa36a98da4146d85e7813e99df7d97497"></a><!-- doxytag: member="WebUsers::getUId" ref="aa36a98da4146d85e7813e99df7d97497" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#aa36a98da4146d85e7813e99df7d97497">getUId</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>get uId attribute of the object. </p> </div> </div> <a class="anchor" id="aa36a98da4146d85e7813e99df7d97497"></a><!-- doxytag: member="WebUsers::getUId" ref="aa36a98da4146d85e7813e99df7d97497" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#aa36a98da4146d85e7813e99df7d97497">getUId</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>get uId attribute of the object. </p> </div> </div> <a class="anchor" id="a81b37a3c9d639574e394f80c1138c75e"></a><!-- doxytag: member="WebUsers::getUsername" ref="a81b37a3c9d639574e394f80c1138c75e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a81b37a3c9d639574e394f80c1138c75e">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="a81b37a3c9d639574e394f80c1138c75e"></a><!-- doxytag: member="WebUsers::getUsername" ref="a81b37a3c9d639574e394f80c1138c75e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a81b37a3c9d639574e394f80c1138c75e">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="a0fc10b64683021b70c7eb95fb514c119"></a><!-- doxytag: member="WebUsers::getUsers" ref="a0fc10b64683021b70c7eb95fb514c119" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a0fc10b64683021b70c7eb95fb514c119">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="a0fc10b64683021b70c7eb95fb514c119"></a><!-- doxytag: member="WebUsers::getUsers" ref="a0fc10b64683021b70c7eb95fb514c119" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a0fc10b64683021b70c7eb95fb514c119">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="a33bdd79e5da367ebddd4cfbdbbfc7cff"></a><!-- doxytag: member="WebUsers::isLoggedIn" ref="a33bdd79e5da367ebddd4cfbdbbfc7cff" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a33bdd79e5da367ebddd4cfbdbbfc7cff">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="a33bdd79e5da367ebddd4cfbdbbfc7cff"></a><!-- doxytag: member="WebUsers::isLoggedIn" ref="a33bdd79e5da367ebddd4cfbdbbfc7cff" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a33bdd79e5da367ebddd4cfbdbbfc7cff">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="a8bdfe0a5256e35367225bcd6d278ef21"></a><!-- doxytag: member="WebUsers::set" ref="a8bdfe0a5256e35367225bcd6d278ef21" args="($values)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.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. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a8bdfe0a5256e35367225bcd6d278ef21"></a><!-- doxytag: member="WebUsers::set" ref="a8bdfe0a5256e35367225bcd6d278ef21" args="($values)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.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. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a0cd214763f395718db166fbd598689f4"></a><!-- doxytag: member="WebUsers::setEmail" ref="a0cd214763f395718db166fbd598689f4" args="($user, $mail)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a0cd214763f395718db166fbd598689f4">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="a0cd214763f395718db166fbd598689f4"></a><!-- doxytag: member="WebUsers::setEmail" ref="a0cd214763f395718db166fbd598689f4" args="($user, $mail)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a0cd214763f395718db166fbd598689f4">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="a5ab1bd5f0959a3c33a46c176d9412c80"></a><!-- doxytag: member="WebUsers::setLanguage" ref="a5ab1bd5f0959a3c33a46c176d9412c80" args="($user, $language)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classWebUsers.html#a5ab1bd5f0959a3c33a46c176d9412c80">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="a5ab1bd5f0959a3c33a46c176d9412c80"></a><!-- doxytag: member="WebUsers::setLanguage" ref="a5ab1bd5f0959a3c33a46c176d9412c80" args="($user, $language)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classWebUsers.html#a5ab1bd5f0959a3c33a46c176d9412c80">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="a91506e5f74c9884045e865ef7c314fed"></a><!-- doxytag: member="WebUsers::setPassword" ref="a91506e5f74c9884045e865ef7c314fed" args="($user, $pass)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a91506e5f74c9884045e865ef7c314fed">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="a91506e5f74c9884045e865ef7c314fed"></a><!-- doxytag: member="WebUsers::setPassword" ref="a91506e5f74c9884045e865ef7c314fed" args="($user, $pass)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWebUsers.html#a91506e5f74c9884045e865ef7c314fed">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="aa0f439ff7a5cd6377a557f545fbeb45c"></a><!-- doxytag: member="WebUsers::setReceiveMail" ref="aa0f439ff7a5cd6377a557f545fbeb45c" args="($user, $receivemail)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classWebUsers.html#aa0f439ff7a5cd6377a557f545fbeb45c">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> <a class="anchor" id="aa0f439ff7a5cd6377a557f545fbeb45c"></a><!-- doxytag: member="WebUsers::setReceiveMail" ref="aa0f439ff7a5cd6377a557f545fbeb45c" args="($user, $receivemail)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classWebUsers.html#aa0f439ff7a5cd6377a557f545fbeb45c">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>Field Documentation</h2> <a class="anchor" id="a1437a5f6eb157f0eb267a26e0ad4f1ba"></a><!-- doxytag: member="WebUsers::$country" ref="a1437a5f6eb157f0eb267a26e0ad4f1ba" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">$country<code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>2 letter word matching the country of the user </p> </div> </div> <a class="anchor" id="ad634f418b20382e2802f80532d76d3cd"></a><!-- doxytag: member="WebUsers::$email" ref="ad634f418b20382e2802f80532d76d3cd" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">$email<code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The email address. </p> </div> </div> <a class="anchor" id="a55793c72c535d153ffd3f0e43377898b"></a><!-- doxytag: member="WebUsers::$firstname" ref="a55793c72c535d153ffd3f0e43377898b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">$firstname<code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The users first name. </p> </div> </div> <a class="anchor" id="a0f1d7cfb9dc6f494b9014885205fc47e"></a><!-- doxytag: member="WebUsers::$gender" ref="a0f1d7cfb9dc6f494b9014885205fc47e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">$gender<code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The gender. </p> </div> </div> <a class="anchor" id="a83170d318260a5a2e2a79dccdd371b10"></a><!-- doxytag: member="WebUsers::$language" ref="a83170d318260a5a2e2a79dccdd371b10" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">$language<code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Language of the user. </p> </div> </div> <a class="anchor" id="a1d2ddb6354180329b59e8b90ed94dc7f"></a><!-- doxytag: member="WebUsers::$lastname" ref="a1d2ddb6354180329b59e8b90ed94dc7f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">$lastname<code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The users last name. </p> </div> </div> <a class="anchor" id="afc31993e855f9631572adfedcfe6f34b"></a><!-- doxytag: member="WebUsers::$login" ref="afc31993e855f9631572adfedcfe6f34b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">$<a class="el" href="inc_2login_8php.html#aa311da27ba5706f5710cea7706c8eae1">login</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The username. </p> </div> </div> <a class="anchor" id="a3c74ba660e348124f36d978b137f691d"></a><!-- doxytag: member="WebUsers::$receiveMail" ref="a3c74ba660e348124f36d978b137f691d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">$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> <a class="anchor" id="a8f11c60ae8f70a5059b97bc0ea9d0de5"></a><!-- doxytag: member="WebUsers::$uId" ref="a8f11c60ae8f70a5059b97bc0ea9d0de5" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">$uId<code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The user id. </p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li>/home/daan/ryzom/ryzomcore/code/ryzom/tools/server/ryzom_ams/drupal_module/ryzommanage/autoload/<a class="el" href="drupal__module_2ryzommanage_2autoload_2webusers_8php.html">webusers.php</a></li> <li>/home/daan/ryzom/ryzomcore/code/ryzom/tools/server/ryzom_ams/www/html/autoload/<a class="el" href="www_2html_2autoload_2webusers_8php.html">webusers.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>