LDAPAccountManager/lam-web/developers/phpdoc/elementindex_selfService.html

224 lines
12 KiB
HTML
Raw Normal View History

2006-11-15 17:12:15 +00:00
<html>
<head>
<title>Package selfService Element Index</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">selfService</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">
2007-11-04 11:19:11 +00:00
2008-01-06 18:15:35 +00:00
[ <a href="classtrees_selfService.html" class="menu">class tree: selfService</a> ]
2006-11-15 17:12:15 +00:00
[ <a href="elementindex_selfService.html" class="menu">index: selfService</a> ]
2007-11-04 11:19:11 +00:00
[ <a href="elementindex.html" class="menu">all elements</a> ]
2006-11-15 17:12:15 +00:00
</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">
2007-11-04 11:19:11 +00:00
<p><a href="ric_README.html">README</a></p>
2008-01-06 18:15:35 +00:00
<p><a href="ric_INSTALL.html">INSTALL</a></p>
2006-11-15 17:12:15 +00:00
</div>
<b>Packages:</b><br />
<a href="li_PDF.html">PDF</a><br />
2008-01-06 18:15:35 +00:00
<a href="li_lists.html">lists</a><br />
<a href="li_profiles.html">profiles</a><br />
<a href="li_LDAP.html">LDAP</a><br />
<a href="li_types.html">types</a><br />
2006-11-15 17:12:15 +00:00
<a href="li_lib.html">lib</a><br />
<a href="li_modules.html">modules</a><br />
2008-01-06 18:15:35 +00:00
<a href="li_selfService.html">selfService</a><br />
2006-11-15 17:12:15 +00:00
<a href="li_configuration.html">configuration</a><br />
<a href="li_tools.html">tools</a><br />
2008-01-06 18:15:35 +00:00
<a href="li_Help.html">Help</a><br />
2007-11-04 11:19:11 +00:00
<a href="li_tests.html">tests</a><br />
2008-01-06 18:15:35 +00:00
<a href="li_main.html">main</a><br />
2006-11-15 17:12:15 +00:00
<br /><br />
<b>Files:</b><br />
<div class="package">
2008-01-06 18:15:35 +00:00
<a href="selfService/_templates---selfService---adminLogin.php.html"> adminLogin.php
</a><br>
<a href="selfService/_templates---selfService---adminMain.php.html"> adminMain.php
</a><br>
<a href="selfService/_templates---selfService---profManage.php.html"> profManage.php
</a><br>
2007-11-04 11:19:11 +00:00
<a href="selfService/_lib---selfService.inc.html"> selfService.inc
2008-01-06 18:15:35 +00:00
</a><br>
<a href="selfService/_templates---selfService---selfServiceLogin.php.html"> selfServiceLogin.php
</a><br>
<a href="selfService/_templates---selfService---selfServiceMain.php.html"> selfServiceMain.php
2006-11-15 17:12:15 +00:00
</a><br>
</div><br />
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
<b>Classes:</b><br />
<div class="package">
<a href="selfService/selfServiceProfile.html">selfServiceProfile</a><br />
</div>
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<a name="top"></a>
<h1>Element index for package selfService</h1>
2008-01-06 18:15:35 +00:00
[ <a href="elementindex_selfService.html#a">a</a> ]
2006-11-15 17:12:15 +00:00
[ <a href="elementindex_selfService.html#c">c</a> ]
[ <a href="elementindex_selfService.html#g">g</a> ]
[ <a href="elementindex_selfService.html#i">i</a> ]
[ <a href="elementindex_selfService.html#l">l</a> ]
[ <a href="elementindex_selfService.html#m">m</a> ]
2008-01-06 18:15:35 +00:00
[ <a href="elementindex_selfService.html#p">p</a> ]
2006-11-15 17:12:15 +00:00
[ <a href="elementindex_selfService.html#s">s</a> ]
2008-01-06 18:15:35 +00:00
[ <a href="elementindex_selfService.html#_">_</a> ]
2006-11-15 17:12:15 +00:00
2008-01-06 18:15:35 +00:00
<hr />
<a name="_"></a>
<div>
<h2>_</h2>
<dl>
<dt><b>__construct</b></dt>
<dd>in file selfService.inc, method <a href="selfService/selfServiceProfile.html#method__construct">selfServiceProfile::__construct()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Constructor</dd>
</dl>
</div>
<a href="elementindex_selfService.html#top">top</a><br>
<hr />
<a name="a"></a>
<div>
<h2>a</h2>
<dl>
<dt><b>adminLogin.php</b></dt>
<dd>procedural page <a href="selfService/_templates---selfService---adminLogin.php.html">adminLogin.php</a></dd>
<dt><b>adminMain.php</b></dt>
<dd>procedural page <a href="selfService/_templates---selfService---adminMain.php.html">adminMain.php</a></dd>
</dl>
</div>
<a href="elementindex_selfService.html#top">top</a><br>
2006-11-15 17:12:15 +00:00
<hr />
<a name="c"></a>
<div>
<h2>c</h2>
<dl>
<dt><b>checkSelfServiceOptions</b></dt>
2007-11-04 11:19:11 +00:00
<dd>in file selfService.inc, function <a href="selfService/_lib---selfService.inc.html#functioncheckSelfServiceOptions">checkSelfServiceOptions()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Checks if all input values are correct and returns the LDAP commands which should be executed.</dd>
<dt><b>checkSelfServiceSettings</b></dt>
<dd>in file selfService.inc, function <a href="selfService/_lib---selfService.inc.html#functioncheckSelfServiceSettings">checkSelfServiceSettings()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Checks if the self service settings are valid</dd>
2006-11-15 17:12:15 +00:00
</dl>
</div>
<a href="elementindex_selfService.html#top">top</a><br>
<hr />
<a name="g"></a>
<div>
<h2>g</h2>
<dl>
<dt><b>getSelfServiceFieldSettings</b></dt>
2007-11-04 11:19:11 +00:00
<dd>in file selfService.inc, function <a href="selfService/_lib---selfService.inc.html#functiongetSelfServiceFieldSettings">getSelfServiceFieldSettings()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the field settings for the self service.</dd>
2006-11-15 17:12:15 +00:00
<dt><b>getSelfServiceOptions</b></dt>
2007-11-04 11:19:11 +00:00
<dd>in file selfService.inc, function <a href="selfService/_lib---selfService.inc.html#functiongetSelfServiceOptions">getSelfServiceOptions()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns meta HTML code for each self service field.</dd>
2006-11-15 17:12:15 +00:00
<dt><b>getSelfServiceProfiles</b></dt>
2007-11-04 11:19:11 +00:00
<dd>in file selfService.inc, function <a href="selfService/_lib---selfService.inc.html#functiongetSelfServiceProfiles">getSelfServiceProfiles()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of all available self service profiles (without .conf)</dd>
2006-11-15 17:12:15 +00:00
<dt><b>getSelfServiceSearchAttributes</b></dt>
2007-11-04 11:19:11 +00:00
<dd>in file selfService.inc, function <a href="selfService/_lib---selfService.inc.html#functiongetSelfServiceSearchAttributes">getSelfServiceSearchAttributes()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of possible search attributes for the self service.</dd>
<dt><b>getSelfServiceSettings</b></dt>
<dd>in file selfService.inc, function <a href="selfService/_lib---selfService.inc.html#functiongetSelfServiceSettings">getSelfServiceSettings()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a hash array (module name =&gt; elements) of all module options for the configuration page.</dd>
2006-11-15 17:12:15 +00:00
</dl>
</div>
<a href="elementindex_selfService.html#top">top</a><br>
<hr />
<a name="i"></a>
<div>
<h2>i</h2>
<dl>
<dt><b>$inputFields</b></dt>
<dd>in file selfService.inc, variable <a href="selfService/selfServiceProfile.html#var$inputFields">selfServiceProfile::$inputFields</a><br>&nbsp;&nbsp;&nbsp;&nbsp;input fields</dd>
<dt><b>isLAMProVersion</b></dt>
2007-11-04 11:19:11 +00:00
<dd>in file selfService.inc, function <a href="selfService/_lib---selfService.inc.html#functionisLAMProVersion">isLAMProVersion()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns if this is a LAM Pro installation.</dd>
2006-11-15 17:12:15 +00:00
</dl>
</div>
<a href="elementindex_selfService.html#top">top</a><br>
<hr />
<a name="l"></a>
<div>
<h2>l</h2>
<dl>
<dt><b>$LDAPPassword</b></dt>
<dd>in file selfService.inc, variable <a href="selfService/selfServiceProfile.html#var$LDAPPassword">selfServiceProfile::$LDAPPassword</a><br>&nbsp;&nbsp;&nbsp;&nbsp;LDAP password</dd>
<dt><b>$LDAPSuffix</b></dt>
<dd>in file selfService.inc, variable <a href="selfService/selfServiceProfile.html#var$LDAPSuffix">selfServiceProfile::$LDAPSuffix</a><br>&nbsp;&nbsp;&nbsp;&nbsp;LDAP suffix</dd>
<dt><b>$LDAPUser</b></dt>
<dd>in file selfService.inc, variable <a href="selfService/selfServiceProfile.html#var$LDAPUser">selfServiceProfile::$LDAPUser</a><br>&nbsp;&nbsp;&nbsp;&nbsp;LDAP user DN</dd>
<dt><b>$loginAttributeText</b></dt>
<dd>in file selfService.inc, variable <a href="selfService/selfServiceProfile.html#var$loginAttributeText">selfServiceProfile::$loginAttributeText</a><br>&nbsp;&nbsp;&nbsp;&nbsp;describing text for search attribute</dd>
<dt><b>$loginCaption</b></dt>
<dd>in file selfService.inc, variable <a href="selfService/selfServiceProfile.html#var$loginCaption">selfServiceProfile::$loginCaption</a><br>&nbsp;&nbsp;&nbsp;&nbsp;describing text for user login</dd>
<dt><b>loadSelfServiceProfile</b></dt>
2007-11-04 11:19:11 +00:00
<dd>in file selfService.inc, function <a href="selfService/_lib---selfService.inc.html#functionloadSelfServiceProfile">loadSelfServiceProfile()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Loads all settings of a self service profile.</dd>
2006-11-15 17:12:15 +00:00
</dl>
</div>
<a href="elementindex_selfService.html#top">top</a><br>
<hr />
<a name="m"></a>
<div>
<h2>m</h2>
<dl>
<dt><b>$mainPageText</b></dt>
<dd>in file selfService.inc, variable <a href="selfService/selfServiceProfile.html#var$mainPageText">selfServiceProfile::$mainPageText</a><br>&nbsp;&nbsp;&nbsp;&nbsp;describing text for self service main page</dd>
2007-11-04 11:19:11 +00:00
<dt><b>$moduleSettings</b></dt>
<dd>in file selfService.inc, variable <a href="selfService/selfServiceProfile.html#var$moduleSettings">selfServiceProfile::$moduleSettings</a><br>&nbsp;&nbsp;&nbsp;&nbsp;configuration settings of modules</dd>
2006-11-15 17:12:15 +00:00
</dl>
</div>
<a href="elementindex_selfService.html#top">top</a><br>
2008-01-06 18:15:35 +00:00
<hr />
<a name="p"></a>
<div>
<h2>p</h2>
<dl>
<dt><b>profManage.php</b></dt>
<dd>procedural page <a href="selfService/_templates---selfService---profManage.php.html">profManage.php</a></dd>
</dl>
</div>
<a href="elementindex_selfService.html#top">top</a><br>
2006-11-15 17:12:15 +00:00
<hr />
<a name="s"></a>
<div>
<h2>s</h2>
<dl>
<dt><b>$searchAttribute</b></dt>
<dd>in file selfService.inc, variable <a href="selfService/selfServiceProfile.html#var$searchAttribute">selfServiceProfile::$searchAttribute</a><br>&nbsp;&nbsp;&nbsp;&nbsp;LDAP search attribute</dd>
<dt><b>$serverURL</b></dt>
<dd>in file selfService.inc, variable <a href="selfService/selfServiceProfile.html#var$serverURL">selfServiceProfile::$serverURL</a><br>&nbsp;&nbsp;&nbsp;&nbsp;server address</dd>
<dt><b>selfService.inc</b></dt>
2007-11-04 11:19:11 +00:00
<dd>procedural page <a href="selfService/_lib---selfService.inc.html">selfService.inc</a></dd>
2006-11-15 17:12:15 +00:00
<dt><b>saveSelfServiceProfile</b></dt>
2007-11-04 11:19:11 +00:00
<dd>in file selfService.inc, function <a href="selfService/_lib---selfService.inc.html#functionsaveSelfServiceProfile">saveSelfServiceProfile()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Saves a self service profile.</dd>
2006-11-15 17:12:15 +00:00
<dt><b>selfServiceProfile</b></dt>
2007-11-04 11:19:11 +00:00
<dd>in file selfService.inc, class <a href="selfService/selfServiceProfile.html">selfServiceProfile</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Includes all settings of a self service profile.</dd>
2008-01-06 18:15:35 +00:00
<dt><b>selfServiceLogin.php</b></dt>
<dd>procedural page <a href="selfService/_templates---selfService---selfServiceLogin.php.html">selfServiceLogin.php</a></dd>
<dt><b>selfServiceMain.php</b></dt>
<dd>procedural page <a href="selfService/_templates---selfService---selfServiceMain.php.html">selfServiceMain.php</a></dd>
2006-11-15 17:12:15 +00:00
</dl>
</div>
<a href="elementindex_selfService.html#top">top</a><br>
<div class="credit">
<hr />
2008-01-06 18:15:35 +00:00
Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a>
2006-11-15 17:12:15 +00:00
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>