khanat-opennel-code/code/ryzom/tools/server/ryzom_ams_docs/html/classTicket__Category.html

402 lines
18 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Ryzom Account Management System: Ticket_Category 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">Ticket_Category Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="Ticket_Category" -->
<p>Class related to the ticket categories.
<a href="classTicket__Category.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="classTicket__Category.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="classTicket__Category.html#ab3a70940917530d91a39536a6d45a21d">load_With_TCategoryId</a> ($id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">loads the object's attributes. <a href="#ab3a70940917530d91a39536a6d45a21d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Category.html#a842e4774e3b3601a005b995c02f7e883">update</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">update object attributes to the DB. <a href="#a842e4774e3b3601a005b995c02f7e883"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Category.html#a3d0963e68bb313b163a73f2803c64600">getName</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get name attribute of the object. <a href="#a3d0963e68bb313b163a73f2803c64600"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Category.html#acb530a119e5e52230a92ece95cc7ec82">getTCategoryId</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get tCategoryId attribute of the object. <a href="#acb530a119e5e52230a92ece95cc7ec82"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Category.html#aa3dcc220094e19fef1f918a3a917dba7">setName</a> ($n)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set name attribute of the object. <a href="#aa3dcc220094e19fef1f918a3a917dba7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Category.html#a39a64c3f7ab33ba3f5a67c31647e889f">setTCategoryId</a> ($id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set tCategoryId attribute of the object. <a href="#a39a64c3f7ab33ba3f5a67c31647e889f"></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="classTicket__Category.html#a506fc7f32de9547e91a5dbb68c391907">createTicketCategory</a> ($name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">creates a ticket_Catergory in the DB. <a href="#a506fc7f32de9547e91a5dbb68c391907"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Category.html#a332d2dd59b46fc933a3c9a1b2967803a">constr_TCategoryId</a> ($id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">construct a category object based on the TCategoryId. <a href="#a332d2dd59b46fc933a3c9a1b2967803a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Category.html#a1e4b8ecfd737337e35976126b521499f">getAllCategories</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return a list of all category objects. <a href="#a1e4b8ecfd737337e35976126b521499f"></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="classTicket__Category.html#a0111df4559c9f524272d94df0b7f9d6b">$tCategoryId</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The id of the category. <a href="#a0111df4559c9f524272d94df0b7f9d6b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTicket__Category.html#ab2fc40d43824ea3e1ce5d86dee0d763b">$name</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the category. <a href="#ab2fc40d43824ea3e1ce5d86dee0d763b"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class related to the ticket categories. </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="Ticket_Category::__construct" ref="a095c5d389db211932136b53f25f39685" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Category.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="a332d2dd59b46fc933a3c9a1b2967803a"></a><!-- doxytag: member="Ticket_Category::constr_TCategoryId" ref="a332d2dd59b46fc933a3c9a1b2967803a" args="($id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket__Category.html#a332d2dd59b46fc933a3c9a1b2967803a">constr_TCategoryId</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>construct a category object based on the TCategoryId. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>constructed element based on TCategoryId </dd></dl>
</div>
</div>
<a class="anchor" id="a506fc7f32de9547e91a5dbb68c391907"></a><!-- doxytag: member="Ticket_Category::createTicketCategory" ref="a506fc7f32de9547e91a5dbb68c391907" args="($name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket__Category.html#a506fc7f32de9547e91a5dbb68c391907">createTicketCategory</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>creates a ticket_Catergory in the DB. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>name we want to give to the new category. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1e4b8ecfd737337e35976126b521499f"></a><!-- doxytag: member="Ticket_Category::getAllCategories" ref="a1e4b8ecfd737337e35976126b521499f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTicket__Category.html#a1e4b8ecfd737337e35976126b521499f">getAllCategories</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return a list of all category objects. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array consisting of all category objects. </dd></dl>
</div>
</div>
<a class="anchor" id="a3d0963e68bb313b163a73f2803c64600"></a><!-- doxytag: member="Ticket_Category::getName" ref="a3d0963e68bb313b163a73f2803c64600" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Category.html#a3d0963e68bb313b163a73f2803c64600">getName</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get name attribute of the object. </p>
</div>
</div>
<a class="anchor" id="acb530a119e5e52230a92ece95cc7ec82"></a><!-- doxytag: member="Ticket_Category::getTCategoryId" ref="acb530a119e5e52230a92ece95cc7ec82" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Category.html#acb530a119e5e52230a92ece95cc7ec82">getTCategoryId</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get tCategoryId attribute of the object. </p>
</div>
</div>
<a class="anchor" id="ab3a70940917530d91a39536a6d45a21d"></a><!-- doxytag: member="Ticket_Category::load_With_TCategoryId" ref="ab3a70940917530d91a39536a6d45a21d" args="($id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Category.html#ab3a70940917530d91a39536a6d45a21d">load_With_TCategoryId</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>loads the object's attributes. </p>
<p>loads the object's attributes by giving a categories id. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$id</td><td>the id of the ticket_category that should be loaded </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa3dcc220094e19fef1f918a3a917dba7"></a><!-- doxytag: member="Ticket_Category::setName" ref="aa3dcc220094e19fef1f918a3a917dba7" args="($n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Category.html#aa3dcc220094e19fef1f918a3a917dba7">setName</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set name attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$n</td><td>name of the category </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a39a64c3f7ab33ba3f5a67c31647e889f"></a><!-- doxytag: member="Ticket_Category::setTCategoryId" ref="a39a64c3f7ab33ba3f5a67c31647e889f" args="($id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Category.html#a39a64c3f7ab33ba3f5a67c31647e889f">setTCategoryId</a> </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set tCategoryId attribute of the object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">$id</td><td>integer id of the category </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a842e4774e3b3601a005b995c02f7e883"></a><!-- doxytag: member="Ticket_Category::update" ref="a842e4774e3b3601a005b995c02f7e883" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTicket__Category.html#a842e4774e3b3601a005b995c02f7e883">update</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>update object attributes to the DB. </p>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="ab2fc40d43824ea3e1ce5d86dee0d763b"></a><!-- doxytag: member="Ticket_Category::$name" ref="ab2fc40d43824ea3e1ce5d86dee0d763b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$name<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of the category. </p>
</div>
</div>
<a class="anchor" id="a0111df4559c9f524272d94df0b7f9d6b"></a><!-- doxytag: member="Ticket_Category::$tCategoryId" ref="a0111df4559c9f524272d94df0b7f9d6b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$tCategoryId<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The id of the category. </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="ticket__category_8php.html">ticket_category.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 Sat Sep 14 2013 00:33:46 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>