aleajactaest/khanat-opennel-code
1
0
Fork 0
mirror of https://port.numenaute.org/aleajactaest/khanat-opennel-code.git synced 2024-12-18 23:18:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
khanat-opennel-code/code/web/docs/ams/html/classIn__Support__Group.html

393 lines
18 KiB
HTML
Raw Blame History

<!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: In_Support_Group Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Ryzom Account Management System
&#160;<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;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&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">In_Support_Group Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="In_Support_Group" -->
<p>Handles the linkage of users being in a support group.
<a href="classIn__Support__Group.html#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a095c5d389db211932136b53f25f39685">__construct</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor. <a href="#a095c5d389db211932136b53f25f39685"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a8bdfe0a5256e35367225bcd6d278ef21">set</a> ($values)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">sets the object's attributes. <a href="#a8bdfe0a5256e35367225bcd6d278ef21"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a435e7d7525d4bcd0ed5e34a469f3adf6">create</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">creates a new 'in_support_group' entry. <a href="#a435e7d7525d4bcd0ed5e34a469f3adf6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a13bdffdd926f26b825ea57066334ff01">delete</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">deletes an existing 'in_support_group' entry. <a href="#a13bdffdd926f26b825ea57066334ff01"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#ae81b7186fb97a7c6457edcc68c9aa2ef">getUser</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get user attribute of the object. <a href="#ae81b7186fb97a7c6457edcc68c9aa2ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a4f44e7bc9de772c21b4304d11e87bf16">getGroup</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get group attribute of the object. <a href="#a4f44e7bc9de772c21b4304d11e87bf16"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#af560ca7f201e2f871384a150e8ffd9aa">setUser</a> ($u)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set user attribute of the object. <a href="#af560ca7f201e2f871384a150e8ffd9aa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a3116db27c2e2f33cbb10a9488db34da3">setGroup</a> ($g)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set group attribute of the object. <a href="#a3116db27c2e2f33cbb10a9488db34da3"></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&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a1a25afa24efc6c01ffd236f735281543">userExistsInSGroup</a> ($user_id, $group_id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if user is in in_support_group. <a href="#a1a25afa24efc6c01ffd236f735281543"></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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a598ca4e71b15a1313ec95f0df1027ca5">$user</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The id of the user being in a support group. <a href="#a598ca4e71b15a1313ec95f0df1027ca5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#ad530a85733b0ec1dc321859fd8faa0dc">$group</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The id of the support group. <a href="#ad530a85733b0ec1dc321859fd8faa0dc"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Handles the linkage of users being in a support group. </p>
<p>Moderators and Admins can be part of a support group, this class offers functionality to check if a link between a user and group is existing. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Daan Janssens, mentored by Matthew Lagoe </dd></dl>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a095c5d389db211932136b53f25f39685"></a><!-- doxytag: member="In_Support_Group::__construct" ref="a095c5d389db211932136b53f25f39685" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classIn__Support__Group.html#a095c5d389db211932136b53f25f39685">__construct</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A constructor. </p>
<p>Empty constructor </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a435e7d7525d4bcd0ed5e34a469f3adf6"></a><!-- doxytag: member="In_Support_Group::create" ref="a435e7d7525d4bcd0ed5e34a469f3adf6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classIn__Support__Group.html#a435e7d7525d4bcd0ed5e34a469f3adf6">create</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>creates a new 'in_support_group' entry. </p>
<p>this method will use the object's attributes for creating a new 'in_support_group' entry in the database. </p>
</div>
</div>
<a class="anchor" id="a13bdffdd926f26b825ea57066334ff01"></a><!-- doxytag: member="In_Support_Group::delete" ref="a13bdffdd926f26b825ea57066334ff01" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classIn__Support__Group.html#a13bdffdd926f26b825ea57066334ff01">delete</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>deletes an existing 'in_support_group' entry. </p>
<p>this method will use the object's attributes for deleting an existing 'in_support_group' entry in the database. </p>
</div>
</div>
<a class="anchor" id="a4f44e7bc9de772c21b4304d11e87bf16"></a><!-- doxytag: member="In_Support_Group::getGroup" ref="a4f44e7bc9de772c21b4304d11e87bf16" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classIn__Support__Group.html#a4f44e7bc9de772c21b4304d11e87bf16">getGroup</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get group attribute of the object. </p>
</div>
</div>
<a class="anchor" id="ae81b7186fb97a7c6457edcc68c9aa2ef"></a><!-- doxytag: member="In_Support_Group::getUser" ref="ae81b7186fb97a7c6457edcc68c9aa2ef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classIn__Support__Group.html#ae81b7186fb97a7c6457edcc68c9aa2ef">getUser</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get user attribute of the object. </p>
</div>
</div>
<a class="anchor" id="a8bdfe0a5256e35367225bcd6d278ef21"></a><!-- doxytag: member="In_Support_Group::set" ref="a8bdfe0a5256e35367225bcd6d278ef21" args="($values)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classIn__Support__Group.html#a8bdfe0a5256e35367225bcd6d278ef21">set</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>values</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sets the object's attributes. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$values</td><td>should be an array of the form array('User' =&gt; user_id, 'Group' =&gt; support_groups_id). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3116db27c2e2f33cbb10a9488db34da3"></a><!-- doxytag: member="In_Support_Group::setGroup" ref="a3116db27c2e2f33cbb10a9488db34da3" args="($g)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classIn__Support__Group.html#a3116db27c2e2f33cbb10a9488db34da3">setGroup</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>g</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set group attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$g</td><td>integer id of the support group </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af560ca7f201e2f871384a150e8ffd9aa"></a><!-- doxytag: member="In_Support_Group::setUser" ref="af560ca7f201e2f871384a150e8ffd9aa" args="($u)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classIn__Support__Group.html#af560ca7f201e2f871384a150e8ffd9aa">setUser</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>u</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set user attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$u</td><td>integer id of the user </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1a25afa24efc6c01ffd236f735281543"></a><!-- doxytag: member="In_Support_Group::userExistsInSGroup" ref="a1a25afa24efc6c01ffd236f735281543" args="($user_id, $group_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classIn__Support__Group.html#a1a25afa24efc6c01ffd236f735281543">userExistsInSGroup</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>user_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>group_id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if user is in in_support_group. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$user_id</td><td>the id of the user. </td></tr>
<tr><td class="paramname">$group_id</td><td>the id of the support group. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true is returned in case the user is in the support group, else false is returned. </dd></dl>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="ad530a85733b0ec1dc321859fd8faa0dc"></a><!-- doxytag: member="In_Support_Group::$group" ref="ad530a85733b0ec1dc321859fd8faa0dc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$group<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The id of the support group. </p>
</div>
</div>
<a class="anchor" id="a598ca4e71b15a1313ec95f0df1027ca5"></a><!-- doxytag: member="In_Support_Group::$user" ref="a598ca4e71b15a1313ec95f0df1027ca5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$user<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The id of the user being in a support group. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/daan/ryzom/ryzomcore/code/ryzom/tools/server/ryzom_ams/ams_lib/autoload/<a class="el" href="in__support__group_8php.html">in_support_group.php</a></li>
</ul>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</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 &#160;<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>
Reference in a new issue View git blame Copy permalink