diff --git a/lam/docs/devel/mod_profiles.htm b/lam/docs/devel/mod_profiles.htm index 7c1643fb..7d394fcf 100644 --- a/lam/docs/devel/mod_profiles.htm +++ b/lam/docs/devel/mod_profiles.htm @@ -152,8 +152,54 @@ common cases.


3. Loading an account profile

+When an account profile is loaded the modules have to check what values +they need for their internal data structures.
+The baseModule already +provides the possibility to store profile values directly as LDAP +attributes in $this->attributes. +This is done by defining profile-attribute mappings in meta['profile_mappings'].
+If you have other values than LDAP attributes or need some post +processing you can implement the function load_profile() in your module.
+
+Example:
+
+The inetLocalMailRecipient +module only +needs a static mapping. This can be done by +the baseModule.
+
+ + + + + + +
    /**
+    * Returns meta data that is interpreted by parent +class
+    *
+    * @return array array with meta data
+    */
+    function +get_metaData() {
+        $return = array();
+        // profile mappings
+        $return['profile_mappings'] = array(
+           + 'inetLocalMailRecipient_host' => 'mailHost'
+        );
+        [...]
+
+
+In this example the profile option "inetLocalMailRecipient_host" is +stored as LDAP attribute "mailHost".
+

-TODO

diff --git a/lam/docs/modules-specification.htm b/lam/docs/modules-specification.htm index a969a48c..387b4ece 100644 --- a/lam/docs/modules-specification.htm +++ b/lam/docs/modules-specification.htm @@ -26,8 +26,8 @@ All module classes should extend the baseModule class.

2.1.1. can_manage*


- +
false.

2.1.2. get_alias*


+ cellpadding="2" cellspacing="2">

2.1.3. is_base_module*


+ cellpadding="2" cellspacing="2">

2.1.4. get_ldap_filter*


+ cellpadding="2" cellspacing="2">

2.1.5. get_RDNAttributes*


+ cellpadding="2" cellspacing="2">

2.1.6. get_dependencies*


- +

2.1.7. get_metaData()


- +


2.1.8. get_configOptions()*


- +

2.1.9. get_configDescriptions()*


- +

2.1.10. check_configOptions*


+ cellpadding="2" cellspacing="2">

2.1.11. get_scope()


- +

2.1.12. get_uploadColumns*


+ cellpadding="2" cellspacing="2">
2.1.13. get_uploadPreDepends*
+ cellpadding="2" cellspacing="2">

2.1.14. build_uploadAccounts


+ cellpadding="2" cellspacing="2">

2.1.15. do_uploadPostActions


+ cellpadding="2" cellspacing="2">

2.1.16. get_profileOptions*


- +

2.1.17. check_profileOptions*


+ cellpadding="2" cellspacing="2">
If no errors occured the function returns an empty array.

+

2.1.18. load_profile*

+
+ + + + + + +
function load_profile($profile)
+
+
+This function loads the values from an account profile to the module's +internal data structures.
+
+$profile +is an hash array (identifier => array(values))  with all values +of an account profile.
+



@@ -503,8 +524,8 @@ If no errors occured the function returns an empty array.

2.2.1. init


- +

2.2.2. module_ready


- +
false2.2.3. module_complete
+ cellpadding="2" cellspacing="2">

2.2.4. get_help


+ cellpadding="2" cellspacing="2">

2.2.7. get_pdfEntries


+ cellpadding="2" cellspacing="2">

+ cellpadding="2" cellspacing="2">

+ cellpadding="2" cellspacing="2">

+ cellpadding="2" cellspacing="2">

+ cellpadding="2" cellspacing="2">

+ cellpadding="2" cellspacing="2">

+ cellpadding="2" cellspacing="2">

+ cellpadding="2" cellspacing="2">

+ cellpadding="2" cellspacing="2">

+ cellpadding="2" cellspacing="2">

+ cellpadding="2" cellspacing="2">

-

6.8 get_configOptions()
+

6.8 load_profile()
+

+    "profile_mappings" => array('profile_identifier1' +=> 'LDAP_attribute1', 'profile_identifier2' => 'LDAP_attribute2')
+
+    The mapped values are stored directly in +$this->attributes.
+
+ +

6.9 get_configOptions()

    "config_options" => array('user' => array, 'host' => array, 'all' => array)
@@ -1200,7 +1230,7 @@ the return value of get_configOptions().

-

6.9 get_configDescriptions()
+

6.10 get_configDescriptions()

    "config_descriptions" => array

@@ -1209,7 +1239,7 @@ return value of get_configOptions().
return value of get_configDescriptions().

-

6.10 check_configOptions()
+

6.11 check_configOptions()

    "config_checks" => array('user' => array, 'host' => 'array', 'all' => array)
@@ -1223,14 +1253,14 @@ the other values only if they are inside the
-

6.11 get_uploadColumns()

+

6.12 get_uploadColumns()

"upload_columns" => array()

Syntax for array is the same as for the return value of get_uploadColumns().

-

6.12 get_uploadPreDepends()

+

6.13 get_uploadPreDepends()

"upload_preDepends" => array()

Syntax for array is the same as for