From 4ecb2dddfdbe4d8c12cd9ed1d5d30049f1123476 Mon Sep 17 00:00:00 2001 From: Roland Gruber Date: Sun, 6 Mar 2005 12:37:31 +0000 Subject: [PATCH] more friendly layout --- lam/docs/modules-specification.htm | 149 ++++++++++++++++------------- 1 file changed, 82 insertions(+), 67 deletions(-) diff --git a/lam/docs/modules-specification.htm b/lam/docs/modules-specification.htm index 9f317f60..5c77084e 100644 --- a/lam/docs/modules-specification.htm +++ b/lam/docs/modules-specification.htm @@ -4,6 +4,22 @@ Module specification +

This document describes the module @@ -26,12 +42,12 @@ All module classes should extend the baseModule class.

2.1.1. can_manage*


- @@ -45,12 +61,12 @@ otherwise false.

2.1.2. get_alias*


-
function can_manage()
@@ -68,12 +84,12 @@ sure that there is a general alias for unknown types.

2.1.3. is_base_module*


-
function get_alias()
@@ -90,12 +106,12 @@ is structural.

2.1.4. get_ldap_filter*


-
function is_base_module()
@@ -117,12 +133,12 @@ The resulting LDAP filter will look like this:

2.1.5. get_RDNAttributes*


-
function get_ldap_filter()
@@ -144,12 +160,11 @@ for the RDN selection.

2.1.6. get_dependencies*


-
function get_RDNAttributes()
+
@@ -175,12 +190,12 @@ your module depends on one of these modules.

2.1.7. get_metaData()


-
function + style="vertical-align: top; text-align: center; font-weight: bold;">function get_dependencies()
@@ -194,12 +209,12 @@ true);

2.1.8. get_configOptions()*


-
function get_metaData()
@@ -222,12 +237,12 @@ naming confilcts.

2.1.9. get_configDescriptions()*


-
function get_configOptions($scopes)
@@ -249,12 +264,12 @@ array with this format:

2.1.10. check_configOptions*


-
function get_configDescriptions()
@@ -279,12 +294,12 @@ If no errors occured the function returns an empty array.

2.1.11. get_scope()


-
function check_configOptions($scopes, $options)
@@ -298,12 +313,12 @@ baseModule and should not be overwritten.

2.1.12. get_uploadColumns*


-
function get_scope()
@@ -345,12 +360,12 @@ all values of this column must be different values

2.1.13. get_uploadPreDepends*


-
function get_uploadColumns()
@@ -363,12 +378,12 @@ The named modules may not be active, LAM will check this automatically.

2.1.14. build_uploadAccounts


-
function get_uploadPreDepends()
@@ -392,12 +407,12 @@ if any errors occured.

2.1.15. do_uploadPostActions


-
function get_uploadAccounts($rawAccounts, $ids, $partialAccounts)
@@ -440,12 +455,12 @@ StatusMessages

2.1.16. get_profileOptions*


-
function do_uploadPostActions($data, $ids, $failed, &$temp)
@@ -466,12 +481,12 @@ naming confilcts.

2.1.17. check_profileOptions*


-
function get_profileOptions()
@@ -492,12 +507,12 @@ If no errors occured the function returns an empty array.

2.1.18. load_profile*


-
function check_profileOptions($options)
@@ -519,12 +534,12 @@ of an account profile.

2.2.1. init


-
function load_profile($profile)
@@ -539,12 +554,12 @@ several helper functions.

2.2.2. module_ready


-
function init($base)
@@ -558,12 +573,12 @@ your module accepts input, otherwise false

2.2.3. module_complete


-
function module_ready()
@@ -579,12 +594,12 @@ page will be displayed.

2.2.4. get_help


-
function module_complete()
@@ -602,12 +617,12 @@ section 4. "Help entry syntax".

2.2.7. get_pdfEntries


-
function get_help($helpID)
@@ -628,12 +643,12 @@ syntax".

2.2.8. dynamic_Message


-
function get_PDF_Entries($scope)
@@ -651,12 +666,12 @@ Returnis an array as expected from StatusMessage().

2.2.9. load_Messages


-
function dynamic_Message($attribute, $id)
@@ -672,12 +687,12 @@ $this->messages[x][y][z]

2.2.10. load_attributes


-
function load_Messages()
@@ -700,12 +715,12 @@ separat.

2.2.11. save_attributes


-
function load_attributes($attr)
@@ -731,12 +746,12 @@ itself which should be executed by lamdaemon.

2.2.12. delete_attributes


-
function save_attributes()
@@ -752,12 +767,12 @@ is needed t interact with the user.

2.2.13. proccess_attributes


-
function delete_attributes($post)
@@ -790,12 +805,12 @@ array();

2.2.14. proccess_*


-
function proccess_attributes($post)
@@ -812,12 +827,12 @@ is needed t interact with the user.

2.2.15. display_html_attributes($post)


-
function proccess_*($post)
@@ -834,12 +849,12 @@ is needed t interact with the user.

2.2.16. display_html_*($post)


-
function display_html_attributes($post)
@@ -857,12 +872,12 @@ is needed t interact with the user.

2.2.17. display_html_delete($post)


-
function display_html_*($post)
function display_html_delete($post)