diff --git a/lam/docs/devel/mod_accountPages.htm b/lam/docs/devel/mod_accountPages.htm index 5017bce2..2c49d69b 100644 --- a/lam/docs/devel/mod_accountPages.htm +++ b/lam/docs/devel/mod_accountPages.htm @@ -198,6 +198,10 @@ This function is called process_<page name>() where <page name> is the name of your subpage.

+If all input data is ok then return "0" or an array containing no error +message. If you return one or more error messages then the user will be +redirected to your page.
+
Example:

@@ -305,14 +309,20 @@ $this->inputCorrect = true;

5. Defining that your module is ready for LDAP add/modify

Before a new account can be created or modified all modules are asked if they are ready.
-There are two functions which control the module status. The module_ready() function has to +
+There are two functions which control the module status:
+The module_ready() function +has to return true if the user may -move to another module page. If it is false -the user will be redirected to your module page. The second function is +move to your module page. If it is false +the user will be shown an error message that your module is not yet +ready. You can use this if your module depends on input data from other +modules (e.g. you need the user name from posixAccount first).
+The second function is module_complete(). The user -cannot do the LDAP operation if one or modules return false.
+cannot do the LDAP operation if one or more modules return false. This defines if all needed +input data for your module was entered.

Example:
diff --git a/lam/docs/devel/modules-specification.htm b/lam/docs/devel/modules-specification.htm index 2c5bdc82..315056dc 100644 --- a/lam/docs/devel/modules-specification.htm +++ b/lam/docs/devel/modules-specification.htm @@ -529,7 +529,7 @@ several helper functions.

Your module might depend on input of other modules. This function -determines if the module button on the account page is active or not.
+determines if the user can change to your module page or not.
The return value is true if your module accepts input, otherwise false.

@@ -545,12 +545,10 @@ your module accepts input, otherwise false
-This function is called after your module has processed the POST input -data.
-If there was an input error and you want to display a page again then -return false. If true is returned the next module -page will be displayed.
+This function tells LAM if it can create/modify the LDAP account. If +your module needs any additional input then set this to false. The user will be notified +that your module needs more input.

2.2.4. get_help