330 lines
16 KiB
HTML
330 lines
16 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: 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 style="padding-left: 0.5em;">
|
|
<div id="projectname">Ryzom Account Management System
|
|
|
|
</div>
|
|
|
|
</td>
|
|
|
|
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<!-- Generated by Doxygen 1.7.6.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="dirs.html"><span>Directories</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">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>
|
|
|
|
<p><a href="classIn__Support__Group-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="classIn__Support__Group.html#af4b764c40f52108c6ea90534d38c8bae">__construct</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">A constructor. <a href="#af4b764c40f52108c6ea90534d38c8bae"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#af0c47b359920019e0195ad31519437ea">set</a> ($values)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets the object's attributes. <a href="#af0c47b359920019e0195ad31519437ea"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a19eb31ee240ca0d78f70363dae4555b9">create</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">creates a new 'in_support_group' entry. <a href="#a19eb31ee240ca0d78f70363dae4555b9"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a14b353623a7af41c0e801d79c7c5f9c0">delete</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">deletes an existing 'in_support_group' entry. <a href="#a14b353623a7af41c0e801d79c7c5f9c0"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add8c8620030ac6d125bc7f5787d7e501"></a><!-- doxytag: member="In_Support_Group::getUser" ref="add8c8620030ac6d125bc7f5787d7e501" args="()" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#add8c8620030ac6d125bc7f5787d7e501">getUser</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get user attribute of the object. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9682d3369161a216dd24695f5348d0e0"></a><!-- doxytag: member="In_Support_Group::getGroup" ref="a9682d3369161a216dd24695f5348d0e0" args="()" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a9682d3369161a216dd24695f5348d0e0">getGroup</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get group 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="classIn__Support__Group.html#a83b004d30957217bf8fe570df50c4601">setUser</a> ($u)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set user attribute of the object. <a href="#a83b004d30957217bf8fe570df50c4601"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#adf6c62710753773bb90123e4d0f1c7b0">setGroup</a> ($g)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set group attribute of the object. <a href="#adf6c62710753773bb90123e4d0f1c7b0"></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="classIn__Support__Group.html#a5c50054a5ee9171859a329f9e3ef57bb">userExistsInSGroup</a> ($user_id, $group_id)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if user is in in_support_group. <a href="#a5c50054a5ee9171859a329f9e3ef57bb"></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="a50e2869129d0542a657de987e21e8517"></a><!-- doxytag: member="In_Support_Group::$user" ref="a50e2869129d0542a657de987e21e8517" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a50e2869129d0542a657de987e21e8517">$user</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The id of the user being in a support group. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4baa32d40511a8e53a942346c997424c"></a><!-- doxytag: member="In_Support_Group::$group" ref="a4baa32d40511a8e53a942346c997424c" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classIn__Support__Group.html#a4baa32d40511a8e53a942346c997424c">$group</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The id of the support group. <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 & Destructor Documentation</h2>
|
|
<a class="anchor" id="af4b764c40f52108c6ea90534d38c8bae"></a><!-- doxytag: member="In_Support_Group::__construct" ref="af4b764c40f52108c6ea90534d38c8bae" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classIn__Support__Group.html#af4b764c40f52108c6ea90534d38c8bae">In_Support_Group::__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="a19eb31ee240ca0d78f70363dae4555b9"></a><!-- doxytag: member="In_Support_Group::create" ref="a19eb31ee240ca0d78f70363dae4555b9" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classIn__Support__Group.html#a19eb31ee240ca0d78f70363dae4555b9">In_Support_Group::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="a14b353623a7af41c0e801d79c7c5f9c0"></a><!-- doxytag: member="In_Support_Group::delete" ref="a14b353623a7af41c0e801d79c7c5f9c0" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classIn__Support__Group.html#a14b353623a7af41c0e801d79c7c5f9c0">In_Support_Group::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="af0c47b359920019e0195ad31519437ea"></a><!-- doxytag: member="In_Support_Group::set" ref="af0c47b359920019e0195ad31519437ea" args="($values)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classIn__Support__Group.html#af0c47b359920019e0195ad31519437ea">In_Support_Group::set</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>values</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>sets the object's attributes. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$values</td><td>should be an array of the form array('User' => user_id, 'Group' => support_groups_id). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adf6c62710753773bb90123e4d0f1c7b0"></a><!-- doxytag: member="In_Support_Group::setGroup" ref="adf6c62710753773bb90123e4d0f1c7b0" args="($g)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classIn__Support__Group.html#adf6c62710753773bb90123e4d0f1c7b0">In_Support_Group::setGroup</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </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="a83b004d30957217bf8fe570df50c4601"></a><!-- doxytag: member="In_Support_Group::setUser" ref="a83b004d30957217bf8fe570df50c4601" args="($u)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classIn__Support__Group.html#a83b004d30957217bf8fe570df50c4601">In_Support_Group::setUser</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </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="a5c50054a5ee9171859a329f9e3ef57bb"></a><!-- doxytag: member="In_Support_Group::userExistsInSGroup" ref="a5c50054a5ee9171859a329f9e3ef57bb" 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#a5c50054a5ee9171859a329f9e3ef57bb">In_Support_Group::userExistsInSGroup</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>user_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">$ </td>
|
|
<td class="paramname"><em>group_id</em> </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/>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/in_support_group.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>
|