diff --git a/lam/docs/modules-specification.htm b/lam/docs/modules-specification.htm index 7afd6cd6..074a184a 100644 --- a/lam/docs/modules-specification.htm +++ b/lam/docs/modules-specification.htm @@ -4,7 +4,7 @@ Module specification - +

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

2.1.1. can_manage*


- +
- @@ -61,12 +59,10 @@ otherwise false.

2.1.2. get_alias*


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

2.1.3. is_base_module*


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

2.1.4. get_ldap_filter*


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

2.1.5. get_RDNAttributes*


-
function get_ldap_filter()
+
- @@ -190,12 +180,10 @@ your module depends on one of these modules.

2.1.7. get_metaData()


-
function get_RDNAttributes()
+
- @@ -209,12 +197,10 @@ true);

2.1.8. get_configOptions()*


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

2.1.9. get_configDescriptions()*


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

2.1.10. check_configOptions*


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

2.1.11. get_scope()


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

2.1.12. get_uploadColumns*


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

2.1.13. get_uploadPreDepends*


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

2.1.14. build_uploadAccounts


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

2.1.15. do_uploadPostActions


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

2.1.16. get_profileOptions*


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

2.1.17. check_profileOptions*


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

2.1.18. load_profile*


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

2.2.1. init


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

2.2.2. module_ready


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

2.2.3. module_complete


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

2.2.4. get_help


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

2.2.7. get_pdfEntries


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

2.2.8. dynamic_Message


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

2.2.9. load_Messages


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

2.2.10. load_attributes


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

2.2.11. save_attributes


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

2.2.12. delete_attributes


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

2.2.13. process_attributes


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

2.2.14. process_*


-
function process_attributes($post)
+
- @@ -827,12 +769,10 @@ is needed t interact with the user.

2.2.15. display_html_attributes($post)


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

2.2.16. display_html_*($post)


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

2.2.17. display_html_delete($post)


-
function display_html_*($post)
+
- @@ -989,6 +925,17 @@ element.
  • text: The text to display.
    • +
  • image: Displays an image.
    • +
    Beneath those values a "td" @@ -997,11 +944,13 @@ options:


    Example:
    function display_html_delete($post)