The account modules control all the
@@ -21,13 +18,11 @@ accounts, the profile editor sections and much more. They are the core
of LAM.
All account modules are saved in lib/modules/.
-If your module needs any include files etc. please save it in lib/modules/<name of your module>.
+If your module needs any include files etc. please save it in lib/modules/<name of your module>.
Please take a look at the module HowTo for
an example to write your own modules.
-The complete specification for the module interface can be found here.
+The complete specification for the module interface can be found here.
Superclass
All account modules should be
@@ -46,5 +41,4 @@ There is no extra configuration file.
-
-
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/base_module.htm b/lam-web/developers/devel/base_module.htm
index dc9c4f52..5ecffacf 100644
--- a/lam-web/developers/devel/base_module.htm
+++ b/lam-web/developers/devel/base_module.htm
@@ -1,23 +1,19 @@
-
-
-
- Base module
+
+
+
+ Base module
+
-
-
-
+
Base module
-
+
The baseModule
is the parent class of all account modules.
-It implements most functions of the module interface and provides
+It implements most functions of the module interface and provides
the possibility to use meta data
for the module functions.
There are also some class variables which are useful for the child
@@ -26,25 +22,20 @@ classes.
Meta data
The baseModule allows you to
-not implement the module
+not implement the module
interface directly but to provide meta
-data which is interpreted by the baseModule.
-If you do not use certain functions of the interface the baseModule also provides dummy
+data which is interpreted by the baseModule.
+If you do not use certain functions of the interface the baseModule also provides dummy
functions. E.g. if your module needs no configuration option you can
-just skip this function in your code and the baseModule will tell the
+just skip this function in your code and the baseModule will tell the
configuration part that there is no option.
To define meta data you have
-to implement the function get_metaData().
+to implement the function get_metaData().
This function must return a hash array with the meta options as array
keys.
-Please refer to the module
-interface for details about the format of meta data.
+Please refer to the module
+interface for details about the format of meta data.
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:29 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/PDF/UFPDF.html b/lam-web/developers/devel/phpdoc/PDF/UFPDF.html
new file mode 100644
index 00000000..735d30e1
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/PDF/UFPDF.html
@@ -0,0 +1,1647 @@
+
+
+Docs For Class UFPDF
+
+
+
+
+
Software: FPDF * Version: 1.53 * Date: 2004-12-31 * Author: Olivier PLATHEY * License: Freeware * * You may use, modify and redistribute this software as you wish. * *****************************************************************************
+LDAP Account Manager PDF printing library. It consists of lamPDF class, the createModulePDF() function that may be called by other pages and furthermore some helper functions.
+
Tags:
+
+
+
+
author:
Michael Duergner
+
+
+
+
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:37 +0100 by phpDocumentor 1.4.0
+
+LDAP Account Manager PDF printing library. It consists of lamPDF class, the createModulePDF() function that may be called by other pages and furthermore some helper functions.
+
Tags:
+
+
+
+
author:
Michael Duergner
+
+
+
+
+
Includes:
+
+include_once('pdfstruct.inc') [line 39]
+access to PDF configuration files
+
+ This function creates the PDF output of one or more accounts. At the moment this function can create a PDF page for user, group and host accounts. But this is not limited by the function itself but by the account types that are allowed in LAM and the exsisting PDF structure definitions.
+
+
Parameters
+
+
+
array
+
$accounts
+
A numbered array containing all accounts the PDF page should be created for. The entries of the array must be AccountContainer objects.
+
+
+
string
+
$pdf_structure
+
The filename of the structure definition that should be used to create the PDF page. If not submitted the 'default.user' structure definition for the appropriate account type.
+
+ This function will return all available PDF structure definitions for the submitted account scope.
+
Tags:
+
+
+
+
return:
All available PDF structure definitions for the submitted account scope. Each entry is a string being the filename that may be passed to the createModulePDF() function as second argument.
+
+
+
+
+
+
Parameters
+
+
+
string
+
$scope
+
The account scope the PDF structure definitions should be returned.
Software: UFPDF, Unicode Free PDF generator * Version: 0.1 * based on FPDF 1.52 by Olivier PLATHEY * Date: 2004-09-01 * Author: Steven Wittens <steven@acko.net> * License: GPL * * UFPDF is a modification of FPDF to support Unicode through UTF-8. * * This file includes modifications from Andrea Rossato which fix line breaking * in Write()/MultiCell(). * * *****************************************************************************
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:37 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/PDF/xmlParser.html b/lam-web/developers/devel/phpdoc/PDF/xmlParser.html
new file mode 100644
index 00000000..a07ee24f
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/PDF/xmlParser.html
@@ -0,0 +1,215 @@
+
+
+Docs For Class xmlParser
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_Help.html b/lam-web/developers/devel/phpdoc/classtrees_Help.html
new file mode 100644
index 00000000..ea8c009f
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_Help.html
@@ -0,0 +1,62 @@
+
+
+Class Trees for Package Help
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_LDAP.html b/lam-web/developers/devel/phpdoc/classtrees_LDAP.html
new file mode 100644
index 00000000..9985c30c
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_LDAP.html
@@ -0,0 +1,67 @@
+
+
+Class Trees for Package LDAP
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_PDF.html b/lam-web/developers/devel/phpdoc/classtrees_PDF.html
new file mode 100644
index 00000000..48d55530
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_PDF.html
@@ -0,0 +1,76 @@
+
+
+Class Trees for Package PDF
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_configuration.html b/lam-web/developers/devel/phpdoc/classtrees_configuration.html
new file mode 100644
index 00000000..06f984bb
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_configuration.html
@@ -0,0 +1,72 @@
+
+
+Class Trees for Package configuration
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_lib.html b/lam-web/developers/devel/phpdoc/classtrees_lib.html
new file mode 100644
index 00000000..caa1a2f9
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_lib.html
@@ -0,0 +1,79 @@
+
+
+Class Trees for Package lib
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_lists.html b/lam-web/developers/devel/phpdoc/classtrees_lists.html
new file mode 100644
index 00000000..dc313d45
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_lists.html
@@ -0,0 +1,81 @@
+
+
+Class Trees for Package lists
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_main.html b/lam-web/developers/devel/phpdoc/classtrees_main.html
new file mode 100644
index 00000000..c9755174
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_main.html
@@ -0,0 +1,62 @@
+
+
+Class Trees for Package main
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_modules.html b/lam-web/developers/devel/phpdoc/classtrees_modules.html
new file mode 100644
index 00000000..21403db4
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_modules.html
@@ -0,0 +1,89 @@
+
+
+Class Trees for Package modules
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_profiles.html b/lam-web/developers/devel/phpdoc/classtrees_profiles.html
new file mode 100644
index 00000000..351492bd
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_profiles.html
@@ -0,0 +1,62 @@
+
+
+Class Trees for Package profiles
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_selfService.html b/lam-web/developers/devel/phpdoc/classtrees_selfService.html
new file mode 100644
index 00000000..62ba65e6
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_selfService.html
@@ -0,0 +1,67 @@
+
+
+Class Trees for Package selfService
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_tests.html b/lam-web/developers/devel/phpdoc/classtrees_tests.html
new file mode 100644
index 00000000..2fc48e9c
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_tests.html
@@ -0,0 +1,62 @@
+
+
+Class Trees for Package tests
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_tools.html b/lam-web/developers/devel/phpdoc/classtrees_tools.html
new file mode 100644
index 00000000..466e4fb8
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_tools.html
@@ -0,0 +1,81 @@
+
+
+Class Trees for Package tools
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/classtrees_types.html b/lam-web/developers/devel/phpdoc/classtrees_types.html
new file mode 100644
index 00000000..d0ef5b91
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/classtrees_types.html
@@ -0,0 +1,69 @@
+
+
+Class Trees for Package types
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/configuration/LAMCfgMain.html b/lam-web/developers/devel/phpdoc/configuration/LAMCfgMain.html
new file mode 100644
index 00000000..2a812af2
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/configuration/LAMCfgMain.html
@@ -0,0 +1,402 @@
+
+
+Docs For Class LAMCfgMain
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:22 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/configuration/LAMConfig.html b/lam-web/developers/devel/phpdoc/configuration/LAMConfig.html
new file mode 100644
index 00000000..92570fe1
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/configuration/LAMConfig.html
@@ -0,0 +1,1442 @@
+
+
+Docs For Class LAMConfig
+
+
+
+
+
+
+ Returns the version number of this LAM installation.
Format: <major version>.<minor version>.<patch level> Major/minor version are always numbers, patch level may contain letters for inofficial releases only (e.g. 0.5.alpha1).
+ [ a ]
+ [ b ]
+ [ c ]
+ [ d ]
+ [ e ]
+ [ f ]
+ [ g ]
+ [ h ]
+ [ i ]
+ [ k ]
+ [ l ]
+ [ m ]
+ [ n ]
+ [ o ]
+ [ p ]
+ [ q ]
+ [ r ]
+ [ s ]
+ [ t ]
+ [ u ]
+ [ v ]
+ [ w ]
+ [ x ]
+ [ y ]
+ [ z ]
+ [ _ ]
+
+
+
+
+
a
+
+
$aliases
+
in file schema.inc, variable AttributeType::$aliases An array of alias attribute names, strings
in file baseModule.inc, variable baseModule::$autoAddObjectClasses if true, managed object classes are added when an account is created or loaded (default: true)
in file schema.inc, method ObjectClass::addMayAttrs() Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.
+
addMustAttrs
+
in file schema.inc, method ObjectClass::addMustAttrs() Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.
in file schema.inc, method AttributeType::addRequiredByObjectClass() Adds an objectClass name to this attribute's list of "required by" objectClasses, that is the list of objectClasses which must have this attribute.
+
addUsedByAttr
+
in file schema.inc, method MatchingRule::addUsedByAttr() Adds an attribute name to the list of attributes who use this MatchingRule
+
addUsedInObjectClass
+
in file schema.inc, method AttributeType::addUsedInObjectClass() Adds an objectClass name to this attribute's list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
+
add_aliases_to_attrs
+
in file schema.inc, function add_aliases_to_attrs() For each attribute that has multiple names, this function adds unique entries to the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.
+
add_cache
+
in file cache.inc, method cache::add_cache() This function adds attributes to the cache.
+
add_sup_to_attrs
+
in file schema.inc, function add_sup_to_attrs() Adds inherited values to each attributeType specified by the SUP directive.
in file baseModule.inc, class baseModule Parent class of all account modules.
+
baseType
+
in file baseType.inc, class baseType This is the parent class of all account types.
+
buildUploadAccounts
+
in file modules.inc, function buildUploadAccounts() This function builds the LDAP accounts for the file upload.
+
build_initial_tree_icons
+
in file tree.inc, function build_initial_tree_icons() Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned
in file schema.inc, variable ObjectClass::$children_objectclasses array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)
in file modules.inc, function checkProfileOptions() Checks if the profile options are valid
+
checkSchemaForModule
+
in file schemaTest.php, function checkSchemaForModule() Checks if the object classes and attributes for this module are available.
+
checkSelfServiceOptions
+
in file baseModule.inc, method baseModule::checkSelfServiceOptions() Checks if all input values are correct and returns the LDAP attributes which should be changed.
+
checkSelfServiceOptions
+
in file sambaSamAccount.inc, method sambaSamAccount::checkSelfServiceOptions() Checks if all input values are correct and returns the LDAP commands which should be executed.
+
checkSelfServiceOptions
+
in file selfService.inc, function checkSelfServiceOptions() Checks if all input values are correct and returns the LDAP commands which should be executed.
+
checkSelfServiceOptions
+
in file posixAccount.inc, method posixAccount::checkSelfServiceOptions() Checks if all input values are correct and returns the LDAP commands which should be executed.
+
checkSelfServiceOptions
+
in file inetOrgPerson.inc, method inetOrgPerson::checkSelfServiceOptions() Checks if all input values are correct and returns the LDAP commands which should be executed.
+
checkSelfServiceSettings
+
in file selfService.inc, function checkSelfServiceSettings() Checks if the self service settings are valid
in file confmodules.php, function config_showAccountModules() Displays the module selection boxes and checks if dependencies are fulfilled.
+
connect
+
in file ldap.inc, method Ldap::connect() Connects to the server using the given username and password
+
continue_main
+
in file modules.inc, method accountContainer::continue_main() This function is called when the user clicks on any button on the account pages.
+
createModulePDF
+
in file pdf.inc, function createModulePDF() This function creates the PDF output of one or more accounts. At the moment this function can create a PDF page for user, group and host accounts. But this is not limited by the function itself but by the account types that are allowed in LAM and the exsisting PDF structure definitions.
in file sambaMungedDial.inc, method sambaMungedDial::decode_munged() Takes a base64-encoded MungedDial-String and returns an array of included parameters and values
in file baseModule.inc, method baseModule::display_html_delete() This function creates meta HTML code which will be displayed when an account should be deleted.
in file kolabUser.inc, method kolabUser::display_html_deleteUser() This function will create the meta HTML code to show a page to delete accounts.
+
display_html_expire
+
in file shadowAccount.inc, method shadowAccount::display_html_expire() This function will create the meta HTML code to show a page with the expiration date.
in file sambaSamAccount.inc, method sambaSamAccount::display_html_time() This function will create the meta HTML code to show a page to change time values.
+
display_html_user
+
in file posixGroup.inc, method posixGroup::display_html_user() Displays selections to add or remove users from current group.
in file baseModule.inc, method baseModule::doUploadPostActions() This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
doUploadPostActions
+
in file modules.inc, function doUploadPostActions() This function executes one post upload action.
in file tree.inc, function draw_formatted_dn() Gets a DN string using the user-configured tree_display_format string to format it.
+
draw_jpeg_photos
+
in file tree.inc, function draw_jpeg_photos() Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to specify how the images are to be displayed.
+
draw_server_tree
+
in file tree.inc, function draw_server_tree() Prints the HTML of the tree view.
+
draw_tree_html
+
in file tree.php, function draw_tree_html() Recursively descend on the given dn and draw the tree in html
in file schema.inc, method ObjectClass::getIsObsolete() Gets whether this objectClass is flagged as obsolete by the LDAP server.
+
getIsObsolete
+
in file schema.inc, method MatchingRule::getIsObsolete() Gets whether this MatchingRule is flagged as obsolete by the LDAP server.
+
getIsObsolete
+
in file schema.inc, method AttributeType::getIsObsolete() Gets whether this attribute has been flagged as obsolete by the LDAP server
+
getIsSingleValue
+
in file schema.inc, method AttributeType::getIsSingleValue() Gets whether this attribute is single-valued. If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.
in file schema.inc, method AttributeType::getMaxLength() Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.
+
getMayAttrNames
+
in file schema.inc, method ObjectClass::getMayAttrNames() Gets an array of attribute names (strings) that entries of this ObjectClass must define.
+
getMayAttrs
+
in file schema.inc, method ObjectClass::getMayAttrs() Gets an array of AttributeType objects that entries of this ObjectClass may define.
in file baseModule.inc, method baseModule::getOriginalAttributes() Returns the LDAP attributes which are managed in this module (with unchanged values).
in file pdfstruct.inc, function getPDFStructureDefinitions() This function will return all available PDF structure definitions for the submitted account scope.
+
getProfileOptions
+
in file modules.inc, function getProfileOptions() Returns the elements for the profile page.
in file modules.inc, function getRDNAttributes() Returns a list of LDAP attributes which can be used to form the RDN.
+
getReConn
+
in file sambaMungedDial.inc, method sambaMungedDial::getReConn() gets Reconnection value: from any client/from previous client only
+
getRecursiveAttributesFromObjectClass
+
in file schemaTest.php, function getRecursiveAttributesFromObjectClass() Returns the names of all attributes which are managed by the given object class and its parents.
+
getRequiredByObjectClasses
+
in file schema.inc, method AttributeType::getRequiredByObjectClasses() Gets the list of "required by" objectClasses, that is the list of objectClasses which provide must have attribute.
+
getRequiredExtensions
+
in file modules.inc, function getRequiredExtensions() Returns true if the module is a base module
+
getRequiredExtensions
+
in file baseModule.inc, method baseModule::getRequiredExtensions() This function returns a list of PHP extensions (e.g. mhash) which are needed by this module.
in file selfService.inc, function getSelfServiceOptions() Returns meta HTML code for each self service field.
+
getSelfServiceProfiles
+
in file selfService.inc, function getSelfServiceProfiles() Returns a list of all available self service profiles (without .conf)
+
getSelfServiceSearchAttributes
+
in file selfService.inc, function getSelfServiceSearchAttributes() Returns a list of possible search attributes for the self service.
+
getSelfServiceSearchAttributes
+
in file baseModule.inc, method baseModule::getSelfServiceSearchAttributes() This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects.
+
getSelfServiceSettings
+
in file selfService.inc, function getSelfServiceSettings() Returns a hash array (module name => elements) of all module options for the configuration page.
in file schema.inc, method AttributeType::getSubstr() Gets this attribute's substring matching specification
+
getSupAttribute
+
in file schema.inc, method AttributeType::getSupAttribute() Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.
+
getSupClasses
+
in file schema.inc, method ObjectClass::getSupClasses() Gets the objectClass names from which this objectClass inherits.
+
getSyntaxOID
+
in file schema.inc, method AttributeType::getSyntaxOID() Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.
in file types.inc, function getTypeAlias() Returns the alias name of an account type.
+
getTypeDescription
+
in file types.inc, function getTypeDescription() Returns the description of an account type.
+
getTypes
+
in file types.inc, function getTypes() Returns a list of available account types.
+
getUploadColumns
+
in file modules.inc, function getUploadColumns() Returns an array containing all input columns for the file upload.
+
getUsage
+
in file schema.inc, method AttributeType::getUsage() Gets this attribute's usage string as defined by the LDAP server
+
getUsedByAttrs
+
in file schema.inc, method MatchingRule::getUsedByAttrs() Gets an array of attribute names (strings) which use this MatchingRule
+
getUsedByAttrs
+
in file schema.inc, method MatchingRuleUse::getUsedByAttrs() Gets an array of attribute names (strings) which use this MatchingRuleUse object.
+
getUsedInObjectClasses
+
in file schema.inc, method AttributeType::getUsedInObjectClasses() Gets the list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
+
getValue
+
in file lists.inc, method lamListOption::getValue() Returns the option value. The value must not contain "=" and ";".
in file tree.inc, function get_container() Given a DN string, this returns the parent container portion of the string.
+
get_container_contents
+
in file tree.inc, function get_container_contents() Gets a list of child entries for an entry. Given a DN, this function fetches the list of DNs of child entries one level beneath the parent. For example, for the following tree:
in file baseModule.inc, method baseModule::get_profileOptions() This function defines what attributes will be used in the account profiles and their appearance in the profile editor.
in file tree.inc, function get_rdn() Given a DN string, this returns the 'RDN' portion of the string.
+
get_RDNAttributes
+
in file baseModule.inc, method baseModule::get_RDNAttributes() Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).
+
get_schema_attribute
+
in file schema.inc, function get_schema_attribute() Gets a single AttributeType object specified by name.
+
get_schema_attributes
+
in file schema.inc, function get_schema_attributes() Gets an associative array of AttributeType objects for the specified server. Each array entry's key is the name of the attributeType in lower-case and the value is an AttributeType object.
+
get_schema_matching_rules
+
in file schema.inc, function get_schema_matching_rules() Returns an array of MatchingRule objects for the specified server.
+
get_schema_objectclass
+
in file schema.inc, function get_schema_objectclass() Gets a single ObjectClass object specified by name.
+
get_schema_objectclasses
+
in file schema.inc, function get_schema_objectclasses() Gets an associative array of ObjectClass objects for the specified server. Each array entry's key is the name of the objectClass in lower-case and the value is an ObjectClass object.
+
get_schema_syntaxes
+
in file schema.inc, function get_schema_syntaxes() Returns an array of Syntax objects that this LDAP server uses mapped to their descriptions. The key of each entry is the OID of the Syntax.
+
get_scope
+
in file baseModule.inc, method baseModule::get_scope() Returns the account type of this module (user, group, host)
in file baseModule.inc, method baseModule::get_uploadColumns() Returns an array containing all input columns for the file upload.
+
get_uploadColumns
+
in file quota.inc, method quota::get_uploadColumns() Returns an array containing all input columns for the file upload.
+
get_uploadPreDepends
+
in file baseModule.inc, method baseModule::get_uploadPreDepends() Returns a list of module names which must be processed in building the account befor this module.
+
get_user_agent_string
+
in file export.inc, function get_user_agent_string() Gets the USER_AGENT string from the $_SERVER array, all in lower case in an E_NOTICE safe manner.
+
group
+
in file group.inc, class group The account type for group accounts (e.g. Unix and Samba).
in file account.inc, function in_array_ignore_case() Checks if a string exists in an array, ignoring case.
+
in_cache
+
in file cache.inc, method cache::in_cache() This function returns the DN if an LDAP entry with $attribute=$value is found.
+
isAliasFor
+
in file schema.inc, method AttributeType::isAliasFor() Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).
+
isLAMProVersion
+
in file selfService.inc, function isLAMProVersion() Returns if this is a LAM Pro installation.
in file config.inc, method LAMConfig::isWritable() Returns if the file can be written on the filesystem.
+
is_attr_binary
+
in file tree.inc, function is_attr_binary() Given an attribute name and server ID number, this function returns whether the attrbiute may contain binary data. This is useful for developers who wish to display the contents of an arbitrary attribute but don't want to dump binary data on the page.
+
is_attr_boolean
+
in file tree.inc, function is_attr_boolean() Given an attribute name and server ID number, this function returns whether the attrbiute contains boolean data. This is useful for developers who wish to display the contents of a boolean attribute with a drop-down.
+
is_base_module
+
in file baseModule.inc, method baseModule::is_base_module() Returns true if your module is a base module and otherwise false.
+
is_base_module
+
in file modules.inc, function is_base_module() Returns true if the module is a base module
in file export.inc, function is_browser_os_mac() Determines whether the browser's operating system is Macintosh.
+
is_browser_os_unix
+
in file export.inc, function is_browser_os_unix() Determines whether the browser's operating system is UNIX (or something like UNIX).
+
is_browser_os_windows
+
in file export.inc, function is_browser_os_windows() Determines whether the browser's operating system is Windows.
+
is_dn_attr
+
in file tree.inc, function is_dn_attr() Returns true if the attribute specified is required to take as input a DN.
+
is_jpeg_photo
+
in file tree.inc, function is_jpeg_photo() Used to determine if the specified attribute is indeed a jpegPhoto. If the specified attribute is one that houses jpeg data, true is returned. Otherwise this function returns false.
+
is_mail_string
+
in file tree.inc, function is_mail_string() Get whether a string looks like an email address (user@example.com).
+
is_multi_line_attr
+
in file tree.inc, function is_multi_line_attr() Determines if an attribute's value can contain multiple lines. Attributes that fall in this multi-line category may be configured in config.php. Hence, this function accesses the global variable $multi_line_attributes;
+
is_safe_ascii
+
in file export.inc, method PlaExporter::is_safe_ascii() Helper method to check if the attribute value should be base 64 encoded.
in file sambaDomain.inc, method sambaDomain::load_Messages() This function fills the error message array with messages
+
load_Messages
+
in file baseModule.inc, method baseModule::load_Messages() This function fills the $messages variable with output messages from this module.
+
load_Messages
+
in file sambaAccount.inc, method sambaAccount::load_Messages() this functin fills the error message array with messages
+
load_Messages
+
in file kolabUser.inc, method kolabUser::load_Messages() This function fills the error message array with messages
+
load_profile
+
in file shadowAccount.inc, method shadowAccount::load_profile() Loads the values of an account profile into internal variables.
+
load_profile
+
in file baseModule.inc, method baseModule::load_profile() This function loads the values from an account profile to the module's internal data structures.
+
load_profile
+
in file quota.inc, method quota::load_profile() Loads the values of an account profile into internal variables.
+
load_profile
+
in file posixAccount.inc, method posixAccount::load_profile() Loads the values of an account profile into internal variables.
+
load_profile
+
in file sambaGroupMapping.inc, method sambaGroupMapping::load_profile() Loads the values of an account profile into internal variables.
+
load_profile
+
in file sambaAccount.inc, method sambaAccount::load_profile() Loads the values of an account profile into internal variables.
+
load_profile
+
in file sambaSamAccount.inc, method sambaSamAccount::load_profile() Loads the values of an account profile into internal variables.
+
logNewMessage
+
in file security.inc, function logNewMessage() Puts a new message in the log file.
+
logoffAndBackToLoginPage
+
in file security.inc, function logoffAndBackToLoginPage() Logs off the user and displays the login page.
in file ldap.inc, method Ldap::new_rand() Calculates a new value for rand
+
nisMailAlias
+
in file nisMailAlias.inc, class nisMailAlias Provides NIS mail alias management.
+
not_an_attr
+
in file add_attr_form.php, function not_an_attr() Given an attribute $x, this returns true if it is NOT already specified in the current entry, returns false otherwise.
+
nthash
+
in file createntlm.inc, method smbHash::nthash() Calculates the NT hash of a given password.
+
ntPassword
+
in file account.inc, function ntPassword() Generates the NT hash of a password.
in file tree.inc, function pla_compare_dns() Compares 2 DNs. If they are equivelant, returns 0, otherwise, returns their sorting order (similar to strcmp()): Returns < 0 if dn1 is less than dn2.
+
pla_explode_dn
+
in file tree.inc, function pla_explode_dn() Explode a DN into an array of its RDN parts. This function is UTF-8 safe and replaces the buggy PHP ldap_explode_dn() which does not properly handle UTF-8 DNs and also causes segmentation faults with some inputs.
in file tree.inc, function pla_ldap_search() A handy ldap searching function very similar to PHP's ldap_search() with the following exceptions: Callers may specify a search scope and the return value is an array containing the search results rather than an LDAP result resource.
in file tree.inc, function real_attr_name() Prunes off anything after the ";" in an attr name. This is useful for attributes that may have ";binary" appended to their names. With real_attr_name(), you can more easily fetch these attributes' schema with their "real" attribute name.
in file schema.inc, class SchemaItem Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.
+
SCHEMA_SESSION_CACHE_ENABLED
+
in file schema.inc, constant SCHEMA_SESSION_CACHE_ENABLED To enable/disable session-based schema caching (1: enabled, 0: disabled).
+
search_domains
+
in file account.inc, function search_domains() Returns an array with all Samba 3 domain entries under the given suffix
+
search_units
+
in file ldap.inc, method Ldap::search_units() Returns an array with all organizational units under the given suffix
+
search_username
+
in file userlink.php, function search_username() Searches LDAP for a specific user name (uid attribute) and returns its DN entry
+
selfServiceProfile
+
in file selfService.inc, class selfServiceProfile Includes all settings of a self service profile.
+
server
+
in file ldap.inc, method Ldap::server() Returns the LDAP connection handle
in file schema.inc, function set_schema_cache_unavailable() Sets the schema entry for the server_id to be "unavailable" so that we realize that we tried to get the schema but could not, so quit trying next time to fetch it from the server.
in file security.inc, function startSecureSession() Starts a session and checks the environment.
+
StatusMessage
+
in file status.inc, function StatusMessage() This function prints a short status message. It can be used to print INFO, WARN and ERROR messages at the moment.
in file schema.inc, function _get_raw_schema() Fetches the raw schema array for the subschemaSubentry of the server. Note, this function has grown many hairs to accomodate more LDAP servers. It is needfully complicated as it now supports many popular LDAP servers that don't necessarily expose their schema "the right way".
+
_get_schema_dn
+
in file schema.inc, function _get_schema_dn() Helper for _get_raw_schema() which fetches the DN of the schema object
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_Help.html b/lam-web/developers/devel/phpdoc/elementindex_Help.html
new file mode 100644
index 00000000..04ff5782
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_Help.html
@@ -0,0 +1,111 @@
+
+
+Package Help Element Index
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_LDAP.html b/lam-web/developers/devel/phpdoc/elementindex_LDAP.html
new file mode 100644
index 00000000..08932b84
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_LDAP.html
@@ -0,0 +1,183 @@
+
+
+Package LDAP Element Index
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_PDF.html b/lam-web/developers/devel/phpdoc/elementindex_PDF.html
new file mode 100644
index 00000000..68a35f40
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_PDF.html
@@ -0,0 +1,697 @@
+
+
+Package PDF Element Index
+
+
+
+
+
+ [ a ]
+ [ b ]
+ [ c ]
+ [ d ]
+ [ e ]
+ [ f ]
+ [ g ]
+ [ h ]
+ [ i ]
+ [ k ]
+ [ l ]
+ [ m ]
+ [ n ]
+ [ o ]
+ [ p ]
+ [ r ]
+ [ s ]
+ [ t ]
+ [ u ]
+ [ v ]
+ [ w ]
+ [ x ]
+ [ y ]
+ [ z ]
+ [ _ ]
+
+
+
+
in file pdf.inc, function createModulePDF() This function creates the PDF output of one or more accounts. At the moment this function can create a PDF page for user, group and host accounts. But this is not limited by the function itself but by the account types that are allowed in LAM and the exsisting PDF structure definitions.
in file pdfstruct.inc, function getAvailableLogos() This function returns an array with all aviliable logo images.
+
getPDFStructureDefinitions
+
in file pdfstruct.inc, function getPDFStructureDefinitions() This function will return all available PDF structure definitions for the submitted account scope.
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_configuration.html b/lam-web/developers/devel/phpdoc/elementindex_configuration.html
new file mode 100644
index 00000000..f7c0f3b2
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_configuration.html
@@ -0,0 +1,316 @@
+
+
+Package configuration Element Index
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_lib.html b/lam-web/developers/devel/phpdoc/elementindex_lib.html
new file mode 100644
index 00000000..e7b49d11
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_lib.html
@@ -0,0 +1,561 @@
+
+
+Package lib Element Index
+
+
+
+
+
+ [ a ]
+ [ c ]
+ [ d ]
+ [ e ]
+ [ f ]
+ [ g ]
+ [ i ]
+ [ l ]
+ [ m ]
+ [ n ]
+ [ o ]
+ [ p ]
+ [ r ]
+ [ s ]
+ [ t ]
+ [ u ]
+ [ _ ]
+
+
+
+
+
_
+
+
_get_raw_schema
+
in file schema.inc, function _get_raw_schema() Fetches the raw schema array for the subschemaSubentry of the server. Note, this function has grown many hairs to accomodate more LDAP servers. It is needfully complicated as it now supports many popular LDAP servers that don't necessarily expose their schema "the right way".
+
_get_schema_dn
+
in file schema.inc, function _get_schema_dn() Helper for _get_raw_schema() which fetches the DN of the schema object
in file schema.inc, method ObjectClass::addChildObjectClass() Adds an objectClass to the list of objectClasses that inherit from this objectClass.
+
addMayAttrs
+
in file schema.inc, method ObjectClass::addMayAttrs() Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.
+
addMustAttrs
+
in file schema.inc, method ObjectClass::addMustAttrs() Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.
+
addRequiredByObjectClass
+
in file schema.inc, method AttributeType::addRequiredByObjectClass() Adds an objectClass name to this attribute's list of "required by" objectClasses, that is the list of objectClasses which must have this attribute.
+
addUsedByAttr
+
in file schema.inc, method MatchingRule::addUsedByAttr() Adds an attribute name to the list of attributes who use this MatchingRule
+
addUsedInObjectClass
+
in file schema.inc, method AttributeType::addUsedInObjectClass() Adds an objectClass name to this attribute's list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
+
add_aliases_to_attrs
+
in file schema.inc, function add_aliases_to_attrs() For each attribute that has multiple names, this function adds unique entries to the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.
+
add_cache
+
in file cache.inc, method cache::add_cache() This function adds attributes to the cache.
+
add_sup_to_attrs
+
in file schema.inc, function add_sup_to_attrs() Adds inherited values to each attributeType specified by the SUP directive.
+
array_delete
+
in file account.inc, function array_delete() This function will return all values from $array without values of $values.
+
AttributeType
+
in file schema.inc, method AttributeType::AttributeType() Creates a new AttributeType objcet from a raw LDAP AttributeType string.
+
AttributeType
+
in file schema.inc, class AttributeType Represents an LDAP AttributeType
in file schema.inc, variable ObjectClass::$children_objectclasses array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)
+
cache
+
in file cache.inc, class cache This class contains all functions which are needed to manage the LDAP cache.
+
cached_schema_available
+
in file schema.inc, function cached_schema_available() Returns true if the schema for $schema_type has been cached and
+
checkClientIP
+
in file security.inc, function checkClientIP() Checks if the client's IP address is on the list of allowed IPs.
in file schema.inc, method AttributeType::getIsObsolete() Gets whether this attribute has been flagged as obsolete by the LDAP server
+
getIsObsolete
+
in file schema.inc, method ObjectClass::getIsObsolete() Gets whether this objectClass is flagged as obsolete by the LDAP server.
+
getIsObsolete
+
in file schema.inc, method MatchingRule::getIsObsolete() Gets whether this MatchingRule is flagged as obsolete by the LDAP server.
+
getIsSingleValue
+
in file schema.inc, method AttributeType::getIsSingleValue() Gets whether this attribute is single-valued. If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.
+
getMaxLength
+
in file schema.inc, method AttributeType::getMaxLength() Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.
+
getMayAttrNames
+
in file schema.inc, method ObjectClass::getMayAttrNames() Gets an array of attribute names (strings) that entries of this ObjectClass must define.
+
getMayAttrs
+
in file schema.inc, method ObjectClass::getMayAttrs() Gets an array of AttributeType objects that entries of this ObjectClass may define.
+
getMustAttrNames
+
in file schema.inc, method ObjectClass::getMustAttrNames() Gets an array of attribute names (strings) that entries of this ObjectClass must define.
+
getMustAttrs
+
in file schema.inc, method ObjectClass::getMustAttrs() Gets an array of AttributeType objects that entries of this ObjectClass must define.
in file schema.inc, method AttributeType::getRequiredByObjectClasses() Gets the list of "required by" objectClasses, that is the list of objectClasses which provide must have attribute.
+
getshells
+
in file account.inc, function getshells() Returns a list of shells listed in config/shells.
+
getSource
+
in file schema.inc, method ObjectClassAttribute::getSource() Gets the name of the ObjectClass which originally specified this attribute.
+
getSubstr
+
in file schema.inc, method AttributeType::getSubstr() Gets this attribute's substring matching specification
+
getSupAttribute
+
in file schema.inc, method AttributeType::getSupAttribute() Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.
+
getSupClasses
+
in file schema.inc, method ObjectClass::getSupClasses() Gets the objectClass names from which this objectClass inherits.
+
getSyntaxOID
+
in file schema.inc, method AttributeType::getSyntaxOID() Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.
in file schema.inc, method AttributeType::getUsage() Gets this attribute's usage string as defined by the LDAP server
+
getUsedByAttrs
+
in file schema.inc, method MatchingRuleUse::getUsedByAttrs() Gets an array of attribute names (strings) which use this MatchingRuleUse object.
+
getUsedByAttrs
+
in file schema.inc, method MatchingRule::getUsedByAttrs() Gets an array of attribute names (strings) which use this MatchingRule
+
getUsedInObjectClasses
+
in file schema.inc, method AttributeType::getUsedInObjectClasses() Gets the list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
+
get_cache
+
in file cache.inc, method cache::get_cache() Queries the cache for a list of LDAP entries and their attributes.
+
get_cached_schema
+
in file schema.inc, function get_cached_schema() Returns the cached array of schemaitem objects for the specified
+
get_preg
+
in file account.inc, function get_preg() Checks if a given value matches the selected regular expression.
+
get_schema_attribute
+
in file schema.inc, function get_schema_attribute() Gets a single AttributeType object specified by name.
+
get_schema_attributes
+
in file schema.inc, function get_schema_attributes() Gets an associative array of AttributeType objects for the specified server. Each array entry's key is the name of the attributeType in lower-case and the value is an AttributeType object.
+
get_schema_matching_rules
+
in file schema.inc, function get_schema_matching_rules() Returns an array of MatchingRule objects for the specified server.
+
get_schema_objectclass
+
in file schema.inc, function get_schema_objectclass() Gets a single ObjectClass object specified by name.
+
get_schema_objectclasses
+
in file schema.inc, function get_schema_objectclasses() Gets an associative array of ObjectClass objects for the specified server. Each array entry's key is the name of the objectClass in lower-case and the value is an ObjectClass object.
+
get_schema_syntaxes
+
in file schema.inc, function get_schema_syntaxes() Returns an array of Syntax objects that this LDAP server uses mapped to their descriptions. The key of each entry is the OID of the Syntax.
in file account.inc, function in_array_ignore_case() Checks if a string exists in an array, ignoring case.
+
in_cache
+
in file cache.inc, method cache::in_cache() This function returns the DN if an LDAP entry with $attribute=$value is found.
+
isAliasFor
+
in file schema.inc, method AttributeType::isAliasFor() Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).
in file schema.inc, class SchemaItem Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.
in file schema.inc, method MatchingRule::setUsedByAttrs() Sets the list of used_by_attrs to the array specified by $attrs;
+
set_cached_schema
+
in file schema.inc, function set_cached_schema() Caches the specified $schema_type.
+
set_schema_cache_unavailable
+
in file schema.inc, function set_schema_cache_unavailable() Sets the schema entry for the server_id to be "unavailable" so that we realize that we tried to get the schema but could not, so quit trying next time to fetch it from the server.
+
smbflag
+
in file account.inc, function smbflag() Takes a list of Samba flags and creates the corresponding flag string.
+
startSecureSession
+
in file security.inc, function startSecureSession() Starts a session and checks the environment.
+
StatusMessage
+
in file status.inc, function StatusMessage() This function prints a short status message. It can be used to print INFO, WARN and ERROR messages at the moment.
+
Syntax
+
in file schema.inc, method Syntax::Syntax() Creates a new Syntax object from a raw LDAP syntax string.
+
Syntax
+
in file schema.inc, class Syntax Represents an LDAP Syntax
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_lists.html b/lam-web/developers/devel/phpdoc/elementindex_lists.html
new file mode 100644
index 00000000..212806c6
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_lists.html
@@ -0,0 +1,615 @@
+
+
+Package lists Element Index
+
+
+
+
+
in file tree.inc, function build_initial_tree_icons() Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned
in file tree.inc, function draw_formatted_dn() Gets a DN string using the user-configured tree_display_format string to format it.
+
draw_jpeg_photos
+
in file tree.inc, function draw_jpeg_photos() Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to specify how the images are to be displayed.
+
draw_server_tree
+
in file tree.inc, function draw_server_tree() Prints the HTML of the tree view.
+
draw_tree_html
+
in file tree.php, function draw_tree_html() Recursively descend on the given dn and draw the tree in html
in file tree.inc, function get_container() Given a DN string, this returns the parent container portion of the string.
+
get_container_contents
+
in file tree.inc, function get_container_contents() Gets a list of child entries for an entry. Given a DN, this function fetches the list of DNs of child entries one level beneath the parent. For example, for the following tree:
in file tree.inc, function initialize_session_tree() Checks and fixes an initial session's tree cache if needed.
+
is_attr_binary
+
in file tree.inc, function is_attr_binary() Given an attribute name and server ID number, this function returns whether the attrbiute may contain binary data. This is useful for developers who wish to display the contents of an arbitrary attribute but don't want to dump binary data on the page.
+
is_attr_boolean
+
in file tree.inc, function is_attr_boolean() Given an attribute name and server ID number, this function returns whether the attrbiute contains boolean data. This is useful for developers who wish to display the contents of a boolean attribute with a drop-down.
in file tree.inc, function is_dn_attr() Returns true if the attribute specified is required to take as input a DN.
+
is_jpeg_photo
+
in file tree.inc, function is_jpeg_photo() Used to determine if the specified attribute is indeed a jpegPhoto. If the specified attribute is one that houses jpeg data, true is returned. Otherwise this function returns false.
+
is_mail_string
+
in file tree.inc, function is_mail_string() Get whether a string looks like an email address (user@example.com).
+
is_multi_line_attr
+
in file tree.inc, function is_multi_line_attr() Determines if an attribute's value can contain multiple lines. Attributes that fall in this multi-line category may be configured in config.php. Hence, this function accesses the global variable $multi_line_attributes;
+
is_url_string
+
in file tree.inc, function is_url_string() Get whether a string looks like a web URL (http://www.example.com/)
in file add_attr_form.php, function not_an_attr() Given an attribute $x, this returns true if it is NOT already specified in the current entry, returns false otherwise.
in file lists.inc, variable lamList::$page current page number
+
$possibleSuffixes
+
in file lists.inc, variable lamList::$possibleSuffixes list of possible LDAP suffixes(organizational units)
+
pla_compare_dns
+
in file tree.inc, function pla_compare_dns() Compares 2 DNs. If they are equivelant, returns 0, otherwise, returns their sorting order (similar to strcmp()): Returns < 0 if dn1 is less than dn2.
+
pla_explode_dn
+
in file tree.inc, function pla_explode_dn() Explode a DN into an array of its RDN parts. This function is UTF-8 safe and replaces the buggy PHP ldap_explode_dn() which does not properly handle UTF-8 DNs and also causes segmentation faults with some inputs.
+
pla_ldap_search
+
in file tree.inc, function pla_ldap_search() A handy ldap searching function very similar to PHP's ldap_search() with the following exceptions: Callers may specify a search scope and the return value is an array containing the search results rather than an LDAP result resource.
in file tree.inc, function real_attr_name() Prunes off anything after the ";" in an attr name. This is useful for attributes that may have ";binary" appended to their names. With real_attr_name(), you can more easily fetch these attributes' schema with their "real" attribute name.
+
remove_aliases
+
in file custom.php, function remove_aliases() Removes attributes from the array that are aliases for eachother
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_main.html b/lam-web/developers/devel/phpdoc/elementindex_main.html
new file mode 100644
index 00000000..2ebebb9d
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_main.html
@@ -0,0 +1,145 @@
+
+
+Package main Element Index
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_modules.html b/lam-web/developers/devel/phpdoc/elementindex_modules.html
new file mode 100644
index 00000000..4701e964
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_modules.html
@@ -0,0 +1,1062 @@
+
+
+Package modules Element Index
+
+
+
+
+
+ [ a ]
+ [ b ]
+ [ c ]
+ [ d ]
+ [ e ]
+ [ f ]
+ [ g ]
+ [ h ]
+ [ i ]
+ [ k ]
+ [ l ]
+ [ m ]
+ [ n ]
+ [ o ]
+ [ p ]
+ [ q ]
+ [ r ]
+ [ s ]
+ [ t ]
+ [ _ ]
+
+
+
+
in file baseModule.inc, variable baseModule::$autoAddObjectClasses if true, managed object classes are added when an account is created or loaded (default: true)
+
account
+
in file account.inc, class account Manages the object class "account" for users and hosts.
+
accountContainer
+
in file modules.inc, class accountContainer This class includes all modules and attributes of an account.
in file baseModule.inc, method baseModule::can_manage() Returns true if this module can manage accounts of the current type, otherwise false.
+
checkASCII
+
in file posixAccount.inc, method posixAccount::checkASCII() Checks if an attribute contains only ASCII charaters and replaces invalid characters.
+
checkConfigOptions
+
in file modules.inc, function checkConfigOptions() Checks if the configuration options are valid
+
checkProfileOptions
+
in file modules.inc, function checkProfileOptions() Checks if the profile options are valid
+
checkSelfServiceOptions
+
in file inetOrgPerson.inc, method inetOrgPerson::checkSelfServiceOptions() Checks if all input values are correct and returns the LDAP commands which should be executed.
+
checkSelfServiceOptions
+
in file posixAccount.inc, method posixAccount::checkSelfServiceOptions() Checks if all input values are correct and returns the LDAP commands which should be executed.
+
checkSelfServiceOptions
+
in file sambaSamAccount.inc, method sambaSamAccount::checkSelfServiceOptions() Checks if all input values are correct and returns the LDAP commands which should be executed.
+
checkSelfServiceOptions
+
in file baseModule.inc, method baseModule::checkSelfServiceOptions() Checks if all input values are correct and returns the LDAP attributes which should be changed.
in file sambaMungedDial.inc, method sambaMungedDial::decode_munged() Takes a base64-encoded MungedDial-String and returns an array of included parameters and values
+
delete_attributes
+
in file baseModule.inc, method baseModule::delete_attributes() This function returns an array with the same syntax as save_attributes().
in file baseModule.inc, method baseModule::display_html_delete() This function creates meta HTML code which will be displayed when an account should be deleted.
+
display_html_deleteUser
+
in file kolabUser.inc, method kolabUser::display_html_deleteUser() This function will create the meta HTML code to show a page to delete accounts.
+
display_html_expire
+
in file shadowAccount.inc, method shadowAccount::display_html_expire() This function will create the meta HTML code to show a page with the expiration date.
in file sambaSamAccount.inc, method sambaSamAccount::display_html_time() This function will create the meta HTML code to show a page to change time values.
+
display_html_user
+
in file posixGroup.inc, method posixGroup::display_html_user() Displays selections to add or remove users from current group.
in file baseModule.inc, method baseModule::doUploadPostActions() This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
in file sambaMungedDial.inc, method sambaMungedDial::getOnDemandFlags() Returns array of flags, which can be set on-demand with activated java-script
+
getOriginalAttributes
+
in file baseModule.inc, method baseModule::getOriginalAttributes() Returns the LDAP attributes which are managed in this module (with unchanged values).
in file modules.inc, function getRDNAttributes() Returns a list of LDAP attributes which can be used to form the RDN.
+
getReConn
+
in file sambaMungedDial.inc, method sambaMungedDial::getReConn() gets Reconnection value: from any client/from previous client only
+
getRequiredExtensions
+
in file modules.inc, function getRequiredExtensions() Returns true if the module is a base module
+
getRequiredExtensions
+
in file baseModule.inc, method baseModule::getRequiredExtensions() This function returns a list of PHP extensions (e.g. mhash) which are needed by this module.
in file baseModule.inc, method baseModule::getSelfServiceSearchAttributes() This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects.
in file baseModule.inc, method baseModule::get_profileOptions() This function defines what attributes will be used in the account profiles and their appearance in the profile editor.
in file baseModule.inc, method baseModule::get_RDNAttributes() Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).
+
get_scope
+
in file baseModule.inc, method baseModule::get_scope() Returns the account type of this module (user, group, host)
+
get_type
+
in file modules.inc, method accountContainer::get_type() Returns the accout type of this object (e.g. user, group, host).
+
get_uploadColumns
+
in file quota.inc, method quota::get_uploadColumns() Returns an array containing all input columns for the file upload.
+
get_uploadColumns
+
in file baseModule.inc, method baseModule::get_uploadColumns() Returns an array containing all input columns for the file upload.
+
get_uploadPreDepends
+
in file baseModule.inc, method baseModule::get_uploadPreDepends() Returns a list of module names which must be processed in building the account befor this module.
in file sambaSamAccount.inc, method sambaSamAccount::load_profile() Loads the values of an account profile into internal variables.
+
load_profile
+
in file shadowAccount.inc, method shadowAccount::load_profile() Loads the values of an account profile into internal variables.
+
load_profile
+
in file baseModule.inc, method baseModule::load_profile() This function loads the values from an account profile to the module's internal data structures.
+
load_profile
+
in file posixAccount.inc, method posixAccount::load_profile() Loads the values of an account profile into internal variables.
+
load_profile
+
in file quota.inc, method quota::load_profile() Loads the values of an account profile into internal variables.
+
load_profile
+
in file sambaAccount.inc, method sambaAccount::load_profile() Loads the values of an account profile into internal variables.
+
load_profile
+
in file sambaGroupMapping.inc, method sambaGroupMapping::load_profile() Loads the values of an account profile into internal variables.
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_profiles.html b/lam-web/developers/devel/phpdoc/elementindex_profiles.html
new file mode 100644
index 00000000..6e5d948c
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_profiles.html
@@ -0,0 +1,139 @@
+
+
+Package profiles Element Index
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_selfService.html b/lam-web/developers/devel/phpdoc/elementindex_selfService.html
new file mode 100644
index 00000000..e43f2f2d
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_selfService.html
@@ -0,0 +1,186 @@
+
+
+Package selfService Element Index
+
+
+
+
+
in file selfService.inc, function checkSelfServiceOptions() Checks if all input values are correct and returns the LDAP commands which should be executed.
+
checkSelfServiceSettings
+
in file selfService.inc, function checkSelfServiceSettings() Checks if the self service settings are valid
in file selfService.inc, function getSelfServiceOptions() Returns meta HTML code for each self service field.
+
getSelfServiceProfiles
+
in file selfService.inc, function getSelfServiceProfiles() Returns a list of all available self service profiles (without .conf)
+
getSelfServiceSearchAttributes
+
in file selfService.inc, function getSelfServiceSearchAttributes() Returns a list of possible search attributes for the self service.
+
getSelfServiceSettings
+
in file selfService.inc, function getSelfServiceSettings() Returns a hash array (module name => elements) of all module options for the configuration page.
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_tests.html b/lam-web/developers/devel/phpdoc/elementindex_tests.html
new file mode 100644
index 00000000..149dca39
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_tests.html
@@ -0,0 +1,100 @@
+
+
+Package tests Element Index
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_tools.html b/lam-web/developers/devel/phpdoc/elementindex_tools.html
new file mode 100644
index 00000000..325dcd7b
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_tools.html
@@ -0,0 +1,454 @@
+
+
+Package tools Element Index
+
+
+
+
+
+ [ a ]
+ [ b ]
+ [ c ]
+ [ d ]
+ [ e ]
+ [ g ]
+ [ h ]
+ [ i ]
+ [ l ]
+ [ m ]
+ [ n ]
+ [ o ]
+ [ p ]
+ [ q ]
+ [ r ]
+ [ s ]
+ [ t ]
+ [ v ]
+
+
+
+
in file schemaTest.php, function getRecursiveAttributesFromObjectClass() Returns the names of all attributes which are managed by the given object class and its parents.
+
get_user_agent_string
+
in file export.inc, function get_user_agent_string() Gets the USER_AGENT string from the $_SERVER array, all in lower case in an E_NOTICE safe manner.
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/elementindex_types.html b/lam-web/developers/devel/phpdoc/elementindex_types.html
new file mode 100644
index 00000000..9a661de7
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/elementindex_types.html
@@ -0,0 +1,255 @@
+
+
+Package types Element Index
+
+
+
+
+
+Warning on line 445 - Method "displayExportInfo" has no method-level DocBlock.
+Warning on line 590 - Method "PlaVcardExporter" has no method-level DocBlock.
+Warning on line 687 - Method "PlaCSVExporter" has no method-level DocBlock.
+Warning on line 775 - Method "export" has no method-level DocBlock.
+Warning on line 781 - Method "LdapEscape" has no method-level DocBlock.
+Warning on line 795 - Method "MyCutsomExporter" has no method-level DocBlock.
+
+
fpdf.php
+
Warnings:
+Warning on line 202 - Method "SetMargins" has no method-level DocBlock.
+Warning on line 210 - Method "SetLeftMargin" has no method-level DocBlock.
+Warning on line 216 - Method "SetTopMargin" has no method-level DocBlock.
+Warning on line 222 - Method "SetRightMargin" has no method-level DocBlock.
+Warning on line 230 - Method "SetAutoPageBreak" has no method-level DocBlock.
+Warning on line 243 - Method "SetDisplayMode" has no method-level DocBlock.
+Warning on line 252 - Method "SetCompression" has no method-level DocBlock.
+Warning on line 258 - Method "SetTitle" has no method-level DocBlock.
+Warning on line 264 - Method "SetSubject" has no method-level DocBlock.
+Warning on line 270 - Method "SetAuthor" has no method-level DocBlock.
+Warning on line 276 - Method "SetKeywords" has no method-level DocBlock.
+Warning on line 282 - Method "SetCreator" has no method-level DocBlock.
+Warning on line 288 - Method "AliasNbPages" has no method-level DocBlock.
+Warning on line 294 - Method "Error" has no method-level DocBlock.
+Warning on line 300 - Method "Open" has no method-level DocBlock.
+Warning on line 317 - Method "Close" has no method-level DocBlock.
+Warning on line 384 - Method "AddPage" has no method-level DocBlock.
+Warning on line 389 - Method "Header" has no method-level DocBlock.
+Warning on line 394 - Method "Footer" has no method-level DocBlock.
+Warning on line 400 - Method "PageNo" has no method-level DocBlock.
+Warning on line 411 - Method "SetDrawColor" has no method-level DocBlock.
+Warning on line 423 - Method "SetFillColor" has no method-level DocBlock.
+Warning on line 433 - Method "SetTextColor" has no method-level DocBlock.
+Warning on line 445 - Method "GetStringWidth" has no method-level DocBlock.
+Warning on line 453 - Method "SetLineWidth" has no method-level DocBlock.
+Warning on line 459 - Method "Line" has no method-level DocBlock.
+Warning on line 471 - Method "Rect" has no method-level DocBlock.
+Warning on line 519 - Method "AddFont" has no method-level DocBlock.
+Warning on line 579 - Method "SetFont" has no method-level DocBlock.
+Warning on line 590 - Method "SetFontSize" has no method-level DocBlock.
+Warning on line 598 - Method "AddLink" has no method-level DocBlock.
+Warning on line 608 - Method "SetLink" has no method-level DocBlock.
+Warning on line 614 - Method "Link" has no method-level DocBlock.
+Warning on line 625 - Method "Text" has no method-level DocBlock.
+Warning on line 631 - Method "AcceptPageBreak" has no method-level DocBlock.
+Warning on line 710 - Method "Cell" has no method-level DocBlock.
+Warning on line 823 - Method "MultiCell" has no method-level DocBlock.
+Warning on line 904 - Method "Write" has no method-level DocBlock.
+Warning on line 954 - Method "Image" has no method-level DocBlock.
+Warning on line 964 - Method "Ln" has no method-level DocBlock.
+Warning on line 970 - Method "GetX" has no method-level DocBlock.
+Warning on line 979 - Method "SetX" has no method-level DocBlock.
+Warning on line 985 - Method "GetY" has no method-level DocBlock.
+Warning on line 995 - Method "SetY" has no method-level DocBlock.
+Warning on line 1002 - Method "SetXY" has no method-level DocBlock.
+Warning on line 1070 - Method "Output" has no method-level DocBlock.
+Warning on line 1092 - Method "_getfontpath" has no method-level DocBlock.
+Warning on line 1163 - Method "_putpages" has no method-level DocBlock.
+Warning on line 1280 - Method "_putfonts" has no method-level DocBlock.
+Warning on line 1328 - Method "_putimages" has no method-level DocBlock.
+Warning on line 1334 - Method "_putxobjectdict" has no method-level DocBlock.
+Warning on line 1346 - Method "_putresourcedict" has no method-level DocBlock.
+Warning on line 1359 - Method "_putresources" has no method-level DocBlock.
+Warning on line 1375 - Method "_putinfo" has no method-level DocBlock.
+Warning on line 1395 - Method "_putcatalog" has no method-level DocBlock.
+Warning on line 1400 - Method "_putheader" has no method-level DocBlock.
+Warning on line 1407 - Method "_puttrailer" has no method-level DocBlock.
+Warning on line 1442 - Method "_enddoc" has no method-level DocBlock.
+Warning on line 1481 - Method "_beginpage" has no method-level DocBlock.
+Warning on line 1487 - Method "_endpage" has no method-level DocBlock.
+Warning on line 1495 - Method "_newobj" has no method-level DocBlock.
+Warning on line 1504 - Method "_dounderline" has no method-level DocBlock.
+Warning on line 1528 - Method "_parsejpg" has no method-level DocBlock.
+Warning on line 1611 - Method "_parsepng" has no method-level DocBlock.
+Warning on line 1618 - Method "_freadint" has no method-level DocBlock.
+Warning on line 1624 - Method "_textstring" has no method-level DocBlock.
+Warning on line 1630 - Method "_escape" has no method-level DocBlock.
+Warning on line 1637 - Method "_putstream" has no method-level DocBlock.
+Warning on line 1646 - Method "_out" has no method-level DocBlock.
+
+
schema.inc
+
Warnings:
+Warning on line 67 - Method "setOID" has no method-level DocBlock.
+Warning on line 72 - Method "setDescription" has no method-level DocBlock.
+Warning on line 77 - Method "getOID" has no method-level DocBlock.
+Warning on line 82 - Method "getDescription" has no method-level DocBlock.
+Warning on line 1232 - Method "MatchingRuleUse" has no method-level DocBlock.
+
+
ufpdf.php
+
Warnings:
+Warning on line 70 - Method "GetStringWidth" has no method-level DocBlock.
+Warning on line 99 - Method "AddFont" has no method-level DocBlock.
+Warning on line 110 - Method "Text" has no method-level DocBlock.
+Warning on line 116 - Method "AcceptPageBreak" has no method-level DocBlock.
+Warning on line 196 - Method "Cell" has no method-level DocBlock.
+Warning on line 321 - Method "MultiCell" has no method-level DocBlock.
+Warning on line 404 - Method "Write" has no method-level DocBlock.
+Warning on line 410 - Method "AliasNbPages" has no method-level DocBlock.
+Warning on line 487 - Method "_dounderline" has no method-level DocBlock.
+Warning on line 495 - Method "_textstring" has no method-level DocBlock.
+Warning on line 503 - Method "_escapetext" has no method-level DocBlock.
+Warning on line 519 - Method "_putinfo" has no method-level DocBlock.
+Warning on line 592 - Method "_putpages" has no method-level DocBlock.
+Warning on line 694 - Method "utf8_to_utf16be" has no method-level DocBlock.
+Warning on line 702 - Method "code2utf" has no method-level DocBlock.
+Warning on line 706 - Method "strlen" has no method-level DocBlock.
+Warning on line 721 - Method "utf8_substr" has no method-level DocBlock.
+Warning on line 813 - Method "utf8_to_codepoints" has no method-level DocBlock.
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/index.html b/lam-web/developers/devel/phpdoc/index.html
new file mode 100644
index 00000000..d96d9e94
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/index.html
@@ -0,0 +1,65 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+Welcome to types!
+
+This documentation was generated by phpDocumentor v1.4.0
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lib/AttributeType.html b/lam-web/developers/devel/phpdoc/lib/AttributeType.html
new file mode 100644
index 00000000..e7f251f7
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lib/AttributeType.html
@@ -0,0 +1,1199 @@
+
+
+Docs For Class AttributeType
+
+
+
+
+
+
+ Adds an objectClass name to this attribute's list of "required by" objectClasses, that is the list of objectClasses which must have this attribute.
+
+ Gets whether this attribute is single-valued. If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.
+
Tags:
+
+
+
+
return:
Returns true if this attribute is single-valued or false otherwise.
+
+ Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.
Ie, if the syntax string is "1.2.3.4{16}", this function only retruns "1.2.3.4".
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:53 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lib/MatchingRule.html b/lam-web/developers/devel/phpdoc/lib/MatchingRule.html
new file mode 100644
index 00000000..7175f21f
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lib/MatchingRule.html
@@ -0,0 +1,473 @@
+
+
+Docs For Class MatchingRule
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:54 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lib/MatchingRuleUse.html b/lam-web/developers/devel/phpdoc/lib/MatchingRuleUse.html
new file mode 100644
index 00000000..7b00cea9
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lib/MatchingRuleUse.html
@@ -0,0 +1,350 @@
+
+
+Docs For Class MatchingRuleUse
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:54 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lib/ObjectClass.html b/lam-web/developers/devel/phpdoc/lib/ObjectClass.html
new file mode 100644
index 00000000..b472a709
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lib/ObjectClass.html
@@ -0,0 +1,770 @@
+
+
+Docs For Class ObjectClass
+
+
+
+
+
+
+ Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.
An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides.
An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides.
An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides.
An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass requires.
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:54 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lib/ObjectClassAttribute.html b/lam-web/developers/devel/phpdoc/lib/ObjectClassAttribute.html
new file mode 100644
index 00000000..bad03f78
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lib/ObjectClassAttribute.html
@@ -0,0 +1,255 @@
+
+
+Docs For Class ObjectClassAttribute
+
+
+
+
+
+[line 476]
+A simple class for representing AttributeTypes used only by the ObjectClass class.
Users should never instantiate this class. It represents an attribute internal to an ObjectClass. If PHP supported inner-classes and variable permissions, this would be interior to class ObjectClass and flagged private. The reason this class is used and not the "real" class AttributeType is because this class supports the notion of a "source" objectClass, meaning that it keeps track of which objectClass originally specified it. This class is therefore used by the class ObjectClass to determine inheritance.
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:54 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lib/SchemaItem.html b/lam-web/developers/devel/phpdoc/lib/SchemaItem.html
new file mode 100644
index 00000000..d4cde90b
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lib/SchemaItem.html
@@ -0,0 +1,358 @@
+
+
+Docs For Class SchemaItem
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:54 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lib/Syntax.html b/lam-web/developers/devel/phpdoc/lib/Syntax.html
new file mode 100644
index 00000000..127c1024
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lib/Syntax.html
@@ -0,0 +1,256 @@
+
+
+Docs For Class Syntax
+
+
+
+
+
+
+ For each attribute that has multiple names, this function adds unique entries to the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.
This function will create a unique entry for 'gn' and 'givenName'.
+
+ Returns true if the schema for $schema_type has been cached and
is availble. $schema_type may be one of (lowercase) the following: objectclasses attributetypes ldapsyntaxes matchingrules matchingruleuse Note that _get_raw_schema() takes a similar parameter.
+
+ Returns the cached array of schemaitem objects for the specified
$schema_type. For list of valid $schema_type values, see above schema_cache_available(). Note that internally, this function utilizes a two-layer cache, one in memory using a static variable for multiple calls within the same page load, and one in a session for multiple calls within the same user session (spanning multiple page loads).
Returns an array of SchemaItem objects on success or false on failure.
+
+ Gets an associative array of AttributeType objects for the specified server. Each array entry's key is the name of the attributeType in lower-case and the value is an AttributeType object.
+
Tags:
+
+
+
+
return:
An array of AttributeType objects.
+
+
+
+
+
+
Parameters
+
+
+
string
+
$dn
+
(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should).
+
+ Gets an associative array of ObjectClass objects for the specified server. Each array entry's key is the name of the objectClass in lower-case and the value is an ObjectClass object.
$schema_items should be an array of SchemaItem instances (ie, an array of ObjectClass, AttributeType, LDAPSyntax, MatchingRuleUse, or MatchingRule objects.
+
+ Sets the schema entry for the server_id to be "unavailable" so that we realize that we tried to get the schema but could not, so quit trying next time to fetch it from the server.
+ an _get_raw_schema(
+$schema_to_fetch $schema_to_fetch, [$dn $dn = ''])
+
+
+
+ Fetches the raw schema array for the subschemaSubentry of the server. Note, this function has grown many hairs to accomodate more LDAP servers. It is needfully complicated as it now supports many popular LDAP servers that don't necessarily expose their schema "the right way".
+
Tags:
+
+
+
+
return:
array of strings of this form: Array ( [0] => "( 1.3.6.1.4.1.7165.1.2.2.4 NAME 'gidPool' DESC 'Pool ... [1] => "( 1.3.6.1.4.1.7165.2.2.3 NAME 'sambaAccount' DESC 'Sa ... etc.
+
+
+
+
+
+
Parameters
+
+
+
$schema_to_fetch
+
$schema_to_fetch
+
- A string indicating which type of schema to fetch. Five valid values: 'objectclasses', 'attributetypes', 'ldapsyntaxes', 'matchingruleuse', or 'matchingrules'. Case insensitive.
+
+
+
$dn
+
$dn
+
(optional) This paremeter is the DN of the entry whose schema you would like to fetch. Entries have the option of specifying their own subschemaSubentry that points to the DN of the system schema entry which applies to this attribute. If unspecified, this will try to retrieve the schema from the RootDSE subschemaSubentry. Failing that, we use some commonly known schema DNs. Default value is the Root DSE DN (zero-length string)
+
+ Helper for _get_raw_schema() which fetches the DN of the schema object
in an LDAP server based on a DN. Entries should set the subSchemaSubEntry attribute pointing to the DN of the server schema. You can specify the DN whose subSchemaSubEntry you wish to retrieve of specify an empty string to fetch the subScehamSubEntry from the Root DSE.
+
Tags:
+
+
+
+
return:
The DN of the entry which houses this LDAP server's schema.
+
+
+
+
+
+
Parameters
+
+
+
string
+
$dn
+
The DN (may be null) which houses the subschemaSubEntry attribute which this function can use to determine the schema entry's DN.
+
+
+
bool
+
$debug
+
Switch to true to see some nice and copious output. :)
+
+ This function prints a short status message. It can be used to print INFO, WARN and ERROR messages at the moment.
The headline and text may be formated with special tags:
{bold}, {endbold}: All text between these tags is printed bold. {color=#123456}, {endcolor}: All text between these tags is printed in the given color. {link=http://nodomain.org}, {endlink}: A link with the given target is created. The link text is the text between the tags.
+
+
Parameters
+
+
+
string
+
$MessageTyp
+
The type of the message to be printed. It must be one of the following types: 'INFO', 'WARN' or 'ERROR'. Every other type will lead to an error message indicating an invalid message type.
+
+
+
string
+
$MessageHeadline
+
The headline of the status message. It may be formatted with special color/link/bold tags.
+
+
+
string
+
$MessageText
+
The text of the status message. It may be formatted with special color/link/bold tags. This parameter is optional.
+
+
+
array
+
$MessageVariables
+
The variables that are used to replace the spacers (%s) in the submitted text. This parameter is optional.
+
+ Queries the cache for a list of LDAP entries and their attributes.
+
Tags:
+
+
+
+
return:
The found LDAP entries. Format: array(dn1 => array(uidnumber1), dn2 => array(uidnumber2), ... ) if $attributes is of type string or array(dn1 => array(uid => array(myuid), uidNumber => array(1234)), ... ) if $attributes is an array
+
+
+
+
+
+
+
Parameters:
+
+
+
+
mixed
+
$attributes
+
One (string) or many (array) attribute names.
+
+
+
string
+
$objectClass
+
The resulting entries need to contain this object class.
+
+
+
mixed
+
$scopelist
+
the account type(s) as string or array, all scopes if NULL given
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:39 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lists/lamGroupList.html b/lam-web/developers/devel/phpdoc/lists/lamGroupList.html
new file mode 100644
index 00000000..c6dd6263
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lists/lamGroupList.html
@@ -0,0 +1,665 @@
+
+
+Docs For Class lamGroupList
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:31 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lists/lamHostList.html b/lam-web/developers/devel/phpdoc/lists/lamHostList.html
new file mode 100644
index 00000000..9a95bc2a
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lists/lamHostList.html
@@ -0,0 +1,495 @@
+
+
+Docs For Class lamHostList
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:32 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lists/lamList.html b/lam-web/developers/devel/phpdoc/lists/lamList.html
new file mode 100644
index 00000000..5d54d6f5
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lists/lamList.html
@@ -0,0 +1,1401 @@
+
+
+Docs For Class lamList
+
+
+
+
+
+
+ Builds the regular expressions from the filter values.
+
Tags:
+
+
+
+
return:
filter data array($attribute => array('regex' => $reg, 'original' => $orig)) $reg is the regular expression to use, $orig the user's unmodified input string
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:39 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lists/lamListOption.html b/lam-web/developers/devel/phpdoc/lists/lamListOption.html
new file mode 100644
index 00000000..bd02f932
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lists/lamListOption.html
@@ -0,0 +1,461 @@
+
+
+Docs For Class lamListOption
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:39 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lists/lamListTool.html b/lam-web/developers/devel/phpdoc/lists/lamListTool.html
new file mode 100644
index 00000000..52d9f5d0
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lists/lamListTool.html
@@ -0,0 +1,355 @@
+
+
+Docs For Class lamListTool
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:40 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lists/lamMailAliasList.html b/lam-web/developers/devel/phpdoc/lists/lamMailAliasList.html
new file mode 100644
index 00000000..6f86df33
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lists/lamMailAliasList.html
@@ -0,0 +1,495 @@
+
+
+Docs For Class lamMailAliasList
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:40 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lists/lamSelectListOption.html b/lam-web/developers/devel/phpdoc/lists/lamSelectListOption.html
new file mode 100644
index 00000000..8b7feac0
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lists/lamSelectListOption.html
@@ -0,0 +1,409 @@
+
+
+Docs For Class lamSelectListOption
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:40 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lists/lamSmbDomainList.html b/lam-web/developers/devel/phpdoc/lists/lamSmbDomainList.html
new file mode 100644
index 00000000..3b566a9a
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lists/lamSmbDomainList.html
@@ -0,0 +1,495 @@
+
+
+Docs For Class lamSmbDomainList
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:57 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/lists/lamUserList.html b/lam-web/developers/devel/phpdoc/lists/lamUserList.html
new file mode 100644
index 00000000..698768af
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/lists/lamUserList.html
@@ -0,0 +1,733 @@
+
+
+Docs For Class lamUserList
+
+
+
+
+
+This function displays the LDAP tree for all the servers that you have
in config.php. We read the session variable 'tree' to know which dns are expanded or collapsed. No query string parameters are expected, however, you can use a '#' offset to scroll to a given dn. The syntax is tree.php#<rawurlencoded dn>, so if I wanted to scroll to dc=example,dc=com for server 3, the URL would be: tree.php#3_dc%3Dexample%2Cdc%3Dcom
+
+ Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned
array is then stored in the current session. The structure of the returned array is simple, and looks like this:
Array
+
(
+
[0] => Array
+
(
+
[dc=example,dc=com] => "dcobject.png"
+
)
+
[1] => Array
+
[o=Corporation] => "o.png"
+
)
+
)
+ This function is not meant as a user-callable function, but rather a convenient, automated method for setting up the initial data structure for the tree viewer's icon cache.
The DN of the entry that contains the jpeg attribute you want to draw.
+
+
+
string
+
$attr_name
+
The name of the attribute containing the jpeg data (usually 'jpegPhoto').
+
+
+
bool
+
$draw_delete_buttons
+
If true, draws a button beneath the image titled 'Delete' allowing the user to delete the jpeg attribute by calling JavaScript function deleteAttribute() provided in the default modification template.
+
+
+
bool
+
$draw_bytes_and_size
+
If true, draw text below the image indicating the byte size and dimensions.
+
+
+
string
+
$table_html_attrs
+
Specifies optional CSS style attributes for the table tag.
+
+ Gets a list of child entries for an entry. Given a DN, this function fetches the list of DNs of child entries one level beneath the parent. For example, for the following tree:
+
+ Gets the operational attributes for an entry. Given a DN, this function fetches that entry's
operational (ie, system or internal) attributes. These attributes include "createTimeStamp", "creatorsName", and any other attribute that the LDAP server sets automatically. The returned associative array is of this form:
Array
+
(
+
[creatorsName] => Array
+
(
+
[0] => "cn=Admin,dc=example,dc=com"
+
)
+
[createTimeStamp]=> Array
+
(
+
[0] => "10401040130"
+
)
+
[hasSubordinates] => Array
+
(
+
[0] => "FALSE"
+
)
+
)
+
+
Tags:
+
+
+
+
return:
An associative array whose keys are attribute names and whose values are arrays of values for the aforementioned attribute.
+
+
+
+
+
+
Parameters
+
+
+
string
+
$dn
+
The DN of the entry whose interal attributes are desired.
+
+
+
int
+
$deref
+
For aliases and referrals, this parameter specifies whether to follow references to the referenced DN or to fetch the attributes for the referencing DN. See http://php.net/ldap_search for the 4 valid options.
+
+ Given a DN and server ID, this function reads the DN's objectClasses and
determines which icon best represents the entry. The results of this query are cached in a session variable so it is not run every time the tree browser changes, just when exposing new DNs that were not displayed previously. That means we can afford a little bit of inefficiency here in favor of coolness. :)
This function returns a string like "country.png". All icon files are assumed to be contained in the /../../graphics/ directory of phpLDAPadmin.
Developers are encouraged to add new icons to the images directory and modify this function as needed to suit their types of LDAP entries. If the modifications are general to an LDAP audience, the phpLDAPadmin team will gladly accept them as a patch.
+
+ Gets the attributes/values of an entry. Returns an associative array whose
keys are attribute value names and whose values are arrays of values for said attribute. Optionally, callers may specify true for the parameter $lower_case_attr_names to force all keys in the associate array (attribute names) to be lower case.
The distinguished name (DN) of the entry whose attributes/values to fetch.
+
+
+
bool
+
$lower_case_attr_names
+
(optional) If true, all keys of the returned associative array will be lower case. Otherwise, they will be cased as the LDAP server returns them.
+
+
+
int
+
$deref
+
For aliases and referrals, this parameter specifies whether to follow references to the referenced DN or to fetch the attributes for the referencing DN. See http://php.net/ldap_search for the 4 valid options.
+
+ Checks and fixes an initial session's tree cache if needed.
This function is not meant as a user-callable function, but rather a convenient, automated method for checking the initial data structure of the session.
+
+ Given an attribute name and server ID number, this function returns whether the attrbiute may contain binary data. This is useful for developers who wish to display the contents of an arbitrary attribute but don't want to dump binary data on the page.
+
+ Given an attribute name and server ID number, this function returns whether the attrbiute contains boolean data. This is useful for developers who wish to display the contents of a boolean attribute with a drop-down.
+
+ Used to determine if the specified attribute is indeed a jpegPhoto. If the specified attribute is one that houses jpeg data, true is returned. Otherwise this function returns false.
+
+ Determines if an attribute's value can contain multiple lines. Attributes that fall in this multi-line category may be configured in config.php. Hence, this function accesses the global variable $multi_line_attributes;
+ int pla_compare_dns(
+string $dn1, string $dn2)
+
+
+
+ Compares 2 DNs. If they are equivelant, returns 0, otherwise, returns their sorting order (similar to strcmp()): Returns < 0 if dn1 is less than dn2.
Returns > 0 if dn1 is greater than dn2.
The comparison is performed starting with the top-most element of the DN. Thus, the following list:
ou=people,dc=example,dc=com
+
cn=Admin,ou=People,dc=example,dc=com
+
cn=Joe,ou=people,dc=example,dc=com
+
dc=example,dc=com
+
cn=Fred,ou=people,dc=example,dc=org
+
cn=Dave,ou=people,dc=example,dc=org
+ Will be sorted thus using usort( $list, "pla_compare_dns" ):
+
+ Explode a DN into an array of its RDN parts. This function is UTF-8 safe and replaces the buggy PHP ldap_explode_dn() which does not properly handle UTF-8 DNs and also causes segmentation faults with some inputs.
+
Tags:
+
+
+
+
return:
An array of RDN parts of this format:
Array
+
(
+
[0] => uid=ppratt
+
[1] => ou=People
+
[2] => dc=example
+
[3] => dc=com
+
)
+
+
+
+
+
+
+
Parameters
+
+
+
string
+
$dn
+
The DN to explode.
+
+
+
int
+
$with_attriutes
+
(optional) Whether to include attribute names (see http://php.net/ldap_explode_dn for details)
+
+ A handy ldap searching function very similar to PHP's ldap_search() with the following exceptions: Callers may specify a search scope and the return value is an array containing the search results rather than an LDAP result resource.
WARNING: This function will use a lot of memory on large searches since the entire result set is stored in a single array. For large searches, you should consider sing the less memory intensive PHP LDAP API directly (ldap_search(), ldap_next_entry(), ldap_next_attribute(), etc).
+
+
Parameters
+
+
+
string
+
$filter
+
The LDAP filter to use when searching (example: "(objectClass=*)") (see RFC 2254)
+
+
+
string
+
$base_dn
+
The DN of the base of search.
+
+
+
array
+
$attrs
+
An array of attributes to include in the search result (example: array( "objectClass", "uid", "sn" )).
+
+
+
string
+
$scope
+
The LDAP search scope. Must be one of "base", "one", or "sub". Standard LDAP search scope.
+
+
+
bool
+
$sort_results
+
Specify false to not sort results by DN or true to have the returned array sorted by DN (uses ksort)
+
+
+
int
+
$deref
+
When handling aliases or referrals, this specifies whether to follow referrals. Must be one of LDAP_DEREF_ALWAYS, LDAP_DEREF_NEVER, LDAP_DEREF_SEARCHING, or LDAP_DEREF_FINDING. See the PHP LDAP API for details.
Internally, this function makes use of pla_explode_dn() to break the the DN into its components. It then glues them back together with "pretty" HTML. The returned HTML is NOT to be used as a real DN, but simply displayed.
+
+ Prunes off anything after the ";" in an attr name. This is useful for attributes that may have ";binary" appended to their names. With real_attr_name(), you can more easily fetch these attributes' schema with their "real" attribute name.
+This page may simply add the objectClass and take you back to the edit page, but, in one condition it may prompt the user for input. That condition is this:
If the user has requested to add an objectClass that requires a set of attributes with 1 or more not defined by the object. In that case, we will present a form for the user to add those attributes to the object.
+This script displays the LDAP tree for all the servers that you have
in config.php. We read the session variable 'tree' to know which dns are expanded or collapsed. No query string parameters are expected, however, you can use a '#' offset to scroll to a given dn. The syntax is tree.php#<rawurlencoded dn>, so if I wanted to scroll to dc=example,dc=com for server 3, the URL would be: tree.php#3_dc%3Dexample%2Cdc%3Dcom
+Updates or deletes a value from a specified attribute for a specified dn.
Variables that come in on the query string:
dn (rawurlencoded)
update_array (an array in the form expected by PHP's ldap_modify, except for deletions)
+ (will never be empty: update_confirm.php ensures that)
Attribute deletions: To specify that an attribute is to be deleted (whether multi- or single-valued), enter that attribute in the update array like this: attr => ''. For example, to delete the 'sn' attribute from an entry, the update array would look like this: Array ( sn => '' )
On success, redirect to edit.php On failure, echo an error.
+Takes the results of clicking "Save" in edit.php and determines which
attributes need to be updated (ie, which ones actually changed). Then, we present a confirmation table to the user outlining the changes they are about to make. That form submits directly to update.php, which makes the change.
+
+ This function executes one post upload action.
+
Tags:
+
+
+
+
return:
current status array ( 'status' => 'finished' | 'inProgress' 'module' => <name of active module> 'progress' => 0..100 'errors' => array (<array of parameters for StatusMessage>) )
+
+
+
+
+
+
Parameters
+
+
+
string
+
$scope
+
account type
+
+
+
array
+
$data
+
array containing one account in each element
+
+
+
array
+
$ids
+
array(<column_name> => <column number>)
+
+
+
array
+
$failed
+
list of accounts which were not created successfully
+
+ Returns a hash array (module name => dependencies) of all module dependencies
"dependencies" contains an array with two sub arrays: depends, conflicts The elements of "depends" are either module names or an array of module names (OR-case). The elements of conflicts are module names.
+
+ Returns an array containing all input columns for the file upload.
Syntax: array( string: name, // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>) string: description, // short descriptive name string: help, // help ID string: example, // example value boolean: required // true, if user must set a value for this column )
+
+ Takes a list of meta-HTML elements and prints the equivalent HTML output.
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 pages.
Meta HTML code is always returned as a three dimensional array[a][b][c] where a is the row number, b is the column number and c is is a data element.
Format of data elements:
A data element is an array which contains the data to display. All data elements must contail a value "kind" which defines what kind of element should be displayed.
These are the possibilies for kind and what other options have to be added to the array:
fieldset: Inserts a fieldset.
+
legend: The legend of the fieldset.
value: A data element. Can be used recursively.
help: Adds a help link.
+
value: The help number for the help entry.
scope: The account type for the help entry.
input: Adds a HTML input element.
+
name: The name of the element, will be used later as variable name
+ when user input is returned.
checked: Boolean value, if true a checkbox will be checked. This
+ value is only needed or checkboxes.
disabled: Boolean value, if true the element will be disabled.
size: The length of the input element, only used for text, password and file.
maxlength: The maximum size of the input element, only used for
+ text, password and file.
value: The element will have this value as default. Button elements will have
+ this as caption.
select: This will add a select field.
+
name: The name of the element, will be used later as variable name when user input is
+ returned.
multiple: Boolean value, if set to true the user can select more than one entry.
options: Array of string. This is the list of option values the user can select.
options_selected: Array of string. This is the list of pre selected elements, must contain
+ values that are also in options.
descriptiveOptions:
+ Boolean value, if set to true then all elements in options must be arrays themselves (array(value,
+description)) (default: false)
size: The size of the select field, if set to 1 a dropdown box will be displayed.
noSorting: If set to true then the entries will not be sorted. Default is false.
onchange: onchange event
table: Adds a table. Can be used recursively.
+
value: A data element. Can be used recursively.
text: Inserts a text element.
+
text: The text to display.
textarea: Adds a multiline text field.
+
name: The name of the element, will be used later as variable name when user
+ input is returned.
rows: Number of rows (required)
cols: Number of characters for each line (required)
readonly: Boolean value, if true the text field will be read only.
image: Displays an image.
+
path: Path to the image
width: Width of the image
height: Height of the image
alt: Alt text of the image
Beneath those values a "td" value may be added. This has to be an array with one or more of these options:
colspan: Like the HTML colspan attribute for td elements
rowspan: Like the HTML rowspan attribute for td elements
align: left/center/right/justify Like the HTML align attribute
valign: top/middle/bottom Like the HTML valign attribute
width: Like the HTML height attribute for td elements
Input buttons which should load a different subpage of a module must have a special name attribute:
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Returns a list of modifications which have to be made to the LDAP account.
+
Tags:
+
+
+
+
return:
list of modifications This function returns an array with 3 entries: array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) "add" are attributes which have to be added to LDAP entry "remove" are attributes which have to be removed from LDAP entry "modify" are attributes which have to been modified in LDAP entry
+
+
+
+
+
+ Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/accountContainer.html b/lam-web/developers/devel/phpdoc/modules/accountContainer.html
new file mode 100644
index 00000000..c5de113d
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/accountContainer.html
@@ -0,0 +1,761 @@
+
+
+Docs For Class accountContainer
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:42 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/baseModule.html b/lam-web/developers/devel/phpdoc/modules/baseModule.html
new file mode 100644
index 00000000..8b7d9ae7
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/baseModule.html
@@ -0,0 +1,2912 @@
+
+
+Docs For Class baseModule
+
+
+
+
+
Manages the object class "shadowAccount" for users.
+
+
+
+
+
+
+
+
+
+
+
+
Class Details
+
+[line 53]
+Parent class of all account modules.
It implements the complete module interface and uses meta-data provided by the account modules for its functions.
Location and naming of modules All LAM modules are placed in lib/modules/ and are named "<class name>.inc". E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc". The class name of a module must contain only a-z, A-Z, 0-9, -, and _.
You can avoid to override many functions by using get_metaData().
All module classes should extend the baseModule class.
+
+ Checks if the self service settings are valid.
Calling this method does not require the existence of an enclosing accountContainer.
If the input data is invalid the return value is an array that contains arrays to build StatusMessages (message type, message head, message text). If no errors occured the function returns an empty array.
+
Tags:
+
+
+
+
return:
error messages
+
+
+
access:
public
+
+
+
+
+
+
+
Parameters:
+
+
+
+
array
+
$options
+
hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements.
Calling this method does not require the existence of an enclosing accountContainer.
If the input data is invalid the return value is an array that contains subarrays to build StatusMessages ('message type', 'message head', 'message text'). If no errors occured the function returns an empty array.
Calling this method does not require the existence of an enclosing accountContainer.
$options is an hash array (option name => value) that contains the user input. The option values are all arrays containing one or more elements. If the input data is invalid the return value is an array that contains arrays to build StatusMessages (message type, message head, message text). If no errors occured the function returns an empty array.
+
Tags:
+
+
+
+
return:
list of error messages (array(type, title, text)) to generate StatusMessages, if any
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
Calling this method does not require the existence of an enclosing accountContainer.
This function is called as long as the returned status is 'finished'. Please make sure that one function call lasts no longer than 3-4 seconds. Otherwise the upload may fail because the time limit is exceeded. You should not make more than one LDAP operation in each call.
+
Tags:
+
+
+
+
return:
current status array ( 'status' => 'finished' | 'inProgress' // defines if all operations are complete 'progress' => 0..100 // the progress of the operations in percent 'errors' => array // list of arrays which are used to generate StatusMessages )
+
+ Returns a list of self service configuration settings.
Calling this method does not require the existence of an enclosing accountContainer.
The type "fieldset" is not allowed here. The name attributes are used as keywords to load and save settings. We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.
Calling this method does not require the existence of an enclosing accountContainer.
This function returns a more descriptive string than the class name. Alias names are used for the buttons on the account pages and the module selection in the configuration wizard. Please take care that your alias name is not too long. It may contain any character but should not include parts that may be interpreted by the browser (e.g. '<' or '>'). If you use different aliases dependent on the account type please make sure that there is a general alias for unknown types.
Calling this method does not require the existence of an enclosing accountContainer.
The type "fieldset" is not allowed here. The name attributes are used as keywords to load and save settings. We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.
+
+ This function returns a list with all depending and conflicting modules.
Calling this method does not require the existence of an enclosing accountContainer.
The return value is an array with two sub arrays, "depends" and "conflicts". All values of the conflict array are string values with module names. All values of the depends array are either string values with module names or arrays which include only string values with module names. If an element of the depends array is itself an array, this means that your module depends on one of these modules.
+
+ This function returns the help entry array for a specific help id.
Calling this method does not require the existence of an enclosing accountContainer.
The result is an hashtable with the following keys:
Headline (required)
+ The headline of this help entry. Can consist of any alpha-numeric characters. No HTML/CSS elements are allowed.
Text (required)
+ The text of the help entry which may contain any alpha-numeric characters.
SeeAlso (optional)
+ A reference to anonther related web site. It must be an array containing a field called "text" with the link text
+ that should be displayed and a field called "link" which is the link target.
Example:
array('Headline' => 'This is the head line', 'Text' => 'Help content', 'SeeAlso' => array('text' => 'LAM homepage', 'link' => 'http://lam.sf.net'))
Calling this method does not require the existence of an enclosing accountContainer.
Returns an array('or' => '...', 'and' => '...') that is used to build the LDAP filter. Usually, this is used to filter object classes. All "or" filter parts of the base modules are combined with OR and then combined with the "and" parts. The resulting LDAP filter will look like this: (&(|(OR1)(OR2)(OR3))(AND1)(AND2)(AND3))
get_profileOptions()
+
+ Key: profile_options
+ Value: array of profile options
+
+ The syntax for the value array is the same as for the return value of get_profileOptions().
+
check_profileOptions()
+
+ Key: profile_checks
+ Value: array of checks (array("optionName" => array()))
+
+ The "optionName" keys of the value array are the names of the option identifiers.
+ Each array element is an array itself containing these values:
+
type: determines how to check input
+ Possible values:
+
regex: check with regular expression from regex variable, case sensitive
regex_i: check with regular expression from regex variable, case insensitive
int_greater: integer value of cmp_name1 must be greater than the integer value from the option cmp_name2
int_greaterOrEqual: integer value of cmp_name1 must be greater or equal than the integer value from the option cmp_name2
error_message: message that is displayed if input value was syntactically incorrect
+ error_message is an array to build StatusMessages (message type, message head, message text, additional variables)
regex: regular expression string (only if type is regex/regex_i)
cmp_name1: name of first input variable that is used for comparison (only if type is int_greater/int_greaterOrEqual)
cmp_name2: name of second input variable that is used for comparison (only if type is int_greater/int_greaterOrEqual)
required: true or false, if this input field must be filled set to true (optional)
required_message: message that is displayed if no input value was given (only if required == true)
+ required_message is an array to build StatusMessages (message type, message head, message text, additional variables)
get_configOptions()
+
+ Key: config_options
+ Value: array('user' => array, 'host' => array, 'all' => array)
+
+ The values from 'all' are always returned, the other values only if they are inside the $scopes array.
+ The syntax for sub arrays is the same as for the return value of get_configOptions().
+
check_configOptions()
+
+ Key: config_checks
+ Value: array('user' => array, 'host' => 'array', 'all' => array)
+
+ The values from 'all' are always used for checking, the other values only if they are inside the $scopes array.
+ The syntax for sub arrays is the same as for check_configOptions().
+
get_help()
+
+ Key: help
+ Value: hashtable of help entries
+
+ The hashtable is an array which maps help IDs to help entries.
+
+ Example: 'help' => array('myEntry' => array('Headline' => 'This is the head line', 'Text' => 'Help content'))
+
+
+ Returns a hashtable with all entries that may be printed out in the PDF.
Calling this method does not require the existence of an enclosing accountContainer.
This method must be overwritten in case that there are non static values to be returned. The $this->meta['PDF_fields'] array may be used for static content.
Format of returned hashtable:
This function uses XML formatted commands to define the PDF output. Each part in the PDF document is surrounded by "<block>" and "</block>". Inside the <block> tags there are different ways to format the output:
simple line with attribute name and value: <block><key>attribute name</key><value>attribute value</value></block>
Sometimes you have multivalued attributes where it is not applicable to write all values in one line but where you want to list your values one below the other or show a table. This can be done by using the <td> tag.
This example only uses one column but you can just use more <td> tags per <block> tag to display more columns.
+
+ This function defines what attributes will be used in the account profiles and their appearance in the profile editor.
Calling this method does not require the existence of an enclosing accountContainer.
The return value is an array that contains meta HTML code. The type "fieldset" is not allowed here. The name attributes are used as keywords to load and save profiles. We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.
+
+ Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).
Calling this method does not require the existence of an enclosing accountContainer.
The returned elements have this form: <attribute> => <priority> <attribute> is the name of the LDAP attribute <priority> defines the priority of the attribute (can be "low", "normal", "high")
+
+ Returns an array containing all input columns for the file upload.
Calling this method does not require the existence of an enclosing accountContainer.
This funtion returns an array which contains subarrays which represent an upload column. Syntax of column arrays:
array( string: name, // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>) string: description, // short descriptive name string: help, // help ID string: example, // example value string: values, // possible input values (optional) string: default, // default value (optional) boolean: required // true, if user must set a value for this column boolean: unique // true if all values of this column must be different values (optional, default: "false") )
+
+ Returns true if your module is a base module and otherwise false.
Calling this method does not require the existence of an enclosing accountContainer.
Every account type needs exactly one base module. A base module manages a structural object class. E.g. the inetOrgPerson module is a base module since its object class is structural.
+
Tags:
+
+
+
+
return:
true if base module (defaults to false if no meta data is provided)
+
+ This functions is used to check if all settings for this module have been made.
Calling this method requires the existence of an enclosing accountContainer.
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. This method's return value defaults to true.
+
+ This function is used to check if this module page can be displayed.
Calling this method requires the existence of an enclosing accountContainer.
Your module might depend on input of other modules. This function determines if the user can change to your module page or not. The return value is true if your module accepts input, otherwise false. This method's return value defaults to true.
+
+ Returns a list of modifications which have to be made to the LDAP account.
Calling this method requires the existence of an enclosing accountContainer.
This function returns an array with 3 entries: array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) DN is the DN to change. It is possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
"add" are attributes which have to be added to the LDAP entry "remove" are attributes which have to be removed from the LDAP entry "modify" are attributes which have to be modified in the LDAP entry "notchanged" are attributes which stay unchanged
This builds the required comands from $this-attributes and $this->orig.
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:18 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/ieee802Device.html b/lam-web/developers/devel/phpdoc/modules/ieee802Device.html
new file mode 100644
index 00000000..8597307c
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/ieee802Device.html
@@ -0,0 +1,735 @@
+
+
+Docs For Class ieee802Device
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:32 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/inetLocalMailRecipient.html b/lam-web/developers/devel/phpdoc/modules/inetLocalMailRecipient.html
new file mode 100644
index 00000000..99bba353
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/inetLocalMailRecipient.html
@@ -0,0 +1,735 @@
+
+
+Docs For Class inetLocalMailRecipient
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:33 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/inetOrgPerson.html b/lam-web/developers/devel/phpdoc/modules/inetOrgPerson.html
new file mode 100644
index 00000000..ab6a4bb4
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/inetOrgPerson.html
@@ -0,0 +1,985 @@
+
+
+Docs For Class inetOrgPerson
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Returns a list of modifications which have to be made to the LDAP account.
+
Tags:
+
+
+
+
return:
list of modifications This function returns an array with 3 entries: array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) "add" are attributes which have to be added to LDAP entry "remove" are attributes which have to be removed from LDAP entry "modify" are attributes which have to been modified in LDAP entry
+
+
+
+
+
+ Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:34 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/kolabUser.html b/lam-web/developers/devel/phpdoc/modules/kolabUser.html
new file mode 100644
index 00000000..b2930b04
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/kolabUser.html
@@ -0,0 +1,849 @@
+
+
+Docs For Class kolabUser
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Returns a list of modifications which have to be made to the LDAP account.
+
Tags:
+
+
+
+
return:
list of modifications This function returns an array with 3 entries: array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) "add" are attributes which have to be added to LDAP entry "remove" are attributes which have to be removed from LDAP entry "modify" are attributes which have to been modified in LDAP entry
+
+
+
+
+
+ Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:35 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/ldapPublicKey.html b/lam-web/developers/devel/phpdoc/modules/ldapPublicKey.html
new file mode 100644
index 00000000..80dba872
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/ldapPublicKey.html
@@ -0,0 +1,709 @@
+
+
+Docs For Class ldapPublicKey
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:37 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/nisMailAlias.html b/lam-web/developers/devel/phpdoc/modules/nisMailAlias.html
new file mode 100644
index 00000000..20b0ffc0
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/nisMailAlias.html
@@ -0,0 +1,787 @@
+
+
+Docs For Class nisMailAlias
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Returns a list of modifications which have to be made to the LDAP account.
+
Tags:
+
+
+
+
return:
list of modifications This function returns an array with 3 entries: array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) "add" are attributes which have to be added to LDAP entry "remove" are attributes which have to be removed from LDAP entry "modify" are attributes which have to been modified in LDAP entry
+
+
+
+
+
+ Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:42 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/posixAccount.html b/lam-web/developers/devel/phpdoc/modules/posixAccount.html
new file mode 100644
index 00000000..fc4980a8
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/posixAccount.html
@@ -0,0 +1,1412 @@
+
+
+Docs For Class posixAccount
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ This function executes one post upload action.
+
Tags:
+
+
+
+
return:
current status array ( 'status' => 'finished' | 'inProgress' 'progress' => 0..100 'errors' => array (<array of parameters for StatusMessage>) )
+
+
+
+
+
+ Overrides baseModule::doUploadPostActions() (This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).)
+
Parameters:
+
+
+
+
array
+
$data
+
array containing one account in each element
+
+
+
array
+
$ids
+
array(<column_name> => <column number>)
+
+
+
array
+
$failed
+
list of accounts which were not created successfully
+
+
+
array
+
$temp
+
variable to store temporary data between two post actions
+
+ Returns a list of elements for the account profiles.
+
Tags:
+
+
+
+
return:
elements
+
+
+
+
+
+ Overrides baseModule::get_profileOptions() (This function defines what attributes will be used in the account profiles and their appearance in the profile editor.)
+
+ Returns a list of modifications which have to be made to the LDAP account.
+
Tags:
+
+
+
+
return:
list of modifications This function returns an array with 3 entries: array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) "add" are attributes which have to be added to LDAP entry "remove" are attributes which have to be removed from LDAP entry "modify" are attributes which have to been modified in LDAP entry
+
+
+
+
+
+ Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:44 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/posixGroup.html b/lam-web/developers/devel/phpdoc/modules/posixGroup.html
new file mode 100644
index 00000000..0851f356
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/posixGroup.html
@@ -0,0 +1,1063 @@
+
+
+Docs For Class posixGroup
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Returns a list of modifications which have to be made to the LDAP account.
+
Tags:
+
+
+
+
return:
list of modifications This function returns an array with 3 entries: array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) "add" are attributes which have to be added to LDAP entry "remove" are attributes which have to be removed from LDAP entry "modify" are attributes which have to been modified in LDAP entry
+
+
+
+
+
+ Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:45 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/quota.html b/lam-web/developers/devel/phpdoc/modules/quota.html
new file mode 100644
index 00000000..51e8d1ea
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/quota.html
@@ -0,0 +1,992 @@
+
+
+Docs For Class quota
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ This function executes one post upload action.
+
Tags:
+
+
+
+
return:
current status array ( 'status' => 'finished' | 'inProgress' 'progress' => 0..100 'errors' => array (<array of parameters for StatusMessage>) )
+
+
+
+
+
+ Overrides baseModule::doUploadPostActions() (This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).)
+
Parameters:
+
+
+
+
array
+
$data
+
array containing one account in each element
+
+
+
array
+
$ids
+
array(<column_name> => <column number>)
+
+
+
array
+
$failed
+
list of accounts which were not created successfully
+
+
+
array
+
$temp
+
variable to store temporary data between two post actions
+
+ Returns a list of elements for the account profiles.
+
Tags:
+
+
+
+
return:
elements
+
+
+
+
+
+ Overrides baseModule::get_profileOptions() (This function defines what attributes will be used in the account profiles and their appearance in the profile editor.)
+
+ Returns an array containing all input columns for the file upload.
Syntax: array( string: name, // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>) string: description, // short descriptive name string: help, // help ID string: example, // example value boolean: required // true, if user must set a value for this column )
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:47 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/samba3domain.html b/lam-web/developers/devel/phpdoc/modules/samba3domain.html
new file mode 100644
index 00000000..ad20a5fd
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/samba3domain.html
@@ -0,0 +1,363 @@
+
+
+Docs For Class samba3domain
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:16 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/sambaAccount.html b/lam-web/developers/devel/phpdoc/modules/sambaAccount.html
new file mode 100644
index 00000000..8e6b4fff
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/sambaAccount.html
@@ -0,0 +1,992 @@
+
+
+Docs For Class sambaAccount
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Returns a list of modifications which have to be made to the LDAP account.
+
Tags:
+
+
+
+
return:
list of modifications This function returns an array with 3 entries: array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) "add" are attributes which have to be added to LDAP entry "remove" are attributes which have to be removed from LDAP entry "modify" are attributes which have to been modified in LDAP entry
+
+
+
+
+
+ Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:48 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/sambaDomain.html b/lam-web/developers/devel/phpdoc/modules/sambaDomain.html
new file mode 100644
index 00000000..a6dbbf7b
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/sambaDomain.html
@@ -0,0 +1,735 @@
+
+
+Docs For Class sambaDomain
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:49 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/sambaGroupMapping.html b/lam-web/developers/devel/phpdoc/modules/sambaGroupMapping.html
new file mode 100644
index 00000000..7c643bd3
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/sambaGroupMapping.html
@@ -0,0 +1,897 @@
+
+
+Docs For Class sambaGroupMapping
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Returns a list of elements for the account profiles.
+
Tags:
+
+
+
+
return:
elements
+
+
+
+
+
+ Overrides baseModule::get_profileOptions() (This function defines what attributes will be used in the account profiles and their appearance in the profile editor.)
+
+ Returns a list of modifications which have to be made to the LDAP account.
+
Tags:
+
+
+
+
return:
list of modifications This function returns an array with 3 entries: array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) "add" are attributes which have to be added to LDAP entry "remove" are attributes which have to be removed from LDAP entry "modify" are attributes which have to been modified in LDAP entry
+
+
+
+
+
+ Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:50 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/sambaMungedDial.html b/lam-web/developers/devel/phpdoc/modules/sambaMungedDial.html
new file mode 100644
index 00000000..9775745f
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/sambaMungedDial.html
@@ -0,0 +1,1138 @@
+
+
+Docs For Class sambaMungedDial
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:51 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/sambaSamAccount.html b/lam-web/developers/devel/phpdoc/modules/sambaSamAccount.html
new file mode 100644
index 00000000..cceffbdf
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/sambaSamAccount.html
@@ -0,0 +1,1182 @@
+
+
+Docs For Class sambaSamAccount
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Returns a list of elements for the account profiles.
+
Tags:
+
+
+
+
return:
elements
+
+
+
+
+
+ Overrides baseModule::get_profileOptions() (This function defines what attributes will be used in the account profiles and their appearance in the profile editor.)
+
+ Returns a list of modifications which have to be made to the LDAP account.
+
Tags:
+
+
+
+
return:
list of modifications This function returns an array with 3 entries: array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) "add" are attributes which have to be added to LDAP entry "remove" are attributes which have to be removed from LDAP entry "modify" are attributes which have to been modified in LDAP entry
+
+
+
+
+
+ Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:51 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/shadowAccount.html b/lam-web/developers/devel/phpdoc/modules/shadowAccount.html
new file mode 100644
index 00000000..03284710
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/shadowAccount.html
@@ -0,0 +1,841 @@
+
+
+Docs For Class shadowAccount
+
+
+
+
+
+ This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
+
+
+ Returns a list of modifications which have to be made to the LDAP account.
+
Tags:
+
+
+
+
return:
list of modifications This function returns an array with 3 entries: array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) "add" are attributes which have to be added to LDAP entry "remove" are attributes which have to be removed from LDAP entry "modify" are attributes which have to been modified in LDAP entry
+
+
+
+
+
+ Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:56 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/modules/smbHash.html b/lam-web/developers/devel/phpdoc/modules/smbHash.html
new file mode 100644
index 00000000..23eaf421
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/modules/smbHash.html
@@ -0,0 +1,309 @@
+
+
+Docs For Class smbHash
+
+
+
+
+
+
+Installation Instructions for LAM
+---------------------------------
+
+
+1. Requirements
+
+ - Apache webserver (SSL optional) with PHP module (PHP 5 (>= 5.1) with
+ ldap, gettext, xml and optional mcrypt)
+ - some LAM plugins may require additional PHP extensions (you will get a
+ note on the login page if something is missing)
+ - Perl (optional, needed only for lamdaemon)
+ - OpenLDAP (>2.0)
+ - A web browser :-)
+
+ MHash is only needed for Samba password hashes.
+ MCrypt will be used to store your LDAP password encrypted in the session file.
+
+
+ See docs/README.schema.txt for information about used LDAP schema files.
+
+
+2. Installation
+
+ 1. Extract package with:
+ tar xzf ldap-account-manager-<version>.tar.gz
+
+
+ 2. Install the files
+
+ 2a. Copy the files into the html-file scope of the webserver. For example
+ /apache/htdocs.
+
+ Set appropriate file permissions:
+ - lam/sess: write permission for apache user
+ - lam/tmp: write permission for apache user
+ - lam/config (with subdirectories): write permission for apache user
+ - lam/lib: lamdaemon.pl must be set executable (See also
+ docs/readme.lamdeamon.txt)
+
+ 2b. You can also use the included configure script to install LAM. See
+ "./configure --help" for a list of install options.
+
+
+ 3. Configure config.cfg and create a configuration profile.
+ Copy config.cfg_sample to config.cfg and set the master password and default
+ profile.
+
+ Open the index.html in your web browser:
+ - Follow the link "Configuration Login" from the start page.
+ (The default password to edit the options is "lam")
+ - Select the default lam profile or create a new profile.
+ - Change the settings to fit your environment.
+
+
+
+3. Setting up PHP
+
+ LAM runs with PHP5 (>= 5.1).
+
+ Needed changes in your php.ini:
+
+ * memory_limit = 64M
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/ric_README.html b/lam-web/developers/devel/phpdoc/ric_README.html
new file mode 100644
index 00000000..620363c1
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/ric_README.html
@@ -0,0 +1,142 @@
+
+
+README
+
+
+
+
+
+
+LAM - Readme
+============
+
+ LDAP Account Manager (LAM) manages user, group and host accounts in an LDAP
+ directory. LAM runs on any webserver with PHP5 support and connects to your
+ LDAP server unencrypted or via SSL/TLS.
+ Currently LAM supports these account types: Samba 2 and 3, Unix, Kolab 2,
+ address book entries, NIS mail aliases and MAC addresses. There is a tree
+ viewer included to allow access to the raw LDAP attributes. You can use
+ templates for account creation and use multiple configuration profiles.
+ LAM is translated to Catalan, Chinese (Traditional + Simplified), Czech,
+ Dutch, English, French, German, Hungarian, Italian, Japanese, Portuguese,
+ Russian and Spanish.
+
+ http://sourceforge.net/projects/lam/
+
+ Copyright (C) 2003 - 2007 Michael Duergner <michael@duergner.com>
+ Roland Gruber <post@rolandgruber.de>
+ Tilo Lutz <tilolutz@gmx.de>
+
+ Requirements:
+ PHP5 (>= 5.1)
+ Openldap (2.0 or greater)
+ A web-browser that supports CSS
+
+ Summary:
+ With LAM you can easily manage user, group and machine accounts stored in
+ an LDAP directory over a web interface. At the moment it supports:
+
+ - managing user/group/host/domain entries
+ - filtering and sorting
+ - account profiles
+ - multiple configuration profiles
+ - tree viwer
+ - schema browser
+ - OU Editor
+ - account creation via file upload
+ - PDF export for all accounts
+ - manage user/group Quota and create home directories
+
+ Important:
+ The default password to edit the configuration options is "lam".
+
+ Installation:
+ Please see the INSTALL file.
+
+ Documentation:
+ Basic documentation is available in the directory "docs".
+
+ Upgrade from older versions:
+ See docs/README.upgrade.txt for upgrade instructions.
+
+ Internationalisation:
+ If you want to use a translated version of LAM be sure to install the
+ needed locales. See the LAM "locale" directory for a list of supported locales and languages.
+ You can get a list of all installed locales on your sysem by executing: locale -a
+ Debian users can add locales with "dpkg-reconfigure locales".
+
+ Security:
+ It is strongly recommended to use a SSL connection to your web server.
+
+ LAM needs to store your LDAP user name + password in the session. The session
+ files are saved in sess/ and are accessible only by the web server. To increase
+ security username and password are encrypted with MCrypt/AES if available.
+ The key and IV are generated at random when you log in. They are stored in two
+ cookies.
+
+ Download:
+ You can get the newest version at http://lam.sourceforge.net/.
+
+ License:
+ LAM is published under the GNU General Public License.
+ The complete list of licenses can be found in the copyright file.
+
+
+ Have fun!
+ The LAM devel team
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/selfService/_lib---selfService.inc.html b/lam-web/developers/devel/phpdoc/selfService/_lib---selfService.inc.html
new file mode 100644
index 00000000..7fb91194
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/selfService/_lib---selfService.inc.html
@@ -0,0 +1,450 @@
+
+
+Docs for page selfService.inc
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:57 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/tools/LdapExportInfo.html b/lam-web/developers/devel/phpdoc/tools/LdapExportInfo.html
new file mode 100644
index 00000000..59e436b2
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/tools/LdapExportInfo.html
@@ -0,0 +1,255 @@
+
+
+Docs For Class LdapExportInfo
+
+
+
+
+
+[line 84]
+This class encapsulate informations about the ldap server from which the export is done.
The following info are provided within this class:
$base_dn: if the source of the export is the ldap server, it indicates the base dn of the search. $query_filter: if the source of the export is the ldap server, it indicates the query filter for the search. $scope: if the source of the export is the ldap server, it indicates the scope of the search.
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:26 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/tools/MyCustomExporter.html b/lam-web/developers/devel/phpdoc/tools/MyCustomExporter.html
new file mode 100644
index 00000000..00acde04
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/tools/MyCustomExporter.html
@@ -0,0 +1,321 @@
+
+
+Docs For Class MyCustomExporter
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:26 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/tools/PlaAbstractExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaAbstractExporter.html
new file mode 100644
index 00000000..731cbf98
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/tools/PlaAbstractExporter.html
@@ -0,0 +1,362 @@
+
+
+Docs For Class PlaAbstractExporter
+
+
+
+
+
+[line 119]
+This class represents the base class of all exporters
It can be subclassed directly if your intend is to write a source exporter(ie. it will act only as a decoree which will be wrapped by an another exporter.) If you consider writting an exporter for filtering data or directly display entries, please consider subclass the PlaExporter
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:27 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/tools/PlaCSVExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaCSVExporter.html
new file mode 100644
index 00000000..866d0fb6
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/tools/PlaCSVExporter.html
@@ -0,0 +1,436 @@
+
+
+Docs For Class PlaCSVExporter
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:27 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/tools/PlaDsmlExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaDsmlExporter.html
new file mode 100644
index 00000000..886eab5b
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/tools/PlaDsmlExporter.html
@@ -0,0 +1,375 @@
+
+
+Docs For Class PlaDsmlExporter
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:27 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/tools/PlaExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaExporter.html
new file mode 100644
index 00000000..d01ef54b
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/tools/PlaExporter.html
@@ -0,0 +1,526 @@
+
+
+Docs For Class PlaExporter
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:28 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/tools/PlaLdapExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaLdapExporter.html
new file mode 100644
index 00000000..5bf0324e
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/tools/PlaLdapExporter.html
@@ -0,0 +1,539 @@
+
+
+Docs For Class PlaLdapExporter
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:28 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/tools/PlaLdifExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaLdifExporter.html
new file mode 100644
index 00000000..d2f31711
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/tools/PlaLdifExporter.html
@@ -0,0 +1,431 @@
+
+
+Docs For Class PlaLdifExporter
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:28 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/tools/PlaVcardExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaVcardExporter.html
new file mode 100644
index 00000000..2855d345
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/tools/PlaVcardExporter.html
@@ -0,0 +1,380 @@
+
+
+Docs For Class PlaVcardExporter
+
+
+
+
+
+Functions and classes for exporting LDAP entries to others formats (LDIF,DSML,..) An example is provided at the bottom of this file if you want implement yours.
+
Tags:
+
+
+
+
author:
The phpLDAPadmin development team
+
+
+
author:
Roland Gruber
+
+
+
+
+
Includes:
+
+include_once('status.inc') [line 40]
+used to print status messages
+
+
+
+
+
+
get_user_agent_string [line 847]
+
+
+
+ String get_user_agent_string(
+)
+
+
+
+ Gets the USER_AGENT string from the $_SERVER array, all in lower case in an E_NOTICE safe manner.
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:20 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/types/group.html b/lam-web/developers/devel/phpdoc/types/group.html
new file mode 100644
index 00000000..04ebd3e4
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/types/group.html
@@ -0,0 +1,317 @@
+
+
+Docs For Class group
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:30 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/types/host.html b/lam-web/developers/devel/phpdoc/types/host.html
new file mode 100644
index 00000000..db3ac1f5
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/types/host.html
@@ -0,0 +1,317 @@
+
+
+Docs For Class host
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:32 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/types/mailAlias.html b/lam-web/developers/devel/phpdoc/types/mailAlias.html
new file mode 100644
index 00000000..46d44df0
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/types/mailAlias.html
@@ -0,0 +1,317 @@
+
+
+Docs For Class mailAlias
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:40 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/types/smbDomain.html b/lam-web/developers/devel/phpdoc/types/smbDomain.html
new file mode 100644
index 00000000..6316823c
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/types/smbDomain.html
@@ -0,0 +1,317 @@
+
+
+Docs For Class smbDomain
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:26:57 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/phpdoc/types/user.html b/lam-web/developers/devel/phpdoc/types/user.html
new file mode 100644
index 00000000..204cda92
--- /dev/null
+++ b/lam-web/developers/devel/phpdoc/types/user.html
@@ -0,0 +1,317 @@
+
+
+Docs For Class user
+
+
+
+
+
+
+ Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/devel/profile_editor.htm b/lam-web/developers/devel/profile_editor.htm
index afbad39f..19cc6038 100644
--- a/lam-web/developers/devel/profile_editor.htm
+++ b/lam-web/developers/devel/profile_editor.htm
@@ -1,17 +1,14 @@
-
-
-
- Profile editor
+
+
+
+ Profile editor
+
-
-
-
+
Profile editor
-
+
The profile
@@ -24,9 +21,7 @@ This is the start page of the profile
editor. The user can select to add/modify/remove selected
account profiles.
-The list of existing account profiles is returned by getAccountProfiles() in modules.inc. It includes all
+The list of existing account profiles is returned by getAccountProfiles() in modules.inc. It includes all
profile names without file extensions.
Profilepage.php
@@ -36,17 +31,15 @@ This script is used to display the account profile to the user.
The profile options include the LDAP OU suffix and options provided by
the account modules.
-The values for the OU selection are read with search_units().
+The values for the OU selection are read with search_units().
The account modules provide
all other profile options. The profile editor displays a separate
fieldset for each module containing its options.
The function print_option()
manages the display of the different option types (checkbox, select,
-...). The type of each option is saved in $_SESSION['profile_types'].
-See the modules specification
+...). The type of each option is saved in $_SESSION['profile_types'].
+See the modules specification
for a complete list of supported types.
The profiles have unique names under which they are saved. If a profile
@@ -56,10 +49,8 @@ When the user selects to save the profile then
profilepage.php will check the input for correctness.
First the values are converted to the correct type (checkbox ->
Boolean) by checking $_SESSION['profile_types'].
-Then LAM will replace all "\'" with "'" if magic_quotes_gpc is on. Now the
-input data is checked for correctness by calling checkProfileOptions().
+Then LAM will replace all "\'" with "'" if magic_quotes_gpc is on. Now the
+input data is checked for correctness by calling checkProfileOptions().
The account modules return a
list of
error messages if one or more options are incorrect. If there are
@@ -67,19 +58,15 @@ errors they will be displayed, otherwise the profile is
saved by calling saveAccountProfile().
Profiledelete.php
-When the user selected to delete a profile in profilemain.php he is redirected to
+When the user selected to delete a profile in profilemain.php he is redirected to
this page.
LAM will ask once again if the user is sure to delete the profile. If
-this is the case the profile will be deleted with delAccountProfile() from profiles.inc.
+this is the case the profile will be deleted with delAccountProfile() from profiles.inc.