LDAPAccountManager/lam-web/developers/phpdoc/types/_lib---types.inc.html

304 lines
10 KiB
HTML

<html>
<head>
<title>Docs for page types.inc</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">types</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="../classtrees_types.html" class="menu">class tree: types</a> ]
[ <a href="../elementindex_types.html" class="menu">index: types</a> ]
[ <a href="../elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="ric">
<p><a href="../ric_INSTALL.html">INSTALL</a></p>
<p><a href="../ric_README.html">README</a></p>
</div>
<b>Packages:</b><br />
<a href="../li_configuration.html">configuration</a><br />
<a href="../li_Help.html">Help</a><br />
<a href="../li_LDAP.html">LDAP</a><br />
<a href="../li_lib.html">lib</a><br />
<a href="../li_lists.html">lists</a><br />
<a href="../li_main.html">main</a><br />
<a href="../li_modules.html">modules</a><br />
<a href="../li_PDF.html">PDF</a><br />
<a href="../li_profiles.html">profiles</a><br />
<a href="../li_selfService.html">selfService</a><br />
<a href="../li_tests.html">tests</a><br />
<a href="../li_tools.html">tools</a><br />
<a href="../li_types.html">types</a><br />
<br /><br />
<b>Files:</b><br />
<div class="package">
<a href="../types/_lib---baseType.inc.html"> baseType.inc
</a><br>
<a href="../types/_lib---types---group.inc.html"> group.inc
</a><br>
<a href="../types/_lib---types---host.inc.html"> host.inc
</a><br>
<a href="../types/_lib---types---mailAlias.inc.html"> mailAlias.inc
</a><br>
<a href="../types/_lib---types---smbDomain.inc.html"> smbDomain.inc
</a><br>
<a href="../types/_lib---types.inc.html"> types.inc
</a><br>
<a href="../types/_lib---types---user.inc.html"> user.inc
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="../types/baseType.html">baseType</a><br />
<a href="../types/group.html">group</a><br />
<a href="../types/host.html">host</a><br />
<a href="../types/mailAlias.html">mailAlias</a><br />
<a href="../types/smbDomain.html">smbDomain</a><br />
<a href="../types/user.html">user</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<h1>Procedural File: types.inc</h1>
Source Location: /lib/types.inc<br /><br />
<br>
<br>
<h2>Page Details:</h2>
This file is the interface to the different account types.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Roland Gruber</td>
</tr>
</table>
</div>
<br /><br />
<h4>Includes:</h4>
<div class="tags">
include_once(<a href="../types/_lib---baseType.inc.html">"baseType.inc"</a>) [line 32]<br />
parent class of account types<br /><br />include_once(<a href="../lists/_lib---lists.inc.html">"lists.inc"</a>) [line 34]<br />
parent class of list views<br /><br />include_once($typesINC_dirname.'/'.$entry) [line 45]<br />
This includes all type definitions.<br /><br /></div>
<br /><br />
<br /><br />
<br />
<hr />
<a name="functiongetDefaultListAttributes"></a>
<h3>getDefaultListAttributes <span class="smalllinenumber">[line 107]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getDefaultListAttributes(
string $type)</code>
</td></tr></table>
</td></tr></table><br />
Returns the default attribute list for an account type.<br /><br /><p>It is used as default value for the configuration editor.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>attribute list</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$type</b>&nbsp;&nbsp;</td>
<td>account type</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiongetListAttributeDescriptions"></a>
<h3>getListAttributeDescriptions <span class="smalllinenumber">[line 119]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getListAttributeDescriptions(
string $type)</code>
</td></tr></table>
</td></tr></table><br />
Returns a list of attributes which have a translated description.<br /><br /><p>This is used for the head row in the list view.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>list of descriptions</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$type</b>&nbsp;&nbsp;</td>
<td>account type</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiongetListClassName"></a>
<h3>getListClassName <span class="smalllinenumber">[line 95]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getListClassName(
string $type)</code>
</td></tr></table>
</td></tr></table><br />
Returns the class name for the list object.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>class name</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$type</b>&nbsp;&nbsp;</td>
<td>account type</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiongetTypeAlias"></a>
<h3>getTypeAlias <span class="smalllinenumber">[line 73]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getTypeAlias(
string $type)</code>
</td></tr></table>
</td></tr></table><br />
Returns the alias name of an account type.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>type alias</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$type</b>&nbsp;&nbsp;</td>
<td>type name</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiongetTypeDescription"></a>
<h3>getTypeDescription <span class="smalllinenumber">[line 84]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getTypeDescription(
string $type)</code>
</td></tr></table>
</td></tr></table><br />
Returns the description of an account type.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>type description</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$type</b>&nbsp;&nbsp;</td>
<td>type name</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiongetTypes"></a>
<h3>getTypes <span class="smalllinenumber">[line 54]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getTypes(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns a list of available account types.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>list of types</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<div class="credit">
<hr />
Documentation generated on Sun, 04 Nov 2007 12:11:15 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>