diff --git a/lam/docs/modules-specification.htm b/lam/docs/modules-specification.htm index 51162fe7..fd187a7c 100644 --- a/lam/docs/modules-specification.htm +++ b/lam/docs/modules-specification.htm @@ -1,8 +1,8 @@ - + Module specification @@ -25,30 +25,10 @@ These functions are called without instanciating an object of the module class. They must not depend on class variables and are only allowed to call other static functions.

-

2.1.1. Constructor

+

2.1.1. get_alias


- - - - - - -
function <module name> ($base)
-
-
-Every module needs a constructor that has an account -container as argument $base.
-With this account container you can interact with other modules and use -several helper functions.
-
-

2.1.2. get_alias

-
- +
The $scope parameter defines the account type ("user", "group", "host" at this time).

-

2.1.3. get_dependencies

+

2.1.2. is_base_module

+
+ + + + + + +
function is_base_module($scope)
+
+
+Returns true if your module is +a base module and otherwise false.
+$scope is the account type +("user", "group", "host" at this time).
+
+Every account type needs at least one base module. A base module +defines a full qualified account.
+E.g. modules that use the object class posixAccount may be base modules +as it makes sense to manage these Unix accounts. On the other hand the +quota module is no base module as it needs posixAccount.
+
+

2.1.3. get_ldap_filter

+
+ + + + + + +
function get_ldap_filter($scope)
+
+
+Returns a string that can be used as part of a LDAP filter. Usually +used to filter object classes.
+$scope is the account type +("user", "group", "host" at this time).
+
+All filter parts of the base modules are combined with OR and used to +find the accounts for the lists.
+
+Example: return "(objectClass=posixAccount)"
+
+This function +is only used for base modules. Standard modules do not need to +implement it.
+
+

2.1.4. get_dependencies


@@ -100,106 +134,10 @@ your module depends on one of these modules.
=> array("exim"));

+

2.1.5. get_profileOptions


-

2.1.4. module_ready

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

2.1.5. module_complete

-
- - - - - - -
function module_complete()
-
-
-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.
-
-

2.1.6. is_base_module

-
- - - - - - -
function is_base_module($scope)
-
-
-Returns true if your module is -a base module and otherwise false.
-$scope is the account type -("user", "group", "host" at this time).
-
-Every account type needs at least one base module. A base module -defines a full qualified account.
-E.g. modules that use the object class posixAccount may be base modules -as it makes sense to manage these Unix accounts. On the other hand the -quota module is no base module as it needs posixAccount.
-
-

2.1.7. get_ldap_filter

-
- - - - - - -
function get_ldap_filter($scope)
-
-
-Returns a string that can be used as part of a LDAP filter. Usually -used to filter object classes.
-$scope is the account type -("user", "group", "host" at this time).
-
-All filter parts of the base modules are combined with OR and used to -find the accounts for the lists.
-
-Example: return "(objectClass=posixAccount)"
-
-This function -is only used for base modules.
-
-
-

2.1.8. get_profileOptions

-
- +


+

2.2. Class functions

+

2.2.1. Constructor

+
+ + + + + + +
function <module name> ($base)
+
+
+Every module needs a constructor that has an account +container as argument $base.
+With this account container you can interact with other modules and use +several helper functions.
+
+

2.2.2. module_ready

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

2.2.3. module_complete

+
+ + + + + + +
function module_complete()
+
+
+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.
+
+


+

3. Meta HTML code

The modules are not allowed to display HTML code directly but return meta HTML code. This allows to have a common design for all module