WMDE
/
LDAPAccountManager
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

more friendly layout

This commit is contained in:
Roland Gruber 2005-03-06 12:37:31 +00:00
parent 53b8e701fc
commit 4ecb2dddfd
1 changed files with 82 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

149
lam/docs/modules-specification.htm
View File

@ -4,6 +4,22 @@
<meta content="text/html; charset=ISO-8859-15"
http-equiv="content-type">
<title>Module specification</title>
<style>
<!--
h2 {
color:darkblue;
}
h3 {
color:darkblue;
}
h4 {
color:darkblue;
}
table {
background-color:#bdcaff;
}
-->
</style>
</head>
<body>
<h1 style="text-align: center;">This document describes the module
@ -26,12 +42,12 @@ All module classes should extend the baseModule class.<br>
</h3>
<h3>2.1.1. can_manage*</h3>
<br>
<table style="text-align: left; width: 300px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function can_manage()</span><br>
</td>
</tr>
@ -45,12 +61,12 @@ otherwise <span style="font-style: italic;">false</span>.<br>
<br>
<h3>2.1.2. get_alias*</h3>
<br>
<table style="text-align: left; width: 300px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_alias()</span><br>
</td>
</tr>
@ -68,12 +84,12 @@ sure that there is a general alias for unknown types.<br>
<br>
<h3>2.1.3. is_base_module*</h3>
<br>
<table style="text-align: left; width: 300px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function is_base_module()</span><br>
</td>
</tr>
@ -90,12 +106,12 @@ is structural.<br>
<br>
<h3>2.1.4. get_ldap_filter*</h3>
<br>
<table style="text-align: left; width: 300px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_ldap_filter()</span><br>
</td>
</tr>
@ -117,12 +133,12 @@ The resulting LDAP filter will look like this:
<span style="font-weight: bold; color: rgb(255, 0, 0);"></span><br>
<h3>2.1.5. get_RDNAttributes*</h3>
<br>
<table style="text-align: left; width: 300px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_RDNAttributes()</span><br>
</td>
</tr>
@ -144,12 +160,11 @@ for the RDN selection.<br>
<span style="font-weight: bold; color: rgb(255, 0, 0);"></span><br>
<h3>2.1.6. get_dependencies*</h3>
<br>
<table style="text-align: left; width: 300px; font-weight: bold;"
border="0" cellpadding="2" cellspacing="2">
<table border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;">function
style="vertical-align: top; text-align: center; font-weight: bold;">function
get_dependencies()<br>
</td>
</tr>
@ -175,12 +190,12 @@ your module depends on one of these modules.<br>
<br>
<h3>2.1.7. get_metaData()</h3>
<br>
<table style="text-align: left; width: 300px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_metaData()</span><br>
</td>
</tr>
@ -194,12 +209,12 @@ true);</span><br style="font-weight: bold;">
<br>
<h3>2.1.8. get_configOptions()*</h3>
<br>
<table style="text-align: left; width: 300px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_configOptions($scopes)</span><br>
</td>
</tr>
@ -222,12 +237,12 @@ naming confilcts.<br>
<br>
<h3>2.1.9. get_configDescriptions()*</h3>
<br>
<table style="text-align: left; width: 300px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_configDescriptions()</span><br>
</td>
</tr>
@ -249,12 +264,12 @@ array with this format:<br>
<br>
<h3>2.1.10. check_configOptions*</h3>
<br>
<table style="text-align: left; width: 400px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function check_configOptions($scopes,
$options)</span><br>
</td>
@ -279,12 +294,12 @@ If no errors occured the function returns an empty array.<span
<span style="font-weight: bold;"></span>
<h3>2.1.11. get_scope()</h3>
<br>
<table style="text-align: left; width: 300px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_scope()</span><br>
</td>
</tr>
@ -298,12 +313,12 @@ baseModule and should not be overwritten.</span><br>
<br>
<h3>2.1.12. get_uploadColumns*</h3>
<br>
<table style="text-align: left; width: 300px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_uploadColumns()</span><br>
</td>
</tr>
@ -345,12 +360,12 @@ all values of this column must be different values <span
<br>
<h3>2.1.13. get_uploadPreDepends*</h3>
<br>
<table style="text-align: left; width: 300px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_uploadPreDepends()</span><br>
</td>
</tr>
@ -363,12 +378,12 @@ The named modules may not be active, LAM will check this automatically.<br>
<br>
<h3>2.1.14. build_uploadAccounts</h3>
<br>
<table style="text-align: left; width: 484px; height: 31px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_uploadAccounts($rawAccounts,
$ids, $partialAccounts)</span><br>
</td>
@ -392,12 +407,12 @@ if any errors occured.<br>
<br>
<h3>2.1.15. do_uploadPostActions</h3>
<br>
<table style="text-align: left; width: 484px; height: 31px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function do_uploadPostActions($data, $ids,
$failed, &amp;$temp)</span><br>
</td>
@ -440,12 +455,12 @@ StatusMessages<br>
<br>
<h3>2.1.16. get_profileOptions*</h3>
<br>
<table style="text-align: left; width: 300px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_profileOptions()</span><br>
</td>
</tr>
@ -466,12 +481,12 @@ naming confilcts.<br>
<br>
<h3>2.1.17. check_profileOptions*</h3>
<br>
<table style="text-align: left; width: 400px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function check_profileOptions($options)</span><br>
</td>
</tr>
@ -492,12 +507,12 @@ If no errors occured the function returns an empty array.<span
<br>
<h3>2.1.18. load_profile*</h3>
<br>
<table style="text-align: left; width: 400px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function load_profile($profile)</span><br>
</td>
</tr>
@ -519,12 +534,12 @@ of an account profile.<br>
</h3>
<h3>2.2.1. init</h3>
<br>
<table style="text-align: left; width: 300px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function init($base)</span><br>
</td>
</tr>
@ -539,12 +554,12 @@ several helper functions.<br>
<br>
<h3>2.2.2. module_ready</h3>
<br>
<table style="text-align: left; width: 300px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function module_ready()</span><br>
</td>
</tr>
@ -558,12 +573,12 @@ your module accepts input, otherwise <span style="font-weight: bold;">false</spa
<br>
<h3>2.2.3. module_complete</h3>
<br>
<table style="text-align: left; width: 300px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function module_complete()</span><br>
</td>
</tr>
@ -579,12 +594,12 @@ page will be displayed.<br>
<br>
<h3>2.2.4. get_help</h3>
<br>
<table style="text-align: left; width: 300px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_help($helpID)</span><br>
</td>
</tr>
@ -602,12 +617,12 @@ section 4. "Help entry syntax".<br>
<br>
<h3>2.2.7. get_pdfEntries</h3>
<br>
<table style="text-align: left; width: 300px; height: 30px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function get_PDF_Entries($scope)</span><br>
</td>
</tr>
@ -628,12 +643,12 @@ syntax".<br>
<h3>2.2.8. dynamic_Message<br>
</h3>
<br>
<table style="text-align: left; width: 349px; height: 50px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function dynamic_Message($attribute, $id)</span><br>
</td>
</tr>
@ -651,12 +666,12 @@ Returnis an array as expected from StatusMessage().<br>
<h3>2.2.9. load_Messages<br>
</h3>
<br>
<table style="text-align: left; width: 280px; height: 50px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function load_Messages()</span><br>
</td>
</tr>
@ -672,12 +687,12 @@ $this-&gt;messages[x][y][z]<br>
<h3>2.2.10. load_attributes<br>
</h3>
<br>
<table style="text-align: left; width: 280px; height: 50px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function load_attributes($attr)</span><br>
</td>
</tr>
@ -700,12 +715,12 @@ separat.<br>
<h3>2.2.11. save_attributes<br>
</h3>
<br>
<table style="text-align: left; width: 280px; height: 50px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function save_attributes()</span><br>
</td>
</tr>
@ -731,12 +746,12 @@ itself which should be executed by lamdaemon.<br>
<h3>2.2.12. delete_attributes<br>
</h3>
<br>
<table style="text-align: left; width: 280px; height: 50px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function delete_attributes($post)</span><br>
</td>
</tr>
@ -752,12 +767,12 @@ is needed t interact with the user.<br>
<h3>2.2.13. proccess_attributes<br>
</h3>
<br>
<table style="text-align: left; width: 386px; height: 50px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function proccess_attributes($post)</span><br>
</td>
</tr>
@ -790,12 +805,12 @@ array();<br>
<h3>2.2.14. proccess_*<br>
</h3>
<br>
<table style="text-align: left; width: 346px; height: 50px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function proccess_*($post)</span><br>
</td>
</tr>
@ -812,12 +827,12 @@ is needed t interact with the user.<br>
<h3>2.2.15. display_html_attributes($post)<br>
</h3>
<br>
<table style="text-align: left; width: 346px; height: 50px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function display_html_attributes($post)</span><br>
</td>
</tr>
@ -834,12 +849,12 @@ is needed t interact with the user.<br>
<h3>2.2.16. display_html_*($post)<br>
</h3>
<br>
<table style="text-align: left; width: 346px; height: 50px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function display_html_*($post)</span><br>
</td>
</tr>
@ -857,12 +872,12 @@ is needed t interact with the user.<br>
<h3>2.2.17. display_html_delete($post)<br>
</h3>
<br>
<table style="text-align: left; width: 346px; height: 50px;" border="0"
<table border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td
style="vertical-align: top; background-color: rgb(204, 204, 204); text-align: center;"><span
style="vertical-align: top; text-align: center;"><span
style="font-weight: bold;">function display_html_delete($post)</span><br>
</td>
</tr>