From 50dc1c46dcc24b40abd1b4dd7df82b6cca793e30 Mon Sep 17 00:00:00 2001 From: Roland Gruber Date: Sun, 4 Nov 2007 11:19:11 +0000 Subject: [PATCH] *** empty log message *** --- .../phpdoc/Help/_help---help.inc.html | 93 ++ .../phpdoc/Help/_templates---help.php.html | 159 ++ lam-web/developers/phpdoc/LDAP/Ldap.html | 205 +-- .../phpdoc/LDAP/_lib---ldap.inc.html | 138 ++ lam-web/developers/phpdoc/PDF/FPDF.html | 1129 ++++++++++--- lam-web/developers/phpdoc/PDF/UFPDF.html | 726 +++++---- .../phpdoc/PDF/_lib---font---vera.php.html | 121 ++ .../phpdoc/PDF/_lib---font---verab.php.html | 121 ++ .../phpdoc/PDF/_lib---font---verabi.php.html | 121 ++ .../phpdoc/PDF/_lib---font---verai.php.html | 121 ++ .../phpdoc/PDF/_lib---fpdf.php.html | 139 ++ .../developers/phpdoc/PDF/_lib---pdf.inc.html | 322 ++++ .../phpdoc/PDF/_lib---pdfstruct.inc.html | 293 ++++ .../phpdoc/PDF/_lib---ufpdf.php.html | 146 ++ .../phpdoc/PDF/_lib---xml_parser.inc.html | 126 ++ .../_templates---pdfedit---pdfdelete.php.html | 126 ++ .../_templates---pdfedit---pdfmain.php.html | 129 ++ .../_templates---pdfedit---pdfpage.php.html | 133 ++ lam-web/developers/phpdoc/PDF/lamPDF.html | 332 ++-- lam-web/developers/phpdoc/PDF/xmlParser.html | 68 +- .../developers/phpdoc/classtrees_Help.html | 10 +- .../developers/phpdoc/classtrees_LDAP.html | 10 +- lam-web/developers/phpdoc/classtrees_PDF.html | 10 +- .../phpdoc/classtrees_configuration.html | 10 +- lam-web/developers/phpdoc/classtrees_lib.html | 10 +- .../developers/phpdoc/classtrees_lists.html | 10 +- .../developers/phpdoc/classtrees_main.html | 10 +- .../developers/phpdoc/classtrees_modules.html | 15 +- .../phpdoc/classtrees_profiles.html | 10 +- .../phpdoc/classtrees_selfService.html | 10 +- .../developers/phpdoc/classtrees_tests.html | 10 +- .../developers/phpdoc/classtrees_tools.html | 10 +- .../developers/phpdoc/classtrees_types.html | 10 +- .../phpdoc/configuration/LAMCfgMain.html | 174 +- .../phpdoc/configuration/LAMConfig.html | 503 +++--- .../configuration/_lib---config.inc.html | 257 +++ .../_templates---config---conflogin.php.html | 118 ++ .../_templates---config---confmain.php.html | 138 ++ ..._templates---config---confmodules.php.html | 156 ++ .../_templates---config---conftypes.php.html | 119 ++ .../_templates---config---index.php.html | 117 ++ .../_templates---config---mainlogin.php.html | 118 ++ .../_templates---config---mainmanage.php.html | 119 ++ .../_templates---config---profmanage.php.html | 118 ++ lam-web/developers/phpdoc/elementindex.html | 1433 +++++++++-------- .../developers/phpdoc/elementindex_Help.html | 48 +- .../developers/phpdoc/elementindex_LDAP.html | 91 +- .../developers/phpdoc/elementindex_PDF.html | 110 +- .../phpdoc/elementindex_configuration.html | 111 +- .../developers/phpdoc/elementindex_lib.html | 130 +- .../developers/phpdoc/elementindex_lists.html | 304 ++-- .../developers/phpdoc/elementindex_main.html | 57 +- .../phpdoc/elementindex_modules.html | 673 ++++---- .../phpdoc/elementindex_profiles.html | 58 +- .../phpdoc/elementindex_selfService.html | 94 +- .../developers/phpdoc/elementindex_tests.html | 46 +- .../developers/phpdoc/elementindex_tools.html | 78 +- .../developers/phpdoc/elementindex_types.html | 75 +- lam-web/developers/phpdoc/errors.html | 123 +- lam-web/developers/phpdoc/index.html | 12 +- lam-web/developers/phpdoc/li_Help.html | 18 +- lam-web/developers/phpdoc/li_LDAP.html | 17 +- lam-web/developers/phpdoc/li_PDF.html | 39 +- .../developers/phpdoc/li_configuration.html | 33 +- lam-web/developers/phpdoc/li_lib.html | 25 +- lam-web/developers/phpdoc/li_lists.html | 79 +- lam-web/developers/phpdoc/li_main.html | 26 +- lam-web/developers/phpdoc/li_modules.html | 58 +- lam-web/developers/phpdoc/li_profiles.html | 22 +- lam-web/developers/phpdoc/li_selfService.html | 27 +- lam-web/developers/phpdoc/li_tests.html | 20 +- lam-web/developers/phpdoc/li_tools.html | 33 +- lam-web/developers/phpdoc/li_types.html | 29 +- .../developers/phpdoc/lib/AttributeType.html | 108 +- .../developers/phpdoc/lib/MatchingRule.html | 76 +- .../phpdoc/lib/MatchingRuleUse.html | 58 +- .../developers/phpdoc/lib/ObjectClass.html | 78 +- .../phpdoc/lib/ObjectClassAttribute.html | 30 +- lam-web/developers/phpdoc/lib/SchemaItem.html | 60 +- lam-web/developers/phpdoc/lib/Syntax.html | 54 +- .../phpdoc/lib/_lib---account.inc.html | 605 +++++++ .../phpdoc/lib/_lib---cache.inc.html | 123 ++ .../phpdoc/lib/_lib---schema.inc.html | 595 +++++++ .../phpdoc/lib/_lib---security.inc.html | 189 +++ .../phpdoc/lib/_lib---status.inc.html | 149 ++ lam-web/developers/phpdoc/lib/cache.html | 124 +- .../phpdoc/lists/_lib---lists.inc.html | 176 ++ .../_templates---lists---deletelink.php.html | 171 ++ .../lists/_templates---lists---list.php.html | 171 ++ .../_templates---lists---userlink.php.html | 203 +++ .../developers/phpdoc/lists/lamGroupList.html | 299 ++-- .../developers/phpdoc/lists/lamHostList.html | 157 +- lam-web/developers/phpdoc/lists/lamList.html | 338 ++-- .../phpdoc/lists/lamMailAliasList.html | 157 +- .../phpdoc/lists/lamSmbDomainList.html | 157 +- .../developers/phpdoc/lists/lamUserList.html | 323 ++-- .../phpdoc/lists/tree/_lib---tree.inc.html | 1194 ++++++++++++++ .../_templates---tree---add_attr.php.html | 200 +++ ..._templates---tree---add_attr_form.php.html | 199 +++ .../_templates---tree---add_oclass.php.html | 176 ++ ...emplates---tree---add_oclass_form.php.html | 176 ++ .../_templates---tree---add_value.php.html | 176 ++ ...templates---tree---add_value_form.php.html | 176 ++ .../_templates---tree---collapse.php.html | 175 ++ .../tree/_templates---tree---create.php.html | 177 ++ .../_templates---tree---create_form.php.html | 177 ++ ...plates---tree---creation_template.php.html | 178 ++ .../tree/_templates---tree---delete.php.html | 176 ++ .../_templates---tree---delete_attr.php.html | 176 ++ .../_templates---tree---delete_form.php.html | 176 ++ ...tes---tree---download_binary_attr.php.html | 176 ++ .../tree/_templates---tree---edit.php.html | 177 ++ .../tree/_templates---tree---expand.php.html | 175 ++ .../tree/_templates---tree---export.php.html | 177 ++ .../_templates---tree---export_form.php.html | 200 +++ .../tree/_templates---tree---rdelete.php.html | 199 +++ .../tree/_templates---tree---refresh.php.html | 175 ++ ...e---templates---creation---custom.php.html | 247 +++ ...ates---creation---new_ou_template.php.html | 168 ++ ...es---tree---templates---templates.inc.html | 168 ++ .../tree/_templates---tree---tree.php.html | 236 +++ .../_templates---tree---tree_view.php.html | 172 ++ .../tree/_templates---tree---update.php.html | 176 ++ ...templates---tree---update_confirm.php.html | 176 ++ .../phpdoc/main/_templates---delete.php.html | 178 ++ .../main/_templates---initsuff.php.html | 108 ++ .../phpdoc/main/_templates---login.php.html | 132 ++ .../phpdoc/main/_templates---logout.php.html | 107 ++ .../phpdoc/main/_templates---main.php.html | 106 ++ .../main/_templates---main_header.php.html | 107 ++ lam-web/developers/phpdoc/media/style.css | 2 +- .../phpdoc/modules/_lib---baseModule.inc.html | 160 ++ .../phpdoc/modules/_lib---createntlm.inc.html | 160 ++ .../phpdoc/modules/_lib---lamdaemon.inc.html | 235 +++ .../modules/_lib---modules---account.inc.html | 166 ++ .../_lib---modules---ieee802device.inc.html | 160 ++ ...-modules---inetLocalMailRecipient.inc.html | 160 ++ .../_lib---modules---inetOrgPerson.inc.html | 166 ++ .../_lib---modules---kolabUser.inc.html | 160 ++ .../_lib---modules---ldapPublicKey.inc.html | 163 ++ .../_lib---modules---nisMailAlias.inc.html | 160 ++ .../_lib---modules---posixAccount.inc.html | 169 ++ .../_lib---modules---posixGroup.inc.html | 166 ++ .../modules/_lib---modules---quota.inc.html | 166 ++ .../_lib---modules---sambaAccount.inc.html | 166 ++ .../_lib---modules---sambaDomain.inc.html | 160 ++ ...lib---modules---sambaGroupMapping.inc.html | 166 ++ ...sambaSamAccount---sambaMungedDial.inc.html | 186 +++ .../_lib---modules---sambaSamAccount.inc.html | 170 ++ .../_lib---modules---shadowAccount.inc.html | 166 ++ .../phpdoc/modules/_lib---modules.inc.html | 881 ++++++++++ .../_templates---account---edit.php.html | 164 ++ .../developers/phpdoc/modules/account.html | 262 +-- .../phpdoc/modules/accountContainer.html | 352 ++-- .../developers/phpdoc/modules/baseModule.html | 1044 +++++++----- .../phpdoc/modules/ieee802Device.html | 225 +-- .../modules/inetLocalMailRecipient.html | 225 +-- .../phpdoc/modules/inetOrgPerson.html | 290 ++-- .../developers/phpdoc/modules/kolabUser.html | 271 ++-- .../phpdoc/modules/ldapPublicKey.html | 221 +-- .../phpdoc/modules/nisMailAlias.html | 235 +-- .../phpdoc/modules/posixAccount.html | 527 +++--- .../developers/phpdoc/modules/posixGroup.html | 357 ++-- lam-web/developers/phpdoc/modules/quota.html | 435 +++-- .../phpdoc/modules/samba3domain.html | 150 +- .../phpdoc/modules/sambaAccount.html | 420 +++-- .../phpdoc/modules/sambaDomain.html | 225 +-- .../phpdoc/modules/sambaGroupMapping.html | 344 ++-- .../phpdoc/modules/sambaMungedDial.html | 1138 +++++++++++++ .../phpdoc/modules/sambaSamAccount.html | 533 +++--- .../phpdoc/modules/shadowAccount.html | 238 ++- .../developers/phpdoc/modules/smbHash.html | 204 ++- .../phpdoc/profiles/_lib---profiles.inc.html | 245 +++ ...plates---profedit---profiledelete.php.html | 104 ++ ...emplates---profedit---profilemain.php.html | 104 ++ ...emplates---profedit---profilepage.php.html | 106 ++ lam-web/developers/phpdoc/ric_INSTALL.html | 23 +- lam-web/developers/phpdoc/ric_README.html | 20 +- .../selfService/_lib---selfService.inc.html | 450 ++++++ .../selfService/selfServiceProfile.html | 407 +++++ .../tests/_tests---conf-main-test.php.html | 99 ++ .../phpdoc/tests/_tests---conf-test.php.html | 99 ++ .../tests/_tests---status-test.php.html | 99 ++ .../phpdoc/tools/LdapExportInfo.html | 34 +- .../phpdoc/tools/MyCustomExporter.html | 70 +- .../phpdoc/tools/PlaAbstractExporter.html | 42 +- .../phpdoc/tools/PlaCSVExporter.html | 84 +- .../phpdoc/tools/PlaDsmlExporter.html | 58 +- .../developers/phpdoc/tools/PlaExporter.html | 65 +- .../phpdoc/tools/PlaLdapExporter.html | 66 +- .../phpdoc/tools/PlaLdifExporter.html | 74 +- .../phpdoc/tools/PlaVcardExporter.html | 70 +- .../phpdoc/tools/_lib---export.inc.html | 244 +++ .../_templates---massBuildAccounts.php.html | 127 ++ .../tools/_templates---massDoUpload.php.html | 129 ++ .../tools/_templates---masscreate.php.html | 183 +++ .../tools/_templates---ou_edit.php.html | 142 ++ .../_templates---schema---schema.php.html | 130 ++ .../tools/_templates---tests---index.php.html | 125 ++ ...templates---tests---lamdaemonTest.php.html | 175 ++ .../phpdoc/tools/_templates---tools.php.html | 125 ++ .../phpdoc/types/_lib---baseType.inc.html | 118 ++ .../types/_lib---types---group.inc.html | 123 ++ .../phpdoc/types/_lib---types---host.inc.html | 120 ++ .../types/_lib---types---mailAlias.inc.html | 120 ++ .../types/_lib---types---smbDomain.inc.html | 120 ++ .../phpdoc/types/_lib---types---user.inc.html | 120 ++ .../phpdoc/types/_lib---types.inc.html | 303 ++++ lam-web/developers/phpdoc/types/baseType.html | 80 +- lam-web/developers/phpdoc/types/group.html | 65 +- lam-web/developers/phpdoc/types/host.html | 53 +- .../developers/phpdoc/types/mailAlias.html | 53 +- .../developers/phpdoc/types/smbDomain.html | 53 +- lam-web/developers/phpdoc/types/user.html | 53 +- 214 files changed, 31190 insertions(+), 7820 deletions(-) create mode 100644 lam-web/developers/phpdoc/Help/_help---help.inc.html create mode 100644 lam-web/developers/phpdoc/Help/_templates---help.php.html create mode 100644 lam-web/developers/phpdoc/LDAP/_lib---ldap.inc.html create mode 100644 lam-web/developers/phpdoc/PDF/_lib---font---vera.php.html create mode 100644 lam-web/developers/phpdoc/PDF/_lib---font---verab.php.html create mode 100644 lam-web/developers/phpdoc/PDF/_lib---font---verabi.php.html create mode 100644 lam-web/developers/phpdoc/PDF/_lib---font---verai.php.html create mode 100644 lam-web/developers/phpdoc/PDF/_lib---fpdf.php.html create mode 100644 lam-web/developers/phpdoc/PDF/_lib---pdf.inc.html create mode 100644 lam-web/developers/phpdoc/PDF/_lib---pdfstruct.inc.html create mode 100644 lam-web/developers/phpdoc/PDF/_lib---ufpdf.php.html create mode 100644 lam-web/developers/phpdoc/PDF/_lib---xml_parser.inc.html create mode 100644 lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfdelete.php.html create mode 100644 lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfmain.php.html create mode 100644 lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfpage.php.html create mode 100644 lam-web/developers/phpdoc/configuration/_lib---config.inc.html create mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---conflogin.php.html create mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---confmain.php.html create mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---confmodules.php.html create mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---conftypes.php.html create mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---index.php.html create mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---mainlogin.php.html create mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---mainmanage.php.html create mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---profmanage.php.html create mode 100644 lam-web/developers/phpdoc/lib/_lib---account.inc.html create mode 100644 lam-web/developers/phpdoc/lib/_lib---cache.inc.html create mode 100644 lam-web/developers/phpdoc/lib/_lib---schema.inc.html create mode 100644 lam-web/developers/phpdoc/lib/_lib---security.inc.html create mode 100644 lam-web/developers/phpdoc/lib/_lib---status.inc.html create mode 100644 lam-web/developers/phpdoc/lists/_lib---lists.inc.html create mode 100644 lam-web/developers/phpdoc/lists/_templates---lists---deletelink.php.html create mode 100644 lam-web/developers/phpdoc/lists/_templates---lists---list.php.html create mode 100644 lam-web/developers/phpdoc/lists/_templates---lists---userlink.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_lib---tree.inc.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---add_attr.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---add_attr_form.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---add_oclass.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---add_oclass_form.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---add_value.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---add_value_form.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---collapse.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---create.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---create_form.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---creation_template.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---delete.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---delete_attr.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---delete_form.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---download_binary_attr.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---edit.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---expand.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---export.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---export_form.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---rdelete.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---refresh.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---creation---custom.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---creation---new_ou_template.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---templates.inc.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---tree.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---tree_view.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---update.php.html create mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---update_confirm.php.html create mode 100644 lam-web/developers/phpdoc/main/_templates---delete.php.html create mode 100644 lam-web/developers/phpdoc/main/_templates---initsuff.php.html create mode 100644 lam-web/developers/phpdoc/main/_templates---login.php.html create mode 100644 lam-web/developers/phpdoc/main/_templates---logout.php.html create mode 100644 lam-web/developers/phpdoc/main/_templates---main.php.html create mode 100644 lam-web/developers/phpdoc/main/_templates---main_header.php.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---baseModule.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---createntlm.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---lamdaemon.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---account.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---ieee802device.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---inetLocalMailRecipient.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---inetOrgPerson.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---kolabUser.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---ldapPublicKey.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---nisMailAlias.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---posixAccount.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---posixGroup.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---quota.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---sambaAccount.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---sambaDomain.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---sambaGroupMapping.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---sambaSamAccount.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---shadowAccount.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_lib---modules.inc.html create mode 100644 lam-web/developers/phpdoc/modules/_templates---account---edit.php.html create mode 100644 lam-web/developers/phpdoc/modules/sambaMungedDial.html create mode 100644 lam-web/developers/phpdoc/profiles/_lib---profiles.inc.html create mode 100644 lam-web/developers/phpdoc/profiles/_templates---profedit---profiledelete.php.html create mode 100644 lam-web/developers/phpdoc/profiles/_templates---profedit---profilemain.php.html create mode 100644 lam-web/developers/phpdoc/profiles/_templates---profedit---profilepage.php.html create mode 100644 lam-web/developers/phpdoc/selfService/_lib---selfService.inc.html create mode 100644 lam-web/developers/phpdoc/selfService/selfServiceProfile.html create mode 100644 lam-web/developers/phpdoc/tests/_tests---conf-main-test.php.html create mode 100644 lam-web/developers/phpdoc/tests/_tests---conf-test.php.html create mode 100644 lam-web/developers/phpdoc/tests/_tests---status-test.php.html create mode 100644 lam-web/developers/phpdoc/tools/_lib---export.inc.html create mode 100644 lam-web/developers/phpdoc/tools/_templates---massBuildAccounts.php.html create mode 100644 lam-web/developers/phpdoc/tools/_templates---massDoUpload.php.html create mode 100644 lam-web/developers/phpdoc/tools/_templates---masscreate.php.html create mode 100644 lam-web/developers/phpdoc/tools/_templates---ou_edit.php.html create mode 100644 lam-web/developers/phpdoc/tools/_templates---schema---schema.php.html create mode 100644 lam-web/developers/phpdoc/tools/_templates---tests---index.php.html create mode 100644 lam-web/developers/phpdoc/tools/_templates---tests---lamdaemonTest.php.html create mode 100644 lam-web/developers/phpdoc/tools/_templates---tools.php.html create mode 100644 lam-web/developers/phpdoc/types/_lib---baseType.inc.html create mode 100644 lam-web/developers/phpdoc/types/_lib---types---group.inc.html create mode 100644 lam-web/developers/phpdoc/types/_lib---types---host.inc.html create mode 100644 lam-web/developers/phpdoc/types/_lib---types---mailAlias.inc.html create mode 100644 lam-web/developers/phpdoc/types/_lib---types---smbDomain.inc.html create mode 100644 lam-web/developers/phpdoc/types/_lib---types---user.inc.html create mode 100644 lam-web/developers/phpdoc/types/_lib---types.inc.html diff --git a/lam-web/developers/phpdoc/Help/_help---help.inc.html b/lam-web/developers/phpdoc/Help/_help---help.inc.html new file mode 100644 index 00000000..0e29c896 --- /dev/null +++ b/lam-web/developers/phpdoc/Help/_help---help.inc.html @@ -0,0 +1,93 @@ + + +Docs for page help.inc + + + + + + + + + + + + + +
Help
+ + + [ class tree: Help ] + [ index: Help ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: help.inc

+Source Location: /help/help.inc

+ +
+
+ + +

Page Details:

+LDAP Account Manager help entries.



+

Tags:

+
+ + + + +
author:  Michael Duergner
+
+

+

+

+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:10:49 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/Help/_templates---help.php.html b/lam-web/developers/phpdoc/Help/_templates---help.php.html new file mode 100644 index 00000000..ea88c4e9 --- /dev/null +++ b/lam-web/developers/phpdoc/Help/_templates---help.php.html @@ -0,0 +1,159 @@ + + +Docs for page help.php + + + + + + + + + + + + + +
Help
+ + + [ class tree: Help ] + [ index: Help ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: help.php

+Source Location: /templates/help.php

+ +
+
+ + +

Page Details:

+LDAP Account Manager help page.



+

Tags:

+
+ + + + +
author:  Michael Duergner
+
+

+

Includes:

+
+include_once("../lib/ldap.inc") [line 36]
+include_once("../lib/status.inc") [line 49]
+include_once("../lib/modules.inc") [line 127]
+include_once("../help/help.inc") [line 54]
+include_once("../lib/config.inc") [line 41]
+
+

+

+
+
+ +

displayHelp [line 90]

+
+
+
+ void displayHelp( +array $helpEntry, array $helpVariables) +
+

+ + Print help site for a specific help number.



+ +

Parameters

+ + + + + + + + + + + +
array  $helpEntry  The help entry that is to be displayed.
array  $helpVariables  The help variables that are used to replace the spacer in the help text.
+
[ Top ]


+
+
+ +

echoHTMLFoot [line 76]

+
+
+
+ void echoHTMLFoot( +) +
+

+ + Print HTML footer of the help page.



+ +
[ Top ]


+
+
+ +

echoHTMLHead [line 62]

+
+
+
+ void echoHTMLHead( +) +
+

+ + Print HTML header of the help page.



+ +
[ Top ]


+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:10:49 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/LDAP/Ldap.html b/lam-web/developers/phpdoc/LDAP/Ldap.html index 1257fc89..f544336d 100644 --- a/lam-web/developers/phpdoc/LDAP/Ldap.html +++ b/lam-web/developers/phpdoc/LDAP/Ldap.html @@ -12,9 +12,11 @@ - [ class tree: LDAP ] + + + [ class tree: LDAP ] [ index: LDAP ] - [ all elements ] + [ all elements ] @@ -24,8 +26,8 @@
-

README

INSTALL

+

README

Packages:
configuration
@@ -44,15 +46,17 @@

Files:
- ldap.inc + ldap.inc

+ Classes:
Ldap
+
@@ -61,7 +65,6 @@ Source Location: /lib/ldap.inc

- @@ -124,7 +120,6 @@ Source Location: /lib/ldap.inc

-
@@ -80,14 +83,7 @@ Source Location: /lib/ldap.inc

Variables


@@ -139,116 +134,20 @@ Ldap manages connection to LDAP and includes several helper functions.

Class Variables

- -

-

$attributes =

-

[line 68]

- Array with all attribute strings from the LDAP server

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$conf =

-

[line 55]

- Object of Config to access preferences

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$objectClasses =

-

[line 66]

- Array with all objectClass strings from the LDAP server

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$password =

-

[line 63]

- LDAP password used for bind

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$rand =

-

[line 75]

- Random number (changes on every page request)

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$server =

-

[line 58]

- Server handle

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

$supports_unix_hosts =  false

-

[line 72]

- Host attribute in inetOrgPerson

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$username =

-

[line 61]

- LDAP username used for bind

+

[line 74]

+ Host attribute in inetOrgPerson



+

Tags:

+
+ + + + +
access:  public
+
+
@@ -268,7 +167,7 @@ Ldap manages connection to LDAP and includes several helper functions.

-

constructor Ldap [line 80]

+

constructor Ldap [line 82]

@@ -281,8 +180,6 @@ $config)

- -

Parameters:

@@ -297,7 +194,7 @@ $config)
-

method close [line 142]

+

method close [line 144]

@@ -309,13 +206,11 @@ $config) Closes connection to server



- -
[ Top ]

-

method cmp_array [line 428]

+

method cmp_array [line 440]

@@ -338,8 +233,6 @@ $b)

- -

Parameters:

@@ -359,7 +252,7 @@ $b)
-

method connect [line 96]

+

method connect [line 98]

@@ -382,8 +275,6 @@ $passwd)

- -

Parameters:

@@ -403,7 +294,7 @@ $passwd)
-

method decrypt [line 371]

+

method decrypt [line 381]

@@ -425,8 +316,6 @@ $data)

- -

Parameters:

@@ -441,7 +330,7 @@ $data)
-

method decrypt_login [line 405]

+

method decrypt_login [line 417]

@@ -462,13 +351,11 @@ $data)

- -
[ Top ]

-

method destroy [line 414]

+

method destroy [line 426]

@@ -480,13 +367,11 @@ $data) Closes connection to LDAP server and deletes encrypted username/password



- -
[ Top ]

-

method encrypt [line 350]

+

method encrypt [line 358]

@@ -508,8 +393,6 @@ $data)

- -

Parameters:

@@ -524,7 +407,7 @@ $data)
-

method encrypt_login [line 394]

+

method encrypt_login [line 406]

@@ -538,8 +421,6 @@ $password) Encrypts username and password



- -

Parameters:

@@ -559,7 +440,7 @@ $password)
-

method new_rand [line 336]

+

method new_rand [line 344]

@@ -580,13 +461,11 @@ $password)

- -
[ Top ]

-

method search_units [line 152]

+

method search_units [line 154]

@@ -608,8 +487,6 @@ $suffix)

- -

Parameters:

@@ -624,7 +501,7 @@ $suffix)
-

method server [line 295]

+

method server [line 297]

@@ -645,13 +522,11 @@ $suffix)

- -
[ Top ]

-

method updateCapabilities [line 282]

+

method updateCapabilities [line 284]

diff --git a/lam-web/developers/phpdoc/configuration/LAMCfgMain.html b/lam-web/developers/phpdoc/configuration/LAMCfgMain.html index 9bc7f318..82f5a2c2 100644 --- a/lam-web/developers/phpdoc/configuration/LAMCfgMain.html +++ b/lam-web/developers/phpdoc/configuration/LAMCfgMain.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
@@ -663,13 +538,11 @@ $suffix) Updates the capabilities values (var $supports_*)



- -
[ Top ]

-

method updateClasses [line 179]

+

method updateClasses [line 181]

diff --git a/lam-web/developers/phpdoc/classtrees_types.html b/lam-web/developers/phpdoc/classtrees_types.html index eddd9fd0..f601ab88 100644 --- a/lam-web/developers/phpdoc/classtrees_types.html +++ b/lam-web/developers/phpdoc/classtrees_types.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
diff --git a/lam-web/developers/phpdoc/classtrees_tools.html b/lam-web/developers/phpdoc/classtrees_tools.html index e08cb3b8..04e97cf0 100644 --- a/lam-web/developers/phpdoc/classtrees_tools.html +++ b/lam-web/developers/phpdoc/classtrees_tools.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
@@ -681,13 +554,11 @@ $suffix) Reads the array of objectClasses from the LDAP server



- -
[ Top ]

-

method __sleep [line 300]

+

method __sleep [line 307]

diff --git a/lam-web/developers/phpdoc/classtrees_tests.html b/lam-web/developers/phpdoc/classtrees_tests.html index 8d831d33..7e767030 100644 --- a/lam-web/developers/phpdoc/classtrees_tests.html +++ b/lam-web/developers/phpdoc/classtrees_tests.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
@@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/classtrees_selfService.html b/lam-web/developers/phpdoc/classtrees_selfService.html index 72e4e7bf..d3d2be4b 100644 --- a/lam-web/developers/phpdoc/classtrees_selfService.html +++ b/lam-web/developers/phpdoc/classtrees_selfService.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
@@ -699,13 +570,11 @@ $suffix) Closes connection to LDAP server before serialization



- -
[ Top ]

-

method __wakeup [line 308]

+

method __wakeup [line 315]

diff --git a/lam-web/developers/phpdoc/LDAP/_lib---ldap.inc.html b/lam-web/developers/phpdoc/LDAP/_lib---ldap.inc.html new file mode 100644 index 00000000..11ef0322 --- /dev/null +++ b/lam-web/developers/phpdoc/LDAP/_lib---ldap.inc.html @@ -0,0 +1,138 @@ + + +Docs for page ldap.inc + + + + +
@@ -717,8 +586,6 @@ $suffix) Reconnects to LDAP server when deserialized



- -
[ Top ]

@@ -726,7 +593,7 @@ $suffix)

- Documentation generated on Wed, 15 Nov 2006 18:00:50 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:54 +0100 by phpDocumentor 1.4.0
+ + + + + + + + +
LDAP
+ + + [ class tree: LDAP ] + [ index: LDAP ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: ldap.inc

+Source Location: /lib/ldap.inc

+ +
+
+ +
+

Classes:

+
Ldap
+
Ldap manages connection to LDAP and includes several helper functions.
+


+ +

Page Details:

+ldap.inc provides basic functions to connect to the OpenLDAP server.



+

Tags:

+
+ + + + +
author:  Roland Gruber
+
+

+

Includes:

+
+include_once("config.inc") [line 32]
+Access to configuration data

include_once("schema.inc") [line 34]
+LDAP schema

+

+

+
+
+ +

hex2bin [line 42]

+
+
+
+ binary hex2bin( +string $value) +
+

+ + Converts a HEX string to a binary value



+

Tags:

+
+ + + + +
return:  result binary
+
+

+ +

Parameters

+ + + + + + +
string  $value  HEX string
+
[ Top ]


+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:10:54 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/FPDF.html b/lam-web/developers/phpdoc/PDF/FPDF.html index fd6fa812..8c838efc 100644 --- a/lam-web/developers/phpdoc/PDF/FPDF.html +++ b/lam-web/developers/phpdoc/PDF/FPDF.html @@ -12,9 +12,11 @@
- [ class tree: PDF ] + + + [ class tree: PDF ] [ index: PDF ] - [ all elements ] + [ all elements ]
diff --git a/lam-web/developers/phpdoc/classtrees_profiles.html b/lam-web/developers/phpdoc/classtrees_profiles.html index 01b3c277..5fa4c5f2 100644 --- a/lam-web/developers/phpdoc/classtrees_profiles.html +++ b/lam-web/developers/phpdoc/classtrees_profiles.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
@@ -86,7 +90,6 @@ Source Location: /lib/fpdf.php

- diff --git a/lam-web/developers/phpdoc/PDF/UFPDF.html b/lam-web/developers/phpdoc/PDF/UFPDF.html index 50252bb1..c9f6c17c 100644 --- a/lam-web/developers/phpdoc/PDF/UFPDF.html +++ b/lam-web/developers/phpdoc/PDF/UFPDF.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/classtrees_modules.html b/lam-web/developers/phpdoc/classtrees_modules.html index 61f09a6d..bf07a950 100644 --- a/lam-web/developers/phpdoc/classtrees_modules.html +++ b/lam-web/developers/phpdoc/classtrees_modules.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
@@ -250,7 +253,6 @@ Source Location: /lib/fpdf.php

-

Child classes:

@@ -1162,9 +1164,9 @@ Main FPDF class for creating PDF documents



FPDF FPDF( -[mixed -$orientation = 'P'], [mixed -$unit = 'mm'], [mixed +[ +$orientation = 'P'], [ +$unit = 'mm'], [ $format = 'A4'])

@@ -1172,8 +1174,26 @@ $format = 'A4']) *****************************************************************************

* Public methods * * *****************************************************************************




- - +

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $orientation  
  $unit  
  $format  
+

[ Top ]

@@ -1196,8 +1216,6 @@ $format = 'A4'])

- -
[ Top ]

@@ -1207,9 +1225,9 @@ $format = 'A4'])
void AddFont( -mixed -$family, [mixed -$style = ''], [mixed + +$family, [ +$style = ''], [ $file = ''])

@@ -1223,8 +1241,26 @@ $file = ''])

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $family  
  $style  
  $file  
+

[ Top ]

@@ -1241,8 +1277,6 @@ $file = ''])

- -
[ Top ]

@@ -1252,7 +1286,7 @@ $file = ''])
void AddPage( -[mixed +[ $orientation = ''])

@@ -1260,8 +1294,16 @@ $orientation = ''])

- - +

Parameters:

+
+ + + + + + +
  $orientation  
+

[ Top ]

@@ -1271,7 +1313,7 @@ $orientation = ''])
void AliasNbPages( -[mixed +[ $alias = '{nb}'])

@@ -1285,8 +1327,16 @@ $alias = '{nb}'])

- - +

Parameters:

+
+ + + + + + +
  $alias  
+

[ Top ]

@@ -1296,14 +1346,14 @@ $alias = '{nb}'])
void Cell( -mixed -$w, [mixed -$h = 0], [mixed -$txt = ''], [mixed -$border = 0], [mixed -$ln = 0], [mixed -$align = ''], [mixed -$fill = 0], [mixed + +$w, [ +$h = 0], [ +$txt = ''], [ +$border = 0], [ +$ln = 0], [ +$align = ''], [ +$fill = 0], [ $link = ''])

@@ -1317,8 +1367,51 @@ $link = ''])

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
  $w  
  $h  
  $txt  
  $border  
  $ln  
  $align  
  $fill  
  $link  
+

[ Top ]

@@ -1335,8 +1428,6 @@ $link = ''])

- -
[ Top ]

@@ -1346,7 +1437,7 @@ $link = ''])
void Error( -mixed + $msg)

@@ -1354,8 +1445,16 @@ $msg)

- - +

Parameters:

+
+ + + + + + +
  $msg  
+

[ Top ]

@@ -1372,8 +1471,6 @@ $msg)

- -
[ Top ]

@@ -1383,7 +1480,7 @@ $msg)
void GetStringWidth( -mixed + $s)

@@ -1397,8 +1494,16 @@ $s)

- - +

Parameters:

+
+ + + + + + +
  $s  
+

[ Top ]

@@ -1415,8 +1520,6 @@ $s)

- -
[ Top ]

@@ -1433,8 +1536,6 @@ $s)

- -
[ Top ]

@@ -1451,8 +1552,6 @@ $s)

- -
[ Top ]

@@ -1462,13 +1561,13 @@ $s)
void Image( -mixed -$file, mixed -$x, mixed -$y, [mixed -$w = 0], [mixed -$h = 0], [mixed -$type = ''], [mixed + +$file, +$x, +$y, [ +$w = 0], [ +$h = 0], [ +$type = ''], [ $link = ''])

@@ -1476,8 +1575,46 @@ $link = ''])

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
  $file  
  $x  
  $y  
  $w  
  $h  
  $type  
  $link  
+

[ Top ]

@@ -1487,10 +1624,10 @@ $link = ''])
void Line( -mixed -$x1, mixed -$y1, mixed -$x2, mixed + +$x1, +$y1, +$x2, $y2)

@@ -1498,8 +1635,31 @@ $y2)

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + + + + + + +
  $x1  
  $y1  
  $x2  
  $y2  
+

[ Top ]

@@ -1509,11 +1669,11 @@ $y2)
void Link( -mixed -$x, mixed -$y, mixed -$w, mixed -$h, mixed + +$x, +$y, +$w, +$h, $link)

@@ -1521,8 +1681,36 @@ $link)

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
  $x  
  $y  
  $w  
  $h  
  $link  
+

[ Top ]

@@ -1532,7 +1720,7 @@ $link)
void Ln( -[mixed +[ $h = ''])

@@ -1540,8 +1728,16 @@ $h = ''])

- - +

Parameters:

+
+ + + + + + +
  $h  
+

[ Top ]

@@ -1551,12 +1747,12 @@ $h = ''])
void MultiCell( -mixed -$w, mixed -$h, mixed -$txt, [mixed -$border = 0], [mixed -$align = 'J'], [mixed + +$w, +$h, +$txt, [ +$border = 0], [ +$align = 'J'], [ $fill = 0])

@@ -1570,8 +1766,41 @@ $fill = 0])

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
  $w  
  $h  
  $txt  
  $border  
  $align  
  $fill  
+

[ Top ]

@@ -1588,8 +1817,6 @@ $fill = 0])

- -
[ Top ]

@@ -1599,8 +1826,8 @@ $fill = 0])
void Output( -[mixed -$name = ''], [mixed +[ +$name = ''], [ $dest = ''])

@@ -1608,8 +1835,21 @@ $dest = ''])

- - +

Parameters:

+
+ + + + + + + + + + + +
  $name  
  $dest  
+

[ Top ]

@@ -1626,8 +1866,6 @@ $dest = ''])

- -
[ Top ]

@@ -1637,11 +1875,11 @@ $dest = ''])
void Rect( -mixed -$x, mixed -$y, mixed -$w, mixed -$h, [mixed + +$x, +$y, +$w, +$h, [ $style = ''])

@@ -1649,8 +1887,36 @@ $style = ''])

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
  $x  
  $y  
  $w  
  $h  
  $style  
+

[ Top ]

@@ -1660,7 +1926,7 @@ $style = ''])
void SetAuthor( -mixed + $author)

@@ -1668,8 +1934,16 @@ $author)

- - +

Parameters:

+
+ + + + + + +
  $author  
+

[ Top ]

@@ -1679,8 +1953,8 @@ $author)
void SetAutoPageBreak( -mixed -$auto, [mixed + +$auto, [ $margin = 0])

@@ -1688,8 +1962,21 @@ $margin = 0])

- - +

Parameters:

+
+ + + + + + + + + + + +
  $auto  
  $margin  
+

[ Top ]

@@ -1699,7 +1986,7 @@ $margin = 0])
void SetCompression( -mixed + $compress)

@@ -1707,8 +1994,16 @@ $compress)

- - +

Parameters:

+
+ + + + + + +
  $compress  
+

[ Top ]

@@ -1718,7 +2013,7 @@ $compress)
void SetCreator( -mixed + $creator)

@@ -1726,8 +2021,16 @@ $creator)

- - +

Parameters:

+
+ + + + + + +
  $creator  
+

[ Top ]

@@ -1737,8 +2040,8 @@ $creator)
void SetDisplayMode( -mixed -$zoom, [mixed + +$zoom, [ $layout = 'continuous'])

@@ -1746,8 +2049,21 @@ $layout = 'continuous'])

- - +

Parameters:

+
+ + + + + + + + + + + +
  $zoom  
  $layout  
+

[ Top ]

@@ -1757,9 +2073,9 @@ $layout = 'continuous'])
void SetDrawColor( -mixed -$r, [mixed -$g = -1], [mixed + +$r, [ +$g = -1], [ $b = -1])

@@ -1767,8 +2083,26 @@ $b = -1])

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $r  
  $g  
  $b  
+

[ Top ]

@@ -1778,9 +2112,9 @@ $b = -1])
void SetFillColor( -mixed -$r, [mixed -$g = -1], [mixed + +$r, [ +$g = -1], [ $b = -1])

@@ -1788,8 +2122,26 @@ $b = -1])

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $r  
  $g  
  $b  
+

[ Top ]

@@ -1799,9 +2151,9 @@ $b = -1])
void SetFont( -mixed -$family, [mixed -$style = ''], [mixed + +$family, [ +$style = ''], [ $size = 0])

@@ -1809,8 +2161,26 @@ $size = 0])

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $family  
  $style  
  $size  
+

[ Top ]

@@ -1820,7 +2190,7 @@ $size = 0])
void SetFontSize( -mixed + $size)

@@ -1828,8 +2198,16 @@ $size)

- - +

Parameters:

+
+ + + + + + +
  $size  
+

[ Top ]

@@ -1839,7 +2217,7 @@ $size)
void SetKeywords( -mixed + $keywords)

@@ -1847,8 +2225,16 @@ $keywords)

- - +

Parameters:

+
+ + + + + + +
  $keywords  
+

[ Top ]

@@ -1858,7 +2244,7 @@ $keywords)
void SetLeftMargin( -mixed + $margin)

@@ -1866,8 +2252,16 @@ $margin)

- - +

Parameters:

+
+ + + + + + +
  $margin  
+

[ Top ]

@@ -1877,7 +2271,7 @@ $margin)
void SetLineWidth( -mixed + $width)

@@ -1885,8 +2279,16 @@ $width)

- - +

Parameters:

+
+ + + + + + +
  $width  
+

[ Top ]

@@ -1896,9 +2298,9 @@ $width)
void SetLink( -mixed -$link, [mixed -$y = 0], [mixed + +$link, [ +$y = 0], [ $page = -1])

@@ -1906,8 +2308,26 @@ $page = -1])

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $link  
  $y  
  $page  
+

[ Top ]

@@ -1917,9 +2337,9 @@ $page = -1])
void SetMargins( -mixed -$left, mixed -$top, [mixed + +$left, +$top, [ $right = -1])

@@ -1927,8 +2347,26 @@ $right = -1])

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $left  
  $top  
  $right  
+

[ Top ]

@@ -1938,7 +2376,7 @@ $right = -1])
void SetRightMargin( -mixed + $margin)

@@ -1946,8 +2384,16 @@ $margin)

- - +

Parameters:

+
+ + + + + + +
  $margin  
+

[ Top ]

@@ -1957,7 +2403,7 @@ $margin)
void SetSubject( -mixed + $subject)

@@ -1965,8 +2411,16 @@ $subject)

- - +

Parameters:

+
+ + + + + + +
  $subject  
+

[ Top ]

@@ -1976,9 +2430,9 @@ $subject)
void SetTextColor( -mixed -$r, [mixed -$g = -1], [mixed + +$r, [ +$g = -1], [ $b = -1])

@@ -1986,8 +2440,26 @@ $b = -1])

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $r  
  $g  
  $b  
+

[ Top ]

@@ -1997,7 +2469,7 @@ $b = -1])
void SetTitle( -mixed + $title)

@@ -2005,8 +2477,16 @@ $title)

- - +

Parameters:

+
+ + + + + + +
  $title  
+

[ Top ]

@@ -2016,7 +2496,7 @@ $title)
void SetTopMargin( -mixed + $margin)

@@ -2024,8 +2504,16 @@ $margin)

- - +

Parameters:

+
+ + + + + + +
  $margin  
+

[ Top ]

@@ -2035,7 +2523,7 @@ $margin)
void SetX( -mixed + $x)

@@ -2043,8 +2531,16 @@ $x)

- - +

Parameters:

+
+ + + + + + +
  $x  
+

[ Top ]

@@ -2054,8 +2550,8 @@ $x)
void SetXY( -mixed -$x, mixed + +$x, $y)

@@ -2063,8 +2559,21 @@ $y)

- - +

Parameters:

+
+ + + + + + + + + + + +
  $x  
  $y  
+

[ Top ]

@@ -2074,7 +2583,7 @@ $y)
void SetY( -mixed + $y)

@@ -2082,8 +2591,16 @@ $y)

- - +

Parameters:

+
+ + + + + + +
  $y  
+

[ Top ]

@@ -2093,9 +2610,9 @@ $y)
void Text( -mixed -$x, mixed -$y, mixed + +$x, +$y, $txt)

@@ -2109,8 +2626,26 @@ $txt)

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $x  
  $y  
  $txt  
+

[ Top ]

@@ -2120,9 +2655,9 @@ $txt)
void Write( -mixed -$h, mixed -$txt, [mixed + +$h, +$txt, [ $link = ''])

@@ -2136,8 +2671,26 @@ $link = ''])

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $h  
  $txt  
  $link  
+

[ Top ]

@@ -2147,7 +2700,7 @@ $link = ''])
void _beginpage( -mixed + $orientation)

@@ -2155,8 +2708,16 @@ $orientation)

- - +

Parameters:

+
+ + + + + + +
  $orientation  
+

[ Top ]

@@ -2173,8 +2734,6 @@ $orientation) *****************************************************************************

* Protected methods * * *****************************************************************************




- -
[ Top ]

@@ -2184,9 +2743,9 @@ $orientation)
void _dounderline( -mixed -$x, mixed -$y, mixed + +$x, +$y, $txt)

@@ -2200,8 +2759,26 @@ $txt)

- - +

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $x  
  $y  
  $txt  
+

[ Top ]

@@ -2218,8 +2795,6 @@ $txt)

- -
[ Top ]

@@ -2236,8 +2811,6 @@ $txt)

- -
[ Top ]

@@ -2247,7 +2820,7 @@ $txt)
void _escape( -mixed + $s)

@@ -2255,8 +2828,16 @@ $s)

- - +

Parameters:

+
+ + + + + + +
  $s  
+

[ Top ]

@@ -2266,7 +2847,7 @@ $s)
void _freadint( -mixed + $f)

@@ -2274,8 +2855,16 @@ $f)

- - +

Parameters:

+
+ + + + + + +
  $f  
+

[ Top ]

@@ -2292,8 +2881,6 @@ $f)

- -
[ Top ]

@@ -2310,8 +2897,6 @@ $f)

- -
[ Top ]

@@ -2321,7 +2906,7 @@ $f)
void _out( -mixed + $s)

@@ -2329,8 +2914,16 @@ $s)

- - +

Parameters:

+
+ + + + + + +
  $s  
+

[ Top ]

@@ -2340,7 +2933,7 @@ $s)
void _parsejpg( -mixed + $file)

@@ -2348,8 +2941,16 @@ $file)

- - +

Parameters:

+
+ + + + + + +
  $file  
+

[ Top ]

@@ -2359,7 +2960,7 @@ $file)
void _parsepng( -mixed + $file)

@@ -2367,8 +2968,16 @@ $file)

- - +

Parameters:

+
+ + + + + + +
  $file  
+

[ Top ]

@@ -2385,8 +2994,6 @@ $file)

- -
[ Top ]

@@ -2403,8 +3010,6 @@ $file)

- -
[ Top ]

@@ -2421,8 +3026,6 @@ $file)

- -
[ Top ]

@@ -2439,8 +3042,6 @@ $file)

- -
[ Top ]

@@ -2463,8 +3064,6 @@ $file)

- -
[ Top ]

@@ -2487,8 +3086,6 @@ $file)

- -
[ Top ]

@@ -2505,8 +3102,6 @@ $file)

- -
[ Top ]

@@ -2523,8 +3118,6 @@ $file)

- -
[ Top ]

@@ -2534,7 +3127,7 @@ $file)
void _putstream( -mixed + $s)

@@ -2542,8 +3135,16 @@ $s)

- - +

Parameters:

+
+ + + + + + +
  $s  
+

[ Top ]

@@ -2560,8 +3161,6 @@ $s)

- -
[ Top ]

@@ -2578,8 +3177,6 @@ $s)

- -
[ Top ]

@@ -2589,7 +3186,7 @@ $s)
void _textstring( -mixed + $s)

@@ -2603,8 +3200,16 @@ $s)

- - +

Parameters:

+
+ + + + + + +
  $s  
+

[ Top ]

@@ -2612,7 +3217,7 @@ $s)

- Documentation generated on Wed, 15 Nov 2006 18:00:45 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:47 +0100 by phpDocumentor 1.4.0
- [ class tree: PDF ] + + + [ class tree: PDF ] [ index: PDF ] - [ all elements ] + [ all elements ]
@@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/classtrees_main.html b/lam-web/developers/phpdoc/classtrees_main.html index cc8fa8fe..09f64140 100644 --- a/lam-web/developers/phpdoc/classtrees_main.html +++ b/lam-web/developers/phpdoc/classtrees_main.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
@@ -86,7 +90,6 @@ Source Location: /lib/ufpdf.php

- diff --git a/lam-web/developers/phpdoc/PDF/_lib---font---vera.php.html b/lam-web/developers/phpdoc/PDF/_lib---font---vera.php.html new file mode 100644 index 00000000..9ef8097f --- /dev/null +++ b/lam-web/developers/phpdoc/PDF/_lib---font---vera.php.html @@ -0,0 +1,121 @@ + + +Docs for page vera.php + + + + +
@@ -141,7 +144,6 @@ Source Location: /lib/ufpdf.php

-

Child classes:

@@ -160,407 +162,349 @@ Source Location: /lib/ufpdf.php

FPDF::$AliasNbPages - -
+
FPDF::$author - -
+
FPDF::$AutoPageBreak - -
+
FPDF::$bMargin - -
+
FPDF::$buffer - -
+
FPDF::$cMargin - -
+
FPDF::$ColorFlag - -
+
FPDF::$compress - -
+
FPDF::$CoreFonts - -
+
FPDF::$creator - -
+
FPDF::$CurOrientation - -
+
FPDF::$CurrentFont - -
+
FPDF::$DefOrientation - -
+
FPDF::$diffs - -
+
FPDF::$DrawColor - -
+
FPDF::$fh - -
+
FPDF::$fhPt - -
+
FPDF::$FillColor - -
+
FPDF::$FontFamily - -
+
FPDF::$FontFiles - -
+
FPDF::$fonts - -
+
FPDF::$FontSize - -
+
FPDF::$FontSizePt - -
+
FPDF::$FontStyle - -
+
FPDF::$fw - -
+
FPDF::$fwPt - -
+
FPDF::$h - -
+
FPDF::$hPt - -
+
FPDF::$images - -
+
FPDF::$InFooter - -
+
FPDF::$k - -
+
FPDF::$keywords - -
+
FPDF::$lasth - -
+
FPDF::$LayoutMode - -
+
FPDF::$LineWidth - -
+
FPDF::$links - -
+
FPDF::$lMargin - -
+
FPDF::$n - -
+
FPDF::$offsets - -
+
FPDF::$OrientationChanges - -
+
FPDF::$page - -
+
FPDF::$PageBreakTrigger - -
+
FPDF::$PageLinks - -
+
FPDF::$pages - -
+
FPDF::$PDFVersion - -
+
FPDF::$rMargin - -
+
FPDF::$state - -
+
FPDF::$subject - -
+
FPDF::$TextColor - -
+
FPDF::$title - -
+
FPDF::$tMargin - -
+
FPDF::$underline - -
+
FPDF::$w - -
+
FPDF::$wPt - -
+
FPDF::$ws - -
+
FPDF::$x - -
+
FPDF::$y - -
+
FPDF::$ZoomMode - -
+
@@ -575,497 +519,426 @@ Source Location: /lib/ufpdf.php

FPDF::FPDF() -
*****************************************************************************
FPDF::AcceptPageBreak() -
FPDF::AddFont() -
FPDF::AddLink() -
FPDF::AddPage() -
FPDF::AliasNbPages() -
FPDF::Cell() -
FPDF::Close() -
FPDF::Error() -
FPDF::Footer() -
FPDF::GetStringWidth() -
FPDF::GetX() -
FPDF::GetY() -
FPDF::Header() -
FPDF::Image() -
FPDF::Line() -
FPDF::Link() -
FPDF::Ln() -
FPDF::MultiCell() -
FPDF::Open() -
FPDF::Output() -
FPDF::PageNo() -
FPDF::Rect() -
FPDF::SetAuthor() -
FPDF::SetAutoPageBreak() -
FPDF::SetCompression() -
FPDF::SetCreator() -
FPDF::SetDisplayMode() -
FPDF::SetDrawColor() -
FPDF::SetFillColor() -
FPDF::SetFont() -
FPDF::SetFontSize() -
FPDF::SetKeywords() -
FPDF::SetLeftMargin() -
FPDF::SetLineWidth() -
FPDF::SetLink() -
FPDF::SetMargins() -
FPDF::SetRightMargin() -
FPDF::SetSubject() -
FPDF::SetTextColor() -
FPDF::SetTitle() -
FPDF::SetTopMargin() -
FPDF::SetX() -
FPDF::SetXY() -
FPDF::SetY() -
FPDF::Text() -
FPDF::Write() -
FPDF::_beginpage() -
FPDF::_dochecks() -
*****************************************************************************
FPDF::_dounderline() -
FPDF::_enddoc() -
FPDF::_endpage() -
FPDF::_escape() -
FPDF::_freadint() -
FPDF::_getfontpath() -
FPDF::_newobj() -
FPDF::_out() -
FPDF::_parsejpg() -
FPDF::_parsepng() -
FPDF::_putcatalog() -
FPDF::_putfonts() -
FPDF::_putheader() -
FPDF::_putimages() -
FPDF::_putinfo() -
FPDF::_putpages() -
FPDF::_putresourcedict() -
FPDF::_putresources() -
FPDF::_putstream() -
FPDF::_puttrailer() -
FPDF::_putxobjectdict() -
FPDF::_textstring() -
@@ -1106,9 +979,9 @@ Main UFPDF class for creating Unicode PDF documents



UFPDF UFPDF( -[mixed -$orientation = 'P'], [mixed -$unit = 'mm'], [mixed +[ +$orientation = 'P'], [ +$unit = 'mm'], [ $format = 'A4'])

@@ -1116,8 +989,26 @@ $format = 'A4']) *****************************************************************************

* Public methods * * *****************************************************************************




- - +

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $orientation  
  $unit  
  $format  
+

[ Top ]

@@ -1133,9 +1024,7 @@ $format = 'A4'])

- -Overrides FPDF::AcceptPageBreak() (parent method not documented)

- + Overrides FPDF::AcceptPageBreak() (parent method not documented)

[ Top ]

@@ -1145,18 +1034,36 @@ Overrides FPDF::AcceptPageBreak
void AddFont( -mixed -$family, [mixed -$style = ''], [mixed + +$family, [ +$style = ''], [ $file = ''])



- -Overrides
FPDF::AddFont() (parent method not documented)

- + Overrides FPDF::AddFont() (parent method not documented)

+

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $family  
  $style  
  $file  
+

[ Top ]

@@ -1166,16 +1073,24 @@ Overrides FPDF::AddFont() (parent m
void AliasNbPages( -[mixed +[ $alias = '{nb}'])



- -Overrides FPDF::AliasNbPages() (parent method not documented)

- + Overrides FPDF::AliasNbPages() (parent method not documented)

+

Parameters:

+
+ + + + + + +
  $alias  
+

[ Top ]

@@ -1185,23 +1100,66 @@ Overrides FPDF::AliasNbPages()
void Cell( -mixed -$w, [mixed -$h = 0], [mixed -$txt = ''], [mixed -$border = 0], [mixed -$ln = 0], [mixed -$align = 'J'], [mixed -$fill = 0], [mixed + +$w, [ +$h = 0], [ +$txt = ''], [ +$border = 0], [ +$ln = 0], [ +$align = 'J'], [ +$fill = 0], [ $link = ''])



- -Overrides FPDF::Cell() (parent method not documented)

- + Overrides FPDF::Cell() (parent method not documented)

+

Parameters:

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
  $w  
  $h  
  $txt  
  $border  
  $ln  
  $align  
  $fill  
  $link  
+

[ Top ]

@@ -1211,7 +1169,7 @@ Overrides FPDF::Cell() (parent method
void code2utf( -mixed + $num)

@@ -1219,8 +1177,16 @@ $num)

- - +

Parameters:

+
+ + + + + + +
  $num  
+

[ Top ]

@@ -1230,16 +1196,24 @@ $num)
void GetStringWidth( -mixed + $s)



- -Overrides FPDF::GetStringWidth() (parent method not documented)

- + Overrides FPDF::GetStringWidth() (parent method not documented)

+

Parameters:

+
+ + + + + + +
  $s  
+

[ Top ]

@@ -1249,21 +1223,54 @@ Overrides FPDF::GetStringWidth()
void MultiCell( -mixed -$w, mixed -$h, mixed -$txt, [mixed -$border = 0], [mixed -$align = 'J'], [mixed + +$w, +$h, +$txt, [ +$border = 0], [ +$align = 'J'], [ $fill = 0])



- -Overrides
FPDF::MultiCell() (parent method not documented)

- + Overrides FPDF::MultiCell() (parent method not documented)

+

Parameters:

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
  $w  
  $h  
  $txt  
  $border  
  $align  
  $fill  
+

[ Top ]

@@ -1273,7 +1280,7 @@ Overrides FPDF::MultiCell() (pare
void strlen( -mixed + $s)

@@ -1281,8 +1288,16 @@ $s)

- - +

Parameters:

+
+ + + + + + +
  $s  
+

[ Top ]

@@ -1292,18 +1307,36 @@ $s)
void Text( -mixed -$x, mixed -$y, mixed + +$x, +$y, $txt)



- -Overrides FPDF::Text() (parent method not documented)

- + Overrides FPDF::Text() (parent method not documented)

+

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $x  
  $y  
  $txt  
+

[ Top ]

@@ -1313,8 +1346,8 @@ Overrides FPDF::Text() (parent method
void utf8_substr( -mixed -$str, mixed + +$str, $start)

@@ -1322,8 +1355,21 @@ $start)

- - +

Parameters:

+
+ + + + + + + + + + + +
  $str  
  $start  
+

[ Top ]

@@ -1333,7 +1379,7 @@ $start)
void utf8_to_codepoints( -mixed + $txt)

@@ -1341,8 +1387,16 @@ $txt)

- - +

Parameters:

+
+ + + + + + +
  $txt  
+

[ Top ]

@@ -1352,8 +1406,8 @@ $txt)
void utf8_to_utf16be( -mixed -&$txt, [mixed + +&$txt, [ $bom = true])

@@ -1361,8 +1415,21 @@ $bom = true])

- - +

Parameters:

+
+ + + + + + + + + + + +
  &$txt  
  $bom  
+

[ Top ]

@@ -1372,18 +1439,36 @@ $bom = true])
void Write( -mixed -$h, mixed -$txt, [mixed + +$h, +$txt, [ $link = ''])



- -Overrides FPDF::Write() (parent method not documented)

- + Overrides FPDF::Write() (parent method not documented)

+

Parameters:

+
+ + + + + + + + + + + + + + + + +
  $h  
  $txt  
  $link  
+

[ Top ]

@@ -1393,19 +1478,42 @@ Overrides FPDF::Write() (parent metho
void _dounderline( -mixed -$x, mixed -$y, mixed -$width, mixed + +$x, +$y, +$width, $txt)



- -Overrides FPDF::_dounderline() (parent method not documented)

- + Overrides FPDF::_dounderline() (parent method not documented)

+

Parameters:

+
+ + + + + + + + + + + + + + + + + + + + + +
  $x  
  $y  
  $width  
  $txt  
+

[ Top ]

@@ -1415,7 +1523,7 @@ Overrides FPDF::_dounderline()
void _escapetext( -mixed + $s)

@@ -1423,8 +1531,16 @@ $s)

- - +

Parameters:

+
+ + + + + + +
  $s  
+

[ Top ]

@@ -1440,9 +1556,7 @@ $s)

- -Overrides FPDF::_putinfo() (parent method not documented)

- + Overrides FPDF::_putinfo() (parent method not documented)

[ Top ]

@@ -1458,9 +1572,7 @@ Overrides FPDF::_putinfo() (parent

- -Overrides FPDF::_putpages() (parent method not documented)

- + Overrides FPDF::_putpages() (parent method not documented)

[ Top ]

@@ -1470,7 +1582,7 @@ Overrides FPDF::_putpages() (pare
void _puttruetypeunicode( -mixed + $font)

@@ -1478,8 +1590,16 @@ $font) *****************************************************************************

* Protected methods * * *****************************************************************************




- - +

Parameters:

+
+ + + + + + +
  $font  
+

[ Top ]

@@ -1489,16 +1609,24 @@ $font)
void _textstring( -mixed + $s)



- -Overrides FPDF::_textstring() (parent method not documented)

- + Overrides FPDF::_textstring() (parent method not documented)

+

Parameters:

+
+ + + + + + +
  $s  
+

[ Top ]

@@ -1506,7 +1634,7 @@ Overrides FPDF::_textstring() (

- Documentation generated on Wed, 15 Nov 2006 18:01:12 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:11:15 +0100 by phpDocumentor 1.4.0
+ + + + + + + + +
PDF
+ + + [ class tree: PDF ] + [ index: PDF ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: vera.php

+Source Location: /lib/font/vera.php

+ +
+
+ + +

Page Details:

+This file includes information about the Bitstream Vera font.



+

Tags:

+
+ + + + +
author:  Roland Gruber
+
+

+

+

+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:11:16 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/_lib---font---verab.php.html b/lam-web/developers/phpdoc/PDF/_lib---font---verab.php.html new file mode 100644 index 00000000..ec978b9b --- /dev/null +++ b/lam-web/developers/phpdoc/PDF/_lib---font---verab.php.html @@ -0,0 +1,121 @@ + + +Docs for page verab.php + + + + + + + + + + + + + +
PDF
+ + + [ class tree: PDF ] + [ index: PDF ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: verab.php

+Source Location: /lib/font/verab.php

+ +
+
+ + +

Page Details:

+This file includes information about the Bitstream Vera font.



+

Tags:

+
+ + + + +
author:  Roland Gruber
+
+

+

+

+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:11:16 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/_lib---font---verabi.php.html b/lam-web/developers/phpdoc/PDF/_lib---font---verabi.php.html new file mode 100644 index 00000000..44948fa9 --- /dev/null +++ b/lam-web/developers/phpdoc/PDF/_lib---font---verabi.php.html @@ -0,0 +1,121 @@ + + +Docs for page verabi.php + + + + + + + + + + + + + +
PDF
+ + + [ class tree: PDF ] + [ index: PDF ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: verabi.php

+Source Location: /lib/font/verabi.php

+ +
+
+ + +

Page Details:

+This file includes information about the Bitstream Vera font.



+

Tags:

+
+ + + + +
author:  Roland Gruber
+
+

+

+

+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:11:16 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/_lib---font---verai.php.html b/lam-web/developers/phpdoc/PDF/_lib---font---verai.php.html new file mode 100644 index 00000000..39d3d2f3 --- /dev/null +++ b/lam-web/developers/phpdoc/PDF/_lib---font---verai.php.html @@ -0,0 +1,121 @@ + + +Docs for page verai.php + + + + + + + + + + + + + +
PDF
+ + + [ class tree: PDF ] + [ index: PDF ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: verai.php

+Source Location: /lib/font/verai.php

+ +
+
+ + +

Page Details:

+This file includes information about the Bitstream Vera font.



+

Tags:

+
+ + + + +
author:  Roland Gruber
+
+

+

+

+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:11:16 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/_lib---fpdf.php.html b/lam-web/developers/phpdoc/PDF/_lib---fpdf.php.html new file mode 100644 index 00000000..02da3250 --- /dev/null +++ b/lam-web/developers/phpdoc/PDF/_lib---fpdf.php.html @@ -0,0 +1,139 @@ + + +Docs for page fpdf.php + + + + + + + + + + + + + +
PDF
+ + + [ class tree: PDF ] + [ index: PDF ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: fpdf.php

+Source Location: /lib/fpdf.php

+ +
+
+ +
+

Classes:

+
FPDF
+
Main FPDF class for creating PDF documents
+


+ +

Page Details:

+This file includes the FPDF implementation which is used to generate PDF files.



+

Tags:

+
+ + + + +
author:  Olivier Plathey
+
+

+

+

+
+ +

FPDF_VERSION [line 21]

+
+
+
+ FPDF_VERSION = '1.53' +
+
+ + *****************************************************************************

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. * *****************************************************************************



+
+
[ Top ]


+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:10:47 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/_lib---pdf.inc.html b/lam-web/developers/phpdoc/PDF/_lib---pdf.inc.html new file mode 100644 index 00000000..baa21296 --- /dev/null +++ b/lam-web/developers/phpdoc/PDF/_lib---pdf.inc.html @@ -0,0 +1,322 @@ + + +Docs for page pdf.inc + + + + + + + + + + + + + +
PDF
+ + + [ class tree: PDF ] + [ index: PDF ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: pdf.inc

+Source Location: /lib/pdf.inc

+ +
+
+ +
+

Classes:

+
lamPDF
+
Creates a LAM information page in PDF format.
+


+ +

Page Details:

+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("ufpdf.php") [line 39]
+Unicode support for FPDF

include_once('xml_parser.inc') [line 42]
+XML functions

include_once("fpdf.php") [line 36]
+PDF generator class

include_once('pdfstruct.inc') [line 45]
+access to PDF configuration files

+

+

+
+ +

LAMPDF_LINEWIDTH [line 33]

+
+
+
+ LAMPDF_LINEWIDTH = 190 +
+
+ + PDF line width


+
+
[ Top ]


+
+
+ +

createModulePDF [line 62]

+
+
+
+ void createModulePDF( +array $accounts, [string $pdf_structure = "default"]) +
+

+ + 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.
+
[ Top ]


+
+
+ +

getSectionHeadline [line 169]

+
+
+
+ string getSectionHeadline( +string $line) +
+

+ + Creates a section headline.



+

Tags:

+
+ + + + +
return:  XML code for headline
+
+

+ +

Parameters

+ + + + + + +
string  $line  section name
+
[ Top ]


+
+
+ +

processAttributes [line 297]

+
+
+
+ array processAttributes( +string $attrs, [array $return = array()]) +
+

+ + Processes width, height and alignment attributes.



+

Tags:

+
+ + + + +
return:  XML code
+
+

+ +

Parameters

+ + + + + + + + + + + +
string  $attrs  attributes
array  $return  XML code
+
[ Top ]


+
+
+ +

processFormatTags [line 264]

+
+
+
+ array processFormatTags( +string $line, string $style) +
+

+ + Formats the XML code.



+

Tags:

+
+ + + + +
return:  XML code
+
+

+ +

Parameters

+ + + + + + + + + + + +
string  $line  XML code of PDF entry
string  $style  style commands
+
[ Top ]


+
+
+ +

processLine [line 188]

+
+
+
+ array processLine( +string $line, [boolean $first_td = true], $fontName) +
+

+ + Creates the XML code for an PDF entry.



+

Tags:

+
+ + + + +
return:  XML codes
+
+

+ +

Parameters

+ + + + + + + + + + + + + + + + +
string  $line  XML code of PDF entry
boolean  $first_td  True if this is the first column
  $fontName  
+
[ Top ]


+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:10:59 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/_lib---pdfstruct.inc.html b/lam-web/developers/phpdoc/PDF/_lib---pdfstruct.inc.html new file mode 100644 index 00000000..8caebb44 --- /dev/null +++ b/lam-web/developers/phpdoc/PDF/_lib---pdfstruct.inc.html @@ -0,0 +1,293 @@ + + +Docs for page pdfstruct.inc + + + + + + + + + + + + + +
PDF
+ + + [ class tree: PDF ] + [ index: PDF ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: pdfstruct.inc

+Source Location: /lib/pdfstruct.inc

+ +
+
+ + +

Page Details:

+Functions to manage the PDF structures.



+

Tags:

+
+ + + + +
author:  Michael Dürgner
+
+

+

Includes:

+
+include_once("ldap.inc") [line 34]
+LDAP object

include_once("config.inc") [line 31]
+LAM configuration

+

+

+
+
+ +

deletePDFStructureDefinition [line 158]

+
+
+
+ boolean deletePDFStructureDefinition( +string $scope, string $definition) +
+

+ + Deletes XML file with PDF structure definitions.



+

Tags:

+
+ + + + +
return:  True if file was deleted or false if a problem occured.
+
+

+ +

Parameters

+ + + + + + + + + + + +
string  $scope  account type
string  $definition  Name of definition to delete
+
[ Top ]


+
+
+ +

getAvailableLogos [line 176]

+
+
+
+ array getAvailableLogos( +) +
+

+ + This function returns an array with all aviliable logo images.



+

Tags:

+
+ + + + +
return:  list of logo files
+
+

+ +
[ Top ]


+
+
+ +

getPDFStructureDefinitions [line 47]

+
+
+
+ array getPDFStructureDefinitions( +[string $scope = "user"]) +
+

+ + 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.
+
[ Top ]


+
+
+ +

loadPDFStructureDefinitions [line 72]

+
+
+
+ array loadPDFStructureDefinitions( +[string $scope = 'user'], [string $pdf_structure = 'default']) +
+

+ + This function is used to get pdf structure from xml file.

Used in createModulePDF.




+

Tags:

+
+ + + + +
return:  PDF structure
+
+

+ +

Parameters

+ + + + + + + + + + + +
string  $scope  The account scope for wich the PDF structure should be returned.
string  $pdf_structure  Structure name of selected scope wich should be returned.
+
[ Top ]


+
+
+ +

savePDFStructureDefinitions [line 100]

+
+
+
+ string savePDFStructureDefinitions( +string $scope, string $definition) +
+

+ + Saves PDF structure definitions to XML file in format: <name>.<scope>.xml



+

Tags:

+
+ + + + +
return:  "no perms" if access denied or "ok".
+
+

+ +

Parameters

+ + + + + + + + + + + +
string  $scope  account type
string  $definition  Name of definition
+
[ Top ]


+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:10:59 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/_lib---ufpdf.php.html b/lam-web/developers/phpdoc/PDF/_lib---ufpdf.php.html new file mode 100644 index 00000000..e390a4c6 --- /dev/null +++ b/lam-web/developers/phpdoc/PDF/_lib---ufpdf.php.html @@ -0,0 +1,146 @@ + + +Docs for page ufpdf.php + + + + + + + + + + + + + +
PDF
+ + + [ class tree: PDF ] + [ index: PDF ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: ufpdf.php

+Source Location: /lib/ufpdf.php

+ +
+
+ +
+

Classes:

+
UFPDF
+
Main UFPDF class for creating Unicode PDF documents
+


+ +

Page Details:

+This file includes UFPDF which adds Unicode support to FPDF.



+

Tags:

+
+ + + + + + + +
author:  Steven Wittens
author:  Andrea Rossato
+
+

+

Includes:

+
+include_once('fpdf.php') [line 29]
+
+

+

+
+ +

UFPDF_VERSION [line 27]

+
+
+
+ UFPDF_VERSION = '0.1' +
+
+ + *****************************************************************************

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(). * * *****************************************************************************



+
+
[ Top ]


+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:11:15 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/_lib---xml_parser.inc.html b/lam-web/developers/phpdoc/PDF/_lib---xml_parser.inc.html new file mode 100644 index 00000000..1eb651b4 --- /dev/null +++ b/lam-web/developers/phpdoc/PDF/_lib---xml_parser.inc.html @@ -0,0 +1,126 @@ + + +Docs for page xml_parser.inc + + + + + + + + + + + + + +
PDF
+ + + [ class tree: PDF ] + [ index: PDF ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: xml_parser.inc

+Source Location: /lib/xml_parser.inc

+ +
+
+ +
+

Classes:

+
xmlParser
+
+


+ +

Page Details:

+LDAP Account Manager xmlParser class



+

Tags:

+
+ + + + +
author:  Michael Duergner
+
+

+

+

+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:11:16 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfdelete.php.html b/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfdelete.php.html new file mode 100644 index 00000000..23d58fb2 --- /dev/null +++ b/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfdelete.php.html @@ -0,0 +1,126 @@ + + +Docs for page pdfdelete.php + + + + + + + + + + + + + +
PDF
+ + + [ class tree: PDF ] + [ index: PDF ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: pdfdelete.php

+Source Location: /templates/pdfedit/pdfdelete.php

+ +
+
+ + +

Page Details:

+Manages deletion of pdf structures.



+

Tags:

+
+ + + + +
author:  Michael Dürgner
+
+

+

Includes:

+
+include_once("../../lib/security.inc") [line 32]
+security functions

include_once('../../lib/pdfstruct.inc') [line 34]
+helper functions for pdf

+

+

+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:10:59 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfmain.php.html b/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfmain.php.html new file mode 100644 index 00000000..a9381cee --- /dev/null +++ b/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfmain.php.html @@ -0,0 +1,129 @@ + + +Docs for page pdfmain.php + + + + + + + + + + + + + +
PDF
+ + + [ class tree: PDF ] + [ index: PDF ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: pdfmain.php

+Source Location: /templates/pdfedit/pdfmain.php

+ +
+
+ + +

Page Details:

+This is the main window of the pdf structure editor.



+

Tags:

+
+ + + + +
author:  Michael Dürgner
+
+

+

Includes:

+
+include_once("../../lib/security.inc") [line 32]
+security functions

include_once("../../lib/pdfstruct.inc") [line 34]
+access to PDF configuration files

include_once("../../lib/ldap.inc") [line 36]
+LDAP object

include_once("../../lib/config.inc") [line 38]
+for language settings

include_once("../../lib/modules.inc") [line 40]
+module functions

+

+

+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:10:59 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfpage.php.html b/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfpage.php.html new file mode 100644 index 00000000..7d687022 --- /dev/null +++ b/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfpage.php.html @@ -0,0 +1,133 @@ + + +Docs for page pdfpage.php + + + + + + + + + + + + + +
PDF
+ + + [ class tree: PDF ] + [ index: PDF ] + [ all elements ] +
+ + + + + + +
+
+ +

Procedural File: pdfpage.php

+Source Location: /templates/pdfedit/pdfpage.php

+ +
+
+ + +

Page Details:

+Displays the main page of the PDF editor where the user can select the displayed entries.



+

Tags:

+
+ + + + + + + +
author:  Michael Duergner
author:  Roland Gruber
+
+

+

Includes:

+
+include_once('../../lib/pdfstruct.inc') [line 37]
+access to PDF configuration files

include_once("../../lib/security.inc") [line 35]
+security functions

include_once('../../lib/ldap.inc') [line 39]
+LDAP object

include_once('../../lib/config.inc') [line 41]
+LAM configuration

include_once('../../lib/xml_parser.inc') [line 45]
+XML functions

include_once('../../lib/modules.inc') [line 43]
+module functions

+

+

+
+ +
+
+ Documentation generated on Sun, 04 Nov 2007 12:10:59 +0100 by phpDocumentor 1.4.0 +
+
+
+ + + diff --git a/lam-web/developers/phpdoc/PDF/lamPDF.html b/lam-web/developers/phpdoc/PDF/lamPDF.html index 25232370..bc3c084c 100644 --- a/lam-web/developers/phpdoc/PDF/lamPDF.html +++ b/lam-web/developers/phpdoc/PDF/lamPDF.html @@ -12,9 +12,11 @@
- [ class tree: PDF ] + + + [ class tree: PDF ] [ index: PDF ] - [ all elements ] + [ all elements ]
diff --git a/lam-web/developers/phpdoc/classtrees_lists.html b/lam-web/developers/phpdoc/classtrees_lists.html index ac297878..210c5359 100644 --- a/lam-web/developers/phpdoc/classtrees_lists.html +++ b/lam-web/developers/phpdoc/classtrees_lists.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
@@ -86,7 +90,6 @@ Source Location: /lib/pdf.inc

- diff --git a/lam-web/developers/phpdoc/classtrees_lib.html b/lam-web/developers/phpdoc/classtrees_lib.html index 4ea537bb..ddb85831 100644 --- a/lam-web/developers/phpdoc/classtrees_lib.html +++ b/lam-web/developers/phpdoc/classtrees_lib.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
@@ -133,7 +136,6 @@ Source Location: /lib/pdf.inc

-

Inherited Variables

@@ -141,407 +143,349 @@ Source Location: /lib/pdf.inc

FPDF::$AliasNbPages - -
+
FPDF::$author - -
+
FPDF::$AutoPageBreak - -
+
FPDF::$bMargin - -
+
FPDF::$buffer - -
+
FPDF::$cMargin - -
+
FPDF::$ColorFlag - -
+
FPDF::$compress - -
+
FPDF::$CoreFonts - -
+
FPDF::$creator - -
+
FPDF::$CurOrientation - -
+
FPDF::$CurrentFont - -
+
FPDF::$DefOrientation - -
+
FPDF::$diffs - -
+
FPDF::$DrawColor - -
+
FPDF::$fh - -
+
FPDF::$fhPt - -
+
FPDF::$FillColor - -
+
FPDF::$FontFamily - -
+
FPDF::$FontFiles - -
+
FPDF::$fonts - -
+
FPDF::$FontSize - -
+
FPDF::$FontSizePt - -
+
FPDF::$FontStyle - -
+
FPDF::$fw - -
+
FPDF::$fwPt - -
+
FPDF::$h - -
+
FPDF::$hPt - -
+
FPDF::$images - -
+
FPDF::$InFooter - -
+
FPDF::$k - -
+
FPDF::$keywords - -
+
FPDF::$lasth - -
+
FPDF::$LayoutMode - -
+
FPDF::$LineWidth - -
+
FPDF::$links - -
+
FPDF::$lMargin - -
+
FPDF::$n - -
+
FPDF::$offsets - -
+
FPDF::$OrientationChanges - -
+
FPDF::$page - -
+
FPDF::$PageBreakTrigger - -
+
FPDF::$PageLinks - -
+
FPDF::$pages - -
+
FPDF::$PDFVersion - -
+
FPDF::$rMargin - -
+
FPDF::$state - -
+
FPDF::$subject - -
+
FPDF::$TextColor - -
+
FPDF::$title - -
+
FPDF::$tMargin - -
+
FPDF::$underline - -
+
FPDF::$w - -
+
FPDF::$wPt - -
+
FPDF::$ws - -
+
FPDF::$x - -
+
FPDF::$y - -
+
FPDF::$ZoomMode - -
+
@@ -556,140 +500,120 @@ Source Location: /lib/pdf.inc

UFPDF::UFPDF() -
*****************************************************************************
UFPDF::AcceptPageBreak() -
UFPDF::AddFont() -
UFPDF::AliasNbPages() -
UFPDF::Cell() -
UFPDF::code2utf() -
UFPDF::GetStringWidth() -
UFPDF::MultiCell() -
UFPDF::strlen() -
UFPDF::Text() -
UFPDF::utf8_substr() -
UFPDF::utf8_to_codepoints() -
UFPDF::utf8_to_utf16be() -
UFPDF::Write() -
UFPDF::_dounderline() -
UFPDF::_escapetext() -
UFPDF::_putinfo() -
UFPDF::_putpages() -
UFPDF::_puttruetypeunicode() -
*****************************************************************************
UFPDF::_textstring() -
@@ -699,497 +623,426 @@ Source Location: /lib/pdf.inc

FPDF::FPDF() -
*****************************************************************************
FPDF::AcceptPageBreak() -
FPDF::AddFont() -
FPDF::AddLink() -
FPDF::AddPage() -
FPDF::AliasNbPages() -
FPDF::Cell() -
FPDF::Close() -
FPDF::Error() -
FPDF::Footer() -
FPDF::GetStringWidth() -
FPDF::GetX() -
FPDF::GetY() -
FPDF::Header() -
FPDF::Image() -
FPDF::Line() -
FPDF::Link() -
FPDF::Ln() -
FPDF::MultiCell() -
FPDF::Open() -
FPDF::Output() -
FPDF::PageNo() -
FPDF::Rect() -
FPDF::SetAuthor() -
FPDF::SetAutoPageBreak() -
FPDF::SetCompression() -
FPDF::SetCreator() -
FPDF::SetDisplayMode() -
FPDF::SetDrawColor() -
FPDF::SetFillColor() -
FPDF::SetFont() -
FPDF::SetFontSize() -
FPDF::SetKeywords() -
FPDF::SetLeftMargin() -
FPDF::SetLineWidth() -
FPDF::SetLink() -
FPDF::SetMargins() -
FPDF::SetRightMargin() -
FPDF::SetSubject() -
FPDF::SetTextColor() -
FPDF::SetTitle() -
FPDF::SetTopMargin() -
FPDF::SetX() -
FPDF::SetXY() -
FPDF::SetY() -
FPDF::Text() -
FPDF::Write() -
FPDF::_beginpage() -
FPDF::_dochecks() -
*****************************************************************************
FPDF::_dounderline() -
FPDF::_enddoc() -
FPDF::_endpage() -
FPDF::_escape() -
FPDF::_freadint() -
FPDF::_getfontpath() -
FPDF::_newobj() -
FPDF::_out() -
FPDF::_parsejpg() -
FPDF::_parsepng() -
FPDF::_putcatalog() -
FPDF::_putfonts() -
FPDF::_putheader() -
FPDF::_putimages() -
FPDF::_putinfo() -
FPDF::_putpages() -
FPDF::_putresourcedict() -
FPDF::_putresources() -
FPDF::_putstream() -
FPDF::_puttrailer() -
FPDF::_putxobjectdict() -
FPDF::_textstring() -
@@ -1204,7 +1057,7 @@ Source Location: /lib/pdf.inc

Class Details

-[line 366]
+[line 338]
Creates a LAM information page in PDF format.



[ Top ]

@@ -1216,7 +1069,7 @@ Creates a LAM information page in PDF format.



$fontList = array(
      'BitstreamVeraSans-Roman' => array('vera.php', 'verab.php', 'verabi.php', 'verai.php'))

-

[line 382]

+

[line 354]

list of supported fonts

format: <font name> => array(<file for default font style>, <file for bold>, <italic>, <bold italic>)



@@ -1231,7 +1084,7 @@ Creates a LAM information page in PDF format.



$fontName =

-

[line 376]

+

[line 348]

current active font name


@@ -1246,7 +1099,7 @@ Creates a LAM information page in PDF format.



$page_definitions =

-

[line 371]

+

[line 343]

format settings for page layout


@@ -1267,14 +1120,14 @@ Creates a LAM information page in PDF format.




-

constructor lamPDF [line 392]

+

constructor lamPDF [line 364]

lamPDF lamPDF( [string -$account_type = "user"], [array -$page_definitions = array()], mixed +$account_type = "user"], [array +$page_definitions = array()], $fontName)

@@ -1282,8 +1135,6 @@ $fontName)

- -

Parameters:

@@ -1296,6 +1147,11 @@ $fontName) + + + + +
array   $page_definitions  
  $fontName  

@@ -1303,7 +1159,7 @@ $fontName)

-

method footer [line 448]

+

method footer [line 420]

diff --git a/lam-web/developers/phpdoc/classtrees_configuration.html b/lam-web/developers/phpdoc/classtrees_configuration.html index 30555070..9d5207c9 100644 --- a/lam-web/developers/phpdoc/classtrees_configuration.html +++ b/lam-web/developers/phpdoc/classtrees_configuration.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
diff --git a/lam-web/developers/phpdoc/classtrees_PDF.html b/lam-web/developers/phpdoc/classtrees_PDF.html index 8d207b85..e2405b68 100644 --- a/lam-web/developers/phpdoc/classtrees_PDF.html +++ b/lam-web/developers/phpdoc/classtrees_PDF.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
@@ -1315,13 +1171,11 @@ $fontName)

- -
[ Top ]

-

method header [line 416]

+

method header [line 388]

diff --git a/lam-web/developers/phpdoc/PDF/xmlParser.html b/lam-web/developers/phpdoc/PDF/xmlParser.html index 2214398d..ce369cf8 100644 --- a/lam-web/developers/phpdoc/PDF/xmlParser.html +++ b/lam-web/developers/phpdoc/PDF/xmlParser.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/classtrees_LDAP.html b/lam-web/developers/phpdoc/classtrees_LDAP.html index 8b8870a6..dc48993c 100644 --- a/lam-web/developers/phpdoc/classtrees_LDAP.html +++ b/lam-web/developers/phpdoc/classtrees_LDAP.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
@@ -1333,8 +1187,6 @@ $fontName)

- -
[ Top ]

@@ -1342,7 +1194,7 @@ $fontName)

- Documentation generated on Wed, 15 Nov 2006 18:00:55 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:59 +0100 by phpDocumentor 1.4.0
- [ class tree: PDF ] + + + [ class tree: PDF ] [ index: PDF ] - [ all elements ] + [ all elements ]
diff --git a/lam-web/developers/phpdoc/classtrees_Help.html b/lam-web/developers/phpdoc/classtrees_Help.html index 5dd5c5e7..089702af 100644 --- a/lam-web/developers/phpdoc/classtrees_Help.html +++ b/lam-web/developers/phpdoc/classtrees_Help.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
@@ -86,7 +90,6 @@ Source Location: /lib/xml_parser.inc

- -
@@ -106,12 +109,6 @@ Source Location: /lib/xml_parser.inc

-

Variables

- -
@@ -132,7 +129,6 @@ Source Location: /lib/xml_parser.inc

-

@@ -152,26 +148,6 @@ Source Location: /lib/xml_parser.inc



[ Top ]

-
- -

Class Variables

-
- -

-

$xmlParser =

-

[line 41]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-


@@ -192,8 +168,6 @@ Source Location: /lib/xml_parser.inc



- -
[ Top ]

@@ -211,8 +185,6 @@ $filename)

- -

Parameters:

@@ -230,7 +202,7 @@ $filename)

- Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:11:16 +0100 by phpDocumentor 1.4.0
- [ class tree: Help ] + + + [ class tree: Help ] [ index: Help ] - [ all elements ] + [ all elements ]
- [ class tree: LDAP ] + + + [ class tree: LDAP ] [ index: LDAP ] - [ all elements ] + [ all elements ]
- [ class tree: PDF ] + + + [ class tree: PDF ] [ index: PDF ] - [ all elements ] + [ all elements ]
- [ class tree: configuration ] + + + [ class tree: configuration ] [ index: configuration ] - [ all elements ] + [ all elements ]
- [ class tree: lib ] + + + [ class tree: lib ] [ index: lib ] - [ all elements ] + [ all elements ]
- [ class tree: lists ] + + + [ class tree: lists ] [ index: lists ] - [ all elements ] + [ all elements ]
- [ class tree: main ] + + + [ class tree: main ] [ index: main ] - [ all elements ] + [ all elements ]
- [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
- [ class tree: profiles ] + + + [ class tree: profiles ] [ index: profiles ] - [ all elements ] + [ all elements ]
- [ class tree: selfService ] + + + [ class tree: selfService ] [ index: selfService ] - [ all elements ] + [ all elements ]
- [ class tree: tests ] + + + [ class tree: tests ] [ index: tests ] - [ all elements ] + [ all elements ]
- [ class tree: tools ] + + + [ class tree: tools ] [ index: tools ] - [ all elements ] + [ all elements ]
- [ class tree: types ] + + + [ class tree: types ] [ index: types ] - [ all elements ] + [ all elements ]
- [ class tree: configuration ] + + + [ class tree: configuration ] [ index: configuration ] - [ all elements ] + [ all elements ]
@@ -78,7 +82,6 @@ Source Location: /lib/config.inc

- @@ -112,7 +114,6 @@ Source Location: /lib/config.inc

Methods

@@ -127,14 +128,13 @@ Source Location: /lib/config.inc

-
@@ -103,7 +106,6 @@ Source Location: /lib/config.inc

  • $logLevel
  • $password
  • $sessionTimeout
  • -
  • $settings

  • Class Details

    -[line 714]
    +[line 843]
    This class manages config.cfg.



    [ Top ]

    @@ -145,8 +145,17 @@ This class manages config.cfg.



    $allowedHosts =

    -

    [line 732]

    - list of hosts which may access LAM

    +

    [line 861]

    + list of hosts which may access LAM



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    +
    @@ -160,8 +169,17 @@ This class manages config.cfg.



    $default =

    -

    [line 717]

    - Default profile

    +

    [line 846]

    + Default profile



    +

    Tags:

    +
    +
    + + + +
    access:  public
    +
    +
    @@ -175,8 +193,17 @@ This class manages config.cfg.



    $logDestination =

    -

    [line 729]

    - log destination ("SYSLOG":syslog, "/...":file, "NONE":none)

    +

    [line 858]

    + log destination ("SYSLOG":syslog, "/...":file, "NONE":none)



    +

    Tags:

    +
    +
    + + + +
    access:  public
    +
    +
    @@ -190,8 +217,17 @@ This class manages config.cfg.



    $logLevel =

    -

    [line 726]

    - log level

    +

    [line 855]

    + log level



    +

    Tags:

    +
    +
    + + + +
    access:  public
    +
    +
    @@ -205,8 +241,17 @@ This class manages config.cfg.



    $password =

    -

    [line 720]

    - Password to change config.cfg

    +

    [line 849]

    + Password to change config.cfg



    +

    Tags:

    +
    +
    + + + +
    access:  public
    +
    +
    @@ -220,24 +265,17 @@ This class manages config.cfg.



    $sessionTimeout =

    -

    [line 723]

    - Time of inactivity before session times out (minutes)

    -
    -
    -
    - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $settings = array("password", "default", "sessionTimeout",
    -      "logLevel", "logDestination", "allowedHosts")

    -

    [line 735]

    - list of data fields to save in config file

    +

    [line 852]

    + Time of inactivity before session times out (minutes)



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    +
    @@ -257,7 +295,7 @@ This class manages config.cfg.




    -

    constructor LAMCfgMain [line 741]

    +

    constructor LAMCfgMain [line 870]

    diff --git a/lam-web/developers/phpdoc/configuration/LAMConfig.html b/lam-web/developers/phpdoc/configuration/LAMConfig.html index 7353f6d2..62972bfc 100644 --- a/lam-web/developers/phpdoc/configuration/LAMConfig.html +++ b/lam-web/developers/phpdoc/configuration/LAMConfig.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -269,40 +307,11 @@ This class manages config.cfg.



    Loads preferences from config file



    - - -
    [ Top ]
    - -
    - -

    method reload [line 755]

    -
    -
    -
    - boolean reload( -) -
    -

    - - Reloads preferences from config file config.cfg



    -

    Tags:

    -
    - - - - -
    return:  true if file was readable
    -
    -

    - - - -
    [ Top ]

    -

    method save [line 782]

    +

    method save [line 911]

    @@ -312,10 +321,17 @@ This class manages config.cfg.




    Saves preferences to config file config.cfg



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    +

    - -
    [ Top ]

    @@ -323,7 +339,7 @@ This class manages config.cfg.




    - Documentation generated on Wed, 15 Nov 2006 18:00:39 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:41 +0100 by phpDocumentor 1.4.0
    - [ class tree: configuration ] + + + [ class tree: configuration ] [ index: configuration ] - [ all elements ] + [ all elements ]
    @@ -78,7 +82,6 @@ Source Location: /lib/config.inc

    -
    @@ -106,9 +109,9 @@ Source Location: /lib/config.inc

  • $moduleSettings
  • $Passwd
  • $scriptPath
  • +
  • $scriptRights
  • $scriptServer
  • $ServerURL
  • -
  • $settings
  • $treesuffix
  • $typeSettings
  • @@ -131,11 +134,12 @@ Source Location: /lib/config.inc

  • get_moduleSettings
  • get_Passwd
  • get_scriptPath
  • -
  • get_scriptServer
  • +
  • get_scriptRights
  • +
  • get_scriptServers
  • get_ServerURL
  • get_Suffix
  • get_typeSettings
  • -
  • reload
  • +
  • isWritable
  • save
  • set_AccountModules
  • set_ActiveTypes
  • @@ -147,7 +151,8 @@ Source Location: /lib/config.inc

  • set_moduleSettings
  • set_Passwd
  • set_scriptPath
  • -
  • set_scriptServer
  • +
  • set_scriptRights
  • +
  • set_scriptServers
  • set_ServerURL
  • set_Suffix
  • set_typeSettings
  • @@ -164,14 +169,13 @@ Source Location: /lib/config.inc

    -

    Class Details

    -[line 123]
    +[line 164]
    This class manages .conf files.



    [ Top ]

    @@ -182,7 +186,7 @@ This class manages .conf files.



    $activeTypes =  "user,group,host,smbDomain"

    -

    [line 169]

    +

    [line 215]

    Active account types


    @@ -197,7 +201,7 @@ This class manages .conf files.



    $Admins =

    -

    [line 129]

    +

    [line 170]

    Array of string: users with admin rights


    @@ -212,7 +216,7 @@ This class manages .conf files.



    $cachetimeout =

    -

    [line 166]

    +

    [line 212]

    LDAP cache timeout


    @@ -227,7 +231,7 @@ This class manages .conf files.



    $defaultLanguage =

    -

    [line 141]

    +

    [line 182]

    Default language


    @@ -242,7 +246,7 @@ This class manages .conf files.



    $file =

    -

    [line 172]

    +

    [line 218]

    Name of configuration file


    @@ -257,7 +261,7 @@ This class manages .conf files.



    $maxlistentries =

    -

    [line 138]

    +

    [line 179]

    Maximum number of rows shown in user/group/host lists


    @@ -272,7 +276,7 @@ This class manages .conf files.



    $moduleSettings = array()

    -

    [line 144]

    +

    [line 185]

    module settings


    @@ -287,7 +291,7 @@ This class manages .conf files.



    $Passwd =

    -

    [line 132]

    +

    [line 173]

    Password to edit preferences


    @@ -302,8 +306,23 @@ This class manages .conf files.



    $scriptPath =

    -

    [line 155]

    +

    [line 196]

    Path to external lamdaemon script on server where it is executed

    This is used for managing quota and home directories. optional setting, may not be defined


    +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    + +

    +

    $scriptRights =

    +

    [line 201]

    + The rights for the home directory


    @@ -317,8 +336,8 @@ This class manages .conf files.



    $scriptServer =

    -

    [line 163]

    - Server where lamdaemon script is executed

    This is used for managing quota and home directories. optional setting, may not be defined


    +

    [line 209]

    + Servers where lamdaemon script is executed

    This is used for managing quota and home directories. optional setting, may not be defined



    @@ -332,25 +351,8 @@ This class manages .conf files.



    $ServerURL =

    -

    [line 126]

    +

    [line 167]

    Server address (e.g. ldap://127.0.0.1:389)

    -
    -
    -
    - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $settings = array("ServerURL", "Passwd", "Admins", "treesuffix", "maxlistentries",
    -      "defaultLanguage", "scriptPath", "scriptServer", "cachetimeout",
    -      "modules", "activeTypes", "types")

    -

    [line 175]

    - List of all settings in config file


    @@ -364,7 +366,7 @@ This class manages .conf files.



    $treesuffix =

    -

    [line 135]

    +

    [line 176]

    LDAP suffix for tree view


    @@ -379,7 +381,7 @@ This class manages .conf files.



    $typeSettings = array()

    -

    [line 147]

    +

    [line 188]

    type settings


    @@ -400,7 +402,7 @@ This class manages .conf files.




    -

    constructor LAMConfig [line 185]

    +

    constructor LAMConfig [line 231]

    @@ -413,8 +415,6 @@ $file = 0]) Loads preferences from config file



    - -

    Parameters:

    @@ -429,7 +429,7 @@ $file = 0])
    -

    method get_AccountModules [line 615]

    +

    method get_AccountModules [line 744]

    + + +
    @@ -446,13 +446,14 @@ $scope)
    return:  user modules
    access:  public


    - -

    Parameters:

    @@ -467,7 +468,7 @@ $scope)
    -

    method get_ActiveTypes [line 671]

    +

    method get_ActiveTypes [line 800]

    + + +
    @@ -483,18 +484,19 @@ $scope)
    return:  list of types
    access:  public


    - -
    [ Top ]

    -

    method get_Admins [line 376]

    +

    method get_Admins [line 441]

    + + +
    @@ -510,18 +512,19 @@ $scope)
    return:  the admin names
    access:  public


    - -
    [ Top ]

    -

    method get_Adminstring [line 385]

    +

    method get_Adminstring [line 450]

    + + +
    @@ -537,18 +540,19 @@ $scope)
    return:  the admin string
    access:  public


    - -
    [ Top ]

    -

    method get_cacheTimeout [line 581]

    +

    method get_cacheTimeout [line 710]

    + + +
    @@ -564,18 +568,19 @@ $scope)
    return:  cache time
    access:  public


    - -
    [ Top ]

    -

    method get_cacheTimeoutSec [line 591]

    +

    method get_cacheTimeoutSec [line 720]

    + + +
    @@ -591,18 +596,19 @@ $scope)
    return:  cache time
    access:  public


    - -
    [ Top ]

    -

    method get_defaultLanguage [line 514]

    +

    method get_defaultLanguage [line 579]

    + + +
    @@ -618,18 +624,19 @@ $scope)
    return:  default language
    access:  public


    - -
    [ Top ]

    -

    method get_listAttributes [line 467]

    +

    method get_listAttributes [line 532]

    + + +
    @@ -646,13 +653,14 @@ $scope)
    return:  the attribute list
    access:  public


    - -

    Parameters:

    @@ -667,7 +675,7 @@ $scope)
    -

    method get_MaxListEntries [line 493]

    +

    method get_MaxListEntries [line 558]

    + + +
    @@ -683,18 +691,19 @@ $scope)
    return:  maximum number
    access:  public


    - -
    [ Top ]

    -

    method get_moduleSettings [line 662]

    +

    method get_moduleSettings [line 791]

    + + +
    @@ -710,18 +719,19 @@ $scope)
    return:  list of settings: array(name => value)
    access:  public


    - -
    [ Top ]

    -

    method get_Passwd [line 409]

    +

    method get_Passwd [line 474]

    + + +
    @@ -737,18 +747,19 @@ $scope)
    return:  the password
    access:  public


    - -
    [ Top ]

    -

    method get_scriptPath [line 535]

    +

    method get_scriptPath [line 600]

    -
    @@ -764,45 +775,75 @@ $scope)
    return:  script path
    - -

    - - - - -
    [ Top ]
    - -
    - -

    method get_scriptServer [line 557]

    -
    -
    -
    - string get_scriptServer( -) -
    -

    - - Returns the server of the external script



    -

    Tags:

    -
    - - +
    return:  script serveraccess:  public


    +
    [ Top ]
    +
    +
    + +

    method get_scriptRights [line 683]

    +
    +
    +
    + string get_scriptRights( +) +
    +

    + + Returns the chmod value for new home directories.



    +

    Tags:

    +
    + + + + + + + +
    return:  rights
    access:  public
    +
    +

    + +
    [ Top ]
    +
    +
    + +

    method get_scriptServers [line 622]

    +
    +
    +
    + string get_scriptServers( +) +
    +

    + + Returns the servers of the external script as a Array



    +

    Tags:

    +
    + + + + + + + +
    return:  script servers
    access:  public
    +
    +

    +
    [ Top ]

    -

    method get_ServerURL [line 355]

    +

    method get_ServerURL [line 420]

    + + +
    @@ -818,18 +859,19 @@ $scope)
    return:  server address
    access:  public


    - -
    [ Top ]

    -

    method get_Suffix [line 431]

    +

    method get_Suffix [line 496]

    + + +
    @@ -846,13 +888,14 @@ $scope)
    return:  the LDAP suffix
    access:  public


    - -

    Parameters:

    @@ -867,7 +910,7 @@ $scope)
    -

    method get_typeSettings [line 702]

    +

    method get_typeSettings [line 831]

    -
    @@ -883,45 +926,47 @@ $scope)
    return:  list of settings: array(name => value)
    - -

    - - - - -
    [ Top ]
    - -
    - -

    method reload [line 200]

    -
    -
    -
    - boolean reload( -) -
    -

    - - Reloads preferences from config file



    -

    Tags:

    -
    - - +
    return:  true if file was readableaccess:  public


    +
    [ Top ]
    +
    +
    + +

    method isWritable [line 400]

    +
    +
    +
    + boolean isWritable( +) +
    +

    + + Returns if the file can be written on the filesystem.



    +

    Tags:

    +
    + + + + + + + +
    return:  true if file is writable
    access:  public
    +
    +

    - +
    [ Top ]

    -

    method save [line 258]

    +

    method save [line 304]

    @@ -931,15 +976,22 @@ $scope)

    Saves preferences to config file



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    +

    - -
    [ Top ]

    -

    method set_AccountModules [line 631]

    +

    method set_AccountModules [line 760]

    + + +
    @@ -957,13 +1009,14 @@ $scope)
    return:  true if $modules has correct format
    access:  public


    - -

    Parameters:

    @@ -983,7 +1036,7 @@ $scope)
    -

    method set_ActiveTypes [line 681]

    +

    method set_ActiveTypes [line 810]

    @@ -994,10 +1047,17 @@ $types)

    Sets the list of active types.



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    +

    - -

    Parameters:

    @@ -1012,7 +1072,7 @@ $types)
    -

    method set_Adminstring [line 395]

    +

    method set_Adminstring [line 460]

    diff --git a/lam-web/developers/phpdoc/li_tools.html b/lam-web/developers/phpdoc/li_tools.html index fff7f5e8..5e723652 100644 --- a/lam-web/developers/phpdoc/li_tools.html +++ b/lam-web/developers/phpdoc/li_tools.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/li_types.html b/lam-web/developers/phpdoc/li_types.html index 73579e80..a766faa8 100644 --- a/lam-web/developers/phpdoc/li_types.html +++ b/lam-web/developers/phpdoc/li_types.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/lib/AttributeType.html b/lam-web/developers/phpdoc/lib/AttributeType.html index 3a5242a5..6e8b32e3 100644 --- a/lam-web/developers/phpdoc/lib/AttributeType.html +++ b/lam-web/developers/phpdoc/lib/AttributeType.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    + + +
    @@ -1029,13 +1089,14 @@ $value)
    return:  true if $value has correct format
    access:  public


    - -

    Parameters:

    @@ -1050,7 +1111,7 @@ $value)
    -

    method set_cacheTimeout [line 601]

    +

    method set_cacheTimeout [line 730]

    diff --git a/lam-web/developers/phpdoc/li_selfService.html b/lam-web/developers/phpdoc/li_selfService.html index 5420b765..89338d11 100644 --- a/lam-web/developers/phpdoc/li_selfService.html +++ b/lam-web/developers/phpdoc/li_selfService.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/li_tests.html b/lam-web/developers/phpdoc/li_tests.html index 05c7a71a..873741db 100644 --- a/lam-web/developers/phpdoc/li_tests.html +++ b/lam-web/developers/phpdoc/li_tests.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ @@ -60,10 +63,11 @@

    LDAP Account Manager - Documentation

    Welcome to tests!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    + + +
    @@ -1067,13 +1128,14 @@ $value)
    return:  true if $value has correct format
    access:  public


    - -

    Parameters:

    @@ -1088,7 +1150,7 @@ $value)
    -

    method set_defaultLanguage [line 524]

    +

    method set_defaultLanguage [line 589]

    diff --git a/lam-web/developers/phpdoc/li_modules.html b/lam-web/developers/phpdoc/li_modules.html index 1e7c7434..05d81f0c 100644 --- a/lam-web/developers/phpdoc/li_modules.html +++ b/lam-web/developers/phpdoc/li_modules.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/li_profiles.html b/lam-web/developers/phpdoc/li_profiles.html index 0eaf377d..0c2bc9e7 100644 --- a/lam-web/developers/phpdoc/li_profiles.html +++ b/lam-web/developers/phpdoc/li_profiles.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ @@ -62,10 +65,11 @@

    LDAP Account Manager - Documentation

    Welcome to profiles!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    + + +
    @@ -1105,13 +1167,14 @@ $value)
    return:  true if $value has correct format
    access:  public


    - -

    Parameters:

    @@ -1126,7 +1189,7 @@ $value)
    -

    method set_listAttributes [line 478]

    +

    method set_listAttributes [line 543]

    diff --git a/lam-web/developers/phpdoc/li_LDAP.html b/lam-web/developers/phpdoc/li_LDAP.html index f8b022a7..1d3bb425 100644 --- a/lam-web/developers/phpdoc/li_LDAP.html +++ b/lam-web/developers/phpdoc/li_LDAP.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/li_PDF.html b/lam-web/developers/phpdoc/li_PDF.html index 12646c26..2a44c187 100644 --- a/lam-web/developers/phpdoc/li_PDF.html +++ b/lam-web/developers/phpdoc/li_PDF.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/li_configuration.html b/lam-web/developers/phpdoc/li_configuration.html index 6baaaa11..e3c5348f 100644 --- a/lam-web/developers/phpdoc/li_configuration.html +++ b/lam-web/developers/phpdoc/li_configuration.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/li_lib.html b/lam-web/developers/phpdoc/li_lib.html index 16ee425c..2767cd7e 100644 --- a/lam-web/developers/phpdoc/li_lib.html +++ b/lam-web/developers/phpdoc/li_lib.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/li_lists.html b/lam-web/developers/phpdoc/li_lists.html index f1f1d1ec..54e03b5c 100644 --- a/lam-web/developers/phpdoc/li_lists.html +++ b/lam-web/developers/phpdoc/li_lists.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/li_main.html b/lam-web/developers/phpdoc/li_main.html index 347dccea..faa9fc65 100644 --- a/lam-web/developers/phpdoc/li_main.html +++ b/lam-web/developers/phpdoc/li_main.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ @@ -66,10 +69,11 @@

    LDAP Account Manager - Documentation

    Welcome to main!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    + + +
    @@ -1144,13 +1207,14 @@ $scope)
    return:  true if $value has correct format
    access:  public


    - -

    Parameters:

    @@ -1170,7 +1234,7 @@ $scope)
    -

    method set_MaxListEntries [line 503]

    +

    method set_MaxListEntries [line 568]

    diff --git a/lam-web/developers/phpdoc/li_Help.html b/lam-web/developers/phpdoc/li_Help.html index fa83ffc9..fe50337d 100644 --- a/lam-web/developers/phpdoc/li_Help.html +++ b/lam-web/developers/phpdoc/li_Help.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ @@ -58,10 +61,11 @@

    LDAP Account Manager - Documentation

    Welcome to Help!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    + + +
    @@ -1187,13 +1251,14 @@ $value)
    return:  true if $value has correct format
    access:  public


    - -

    Parameters:

    @@ -1208,7 +1273,7 @@ $value)
    -

    method set_moduleSettings [line 651]

    +

    method set_moduleSettings [line 780]

    diff --git a/lam-web/developers/phpdoc/elementindex_tools.html b/lam-web/developers/phpdoc/elementindex_tools.html index b1ac1e53..e7421330 100644 --- a/lam-web/developers/phpdoc/elementindex_tools.html +++ b/lam-web/developers/phpdoc/elementindex_tools.html @@ -12,9 +12,11 @@ @@ -24,45 +26,46 @@ diff --git a/lam-web/developers/phpdoc/elementindex_types.html b/lam-web/developers/phpdoc/elementindex_types.html index 1e1bec13..694495e3 100644 --- a/lam-web/developers/phpdoc/elementindex_types.html +++ b/lam-web/developers/phpdoc/elementindex_types.html @@ -12,9 +12,11 @@ @@ -24,41 +26,42 @@ diff --git a/lam-web/developers/phpdoc/errors.html b/lam-web/developers/phpdoc/errors.html index a1b1b073..9c9052cf 100644 --- a/lam-web/developers/phpdoc/errors.html +++ b/lam-web/developers/phpdoc/errors.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ diff --git a/lam-web/developers/phpdoc/index.html b/lam-web/developers/phpdoc/index.html index 599dd935..eec00a64 100644 --- a/lam-web/developers/phpdoc/index.html +++ b/lam-web/developers/phpdoc/index.html @@ -12,9 +12,8 @@ @@ -24,8 +23,8 @@
    + + +
    @@ -1225,13 +1290,14 @@ $settings)
    return:  true if $settings has correct format
    access:  public


    - -

    Parameters:

    @@ -1246,7 +1312,7 @@ $settings)
    -

    method set_Passwd [line 419]

    +

    method set_Passwd [line 484]

    diff --git a/lam-web/developers/phpdoc/elementindex_selfService.html b/lam-web/developers/phpdoc/elementindex_selfService.html index 31982732..a6a49b02 100644 --- a/lam-web/developers/phpdoc/elementindex_selfService.html +++ b/lam-web/developers/phpdoc/elementindex_selfService.html @@ -12,9 +12,11 @@ @@ -24,79 +26,59 @@ diff --git a/lam-web/developers/phpdoc/elementindex_tests.html b/lam-web/developers/phpdoc/elementindex_tests.html index 28b44670..34abd3e3 100644 --- a/lam-web/developers/phpdoc/elementindex_tests.html +++ b/lam-web/developers/phpdoc/elementindex_tests.html @@ -12,9 +12,11 @@ @@ -24,33 +26,34 @@ @@ -60,7 +63,6 @@

    Element index for package tests

    [ c ] - [ i ] [ s ]
    @@ -69,17 +71,9 @@

    c

    conf-main-test.php
    -
    procedural page conf-main-test.php
    +
    procedural page conf-main-test.php
    conf-test.php
    -
    procedural page conf-test.php
    -
    - - top
    -
    - -
    -

    i

    -
    +
    procedural page conf-test.php
    top
    @@ -89,13 +83,13 @@

    s

    status-test.php
    -
    procedural page status-test.php
    +
    procedural page status-test.php
    top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    + + +
    @@ -1263,13 +1329,14 @@ $value)
    return:  true if $value has correct format
    access:  public


    - -

    Parameters:

    @@ -1284,7 +1351,7 @@ $value)
    -

    method set_scriptPath [line 545]

    +

    method set_scriptPath [line 610]

    diff --git a/lam-web/developers/phpdoc/elementindex_modules.html b/lam-web/developers/phpdoc/elementindex_modules.html index 61073f22..1bed6cce 100644 --- a/lam-web/developers/phpdoc/elementindex_modules.html +++ b/lam-web/developers/phpdoc/elementindex_modules.html @@ -12,9 +12,11 @@ @@ -24,67 +26,70 @@ diff --git a/lam-web/developers/phpdoc/elementindex_profiles.html b/lam-web/developers/phpdoc/elementindex_profiles.html index 988b21ce..b4f0a80a 100644 --- a/lam-web/developers/phpdoc/elementindex_profiles.html +++ b/lam-web/developers/phpdoc/elementindex_profiles.html @@ -12,9 +12,11 @@ @@ -24,35 +26,36 @@ @@ -63,7 +66,6 @@

    Element index for package profiles

    [ d ] [ g ] - [ i ] [ l ] [ p ] [ s ] @@ -74,7 +76,7 @@

    d

    delAccountProfile
    -
    in file profiles.inc, function delAccountProfile()
        Deletes an account profile
    +
    in file profiles.inc, function delAccountProfile()
        Deletes an account profile
    top
    @@ -84,15 +86,7 @@

    g

    getAccountProfiles
    -
    in file profiles.inc, function getAccountProfiles()
        Returns an array of string with all available profiles for the given account type
    -
    - - top
    -
    - -
    -

    i

    -
    +
    in file profiles.inc, function getAccountProfiles()
        Returns an array of string with all available profiles for the given account type
    top
    @@ -102,7 +96,7 @@

    l

    loadAccountProfile
    -
    in file profiles.inc, function loadAccountProfile()
        Loads an profile of the given account type
    +
    in file profiles.inc, function loadAccountProfile()
        Loads an profile of the given account type
    top
    @@ -112,13 +106,13 @@

    p

    profiles.inc
    -
    procedural page profiles.inc
    +
    procedural page profiles.inc
    profiledelete.php
    -
    procedural page profiledelete.php
    +
    procedural page profiledelete.php
    profilemain.php
    -
    procedural page profilemain.php
    +
    procedural page profilemain.php
    profilepage.php
    -
    procedural page profilepage.php
    +
    procedural page profilepage.php
    top
    @@ -128,13 +122,13 @@

    s

    saveAccountProfile
    -
    in file profiles.inc, function saveAccountProfile()
        Saves an hash array (attribute => value) to an account profile
    +
    in file profiles.inc, function saveAccountProfile()
        Saves an hash array (attribute => value) to an account profile
    top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    + + +
    @@ -1301,13 +1368,14 @@ $value)
    return:  true if $value has correct format
    access:  public


    - -

    Parameters:

    @@ -1321,38 +1389,78 @@ $value)
    [ Top ]

    - -

    method set_scriptServer [line 567]

    + +

    method set_scriptRights [line 694]

    - boolean set_scriptServer( + boolean set_scriptRights( string -$value) +$chmod)

    - Sets the server of the external script



    + Sets the rights for the home directory.



    Tags:

    - + + + +
    return:  true if $value has correct formatreturn:  true if values has correct format
    access:  public


    +

    Parameters:

    +
    + + + + + + +
    string  $chmod  the rights
    +

    +
    [ Top ]
    +
    +
    + +

    method set_scriptServers [line 632]

    +
    +
    +
    + boolean set_scriptServers( +string +$value) +
    +

    + + Sets the servers of the external script



    +

    Tags:

    +
    + + + + + + + +
    return:  true if $value has correct format
    access:  public
    +
    +

    - +

    Parameters:

    - +
    string   $value  new script servernew script servers

    @@ -1360,7 +1468,7 @@ $value)

    -

    method set_ServerURL [line 365]

    +

    method set_ServerURL [line 430]

    diff --git a/lam-web/developers/phpdoc/elementindex_LDAP.html b/lam-web/developers/phpdoc/elementindex_LDAP.html index aaf1bb71..0791c60c 100644 --- a/lam-web/developers/phpdoc/elementindex_LDAP.html +++ b/lam-web/developers/phpdoc/elementindex_LDAP.html @@ -12,9 +12,11 @@ @@ -24,52 +26,49 @@ diff --git a/lam-web/developers/phpdoc/elementindex_PDF.html b/lam-web/developers/phpdoc/elementindex_PDF.html index 5b57824f..13c1198c 100644 --- a/lam-web/developers/phpdoc/elementindex_PDF.html +++ b/lam-web/developers/phpdoc/elementindex_PDF.html @@ -12,9 +12,11 @@ @@ -24,51 +26,52 @@ diff --git a/lam-web/developers/phpdoc/elementindex_configuration.html b/lam-web/developers/phpdoc/elementindex_configuration.html index 42f7851b..d850dc0e 100644 --- a/lam-web/developers/phpdoc/elementindex_configuration.html +++ b/lam-web/developers/phpdoc/elementindex_configuration.html @@ -12,9 +12,11 @@ @@ -24,45 +26,46 @@ diff --git a/lam-web/developers/phpdoc/elementindex_lib.html b/lam-web/developers/phpdoc/elementindex_lib.html index 5567740a..62dbb973 100644 --- a/lam-web/developers/phpdoc/elementindex_lib.html +++ b/lam-web/developers/phpdoc/elementindex_lib.html @@ -12,9 +12,11 @@ @@ -24,37 +26,38 @@ diff --git a/lam-web/developers/phpdoc/elementindex_lists.html b/lam-web/developers/phpdoc/elementindex_lists.html index 481757cf..dc25392c 100644 --- a/lam-web/developers/phpdoc/elementindex_lists.html +++ b/lam-web/developers/phpdoc/elementindex_lists.html @@ -12,9 +12,11 @@ @@ -24,91 +26,94 @@ diff --git a/lam-web/developers/phpdoc/elementindex_main.html b/lam-web/developers/phpdoc/elementindex_main.html index c4958b81..74a2871b 100644 --- a/lam-web/developers/phpdoc/elementindex_main.html +++ b/lam-web/developers/phpdoc/elementindex_main.html @@ -12,9 +12,11 @@ @@ -24,39 +26,40 @@ @@ -77,11 +80,11 @@

    d

    deleteDN
    -
    in file delete.php, function deleteDN()
        Deletes a DN and all child entries.
    +
    in file delete.php, function deleteDN()
        Deletes a DN and all child entries.
    display_LoginPage
    -
    in file login.php, function display_LoginPage()
        Displays the login window.
    +
    in file login.php, function display_LoginPage()
        Displays the login window.
    delete.php
    -
    procedural page delete.php
    +
    procedural page delete.php
    top
    @@ -91,7 +94,7 @@

    g

    getChildCount
    -
    in file delete.php, function getChildCount()
        Returns the number of child entries of a DN.
    +
    in file delete.php, function getChildCount()
        Returns the number of child entries of a DN.
    top
    @@ -101,7 +104,7 @@

    i

    initsuff.php
    -
    procedural page initsuff.php
    +
    procedural page initsuff.php
    top
    @@ -111,9 +114,9 @@

    l

    login.php
    -
    procedural page login.php
    +
    procedural page login.php
    logout.php
    -
    procedural page logout.php
    +
    procedural page logout.php
    top
    @@ -122,16 +125,16 @@

    m

    -
    main_header.php
    -
    procedural page main_header.php
    main.php
    -
    procedural page main.php
    +
    procedural page main.php
    +
    main_header.php
    +
    procedural page main_header.php
    top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    + + +
    @@ -1377,13 +1485,14 @@ $value)
    return:  true if $value has correct format
    access:  public


    - -

    Parameters:

    @@ -1398,7 +1507,7 @@ $value)
    -

    method set_Suffix [line 447]

    +

    method set_Suffix [line 512]

    diff --git a/lam-web/developers/phpdoc/elementindex_Help.html b/lam-web/developers/phpdoc/elementindex_Help.html index 20ef430d..fcf7bea7 100644 --- a/lam-web/developers/phpdoc/elementindex_Help.html +++ b/lam-web/developers/phpdoc/elementindex_Help.html @@ -12,9 +12,11 @@ @@ -24,31 +26,32 @@ @@ -60,7 +63,6 @@ [ d ] [ e ] [ h ] - [ i ]
    @@ -68,7 +70,7 @@

    d

    displayHelp
    -
    in file help.php, function displayHelp()
        Print help site for a specific help number.
    +
    in file help.php, function displayHelp()
        Print help site for a specific help number.
    top
    @@ -78,9 +80,9 @@

    e

    echoHTMLFoot
    -
    in file help.php, function echoHTMLFoot()
        Print HTML footer of the help page.
    +
    in file help.php, function echoHTMLFoot()
        Print HTML footer of the help page.
    echoHTMLHead
    -
    in file help.php, function echoHTMLHead()
        Print HTML header of the help page.
    +
    in file help.php, function echoHTMLHead()
        Print HTML header of the help page.
    top
    @@ -90,23 +92,15 @@

    h

    help.inc
    -
    procedural page help.inc
    +
    procedural page help.inc
    help.php
    -
    procedural page help.php
    -
    - - top
    -
    - -
    -

    i

    -
    +
    procedural page help.php
    top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    + + +
    @@ -1416,13 +1525,14 @@ $value)
    return:  true if $value has correct format
    access:  public


    - -

    Parameters:

    @@ -1442,7 +1552,7 @@ $value)
    -

    method set_typeSettings [line 691]

    +

    method set_typeSettings [line 820]

    diff --git a/lam-web/developers/phpdoc/configuration/_lib---config.inc.html b/lam-web/developers/phpdoc/configuration/_lib---config.inc.html new file mode 100644 index 00000000..cd911aa0 --- /dev/null +++ b/lam-web/developers/phpdoc/configuration/_lib---config.inc.html @@ -0,0 +1,257 @@ + + +Docs for page config.inc + + + + +
    + + +
    @@ -1459,13 +1569,14 @@ $settings)
    return:  true if $settings has correct format
    access:  public


    - -

    Parameters:

    @@ -1483,7 +1594,7 @@ $settings)

    - Documentation generated on Wed, 15 Nov 2006 18:00:39 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:41 +0100 by phpDocumentor 1.4.0
    + + + + + + + + +
    configuration
    + + + [ class tree: configuration ] + [ index: configuration ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: config.inc

    +Source Location: /lib/config.inc

    + +
    +
    + +
    +

    Classes:

    +
    LAMConfig
    +
    This class manages .conf files.
    +
    LAMCfgMain
    +
    This class manages config.cfg.
    +


    + +

    Page Details:

    +This file includes functions to manage the configuration files.



    +

    Tags:

    +
    + + + + + + + +
    author:  Roland Gruber
    author:  Thomas Manninger
    +
    +

    +

    Includes:

    +
    +include_once("modules.inc") [line 36]
    +Used to get module information.

    include_once("status.inc") [line 34]
    +Used to print messages.

    include_once("types.inc") [line 38]
    +Used to get type information.

    +

    +

    +
    +
    + +

    checkChmod [line 66]

    +
    +
    +
    + true, checkChmod( +$right $right, $target $target, $chmod $chmod) +
    +

    + + Checks whether a specific flag in the rights string is set.



    +

    Tags:

    +
    + + + + +
    return:  if the chmod $right for $target were set
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    $right  $right  read,write or execute
    $target  $target  owner,group or other
    $chmod  $chmod  the chmod rights
    +
    [ Top ]


    +
    +
    + +

    getConfigProfiles [line 102]

    +
    +
    +
    + array getConfigProfiles( +) +
    +

    + + Returns an array of string with all available configuration profiles (without .conf)



    +

    Tags:

    +
    + + + + +
    return:  profile names
    +
    +

    + +
    [ Top ]


    +
    +
    + +

    LAMVersion [line 126]

    +
    +
    +
    + string LAMVersion( +) +
    +

    + + 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).




    +

    Tags:

    +
    + + + + +
    return:  version number
    +
    +

    + +
    [ Top ]


    +
    +
    + +

    metaRefresh [line 144]

    +
    +
    +
    + void metaRefresh( +string $page) +
    +

    + + Prints a meta refresh page



    + +

    Parameters

    + + + + + + +
    string  $page  the URL of the target page
    +
    [ Top ]


    +
    +
    + +

    setlanguage [line 43]

    +
    +
    +
    + void setlanguage( +) +
    +

    + + Sets language settings for automatic translation



    + +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:41 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/configuration/_templates---config---conflogin.php.html b/lam-web/developers/phpdoc/configuration/_templates---config---conflogin.php.html new file mode 100644 index 00000000..3054b369 --- /dev/null +++ b/lam-web/developers/phpdoc/configuration/_templates---config---conflogin.php.html @@ -0,0 +1,118 @@ + + +Docs for page conflogin.php + + + + + + + + + + + + + +
    configuration
    + + + [ class tree: configuration ] + [ index: configuration ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: conflogin.php

    +Source Location: /templates/config/conflogin.php

    + +
    +
    + + +

    Page Details:

    +Login page to change the preferences.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/config.inc') [line 34]
    +Access to config functions

    include_once('../../lib/status.inc') [line 36]
    +Used to print status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:43 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/configuration/_templates---config---confmain.php.html b/lam-web/developers/phpdoc/configuration/_templates---config---confmain.php.html new file mode 100644 index 00000000..ab85f110 --- /dev/null +++ b/lam-web/developers/phpdoc/configuration/_templates---config---confmain.php.html @@ -0,0 +1,138 @@ + + +Docs for page confmain.php + + + + + + + + + + + + + +
    configuration
    + + + [ class tree: configuration ] + [ index: configuration ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: confmain.php

    +Source Location: /templates/config/confmain.php

    + +
    +
    + + +

    Page Details:

    +Main page of configuration



    +

    Tags:

    +
    + + + + + + + +
    author:  Roland Gruber
    author:  Thomas Manninger
    +
    +

    +

    Includes:

    +
    +include_once("../../lib/config.inc") [line 35]
    +Access to config functions

    include_once("../../lib/modules.inc") [line 38]
    +access to module settings

    require('conflogin.php') [line 73]
    +go back to login if password is invalid

    require('conflogin.php') [line 55]
    +go back to login if password is empty

    +

    +

    +
    +
    + +

    saveSettings [line 463]

    +
    +
    +
    + void saveSettings( +) +
    +

    + + Saves the entered settings.



    + +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:43 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/configuration/_templates---config---confmodules.php.html b/lam-web/developers/phpdoc/configuration/_templates---config---confmodules.php.html new file mode 100644 index 00000000..1623c45c --- /dev/null +++ b/lam-web/developers/phpdoc/configuration/_templates---config---confmodules.php.html @@ -0,0 +1,156 @@ + + +Docs for page confmodules.php + + + + + + + + + + + + + +
    configuration
    + + + [ class tree: configuration ] + [ index: configuration ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: confmodules.php

    +Source Location: /templates/config/confmodules.php

    + +
    +
    + + +

    Page Details:

    +confmodules lets the user select the account modules



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/config.inc') [line 34]
    +Access to config functions

    include_once('../../lib/modules.inc') [line 36]
    +Access to module lists

    require('conflogin.php') [line 49]
    +go back to login if password is invalid

    +

    +

    +
    +
    + +

    config_showAccountModules [line 138]

    +
    +
    +
    + boolean config_showAccountModules( +string $scope, string $title) +
    +

    + + Displays the module selection boxes and checks if dependencies are fulfilled.



    +

    Tags:

    +
    + + + + +
    return:  true if all dependencies are ok
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    string  $scope  account type
    string  $title  title for module selection (e.g. "User modules")
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:43 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/configuration/_templates---config---conftypes.php.html b/lam-web/developers/phpdoc/configuration/_templates---config---conftypes.php.html new file mode 100644 index 00000000..9e7a54f4 --- /dev/null +++ b/lam-web/developers/phpdoc/configuration/_templates---config---conftypes.php.html @@ -0,0 +1,119 @@ + + +Docs for page conftypes.php + + + + + + + + + + + + + +
    configuration
    + + + [ class tree: configuration ] + [ index: configuration ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: conftypes.php

    +Source Location: /templates/config/conftypes.php

    + +
    +
    + + +

    Page Details:

    +Here the user can select the account types.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/config.inc') [line 34]
    +Access to config functions

    include_once('../../lib/types.inc') [line 36]
    +Access to account types

    require('conflogin.php') [line 48]
    +go back to login if password is invalid

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:43 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/configuration/_templates---config---index.php.html b/lam-web/developers/phpdoc/configuration/_templates---config---index.php.html new file mode 100644 index 00000000..14c98ca8 --- /dev/null +++ b/lam-web/developers/phpdoc/configuration/_templates---config---index.php.html @@ -0,0 +1,117 @@ + + +Docs for page index.php + + + + + + + + + + + + + +
    configuration
    + + + [ class tree: configuration ] + [ index: configuration ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: index.php

    +Source Location: /templates/config/index.php

    + +
    +
    + + +

    Page Details:

    +Displays links to all configuration pages.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/config.inc') [line 34]
    +Access to config functions

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:51 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/configuration/_templates---config---mainlogin.php.html b/lam-web/developers/phpdoc/configuration/_templates---config---mainlogin.php.html new file mode 100644 index 00000000..a40a79ac --- /dev/null +++ b/lam-web/developers/phpdoc/configuration/_templates---config---mainlogin.php.html @@ -0,0 +1,118 @@ + + +Docs for page mainlogin.php + + + + + + + + + + + + + +
    configuration
    + + + [ class tree: configuration ] + [ index: configuration ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: mainlogin.php

    +Source Location: /templates/config/mainlogin.php

    + +
    +
    + + +

    Page Details:

    +Login page to change the main preferences.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/config.inc') [line 34]
    +Access to config functions

    include_once('../../lib/status.inc') [line 36]
    +Used to print status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:56 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/configuration/_templates---config---mainmanage.php.html b/lam-web/developers/phpdoc/configuration/_templates---config---mainmanage.php.html new file mode 100644 index 00000000..ace8a38e --- /dev/null +++ b/lam-web/developers/phpdoc/configuration/_templates---config---mainmanage.php.html @@ -0,0 +1,119 @@ + + +Docs for page mainmanage.php + + + + + + + + + + + + + +
    configuration
    + + + [ class tree: configuration ] + [ index: configuration ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: mainmanage.php

    +Source Location: /templates/config/mainmanage.php

    + +
    +
    + + +

    Page Details:

    +Manages the main configuration options.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/config.inc') [line 34]
    +Access to config functions

    include_once('../../lib/status.inc') [line 36]
    +Used to print status messages

    require('mainlogin.php') [line 48]
    +
    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:56 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/configuration/_templates---config---profmanage.php.html b/lam-web/developers/phpdoc/configuration/_templates---config---profmanage.php.html new file mode 100644 index 00000000..82cdb18c --- /dev/null +++ b/lam-web/developers/phpdoc/configuration/_templates---config---profmanage.php.html @@ -0,0 +1,118 @@ + + +Docs for page profmanage.php + + + + + + + + + + + + + +
    configuration
    + + + [ class tree: configuration ] + [ index: configuration ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: profmanage.php

    +Source Location: /templates/config/profmanage.php

    + +
    +
    + + +

    Page Details:

    +Configuration profile management.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/config.inc') [line 34]
    +Access to config functions

    include_once('../../lib/status.inc') [line 36]
    +Used to print status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:02 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/elementindex.html b/lam-web/developers/phpdoc/elementindex.html index da589f86..06a7353a 100644 --- a/lam-web/developers/phpdoc/elementindex.html +++ b/lam-web/developers/phpdoc/elementindex.html @@ -7,14 +7,13 @@ - + @@ -24,23 +23,23 @@
    profiles
    - [ class tree: profiles ] - [ index: profiles ] - [ all elements ] + + [ all elements ]
    @@ -93,15 +92,11 @@
    $attrArray
    in file lists.inc, variable lamList::$attrArray
        list of LDAP attributes
    $attributes
    -
    in file cache.inc, variable cache::$attributes
        This variable contains a list and their scope of attributes which should be cached
    +
    in file modules.inc, variable accountContainer::$attributes
        Array of all used attributes
    $attributes
    in file export.inc, variable PlaLdapExporter::$attributes
    $attributes
    in file baseModule.inc, variable baseModule::$attributes
        contains all ldap attributes which should be written
    -
    $attributes
    -
    in file ldap.inc, variable Ldap::$attributes
        Array with all attribute strings from the LDAP server
    -
    $attributes
    -
    in file modules.inc, variable accountContainer::$attributes
        Array of all used attributes
    $attributes_orig
    in file modules.inc, variable accountContainer::$attributes_orig
        original LDAP attributes when account was loaded from LDAP
    $author
    @@ -141,43 +136,41 @@
    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'.
    +
    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 schema.inc, function add_sup_to_attrs()
        Adds inherited values to each attributeType specified by the SUP directive.
    AliasNbPages
    in file ufpdf.php, method UFPDF::AliasNbPages()
    AliasNbPages
    in file fpdf.php, method FPDF::AliasNbPages()
    arrayLower
    -
    in file tree.inc, function arrayLower()
    +
    in file tree.inc, function arrayLower()
    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, class AttributeType
        Represents an LDAP AttributeType
    +
    in file account.inc, function array_delete()
        This function will return all values from $array without values of $values.
    +
    array_stripslashes
    +
    in file tree.inc, function array_stripslashes()
        Strips all slashes from the specified array in place (pass by ref).
    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
    account.inc
    -
    procedural page account.inc
    +
    procedural page account.inc
    account.inc
    -
    procedural page account.inc
    -
    adminLogin.php
    -
    procedural page adminLogin.php
    -
    adminMain.php
    -
    procedural page adminMain.php
    -
    add_attr_form.php
    -
    procedural page add_attr_form.php
    +
    procedural page account.inc
    add_attr.php
    -
    procedural page add_attr.php
    -
    add_oclass_form.php
    -
    procedural page add_oclass_form.php
    +
    procedural page add_attr.php
    +
    add_attr_form.php
    +
    procedural page add_attr_form.php
    add_oclass.php
    -
    procedural page add_oclass.php
    -
    add_value_form.php
    -
    procedural page add_value_form.php
    +
    procedural page add_oclass.php
    +
    add_oclass_form.php
    +
    procedural page add_oclass_form.php
    add_value.php
    -
    procedural page add_value.php
    +
    procedural page add_value.php
    +
    add_value_form.php
    +
    procedural page add_value_form.php
    top
    @@ -186,10 +179,6 @@

    b

    -
    $base
    -
    in file baseModule.inc, variable baseModule::$base
        name of parent accountContainer ($_SESSION[$base])
    -
    $base
    -
    in file modules.inc, variable accountContainer::$base
        Name of accountContainer variable in session
    $base_dn
    in file export.inc, variable LdapExportInfo::$base_dn
    $bMargin
    @@ -199,32 +188,32 @@
    $buffer
    in file fpdf.php, variable FPDF::$buffer
    baseModule
    -
    in file baseModule.inc, class baseModule
        Parent class of all account modules
    +
    in file baseModule.inc, class baseModule
        Parent class of all account modules.
    baseModule
    in file baseModule.inc, method baseModule::baseModule()
        Creates a new base module class
    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.
    +
    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 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
    build_uploadAccounts
    in file posixGroup.inc, method posixGroup::build_uploadAccounts()
        In this function the LDAP account is built up.
    build_uploadAccounts
    in file posixAccount.inc, method posixAccount::build_uploadAccounts()
        In this function the LDAP account is built up.
    build_uploadAccounts
    +
    in file shadowAccount.inc, method shadowAccount::build_uploadAccounts()
        In this function the LDAP account is built up.
    +
    build_uploadAccounts
    in file sambaAccount.inc, method sambaAccount::build_uploadAccounts()
        In this function the LDAP account is built up.
    build_uploadAccounts
    +
    in file sambaDomain.inc, method sambaDomain::build_uploadAccounts()
        In this function the LDAP account is built up.
    +
    build_uploadAccounts
    +
    in file sambaSamAccount.inc, method sambaSamAccount::build_uploadAccounts()
        In this function the LDAP account is built up.
    +
    build_uploadAccounts
    in file sambaGroupMapping.inc, method sambaGroupMapping::build_uploadAccounts()
        In this function the LDAP account is built up.
    build_uploadAccounts
    in file nisMailAlias.inc, method nisMailAlias::build_uploadAccounts()
        In this function the LDAP account is built up.
    build_uploadAccounts
    -
    in file shadowAccount.inc, method shadowAccount::build_uploadAccounts()
        In this function the LDAP account is built up.
    -
    build_uploadAccounts
    -
    in file sambaSamAccount.inc, method sambaSamAccount::build_uploadAccounts()
        In this function the LDAP account is built up.
    -
    build_uploadAccounts
    -
    in file sambaDomain.inc, method sambaDomain::build_uploadAccounts()
        In this function the LDAP account is built up.
    -
    build_uploadAccounts
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::build_uploadAccounts()
        In this function the LDAP account is built up.
    build_uploadAccounts
    in file ieee802device.inc, method ieee802Device::build_uploadAccounts()
        In this function the LDAP account is built up.
    @@ -239,9 +228,9 @@
    build_uploadAccounts
    in file inetOrgPerson.inc, method inetOrgPerson::build_uploadAccounts()
        In this function the LDAP account is built up.
    baseModule.inc
    -
    procedural page baseModule.inc
    +
    procedural page baseModule.inc
    baseType.inc
    -
    procedural page baseType.inc
    +
    procedural page baseType.inc
    top
    @@ -252,126 +241,128 @@
    $cachetimeout
    in file config.inc, variable LAMConfig::$cachetimeout
        LDAP cache timeout
    -
    $changegids
    -
    in file posixGroup.inc, variable posixGroup::$changegids
        change GIDs of users and hosts?
    $children_objectclasses
    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)
    -
    $clearTextPassword
    -
    in file posixAccount.inc, variable posixAccount::$clearTextPassword
    $cMargin
    in file fpdf.php, variable FPDF::$cMargin
    $ColorFlag
    in file fpdf.php, variable FPDF::$ColorFlag
    $compress
    in file fpdf.php, variable FPDF::$compress
    -
    $conf
    -
    in file ldap.inc, variable Ldap::$conf
        Object of Config to access preferences
    $CoreFonts
    in file fpdf.php, variable FPDF::$CoreFonts
    $counter
    -
    in file export.inc, variable PlaLdifExporter::$counter
    -
    $counter
    in file export.inc, variable PlaDsmlExporter::$counter
    -
    $createhomedir
    -
    in file posixAccount.inc, variable posixAccount::$createhomedir
    +
    $counter
    +
    in file export.inc, variable PlaLdifExporter::$counter
    $creator
    in file fpdf.php, variable FPDF::$creator
    +
    $ctx
    +
    in file sambaMungedDial.inc, variable sambaMungedDial::$ctx
    +
    $ctxattributes
    +
    in file sambaMungedDial.inc, variable sambaMungedDial::$ctxattributes
    $CurOrientation
    in file fpdf.php, variable FPDF::$CurOrientation
    $CurrentFont
    in file fpdf.php, variable FPDF::$CurrentFont
    -
    $current_page
    -
    in file modules.inc, variable accountContainer::$current_page
        This variable stores the name of the currently displayed page
    -
    cache
    -
    in file cache.inc, method cache::cache()
        Constructor.
    cache
    in file cache.inc, class cache
        This class contains all functions which are needed to manage the LDAP cache.
    +
    cache
    +
    in file cache.inc, method cache::cache()
        Constructor.
    cached_schema_available
    -
    in file schema.inc, function cached_schema_available()
        Returns true if the schema for $schema_type has been cached and
    +
    in file schema.inc, function cached_schema_available()
        Returns true if the schema for $schema_type has been cached and
    can_manage
    in file baseModule.inc, method baseModule::can_manage()
        Returns true if this module fits for the current scope.
    Cell
    -
    in file ufpdf.php, method UFPDF::Cell()
    -
    Cell
    in file fpdf.php, method FPDF::Cell()
    +
    Cell
    +
    in file ufpdf.php, method UFPDF::Cell()
    checkASCII
    in file posixAccount.inc, method posixAccount::checkASCII()
        Checks if an attribute contains only ASCII charaters and replaces invalid characters.
    +
    checkChmod
    +
    in file config.inc, function checkChmod()
        Checks whether a specific flag in the rights string is set.
    checkClientIP
    -
    in file security.inc, function checkClientIP()
        Checks if the client's IP address is on the list of allowed IPs.
    +
    in file security.inc, function checkClientIP()
        Checks if the client's IP address is on the list of allowed IPs.
    checkConfigOptions
    -
    in file modules.inc, function checkConfigOptions()
        Checks if the configuration options are valid
    +
    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 baseModule.inc, method baseModule::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 sambaSamAccount.inc, method sambaSamAccount::checkSelfServiceOptions()
        Checks if all input values are correct and returns the LDAP commands which should be executed.
    +
    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 baseModule.inc, method baseModule::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.
    -
    check_configOptions
    -
    in file baseModule.inc, method baseModule::check_configOptions()
        Checks input values of module settings.
    +
    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.
    +
    checkSelfServiceSettings
    +
    in file selfService.inc, function checkSelfServiceSettings()
        Checks if the self service settings are valid
    +
    checkSelfServiceSettings
    +
    in file baseModule.inc, method baseModule::checkSelfServiceSettings()
        Checks if the self service settings are valid.
    check_configOptions
    in file posixAccount.inc, method posixAccount::check_configOptions()
        Checks input values of module settings.
    +
    check_configOptions
    +
    in file baseModule.inc, method baseModule::check_configOptions()
        Checks input values of module settings.
    +
    check_ip
    +
    in file account.inc, function check_ip()
        This function checks if the given IP ist valid.
    check_module_conflicts
    -
    in file modules.inc, function check_module_conflicts()
        Checks if there are conflicts between modules
    +
    in file modules.inc, function check_module_conflicts()
        Checks if there are conflicts between modules
    check_module_depends
    -
    in file modules.inc, function check_module_depends()
        Checks if there are missing dependencies between modules.
    +
    in file modules.inc, function check_module_depends()
        Checks if there are missing dependencies between modules.
    check_profileOptions
    in file baseModule.inc, method baseModule::check_profileOptions()
        Checks input values of account profiles.
    check_profileOptions
    in file quota.inc, method quota::check_profileOptions()
        Checks input values of account profiles.
    -
    close
    -
    in file ldap.inc, method Ldap::close()
        Closes connection to server
    Close
    in file fpdf.php, method FPDF::Close()
    +
    close
    +
    in file ldap.inc, method Ldap::close()
        Closes connection to server
    cmp_array
    in file ldap.inc, method Ldap::cmp_array()
        Helper function to sort the unit DNs
    cmp_array
    in file lists.inc, method lamList::cmp_array()
        Compare function used for usort-method
    cmp_domain
    -
    in file account.inc, function cmp_domain()
        Helper function to sort the domains
    +
    in file account.inc, function cmp_domain()
        Helper function to sort the domains
    code2utf
    in file ufpdf.php, method UFPDF::code2utf()
    config_showAccountModules
    -
    in file confmodules.php, function config_showAccountModules()
        Displays the module selection boxes and checks if dependencies are fulfilled.
    +
    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 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.
    cache.inc
    -
    procedural page cache.inc
    +
    procedural page cache.inc
    config.inc
    -
    procedural page config.inc
    +
    procedural page config.inc
    createntlm.inc
    -
    procedural page createntlm.inc
    +
    procedural page createntlm.inc
    conflogin.php
    -
    procedural page conflogin.php
    +
    procedural page conflogin.php
    confmain.php
    -
    procedural page confmain.php
    +
    procedural page confmain.php
    confmodules.php
    -
    procedural page confmodules.php
    +
    procedural page confmodules.php
    conftypes.php
    -
    procedural page conftypes.php
    +
    procedural page conftypes.php
    collapse.php
    -
    procedural page collapse.php
    -
    create_form.php
    -
    procedural page create_form.php
    +
    procedural page collapse.php
    create.php
    -
    procedural page create.php
    +
    procedural page create.php
    +
    create_form.php
    +
    procedural page create_form.php
    creation_template.php
    -
    procedural page creation_template.php
    +
    procedural page creation_template.php
    custom.php
    -
    procedural page custom.php
    +
    procedural page custom.php
    conf-main-test.php
    -
    procedural page conf-main-test.php
    +
    procedural page conf-main-test.php
    conf-test.php
    -
    procedural page conf-test.php
    +
    procedural page conf-test.php
    top
    @@ -380,10 +371,6 @@

    d

    -
    $deactivated
    -
    in file sambaAccount.inc, variable sambaAccount::$deactivated
        account deactivated?
    -
    $deactivated
    -
    in file sambaSamAccount.inc, variable sambaSamAccount::$deactivated
        account deactivated?
    $default
    in file config.inc, variable LAMCfgMain::$default
        Default profile
    $defaultLanguage
    @@ -406,64 +393,64 @@
    in file modules.inc, variable accountContainer::$dn_orig
        DN suffix of account when it was loaded
    $DrawColor
    in file fpdf.php, variable FPDF::$DrawColor
    +
    decode_munged
    +
    in file sambaMungedDial.inc, method sambaMungedDial::decode_munged()
        Takes a base64-encoded MungedDial-String and returns an array of included parameters and values
    decrypt
    in file ldap.inc, method Ldap::decrypt()
        Decrypts a string
    decrypt_login
    in file ldap.inc, method Ldap::decrypt_login()
        Decrypts username and password
    delAccountProfile
    -
    in file profiles.inc, function delAccountProfile()
        Deletes an account profile
    +
    in file profiles.inc, function delAccountProfile()
        Deletes an account profile
    deleteDN
    -
    in file delete.php, function deleteDN()
        Deletes a DN and all child entries.
    +
    in file delete.php, function deleteDN()
        Deletes a DN and all child entries.
    deletePDFStructureDefinition
    -
    in file pdfstruct.inc, function deletePDFStructureDefinition()
        Deletes XML file with PDF structure definitions.
    +
    in file pdfstruct.inc, function deletePDFStructureDefinition()
        Deletes XML file with PDF structure definitions.
    delete_attributes
    -
    in file quota.inc, method quota::delete_attributes()
    -
    delete_attributes
    -
    in file posixGroup.inc, method posixGroup::delete_attributes()
    +
    in file baseModule.inc, method baseModule::delete_attributes()
        Dummy function for modules which use no special options on account deletion.
    delete_attributes
    in file posixAccount.inc, method posixAccount::delete_attributes()
        Additional LDAP operations on delete.
    delete_attributes
    -
    in file baseModule.inc, method baseModule::delete_attributes()
        Dummy function for modules which use no special options on account deletion.
    +
    in file posixGroup.inc, method posixGroup::delete_attributes()
        Checks if the group which should be deleted is still used as primary group.
    destroy
    in file ldap.inc, method Ldap::destroy()
        Closes connection to LDAP server and deletes encrypted username/password
    displayExportInfo
    in file export.inc, method PlaLdifExporter::displayExportInfo()
    displayHelp
    -
    in file help.php, function displayHelp()
        Print help site for a specific help number.
    +
    in file help.php, function displayHelp()
        Print help site for a specific help number.
    display_html_attributes
    -
    in file quota.inc, method quota::display_html_attributes()
    +
    in file sambaDomain.inc, method sambaDomain::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file posixGroup.inc, method posixGroup::display_html_attributes()
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file posixAccount.inc, method posixAccount::display_html_attributes()
    +
    in file ieee802device.inc, method ieee802Device::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file sambaAccount.inc, method sambaAccount::display_html_attributes()
    +
    in file account.inc, method account::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file nisMailAlias.inc, method nisMailAlias::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    +
    in file sambaAccount.inc, method sambaAccount::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file account.inc, method account::display_html_attributes()
    +
    in file quota.inc, method quota::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file sambaDomain.inc, method sambaDomain::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    +
    in file nisMailAlias.inc, method nisMailAlias::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file ieee802device.inc, method ieee802Device::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    +
    in file inetOrgPerson.inc, method inetOrgPerson::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file sambaSamAccount.inc, method sambaSamAccount::display_html_attributes()
    +
    in file ldapPublicKey.inc, method ldapPublicKey::display_html_attributes()
        Returns the HTML meta data for the main account page.
    +
    display_html_attributes
    +
    in file posixGroup.inc, method posixGroup::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    in file shadowAccount.inc, method shadowAccount::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    display_html_attributes
    -
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    +
    in file posixAccount.inc, method posixAccount::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file inetOrgPerson.inc, method inetOrgPerson::display_html_attributes()
    +
    in file kolabUser.inc, method kolabUser::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::display_html_attributes()
    +
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file ldapPublicKey.inc, method ldapPublicKey::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    -
    display_html_attributes
    -
    in file kolabUser.inc, method kolabUser::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    +
    in file sambaSamAccount.inc, method sambaSamAccount::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_delete
    in file baseModule.inc, method baseModule::display_html_delete()
        Dummy function for modules which do not print extra HTML code on account deletion.
    display_html_delete
    -
    in file posixAccount.inc, method posixAccount::display_html_delete()
    +
    in file posixAccount.inc, method posixAccount::display_html_delete()
        Displays the delete homedir option for the delete page.
    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
    @@ -473,57 +460,61 @@
    display_html_logonHours
    in file sambaSamAccount.inc, method sambaSamAccount::display_html_logonHours()
        This function will create the HTML page to edit logon hours.
    display_html_password
    -
    in file posixAccount.inc, method posixAccount::display_html_password()
        Displays the password changing dialog.
    -
    display_html_password
    in file posixGroup.inc, method posixGroup::display_html_password()
        Displays the password changing dialog.
    display_html_password
    +
    in file posixAccount.inc, method posixAccount::display_html_password()
        Displays the password changing dialog.
    +
    display_html_password
    in file inetOrgPerson.inc, method inetOrgPerson::display_html_password()
        Displays the password changing dialog.
    display_html_photo
    in file inetOrgPerson.inc, method inetOrgPerson::display_html_photo()
        Displays the photo upload page.
    display_html_sambaUserWorkstations
    -
    in file sambaSamAccount.inc, method sambaSamAccount::display_html_sambaUserWorkstations()
    +
    in file sambaSamAccount.inc, method sambaSamAccount::display_html_sambaUserWorkstations()
        This function will create the HTML page to edit the allowed workstations.
    +
    display_html_terminalServer
    +
    in file sambaSamAccount.inc, method sambaSamAccount::display_html_terminalServer()
        This function will create the HTML page to edit the terminal server options.
    display_html_time
    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.
    display_html_userWorkstations
    -
    in file sambaAccount.inc, method sambaAccount::display_html_userWorkstations()
    +
    in file sambaAccount.inc, method sambaAccount::display_html_userWorkstations()
        This function will create the HTML page to edit the allowed workstations.
    display_LoginPage
    -
    in file login.php, function display_LoginPage()
        Displays the login window.
    +
    in file login.php, function display_LoginPage()
        Displays the login window.
    display_main
    -
    in file ou_edit.php, function display_main()
    +
    in file ou_edit.php, function display_main()
    dn_exists
    -
    in file tree.inc, function dn_exists()
        Gets whether an entry exists based on its DN. If the entry exists, returns true. Otherwise returns false.
    +
    in file tree.inc, function dn_exists()
        Gets whether an entry exists based on its DN. If the entry exists, returns true. Otherwise returns false.
    doHash
    in file createntlm.inc, method smbHash::doHash()
    doUploadPostActions
    -
    in file quota.inc, method quota::doUploadPostActions()
        This function executes one post upload action.
    -
    doUploadPostActions
    in file posixAccount.inc, method posixAccount::doUploadPostActions()
        This function executes one post upload action.
    doUploadPostActions
    -
    in file baseModule.inc, method baseModule::doUploadPostActions()
        This function executes one post upload action.
    +
    in file modules.inc, function doUploadPostActions()
        This function executes one post upload action.
    doUploadPostActions
    -
    in file modules.inc, function doUploadPostActions()
        This function executes one post upload action.
    +
    in file quota.inc, method quota::doUploadPostActions()
        This function executes one post upload action.
    +
    doUploadPostActions
    +
    in file baseModule.inc, method baseModule::doUploadPostActions()
        This function executes one post upload action.
    draw_create_link
    -
    in file tree.php, function draw_create_link()
    +
    in file tree.php, function draw_create_link()
    draw_formatted_dn
    -
    in file tree.inc, function draw_formatted_dn()
        Gets a DN string using the user-configured tree_display_format string to format it.
    +
    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.
    +
    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.
    +
    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.php, function draw_tree_html()
        Recursively descend on the given dn and draw the tree in html
    delete.php
    -
    procedural page delete.php
    +
    procedural page delete.php
    +
    deletelink.php
    +
    procedural page deletelink.php
    +
    delete.php
    +
    procedural page delete.php
    delete_attr.php
    -
    procedural page delete_attr.php
    +
    procedural page delete_attr.php
    delete_form.php
    -
    procedural page delete_form.php
    -
    delete.php
    -
    procedural page delete.php
    +
    procedural page delete_form.php
    download_binary_attr.php
    -
    procedural page download_binary_attr.php
    +
    procedural page download_binary_attr.php
    top
    @@ -545,41 +536,45 @@
    $exporter
    in file export.inc, variable PlaExporter::$exporter
    echoHTMLFoot
    -
    in file help.php, function echoHTMLFoot()
        Print HTML footer of the help page.
    +
    in file help.php, function echoHTMLFoot()
        Print HTML footer of the help page.
    echoHTMLHead
    -
    in file help.php, function echoHTMLHead()
        Print HTML header of the help page.
    +
    in file help.php, function echoHTMLHead()
        Print HTML header of the help page.
    +
    encode_munged
    +
    in file sambaMungedDial.inc, method sambaMungedDial::encode_munged()
        Encode full MungedDial-String
    encrypt
    in file ldap.inc, method Ldap::encrypt()
        Encrypts a string
    encrypt_login
    in file ldap.inc, method Ldap::encrypt_login()
        Encrypts username and password
    +
    endian
    +
    in file sambaMungedDial.inc, method sambaMungedDial::endian()
        endian
    Error
    in file fpdf.php, method FPDF::Error()
    export
    in file export.inc, method PlaVcardExporter::export()
        When doing an exporter, the method export need to be overriden.
    export
    -
    in file export.inc, method PlaLdifExporter::export()
        Export entries to ldif format
    -
    export
    -
    in file export.inc, method PlaCSVExporter::export()
    -
    export
    -
    in file export.inc, method MyCustomExporter::export()
        When doing an exporter, the method export need to be overriden.
    +
    in file export.inc, method PlaExporter::export()
        Abstract method use to export data.
    export
    in file export.inc, method PlaDsmlExporter::export()
        Export the entries to DSML
    export
    -
    in file export.inc, method PlaExporter::export()
        Abstract method use to export data.
    +
    in file export.inc, method PlaCSVExporter::export()
    +
    export
    +
    in file export.inc, method PlaLdifExporter::export()
        Export entries to ldif format
    +
    export
    +
    in file export.inc, method MyCustomExporter::export()
        When doing an exporter, the method export need to be overriden.
    E_P16
    -
    in file createntlm.inc, method smbHash::E_P16()
    +
    in file createntlm.inc, method smbHash::E_P16()
        E_P16
    export.inc
    -
    procedural page export.inc
    +
    procedural page export.inc
    edit.php
    -
    procedural page edit.php
    +
    procedural page edit.php
    edit.php
    -
    procedural page edit.php
    +
    procedural page edit.php
    expand.php
    -
    procedural page expand.php
    -
    export_form.php
    -
    procedural page export_form.php
    +
    procedural page expand.php
    export.php
    -
    procedural page export.php
    +
    procedural page export.php
    +
    export_form.php
    +
    procedural page export_form.php
    top
    @@ -631,9 +626,9 @@
    FPDF
    in file fpdf.php, class FPDF
        Main FPDF class for creating PDF documents
    FPDF_VERSION
    -
    in file fpdf.php, constant FPDF_VERSION
        *****************************************************************************
    +
    in file fpdf.php, constant FPDF_VERSION
        *****************************************************************************
    fpdf.php
    -
    procedural page fpdf.php
    +
    procedural page fpdf.php
    top
    @@ -642,82 +637,102 @@

    g

    -
    $groups
    -
    in file posixAccount.inc, variable posixAccount::$groups
    -
    $groups_orig
    -
    in file posixAccount.inc, variable posixAccount::$groups_orig
    -
    genpasswd
    -
    in file account.inc, function genpasswd()
        This function will return a password with max. 8 characters.
    +
    genTime
    +
    in file sambaMungedDial.inc, method sambaMungedDial::genTime()
        genTime
    +
    getAccountContainer
    +
    in file baseModule.inc, method baseModule::getAccountContainer()
        Returns the accountContainer object.
    +
    getAccountModule
    +
    in file modules.inc, method accountContainer::getAccountModule()
        Returns the account module with the given class name
    +
    getAccountModules
    +
    in file modules.inc, method accountContainer::getAccountModules()
        Returns the included account modules.
    getAccountProfiles
    -
    in file profiles.inc, function getAccountProfiles()
        Returns an array of string with all available profiles for the given account type
    -
    getAlias
    -
    in file user.inc, method user::getAlias()
        Returns the alias name of this account type.
    -
    getAlias
    -
    in file smbDomain.inc, method smbDomain::getAlias()
        Returns the alias name of this account type.
    -
    getAlias
    -
    in file group.inc, method group::getAlias()
        Returns the alias name of this account type.
    -
    getAlias
    -
    in file host.inc, method host::getAlias()
        Returns the alias name of this account type.
    +
    in file profiles.inc, function getAccountProfiles()
        Returns an array of string with all available profiles for the given account type
    getAlias
    in file mailAlias.inc, method mailAlias::getAlias()
        Returns the alias name of this account type.
    getAlias
    +
    in file host.inc, method host::getAlias()
        Returns the alias name of this account type.
    +
    getAlias
    +
    in file smbDomain.inc, method smbDomain::getAlias()
        Returns the alias name of this account type.
    +
    getAlias
    in file baseType.inc, method baseType::getAlias()
        Returns the alias name of this account type.
    +
    getAlias
    +
    in file user.inc, method user::getAlias()
        Returns the alias name of this account type.
    +
    getAlias
    +
    in file group.inc, method group::getAlias()
        Returns the alias name of this account type.
    getAliases
    in file schema.inc, method AttributeType::getAliases()
        Gets the names of attributes that are an alias for this attribute (if any).
    +
    getAttributes
    +
    in file baseModule.inc, method baseModule::getAttributes()
        Returns the LDAP attributes which are managed in this module.
    getAvailableLogos
    -
    in file pdfstruct.inc, function getAvailableLogos()
        This function returns an array with all aviliable logo images.
    +
    in file pdfstruct.inc, function getAvailableLogos()
        This function returns an array with all aviliable logo images.
    getAvailableModules
    -
    in file modules.inc, function getAvailableModules()
        Returns an array with all available user module names
    +
    in file modules.inc, function getAvailableModules()
        Returns an array with all available user module names
    getAvailablePDFFields
    -
    in file modules.inc, function getAvailablePDFFields()
        Returns a list of available PDF entries.
    -
    getButtonStatus
    -
    in file baseModule.inc, method baseModule::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    -
    getButtonStatus
    -
    in file account.inc, method account::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    -
    getButtonStatus
    -
    in file posixGroup.inc, method posixGroup::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    +
    in file modules.inc, function getAvailablePDFFields()
        Returns a list of available PDF entries.
    +
    getBrokenConn
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getBrokenConn()
        gets Broken-Connection value: disconnect/reset
    getButtonStatus
    in file inetOrgPerson.inc, method inetOrgPerson::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    getButtonStatus
    +
    in file posixGroup.inc, method posixGroup::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    +
    getButtonStatus
    +
    in file account.inc, method account::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    +
    getButtonStatus
    in file nisMailAlias.inc, method nisMailAlias::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    +
    getButtonStatus
    +
    in file baseModule.inc, method baseModule::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    getChildCount
    -
    in file delete.php, function getChildCount()
        Returns the number of child entries of a DN.
    +
    in file delete.php, function getChildCount()
        Returns the number of child entries of a DN.
    getChildObjectClasses
    in file schema.inc, method ObjectClass::getChildObjectClasses()
        Returns the array of objectClass names which inherit from this objectClass.
    +
    getClearTextPassword
    +
    in file posixAccount.inc, method posixAccount::getClearTextPassword()
        Returns the clear text password.
    getConfigOptions
    -
    in file modules.inc, function getConfigOptions()
        Returns a hash array (module name => elements) of all module options for the configuration page.
    +
    in file modules.inc, function getConfigOptions()
        Returns a hash array (module name => elements) of all module options for the configuration page.
    getConfigProfiles
    -
    in file config.inc, function getConfigProfiles()
        Returns an array of string with all available configuration profiles (without .conf)
    +
    in file config.inc, function getConfigProfiles()
        Returns an array of string with all available configuration profiles (without .conf)
    +
    getConnectClientDrives
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getConnectClientDrives()
        gets connect-client-drive-at-logon value: enabled/disabled
    +
    getConnectClientPrinters
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getConnectClientPrinters()
        gets connect-client-printers-at-logon value: enabled/disabled
    +
    getCtxMaxConnectionTimeF
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getCtxMaxConnectionTimeF()
        SMARTY: gets the checkbox state of "Connection"
    +
    getCtxMaxDisconnectionTimeF
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getCtxMaxDisconnectionTimeF()
        SMARTY: gets the checkbox state of "Disconnection"
    +
    getCtxMaxIdleTimeF
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getCtxMaxIdleTimeF()
        SMARTY: gets the checkbox state of "Idle"
    getdays
    -
    in file account.inc, function getdays()
        This function will return the days from 1.1.1970 until now.
    +
    in file account.inc, function getdays()
        This function will return the days from 1.1.1970 until now.
    getDefaultListAttributes
    -
    in file types.inc, function getDefaultListAttributes()
        Returns the default attribute list for an account type.
    +
    in file user.inc, method user::getDefaultListAttributes()
        Returns the default attribute list for this account type.
    getDefaultListAttributes
    -
    in file baseType.inc, method baseType::getDefaultListAttributes()
        Returns the default attribute list for this account type.
    +
    in file group.inc, method group::getDefaultListAttributes()
        Returns the default attribute list for this account type.
    +
    getDefaultListAttributes
    +
    in file types.inc, function getDefaultListAttributes()
        Returns the default attribute list for an account type.
    getDefaultListAttributes
    in file host.inc, method host::getDefaultListAttributes()
        Returns the default attribute list for this account type.
    getDefaultListAttributes
    in file smbDomain.inc, method smbDomain::getDefaultListAttributes()
        Returns the default attribute list for this account type.
    getDefaultListAttributes
    -
    in file group.inc, method group::getDefaultListAttributes()
        Returns the default attribute list for this account type.
    -
    getDefaultListAttributes
    -
    in file user.inc, method user::getDefaultListAttributes()
        Returns the default attribute list for this account type.
    +
    in file baseType.inc, method baseType::getDefaultListAttributes()
        Returns the default attribute list for this account type.
    getDefaultListAttributes
    in file mailAlias.inc, method mailAlias::getDefaultListAttributes()
        Returns the default attribute list for this account type.
    +
    getDefaultPrinter
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getDefaultPrinter()
        gets set-client-printer-to-default value: enabled/disabled
    +
    getDescription
    +
    in file baseType.inc, method baseType::getDescription()
        Returns the description of this account type.
    getDescription
    in file smbDomain.inc, method smbDomain::getDescription()
        Returns the description of this account type.
    getDescription
    -
    in file mailAlias.inc, method mailAlias::getDescription()
        Returns the description of this account type.
    -
    getDescription
    in file schema.inc, method SchemaItem::getDescription()
    getDescription
    -
    in file baseType.inc, method baseType::getDescription()
        Returns the description of this account type.
    +
    in file host.inc, method host::getDescription()
        Returns the description of this account type.
    +
    getDescription
    +
    in file mailAlias.inc, method mailAlias::getDescription()
        Returns the description of this account type.
    getDescription
    in file group.inc, method group::getDescription()
        Returns the description of this account type.
    getDescription
    in file user.inc, method user::getDescription()
        Returns the description of this account type.
    -
    getDescription
    -
    in file host.inc, method host::getDescription()
        Returns the description of this account type.
    getEquality
    in file schema.inc, method AttributeType::getEquality()
        Gets this attribute's equality string
    getgid
    @@ -725,49 +740,51 @@
    getgrnam
    in file cache.inc, method cache::getgrnam()
        This function returns the group name to an existing gidNumber.
    getHelp
    -
    in file modules.inc, function getHelp()
        Returns a help entry from an account module.
    +
    in file modules.inc, function getHelp()
        Returns a help entry from an account module.
    +
    getInheritMode
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getInheritMode()
        gets Inherit-config-from-client value: enabled/disabled
    getIsCollective
    in file schema.inc, method AttributeType::getIsCollective()
        Gets whether this attribute is collective.
    getIsNoUserModification
    in file schema.inc, method AttributeType::getIsNoUserModification()
        Gets whether this attribute is not modifiable by users.
    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.
    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 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.
    getLDAPAliases
    in file baseModule.inc, method baseModule::getLDAPAliases()
        Returns a list of aliases for LDAP attributes.
    getListAttributeDescriptions
    +
    in file host.inc, method host::getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    +
    getListAttributeDescriptions
    in file smbDomain.inc, method smbDomain::getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    getListAttributeDescriptions
    in file group.inc, method group::getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    getListAttributeDescriptions
    +
    in file types.inc, function getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    +
    getListAttributeDescriptions
    +
    in file mailAlias.inc, method mailAlias::getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    +
    getListAttributeDescriptions
    in file user.inc, method user::getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    getListAttributeDescriptions
    in file baseType.inc, method baseType::getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    -
    getListAttributeDescriptions
    -
    in file host.inc, method host::getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    -
    getListAttributeDescriptions
    -
    in file types.inc, function getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    -
    getListAttributeDescriptions
    -
    in file mailAlias.inc, method mailAlias::getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    getListClassName
    -
    in file mailAlias.inc, method mailAlias::getListClassName()
        Returns the class name for the list object.
    -
    getListClassName
    -
    in file group.inc, method group::getListClassName()
        Returns the class name for the list object.
    -
    getListClassName
    -
    in file host.inc, method host::getListClassName()
        Returns the class name for the list object.
    -
    getListClassName
    -
    in file types.inc, function getListClassName()
        Returns the class name for the list object.
    +
    in file user.inc, method user::getListClassName()
        Returns the class name for the list object.
    getListClassName
    in file smbDomain.inc, method smbDomain::getListClassName()
        Returns the class name for the list object.
    getListClassName
    -
    in file baseType.inc, method baseType::getListClassName()
        Returns the class name for the list object.
    +
    in file mailAlias.inc, method mailAlias::getListClassName()
        Returns the class name for the list object.
    getListClassName
    -
    in file user.inc, method user::getListClassName()
        Returns the class name for the list object.
    +
    in file types.inc, function getListClassName()
        Returns the class name for the list object.
    +
    getListClassName
    +
    in file host.inc, method host::getListClassName()
        Returns the class name for the list object.
    +
    getListClassName
    +
    in file group.inc, method group::getListClassName()
        Returns the class name for the list object.
    +
    getListClassName
    +
    in file baseType.inc, method baseType::getListClassName()
        Returns the class name for the list object.
    getManagedAttributes
    in file baseModule.inc, method baseModule::getManagedAttributes()
        Returns a list of LDAP attributes which are managed by this module.
    getManagedObjectClasses
    @@ -779,9 +796,11 @@
    getMayAttrs
    in file schema.inc, method ObjectClass::getMayAttrs()
        Gets an array of AttributeType objects that entries of this ObjectClass may define.
    getModuleAlias
    -
    in file modules.inc, function getModuleAlias()
        Returns the alias name of a module
    +
    in file modules.inc, function getModuleAlias()
        Returns the alias name of a module
    getModulesDependencies
    -
    in file modules.inc, function getModulesDependencies()
        Returns a hash array (module name => dependencies) of all module dependencies
    +
    in file modules.inc, function getModulesDependencies()
        Returns a hash array (module name => dependencies) of all module dependencies
    +
    getMunged
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getMunged()
        Returns ready-to-run mungedDialString to be filled into ldap
    getMustAttrNames
    in file schema.inc, method ObjectClass::getMustAttrNames()
        Gets an array of attribute names (strings) that entries of this ObjectClass must define.
    getMustAttrs
    @@ -793,51 +812,67 @@
    getName
    in file schema.inc, method ObjectClass::getName()
        Gets the name of this objectClass (ie, "inetOrgPerson")
    getName
    -
    in file schema.inc, method ObjectClassAttribute::getName()
        Gets this attribute's name
    -
    getName
    in file schema.inc, method MatchingRuleUse::getName()
        Gets this MatchingRuleUse's name
    +
    getName
    +
    in file schema.inc, method ObjectClassAttribute::getName()
        Gets this attribute's name
    getNextGIDs
    in file posixGroup.inc, method posixGroup::getNextGIDs()
        Returns one or more free GID numbers.
    getNextUIDs
    in file posixAccount.inc, method posixAccount::getNextUIDs()
        Returns one or more free UID numbers.
    getOID
    in file schema.inc, method SchemaItem::getOID()
    +
    getOnDemandFlags
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getOnDemandFlags()
        Returns array of flags, which can be set on-demand with activated java-script
    getOrdering
    in file schema.inc, method AttributeType::getOrdering()
        Gets this attribute's ordering specification.
    +
    getOriginalAttributes
    +
    in file baseModule.inc, method baseModule::getOriginalAttributes()
        Returns the LDAP attributes which are managed in this module (with unchanged values).
    +
    getParentDN
    +
    in file modules.inc, method accountContainer::getParentDN()
        Returns the parent DN of a given DN.
    getPDFStructureDefinitions
    -
    in file pdfstruct.inc, function getPDFStructureDefinitions()
        This function will return all available PDF structure definitions for the submitted account scope.
    +
    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 getProfileOptions()
        Returns the elements for the profile page.
    +
    getRDN
    +
    in file modules.inc, method accountContainer::getRDN()
        Returns the RDN part of a given DN.
    getRDNAttributes
    -
    in file modules.inc, function getRDNAttributes()
        Returns a list of LDAP attributes which can be used to form the RDN.
    +
    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
    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 baseModule.inc, method baseModule::getRequiredExtensions()
        Returns a list of required PHP extensions.
    getRequiredExtensions
    -
    in file modules.inc, function getRequiredExtensions()
        Returns true if the module is a base module
    +
    in file modules.inc, function getRequiredExtensions()
        Returns true if the module is a base module
    getSectionHeadline
    -
    in file pdf.inc, function getSectionHeadline()
        Creates a section headline.
    +
    in file pdf.inc, function getSectionHeadline()
        Creates a section headline.
    getSelfServiceFields
    in file baseModule.inc, method baseModule::getSelfServiceFields()
        Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    getSelfServiceFieldSettings
    -
    in file selfService.inc, function getSelfServiceFieldSettings()
        Returns the field settings for the self service.
    -
    getSelfServiceOptions
    -
    in file selfService.inc, function getSelfServiceOptions()
        Returns meta HTML code for each self service field.
    +
    in file selfService.inc, function getSelfServiceFieldSettings()
        Returns the field settings for the self service.
    getSelfServiceOptions
    in file baseModule.inc, method baseModule::getSelfServiceOptions()
        Returns the meta HTML code for each input field.
    getSelfServiceOptions
    +
    in file inetOrgPerson.inc, method inetOrgPerson::getSelfServiceOptions()
        Returns the meta HTML code for each input field.
    +
    getSelfServiceOptions
    in file posixAccount.inc, method posixAccount::getSelfServiceOptions()
        Returns the meta HTML code for each input field.
    getSelfServiceOptions
    -
    in file inetOrgPerson.inc, method inetOrgPerson::getSelfServiceOptions()
        Returns the meta HTML code for each input field.
    +
    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)
    +
    in file selfService.inc, function getSelfServiceProfiles()
        Returns a list of all available self service profiles (without .conf)
    getSelfServiceSearchAttributes
    in file baseModule.inc, method baseModule::getSelfServiceSearchAttributes()
        Returns a list of possible search attributes for the self service.
    getSelfServiceSearchAttributes
    -
    in file selfService.inc, function getSelfServiceSearchAttributes()
        Returns a list of possible search attributes for the self service.
    +
    in file selfService.inc, function getSelfServiceSearchAttributes()
        Returns a list of possible search attributes for the self service.
    +
    getSelfServiceSettings
    +
    in file baseModule.inc, method baseModule::getSelfServiceSettings()
        Returns a list of self service configuration settings.
    +
    getSelfServiceSettings
    +
    in file selfService.inc, function getSelfServiceSettings()
        Returns a hash array (module name => elements) of all module options for the configuration page.
    +
    getShadow
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getShadow()
        gets shadow value (enum): 0-4
    getshells
    -
    in file account.inc, function getshells()
        Returns a list of shells listed in config/shells.
    +
    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.
    GetStringWidth
    @@ -854,24 +889,26 @@
    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.
    getSyntaxString
    in file schema.inc, method AttributeType::getSyntaxString()
        Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").
    -
    getType
    -
    in file schema.inc, method AttributeType::getType()
        Gets this attribute's type
    +
    getTsLogin
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getTsLogin()
        Gets Terminal-Server-Login value: enabled/disabled
    getType
    in file schema.inc, method ObjectClass::getType()
        Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.
    +
    getType
    +
    in file schema.inc, method AttributeType::getType()
        Gets this attribute's type
    getTypeAlias
    -
    in file types.inc, function getTypeAlias()
        Returns the alias name of an account type.
    +
    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.
    +
    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.
    +
    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.
    +
    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 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
    +
    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.
    GetX
    @@ -889,157 +926,159 @@
    get_alias
    in file baseModule.inc, method baseModule::get_alias()
        Returns an alias name for the module.
    get_attr_select_html
    -
    in file custom.php, function get_attr_select_html()
        Returns option values.
    +
    in file custom.php, function get_attr_select_html()
        Returns option values.
    get_binary_attr_select_html
    -
    in file custom.php, function get_binary_attr_select_html()
        Returns option values.
    +
    in file custom.php, function get_binary_attr_select_html()
        Returns option values.
    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
    +
    in file schema.inc, function get_cached_schema()
        Returns the cached array of schemaitem objects for the specified
    get_cacheTimeout
    in file config.inc, method LAMConfig::get_cacheTimeout()
        Returns the LDAP cache timeout in minutes
    get_cacheTimeoutSec
    in file config.inc, method LAMConfig::get_cacheTimeoutSec()
        Returns the LDAP cache timeout in seconds
    get_configOptions
    -
    in file posixGroup.inc, method posixGroup::get_configOptions()
        Returns a list of elements for the configuration.
    -
    get_configOptions
    in file baseModule.inc, method baseModule::get_configOptions()
        Returns a list of elements for the configuration.
    +
    get_configOptions
    +
    in file posixGroup.inc, method posixGroup::get_configOptions()
        Returns a list of elements for the configuration.
    get_container
    -
    in file tree.inc, function get_container()
        Given a DN string, this returns the parent container portion of the string.
    +
    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 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:
    get_defaultLanguage
    in file config.inc, method LAMConfig::get_defaultLanguage()
        Returns the default language string
    get_dependencies
    in file baseModule.inc, method baseModule::get_dependencies()
        This function returns a list with all depending and conflicting modules.
    get_enc_type
    -
    in file tree.inc, function get_enc_type()
    +
    in file tree.inc, function get_enc_type()
    get_entry_system_attrs
    -
    in file tree.inc, function get_entry_system_attrs()
        Gets the operational attributes for an entry. Given a DN, this function fetches that entry's
    +
    in file tree.inc, function get_entry_system_attrs()
        Gets the operational attributes for an entry. Given a DN, this function fetches that entry's
    get_help
    in file baseModule.inc, method baseModule::get_help()
        This function return the help entry array for a specific help id. Normally this->meta can be used.
    get_icon
    -
    in file tree.inc, function get_icon()
        Given a DN and server ID, this function reads the DN's objectClasses and
    +
    in file tree.inc, function get_icon()
        Given a DN and server ID, this function reads the DN's objectClasses and
    get_ldap_filter
    -
    in file modules.inc, function get_ldap_filter()
        Returns the LDAP filter used by the account lists
    +
    in file modules.inc, function get_ldap_filter()
        Returns the LDAP filter used by the account lists
    get_ldap_filter
    in file baseModule.inc, method baseModule::get_ldap_filter()
        returns an LDAP filter for the account lists
    get_line_end_format
    -
    in file export_form.php, function get_line_end_format()
        Helper functoin for fetching the line end format.
    +
    in file export_form.php, function get_line_end_format()
        Helper functoin for fetching the line end format.
    get_listAttributes
    in file config.inc, method LAMConfig::get_listAttributes()
        Returns the list of attributes to show in user list
    get_MaxListEntries
    in file config.inc, method LAMConfig::get_MaxListEntries()
        Returns the maximum number of rows in user/group/host lists
    get_metaData
    -
    in file shadowAccount.inc, method shadowAccount::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file nisMailAlias.inc, method nisMailAlias::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    in file posixAccount.inc, method posixAccount::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    -
    in file posixGroup.inc, method posixGroup::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file quota.inc, method quota::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file sambaAccount.inc, method sambaAccount::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file ldapPublicKey.inc, method ldapPublicKey::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file inetOrgPerson.inc, method inetOrgPerson::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file account.inc, method account::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file baseModule.inc, method baseModule::get_metaData()
        Dummy function, meta data is provided by sub classes.
    +
    in file nisMailAlias.inc, method nisMailAlias::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    in file ieee802device.inc, method ieee802Device::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    -
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    in file sambaDomain.inc, method sambaDomain::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    +
    in file sambaAccount.inc, method sambaAccount::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file posixGroup.inc, method posixGroup::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file inetOrgPerson.inc, method inetOrgPerson::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file shadowAccount.inc, method shadowAccount::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file account.inc, method account::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    in file kolabUser.inc, method kolabUser::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    in file sambaSamAccount.inc, method sambaSamAccount::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file ldapPublicKey.inc, method ldapPublicKey::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file quota.inc, method quota::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file baseModule.inc, method baseModule::get_metaData()
        Dummy function, meta data is provided by sub classes.
    get_moduleSettings
    in file config.inc, method LAMConfig::get_moduleSettings()
        Returns a list of saved module settings
    get_object_attr
    -
    in file tree.inc, function get_object_attr()
        Much like get_object_attrs(), but only returns the values for one attribute of an object. Example calls:
    +
    in file tree.inc, function get_object_attr()
        Much like get_object_attrs(), but only returns the values for one attribute of an object. Example calls:
    get_object_attrs
    -
    in file tree.inc, function get_object_attrs()
        Gets the attributes/values of an entry. Returns an associative array whose
    +
    in file tree.inc, function get_object_attrs()
        Gets the attributes/values of an entry. Returns an associative array whose
    get_Passwd
    in file config.inc, method LAMConfig::get_Passwd()
        Returns the password to access the preferences wizard
    get_pdfEntries
    -
    in file inetOrgPerson.inc, method inetOrgPerson::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    in file kolabUser.inc, method kolabUser::get_pdfEntries()
        Returns the PDF entries for this module.
    get_pdfEntries
    in file ldapPublicKey.inc, method ldapPublicKey::get_pdfEntries()
        Returns a list of PDF entries
    get_pdfEntries
    -
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file account.inc, method account::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file sambaDomain.inc, method sambaDomain::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    in file nisMailAlias.inc, method nisMailAlias::get_pdfEntries()
        Returns the PDF entries for this module.
    get_pdfEntries
    in file ieee802device.inc, method ieee802Device::get_pdfEntries()
        Returns the PDF entries for this module.
    get_pdfEntries
    in file modules.inc, method accountContainer::get_pdfEntries()
        Returns a list of possible PDF entries for this account.
    get_pdfEntries
    -
    in file shadowAccount.inc, method shadowAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file posixGroup.inc, method posixGroup::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file sambaAccount.inc, method sambaAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file posixAccount.inc, method posixAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file nisMailAlias.inc, method nisMailAlias::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    in file inetOrgPerson.inc, method inetOrgPerson::get_pdfEntries()
        Returns the PDF entries for this module.
    get_pdfEntries
    in file sambaSamAccount.inc, method sambaSamAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    get_pdfEntries
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file account.inc, method account::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file sambaAccount.inc, method sambaAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file posixGroup.inc, method posixGroup::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    in file quota.inc, method quota::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file posixAccount.inc, method posixAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file sambaDomain.inc, method sambaDomain::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file shadowAccount.inc, method shadowAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    get_pdfFields
    in file baseModule.inc, method baseModule::get_pdfFields()
        Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    get_pdf_entries
    in file baseModule.inc, method baseModule::get_pdf_entries()
        Returns a hastable with all entries that may be printed out in the PDF. The
    get_preg
    -
    in file account.inc, function get_preg()
        Checks if a given value matches the selected regular expression.
    -
    get_profileOptions
    -
    in file baseModule.inc, method baseModule::get_profileOptions()
        Returns a list of elements for the account profiles.
    -
    get_profileOptions
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::get_profileOptions()
        Returns a list of elements for the account profiles.
    +
    in file account.inc, function get_preg()
        Checks if a given value matches the selected regular expression.
    get_profileOptions
    in file sambaSamAccount.inc, method sambaSamAccount::get_profileOptions()
        Returns a list of elements for the account profiles.
    get_profileOptions
    +
    in file baseModule.inc, method baseModule::get_profileOptions()
        Returns a list of elements for the account profiles.
    +
    get_profileOptions
    in file posixAccount.inc, method posixAccount::get_profileOptions()
        Returns a list of elements for the account profiles.
    get_profileOptions
    in file quota.inc, method quota::get_profileOptions()
        Returns a list of elements for the account profiles.
    +
    get_profileOptions
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::get_profileOptions()
        Returns a list of elements for the account profiles.
    get_rdn
    -
    in file tree.inc, function get_rdn()
        Given a DN string, this returns the 'RDN' portion of the string.
    +
    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 list of possible LDAP attributes which can be used to form the RDN.
    get_schema_attribute
    -
    in file schema.inc, function get_schema_attribute()
        Gets a single AttributeType object specified by name.
    +
    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.
    +
    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.
    +
    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.
    +
    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.
    +
    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 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)
    get_scriptPath
    in file config.inc, method LAMConfig::get_scriptPath()
        Returns the path to the external script
    -
    get_scriptServer
    -
    in file config.inc, method LAMConfig::get_scriptServer()
        Returns the server of the external script
    +
    get_scriptRights
    +
    in file config.inc, method LAMConfig::get_scriptRights()
        Returns the chmod value for new home directories.
    +
    get_scriptServers
    +
    in file config.inc, method LAMConfig::get_scriptServers()
        Returns the servers of the external script as a Array
    get_ServerURL
    in file config.inc, method LAMConfig::get_ServerURL()
        Returns the server address as string
    get_Suffix
    @@ -1055,11 +1094,15 @@
    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.
    +
    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).
    +
    groupRefreshPrimary
    +
    in file group.inc, method lamGroupList::groupRefreshPrimary()
        Refreshes the primary group members list.
    +
    groupSetUsePrimary
    +
    in file group.inc, method lamGroupList::groupSetUsePrimary()
        Checks if primary group members should be included.
    group.inc
    -
    procedural page group.inc
    +
    procedural page group.inc
    top
    @@ -1072,8 +1115,6 @@
    in file fpdf.php, variable FPDF::$h
    $hasNext
    in file export.inc, variable PlaLdapExporter::$hasNext
    -
    $hex2bitstring
    -
    in file sambaSamAccount.inc, variable sambaSamAccount::$hex2bitstring
        HEX to binary conversion table
    $hPt
    in file fpdf.php, variable FPDF::$hPt
    header
    @@ -1081,15 +1122,17 @@
    Header
    in file fpdf.php, method FPDF::Header()
    help.inc
    -
    procedural page help.inc
    +
    procedural page help.inc
    hex2bin
    -
    in file ldap.inc, function hex2bin()
        Converts a HEX string to a binary value
    +
    in file ldap.inc, function hex2bin()
        Converts a HEX string to a binary value
    +
    hexstr
    +
    in file sambaMungedDial.inc, method sambaMungedDial::hexstr()
        hexstr
    host
    in file host.inc, class host
        The account type for host accounts (e.g. Samba).
    host.inc
    -
    procedural page host.inc
    +
    procedural page host.inc
    help.php
    -
    procedural page help.php
    +
    procedural page help.php
    top
    @@ -1106,8 +1149,6 @@
    in file fpdf.php, variable FPDF::$InFooter
    $inputFields
    in file selfService.inc, variable selfServiceProfile::$inputFields
        input fields
    -
    $invitationPolicies
    -
    in file kolabUser.inc, variable kolabUser::$invitationPolicies
        list of invitation policies
    $isNewAccount
    in file modules.inc, variable accountContainer::$isNewAccount
        True if this is a newly created account
    $is_collective
    @@ -1115,11 +1156,11 @@
    $is_no_user_modification
    in file schema.inc, variable AttributeType::$is_no_user_modification
        boolean: can use modify?
    $is_obsolete
    -
    in file schema.inc, variable AttributeType::$is_obsolete
        string: the description
    -
    $is_obsolete
    in file schema.inc, variable MatchingRule::$is_obsolete
        Boolean value indicating whether this MatchingRule is obsolete
    $is_obsolete
    in file schema.inc, variable ObjectClass::$is_obsolete
        boolean value indicating whether this objectClass is obsolete
    +
    $is_obsolete
    +
    in file schema.inc, variable AttributeType::$is_obsolete
        string: the description
    $is_single_value
    in file schema.inc, variable AttributeType::$is_single_value
        boolean: is single valued only?
    ieee802Device
    @@ -1129,83 +1170,87 @@
    inetLocalMailRecipient
    in file inetLocalMailRecipient.inc, class inetLocalMailRecipient
        Provides mail routing for users.
    inetOrgPerson
    -
    in file inetOrgPerson.inc, class inetOrgPerson
        This class contains all account LDAP attributes and funtioncs required to deal with inetOrgPerson.
    +
    in file inetOrgPerson.inc, class inetOrgPerson
        This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).
    init
    in file sambaAccount.inc, method sambaAccount::init()
        Initializes the module after it became part of an accountContainer
    init
    -
    in file posixAccount.inc, method posixAccount::init()
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::init()
        Initializes the module after it became part of an accountContainer
    init
    -
    in file baseModule.inc, method baseModule::init()
        Initializes the module after it became part of an accountContainer
    +
    in file posixAccount.inc, method posixAccount::init()
        Initializes the module after it became part of an accountContainer
    init
    in file sambaSamAccount.inc, method sambaSamAccount::init()
        Initializes the module after it became part of an accountContainer
    init
    -
    in file quota.inc, method quota::init()
    -
    init
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::init()
        Initializes the module after it became part of an accountContainer
    +
    in file baseModule.inc, method baseModule::init()
        Initializes the module after it became part of an accountContainer
    init
    in file posixGroup.inc, method posixGroup::init()
        This functin will be called when the module will be loaded *
    initialize_session_tree
    -
    in file tree.inc, function initialize_session_tree()
        Checks and fixes an initial session's tree cache if needed.
    -
    initVars
    -
    in file schema.inc, method SchemaItem::initVars()
        Initialize class members to default values.
    -
    initVars
    -
    in file schema.inc, method Syntax::initVars()
        Initializes the class' member variables
    +
    in file tree.inc, function initialize_session_tree()
        Checks and fixes an initial session's tree cache if needed.
    +
    initQuotas
    +
    in file quota.inc, method quota::initQuotas()
        Initializes the quota values.
    initVars
    in file schema.inc, method MatchingRule::initVars()
        Initialize the class' member variables
    initVars
    +
    in file schema.inc, method SchemaItem::initVars()
        Initialize class members to default values.
    +
    initVars
    in file schema.inc, method MatchingRuleUse::initVars()
        Initialize the class' member variables
    initVars
    -
    in file schema.inc, method ObjectClass::initVars()
        Initialize the class' member variables
    -
    initVars
    in file schema.inc, method AttributeType::initVars()
        Initialize the class' member variables
    +
    initVars
    +
    in file schema.inc, method Syntax::initVars()
        Initializes the class' member variables
    +
    initVars
    +
    in file schema.inc, method ObjectClass::initVars()
        Initialize the class' member variables
    in_array_ignore_case
    -
    in file account.inc, function in_array_ignore_case()
        Checks if a string exists in an array, ignoring case.
    +
    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 selfService.inc, function isLAMProVersion()
        Returns if this is a LAM Pro installation.
    +
    isWritable
    +
    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.
    +
    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_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 modules.inc, function is_base_module()
        Returns true if the module is a base module
    +
    in file modules.inc, function is_base_module()
        Returns true if the module is a base module
    is_base_module
    in file baseModule.inc, method baseModule::is_base_module()
        Returns true if this module is enough to provide a sensible account.
    is_binary_option_required
    -
    in file add_attr.php, function is_binary_option_required()
    +
    in file add_attr.php, function is_binary_option_required()
    is_browser_os_mac
    -
    in file export.inc, function is_browser_os_mac()
        Determines whether the browser's operating system is Macintosh.
    +
    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).
    +
    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.
    +
    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.
    +
    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.
    +
    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).
    +
    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;
    +
    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.
    +
    is_samba_path
    +
    in file sambaMungedDial.inc, method sambaMungedDial::is_samba_path()
        Checks if this is a valid Samba path.
    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 tree.inc, function is_url_string()
        Get whether a string looks like a web URL (http://www.example.com/)
    ieee802device.inc
    -
    procedural page ieee802device.inc
    +
    procedural page ieee802device.inc
    inetLocalMailRecipient.inc
    -
    procedural page inetLocalMailRecipient.inc
    +
    procedural page inetLocalMailRecipient.inc
    inetOrgPerson.inc
    -
    procedural page inetOrgPerson.inc
    +
    procedural page inetOrgPerson.inc
    index.php
    -
    procedural page index.php
    +
    procedural page index.php
    initsuff.php
    -
    procedural page initsuff.php
    +
    procedural page initsuff.php
    index.php
    -
    procedural page index.php
    +
    procedural page index.php
    top
    @@ -1223,7 +1268,7 @@
    kolabUser
    in file kolabUser.inc, method kolabUser::kolabUser()
        Creates a new kolabUser object.
    kolabUser.inc
    -
    procedural page kolabUser.inc
    +
    procedural page kolabUser.inc
    top
    @@ -1238,8 +1283,6 @@
    in file fpdf.php, variable FPDF::$lasth
    $LayoutMode
    in file fpdf.php, variable FPDF::$LayoutMode
    -
    $ldapcache
    -
    in file cache.inc, variable cache::$ldapcache
        This variable contains the cache
    $LDAPPassword
    in file selfService.inc, variable selfServiceProfile::$LDAPPassword
        LDAP password
    $LDAPSuffix
    @@ -1271,21 +1314,21 @@
    LAMConfig
    in file config.inc, method LAMConfig::LAMConfig()
        Loads preferences from config file
    lamdaemon
    -
    in file lamdaemon.inc, function lamdaemon()
        Sends commands to lamdaemon script.
    +
    in file lamdaemon.inc, function lamdaemon()
        Sends commands to lamdaemon script.
    lamdaemonSSH
    -
    in file lamdaemon.inc, function lamdaemonSSH()
        Sends commands to lamdaemon script via PHP SSH functions.
    -
    lamGroupList
    -
    in file group.inc, method lamGroupList::lamGroupList()
        Constructor
    +
    in file lamdaemon.inc, function lamdaemonSSH()
        Sends commands to lamdaemon script via PHP SSH functions.
    lamGroupList
    in file group.inc, class lamGroupList
        Generates the list view.
    +
    lamGroupList
    +
    in file group.inc, method lamGroupList::lamGroupList()
        Constructor
    lamHostList
    in file host.inc, method lamHostList::lamHostList()
        Constructor
    lamHostList
    in file host.inc, class lamHostList
        Generates the list view.
    lamList
    -
    in file lists.inc, method lamList::lamList()
        Constructor
    -
    lamList
    in file lists.inc, class lamList
        Generates the list view.
    +
    lamList
    +
    in file lists.inc, method lamList::lamList()
        Constructor
    lamMailAliasList
    in file mailAlias.inc, method lamMailAliasList::lamMailAliasList()
        Constructor
    lamMailAliasList
    @@ -1295,19 +1338,19 @@
    lamPDF
    in file pdf.inc, method lamPDF::lamPDF()
    LAMPDF_LINEWIDTH
    -
    in file pdf.inc, constant LAMPDF_LINEWIDTH
        PDF line width
    -
    lamSmbDomainList
    -
    in file smbDomain.inc, class lamSmbDomainList
        Generates the list view.
    +
    in file pdf.inc, constant LAMPDF_LINEWIDTH
        PDF line width
    lamSmbDomainList
    in file smbDomain.inc, method lamSmbDomainList::lamSmbDomainList()
        Constructor
    +
    lamSmbDomainList
    +
    in file smbDomain.inc, class lamSmbDomainList
        Generates the list view.
    lamTestLamdaemon
    -
    in file lamdaemonTest.php, function lamTestLamdaemon()
        Runs a test case of lamdaemon.
    -
    lamUserList
    -
    in file user.inc, method lamUserList::lamUserList()
        Constructor
    +
    in file lamdaemonTest.php, function lamTestLamdaemon()
        Runs a test case of lamdaemon.
    lamUserList
    in file user.inc, class lamUserList
        Generates the list view.
    +
    lamUserList
    +
    in file user.inc, method lamUserList::lamUserList()
        Constructor
    LAMVersion
    -
    in file config.inc, function LAMVersion()
        Returns the version number of this LAM installation.
    +
    in file config.inc, function LAMVersion()
        Returns the version number of this LAM installation.
    Ldap
    in file ldap.inc, method Ldap::Ldap()
    Ldap
    @@ -1321,13 +1364,13 @@
    ldapPublicKey
    in file ldapPublicKey.inc, class ldapPublicKey
        Manages SSH public keys.
    lamdaemon.inc
    -
    procedural page lamdaemon.inc
    +
    procedural page lamdaemon.inc
    ldap.inc
    -
    procedural page ldap.inc
    +
    procedural page ldap.inc
    lists.inc
    -
    procedural page lists.inc
    +
    procedural page lists.inc
    ldapPublicKey.inc
    -
    procedural page ldapPublicKey.inc
    +
    procedural page ldapPublicKey.inc
    Line
    in file fpdf.php, method FPDF::Line()
    Link
    @@ -1337,6 +1380,8 @@
    listDoPost
    in file user.inc, method lamUserList::listDoPost()
        Manages all POST actions (e.g. button pressed) for the account lists.
    listDoPost
    +
    in file group.inc, method lamGroupList::listDoPost()
        Manages all POST actions (e.g. button pressed) for the account lists.
    +
    listDoPost
    in file lists.inc, method lamList::listDoPost()
        Manages all POST actions (e.g. button pressed) for the account lists.
    listDrawNavigationBar
    in file lists.inc, method lamList::listDrawNavigationBar()
        Draws a navigation bar to switch between pages
    @@ -1345,25 +1390,43 @@
    listGetAttributeDescriptionList
    in file lists.inc, method lamList::listGetAttributeDescriptionList()
        Returns an hash array containing with all attributes to be shown and their descriptions.
    listGetParams
    +
    in file group.inc, method lamGroupList::listGetParams()
        Sets some internal parameters.
    +
    listGetParams
    in file lists.inc, method lamList::listGetParams()
        Sets some internal parameters.
    -
    listPrintButtons
    -
    in file user.inc, method lamUserList::listPrintButtons()
        Prints the create, delete and PDF buttons.
    +
    listGetParams
    +
    in file user.inc, method lamUserList::listGetParams()
        Sets some internal parameters.
    +
    listPrintAdditionalOptions
    +
    in file user.inc, method lamUserList::listPrintAdditionalOptions()
        Prints additional option fields for specific object types.
    +
    listPrintAdditionalOptions
    +
    in file lists.inc, method lamList::listPrintAdditionalOptions()
        Prints additional option fields for specific object types.
    +
    listPrintAdditionalOptions
    +
    in file group.inc, method lamGroupList::listPrintAdditionalOptions()
        Prints additional option field for primary member display.
    listPrintButtons
    in file lists.inc, method lamList::listPrintButtons()
        Prints the create, delete and PDF buttons.
    listPrintHeader
    in file lists.inc, method lamList::listPrintHeader()
        Prints the HTML head.
    listPrintJavaScript
    in file lists.inc, method lamList::listPrintJavaScript()
        Prints JavaScript code needed for mouse-over effects.
    -
    listPrintTableBody
    -
    in file user.inc, method lamUserList::listPrintTableBody()
        Prints the entry list
    +
    listPrintPDFButtons
    +
    in file lists.inc, method lamList::listPrintPDFButtons()
        Prints the PDF button bar.
    listPrintTableBody
    in file lists.inc, method lamList::listPrintTableBody()
        Prints the entry list
    -
    listPrintTableBody
    -
    in file group.inc, method lamGroupList::listPrintTableBody()
        Prints the entry list
    +
    listPrintTableCellContent
    +
    in file user.inc, method lamUserList::listPrintTableCellContent()
        Prints the content of a cell in the account list for a given LDAP entry and attribute.
    +
    listPrintTableCellContent
    +
    in file lists.inc, method lamList::listPrintTableCellContent()
        Prints the content of a cell in the account list for a given LDAP entry and attribute.
    +
    listPrintTableCellContent
    +
    in file group.inc, method lamGroupList::listPrintTableCellContent()
        Prints the content of a cell in the account list for a given LDAP entry and attribute.
    listPrintTableHeader
    in file lists.inc, method lamList::listPrintTableHeader()
        Prints the attribute and filter row at the account table head
    +
    listPrintToolLinks
    +
    in file lists.inc, method lamList::listPrintToolLinks()
        Prints the tool image links (e.g. edit and delete) for each account.
    +
    listRefreshData
    +
    in file user.inc, method lamUserList::listRefreshData()
        Rereads the entries from LDAP.
    listRefreshData
    in file lists.inc, method lamList::listRefreshData()
        Rereads the entries from LDAP.
    +
    listRefreshData
    +
    in file group.inc, method lamGroupList::listRefreshData()
        Rereads the entries from LDAP.
    listShowOUSelection
    in file lists.inc, method lamList::listShowOUSelection()
        Prints a combobox with possible sub-DNs.
    listSort
    @@ -1371,85 +1434,85 @@
    lmhash
    in file createntlm.inc, method smbHash::lmhash()
        Calculates the LM hash of a given password.
    lmPassword
    -
    in file account.inc, function lmPassword()
        Generates the LM hash of a password.
    +
    in file account.inc, function lmPassword()
        Generates the LM hash of a password.
    Ln
    in file fpdf.php, method FPDF::Ln()
    +
    load
    +
    in file sambaMungedDial.inc, method sambaMungedDial::load()
        function takes a base64-encoded sambaMungedDial
    loadAccountProfile
    -
    in file profiles.inc, function loadAccountProfile()
        Loads an profile of the given account type
    +
    in file profiles.inc, function loadAccountProfile()
        Loads an profile of the given account type
    loadPDFStructureDefinitions
    -
    in file pdfstruct.inc, function loadPDFStructureDefinitions()
        This function is used to get pdf structure from xml file.
    +
    in file pdfstruct.inc, function loadPDFStructureDefinitions()
        This function is used to get pdf structure from xml file.
    loadSelfServiceProfile
    -
    in file selfService.inc, function loadSelfServiceProfile()
        Loads all settings of a self service profile.
    +
    in file selfService.inc, function loadSelfServiceProfile()
        Loads all settings of a self service profile.
    load_account
    in file modules.inc, method accountContainer::load_account()
        Loads an LDAP account with the given DN.
    load_attributes
    -
    in file sambaAccount.inc, method sambaAccount::load_attributes()
    -
    load_attributes
    -
    in file quota.inc, method quota::load_attributes()
    +
    in file baseModule.inc, method baseModule::load_attributes()
        This function loads the LDAP attributes for this module.
    load_attributes
    in file posixAccount.inc, method posixAccount::load_attributes()
        This function loads all needed LDAP attributes.
    load_attributes
    -
    in file baseModule.inc, method baseModule::load_attributes()
        This function loads the LDAP attributes for this module.
    +
    in file sambaAccount.inc, method sambaAccount::load_attributes()
        This function loads the LDAP attributes for this module.
    load_attributes
    -
    in file sambaSamAccount.inc, method sambaSamAccount::load_attributes()
    -
    load_Messages
    -
    in file sambaSamAccount.inc, method sambaSamAccount::load_Messages()
        this functin 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 sambaGroupMapping.inc, method sambaGroupMapping::load_Messages()
        this functin fills the error message array with messages
    -
    load_Messages
    -
    in file shadowAccount.inc, method shadowAccount::load_Messages()
        This function builds up the message array.
    -
    load_Messages
    -
    in file ieee802device.inc, method ieee802Device::load_Messages()
        This function fills the error message array with messages
    +
    in file sambaSamAccount.inc, method sambaSamAccount::load_attributes()
        This function loads the LDAP attributes for this module.
    load_Messages
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::load_Messages()
        This function fills the error message array with messages
    load_Messages
    -
    in file quota.inc, method quota::load_Messages()
        this functin fills the error message array with messages
    -
    load_Messages
    -
    in file inetOrgPerson.inc, method inetOrgPerson::load_Messages()
        This function fills the message array.
    -
    load_Messages
    -
    in file sambaDomain.inc, method sambaDomain::load_Messages()
        This function 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_Messages
    -
    in file nisMailAlias.inc, method nisMailAlias::load_Messages()
        This function fills the error message array with messages
    -
    load_Messages
    -
    in file account.inc, method account::load_Messages()
        This function fills the message array.
    +
    in file ieee802device.inc, method ieee802Device::load_Messages()
        This function fills the error message array with messages
    load_Messages
    in file posixGroup.inc, method posixGroup::load_Messages()
        This function fills the $messages variable with output messages from this module.
    load_Messages
    +
    in file nisMailAlias.inc, method nisMailAlias::load_Messages()
        This function fills the error message array with messages
    +
    load_Messages
    in file posixAccount.inc, method posixAccount::load_Messages()
        This function fills the error message array with messages.
    load_Messages
    +
    in file inetOrgPerson.inc, method inetOrgPerson::load_Messages()
        This function fills the message array.
    +
    load_Messages
    +
    in file shadowAccount.inc, method shadowAccount::load_Messages()
        This function builds up the message array.
    +
    load_Messages
    +
    in file kolabUser.inc, method kolabUser::load_Messages()
        This function fills the error message array with messages
    +
    load_Messages
    +
    in file account.inc, method account::load_Messages()
        This function fills the message array.
    +
    load_Messages
    +
    in file sambaDomain.inc, method sambaDomain::load_Messages()
        This function fills the error message array with messages
    +
    load_Messages
    in file sambaAccount.inc, method sambaAccount::load_Messages()
        this functin fills the error message array with messages
    +
    load_Messages
    +
    in file quota.inc, method quota::load_Messages()
        this functin fills the error message array with messages
    +
    load_Messages
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::load_Messages()
        this functin 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 sambaSamAccount.inc, method sambaSamAccount::load_Messages()
        this functin fills the error message array with messages
    load_profile
    in file quota.inc, method quota::load_profile()
        Loads the values of an account profile into internal variables.
    load_profile
    in file baseModule.inc, method baseModule::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 sambaAccount.inc, method sambaAccount::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 shadowAccount.inc, method shadowAccount::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.
    -
    load_profile
    -
    in file posixAccount.inc, method posixAccount::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.
    +
    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 security.inc, function logoffAndBackToLoginPage()
        Logs off the user and displays the login page.
    lshift
    in file createntlm.inc, method smbHash::lshift()
    list.php
    -
    procedural page list.php
    +
    procedural page list.php
    login.php
    -
    procedural page login.php
    +
    procedural page login.php
    logout.php
    -
    procedural page logout.php
    +
    procedural page logout.php
    lamdaemonTest.php
    -
    procedural page lamdaemonTest.php
    +
    procedural page lamdaemonTest.php
    top
    @@ -1474,68 +1537,66 @@
    in file baseModule.inc, variable baseModule::$messages
        contains all error messages of a module
    $meta
    in file baseModule.inc, variable baseModule::$meta
        includes all meta data provided by the sub class
    -
    $module
    -
    in file modules.inc, variable accountContainer::$module
        This is an array with all module objects
    $moduleSettings
    -
    in file baseModule.inc, variable baseModule::$moduleSettings
        configuration settings of all modules
    +
    in file selfService.inc, variable selfServiceProfile::$moduleSettings
        configuration settings of modules
    $moduleSettings
    in file config.inc, variable LAMConfig::$moduleSettings
        module settings
    +
    $moduleSettings
    +
    in file baseModule.inc, variable baseModule::$moduleSettings
        configuration settings of all modules
    $multivalue_separator
    in file export.inc, variable PlaCSVExporter::$multivalue_separator
    $must_attrs
    in file schema.inc, variable ObjectClass::$must_attrs
        arrays of attribute names that this objectClass requires
    modules.inc
    -
    procedural page modules.inc
    +
    procedural page modules.inc
    mailAlias.inc
    -
    procedural page mailAlias.inc
    +
    procedural page mailAlias.inc
    mailAlias
    in file mailAlias.inc, class mailAlias
        The account type for mail aliases.
    MatchingRule
    -
    in file schema.inc, method MatchingRule::MatchingRule()
        Creates a new MatchingRule object from a raw LDAP MatchingRule string.
    -
    MatchingRule
    in file schema.inc, class MatchingRule
        Represents an LDAP MatchingRule
    +
    MatchingRule
    +
    in file schema.inc, method MatchingRule::MatchingRule()
        Creates a new MatchingRule object from a raw LDAP MatchingRule string.
    MatchingRuleUse
    in file schema.inc, method MatchingRuleUse::MatchingRuleUse()
    MatchingRuleUse
    in file schema.inc, class MatchingRuleUse
        Represents an LDAP schema matchingRuleUse entry
    metaRefresh
    -
    in file config.inc, function metaRefresh()
        Prints a meta refresh page
    -
    module_complete
    -
    in file sambaAccount.inc, method sambaAccount::module_complete()
        This functions returns true if all needed settings are done
    -
    module_complete
    -
    in file quota.inc, method quota::module_complete()
    -
    module_complete
    -
    in file posixGroup.inc, method posixGroup::module_complete()
        This functions is used to check if all settings for this module have been made.
    -
    module_complete
    -
    in file posixAccount.inc, method posixAccount::module_complete()
        This functions is used to check if all settings for this module have been made.
    -
    module_complete
    -
    in file kolabUser.inc, method kolabUser::module_complete()
        This function returns true if all needed settings are done.
    -
    module_complete
    -
    in file account.inc, method account::module_complete()
        This functions returns true if all needed settings are done.
    -
    module_complete
    -
    in file baseModule.inc, method baseModule::module_complete()
        This functions is used to check if all settings for this module have been made.
    -
    module_complete
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::module_complete()
    +
    in file config.inc, function metaRefresh()
        Prints a meta refresh page
    module_complete
    in file inetOrgPerson.inc, method inetOrgPerson::module_complete()
        This functions return true if all needed settings are done.
    module_complete
    -
    in file sambaSamAccount.inc, method sambaSamAccount::module_complete()
        This functions is used to check if all settings for this module have been made.
    +
    in file posixGroup.inc, method posixGroup::module_complete()
        This functions is used to check if all settings for this module have been made.
    +
    module_complete
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::module_complete()
        This functions is used to check if all settings for this module have been made.
    +
    module_complete
    +
    in file posixAccount.inc, method posixAccount::module_complete()
        This functions is used to check if all settings for this module have been made.
    +
    module_complete
    +
    in file account.inc, method account::module_complete()
        This functions returns true if all needed settings are done.
    +
    module_complete
    +
    in file kolabUser.inc, method kolabUser::module_complete()
        This function returns true if all needed settings are done.
    +
    module_complete
    +
    in file baseModule.inc, method baseModule::module_complete()
        This functions is used to check if all settings for this module have been made.
    +
    module_complete
    +
    in file sambaAccount.inc, method sambaAccount::module_complete()
        This functions returns true if all needed settings are done
    module_ready
    -
    in file sambaAccount.inc, method sambaAccount::module_ready()
    -
    module_ready
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::module_ready()
    -
    module_ready
    -
    in file baseModule.inc, method baseModule::module_ready()
        This function is used to check if this module page can be displayed.
    +
    in file sambaAccount.inc, method sambaAccount::module_ready()
        This function is used to check if this module page can be displayed.
    module_ready
    in file sambaSamAccount.inc, method sambaSamAccount::module_ready()
        This function is used to check if this module page can be displayed.
    module_ready
    -
    in file quota.inc, method quota::module_ready()
    -
    MultiCell
    -
    in file ufpdf.php, method UFPDF::MultiCell()
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::module_ready()
        This function is used to check if this module page can be displayed.
    +
    module_ready
    +
    in file baseModule.inc, method baseModule::module_ready()
        This function is used to check if this module page can be displayed.
    +
    module_ready
    +
    in file quota.inc, method quota::module_ready()
        This function is used to check if this module page can be displayed.
    MultiCell
    in file fpdf.php, method FPDF::MultiCell()
    +
    MultiCell
    +
    in file ufpdf.php, method UFPDF::MultiCell()
    multi_lines_display
    in file export.inc, method PlaLdifExporter::multi_lines_display()
        Helper method to wrap ldif lines
    +
    munge
    +
    in file sambaMungedDial.inc, method sambaMungedDial::munge()
        Setup parameter given by paramName to MungedDial-Format
    mxor
    in file createntlm.inc, method smbHash::mxor()
    MyCustomExporter
    @@ -1543,19 +1604,19 @@
    MyCutsomExporter
    in file export.inc, method MyCustomExporter::MyCutsomExporter()
    mainlogin.php
    -
    procedural page mainlogin.php
    +
    procedural page mainlogin.php
    mainmanage.php
    -
    procedural page mainmanage.php
    -
    main_header.php
    -
    procedural page main_header.php
    +
    procedural page mainmanage.php
    main.php
    -
    procedural page main.php
    +
    procedural page main.php
    +
    main_header.php
    +
    procedural page main_header.php
    massBuildAccounts.php
    -
    procedural page massBuildAccounts.php
    +
    procedural page massBuildAccounts.php
    masscreate.php
    -
    procedural page masscreate.php
    +
    procedural page masscreate.php
    massDoUpload.php
    -
    procedural page massDoUpload.php
    +
    procedural page massDoUpload.php
    top
    @@ -1567,16 +1628,16 @@
    $n
    in file fpdf.php, variable FPDF::$n
    $name
    +
    in file schema.inc, variable AttributeType::$name
        The name of this attributeType
    +
    $name
    +
    in file schema.inc, variable MatchingRuleUse::$name
        The name of the MathingRule this applies to
    +
    $name
    in file schema.inc, variable MatchingRule::$name
        This rule's name
    $name
    in file schema.inc, variable ObjectClassAttribute::$name
        This Attribute's name
    $name
    -
    in file schema.inc, variable AttributeType::$name
        The name of this attributeType
    -
    $name
    in file schema.inc, variable ObjectClass::$name
        This objectClass' name, ie "inetOrgPerson"
    $name
    -
    in file schema.inc, variable MatchingRuleUse::$name
        The name of the MathingRule this applies to
    -
    $name
    in file account.inc, variable samba3domain::$name
        Domain name
    $nextGroupRID
    in file account.inc, variable samba3domain::$nextGroupRID
        Next group RID
    @@ -1584,18 +1645,10 @@
    in file account.inc, variable samba3domain::$nextRID
        Next RID
    $nextUserRID
    in file account.inc, variable samba3domain::$nextUserRID
        Next user RID
    -
    $noexpire
    -
    in file sambaAccount.inc, variable sambaAccount::$noexpire
        password does not expire?
    -
    $noexpire
    -
    in file sambaSamAccount.inc, variable sambaSamAccount::$noexpire
        password does not expire?
    -
    $nopwd
    -
    in file sambaSamAccount.inc, variable sambaSamAccount::$nopwd
        use no password?
    -
    $nopwd
    -
    in file sambaAccount.inc, variable sambaAccount::$nopwd
        use no password?
    $num_entries
    in file export.inc, variable PlaLdapExporter::$num_entries
    nisMailAlias.inc
    -
    procedural page nisMailAlias.inc
    +
    procedural page nisMailAlias.inc
    new_account
    in file modules.inc, method accountContainer::new_account()
        This function will prepare the object for a new account.
    new_rand
    @@ -1603,13 +1656,13 @@
    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.
    +
    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 account.inc, function ntPassword()
        Generates the NT hash of a password.
    new_ou_template.php
    -
    procedural page new_ou_template.php
    +
    procedural page new_ou_template.php
    top
    @@ -1618,14 +1671,10 @@

    o

    -
    $objectClasses
    -
    in file ldap.inc, variable Ldap::$objectClasses
        Array with all objectClass strings from the LDAP server
    $offsets
    in file fpdf.php, variable FPDF::$offsets
    $oid
    in file schema.inc, variable SchemaItem::$oid
        The OID of this schema item.
    -
    $order
    -
    in file modules.inc, variable accountContainer::$order
        Module order
    $ordering
    in file schema.inc, variable AttributeType::$ordering
        The ordering of the attributeType
    $OrientationChanges
    @@ -1645,7 +1694,7 @@
    Output
    in file fpdf.php, method FPDF::Output()
    ou_edit.php
    -
    procedural page ou_edit.php
    +
    procedural page ou_edit.php
    top
    @@ -1670,8 +1719,6 @@
    in file config.inc, variable LAMConfig::$Passwd
        Password to edit preferences
    $password
    in file config.inc, variable LAMCfgMain::$password
        Password to change config.cfg
    -
    $password
    -
    in file ldap.inc, variable Ldap::$password
        LDAP password used for bind
    $PDFVersion
    in file fpdf.php, variable FPDF::$PDFVersion
    $perm1
    @@ -1689,29 +1736,29 @@
    $possibleSuffixes
    in file lists.inc, variable lamList::$possibleSuffixes
        list of possible LDAP suffixes(organizational units)
    posixAccount.inc
    -
    procedural page posixAccount.inc
    +
    procedural page posixAccount.inc
    posixGroup.inc
    -
    procedural page posixGroup.inc
    -
    pdfstruct.inc
    -
    procedural page pdfstruct.inc
    +
    procedural page posixGroup.inc
    pdf.inc
    -
    procedural page pdf.inc
    +
    procedural page pdf.inc
    +
    pdfstruct.inc
    +
    procedural page pdfstruct.inc
    profiles.inc
    -
    procedural page profiles.inc
    +
    procedural page profiles.inc
    PageNo
    in file fpdf.php, method FPDF::PageNo()
    parse
    in file xml_parser.inc, method xmlParser::parse()
    parseHtml
    -
    in file modules.inc, function parseHtml()
        Takes a list of meta-HTML elements and prints the equivalent HTML output.
    +
    in file modules.inc, function parseHtml()
        Takes a list of meta-HTML elements and prints the equivalent HTML output.
    permute
    in file createntlm.inc, method smbHash::permute()
    PlaAbstractExporter
    in file export.inc, class PlaAbstractExporter
        This class represents the base class of all exporters
    PlaCSVExporter
    -
    in file export.inc, class PlaCSVExporter
        Export to cvs format
    -
    PlaCSVExporter
    in file export.inc, method PlaCSVExporter::PlaCSVExporter()
    +
    PlaCSVExporter
    +
    in file export.inc, class PlaCSVExporter
        Export to cvs format
    PlaDsmlExporter
    in file export.inc, class PlaDsmlExporter
        Export entries to DSML v.1
    PlaDsmlExporter
    @@ -1721,9 +1768,9 @@
    PlaExporter
    in file export.inc, method PlaExporter::PlaExporter()
        Constructor
    PlaLdapExporter
    -
    in file export.inc, class PlaLdapExporter
        Export data from a ldap server
    -
    PlaLdapExporter
    in file export.inc, method PlaLdapExporter::PlaLdapExporter()
        Create a PlaLdapExporter object.
    +
    PlaLdapExporter
    +
    in file export.inc, class PlaLdapExporter
        Export data from a ldap server
    PlaLdifExporter
    in file export.inc, class PlaLdifExporter
        Export entries to ldif format
    PlaLdifExporter
    @@ -1733,87 +1780,103 @@
    PlaVcardExporter
    in file export.inc, method PlaVcardExporter::PlaVcardExporter()
    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.
    +
    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_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_fetch_entry_array
    +
    in file export.inc, method PlaExporter::pla_fetch_entry_array()
        Return the entry as an array
    pla_fetch_entry_array
    in file export.inc, method PlaLdapExporter::pla_fetch_entry_array()
        Return the entry as an array
    pla_fetch_entry_array
    in file export.inc, method PlaAbstractExporter::pla_fetch_entry_array()
        Return the entry as an array
    -
    pla_fetch_entry_array
    -
    in file export.inc, method PlaExporter::pla_fetch_entry_array()
        Return the entry as an array
    +
    pla_fetch_entry_object
    +
    in file export.inc, method PlaLdapExporter::pla_fetch_entry_object()
        Return the entry as an Entry object
    pla_fetch_entry_object
    in file export.inc, method PlaExporter::pla_fetch_entry_object()
        Return the entry as an Entry object
    pla_fetch_entry_object
    in file export.inc, method PlaAbstractExporter::pla_fetch_entry_object()
        Return the entry as an Entry object
    -
    pla_fetch_entry_object
    -
    in file export.inc, method PlaLdapExporter::pla_fetch_entry_object()
        Return the entry as an Entry object
    pla_get_ldap_info
    in file export.inc, method PlaAbstractExporter::pla_get_ldap_info()
        Return a PlaLdapInfo Object
    pla_get_ldap_info
    -
    in file export.inc, method PlaExporter::pla_get_ldap_info()
        Return a PlaLdapInfo Object
    -
    pla_get_ldap_info
    in file export.inc, method PlaLdapExporter::pla_get_ldap_info()
        Return a PlaLdapInfo Object
    -
    pla_has_entry
    -
    in file export.inc, method PlaExporter::pla_has_entry()
        Return true if there is some more entries to be processed
    +
    pla_get_ldap_info
    +
    in file export.inc, method PlaExporter::pla_get_ldap_info()
        Return a PlaLdapInfo Object
    pla_has_entry
    in file export.inc, method PlaLdapExporter::pla_has_entry()
        Return true if there is some more entries to be processed
    pla_has_entry
    +
    in file export.inc, method PlaExporter::pla_has_entry()
        Return true if there is some more entries to be processed
    +
    pla_has_entry
    in file export.inc, method PlaAbstractExporter::pla_has_entry()
        Return true if there is some more entries to be processed
    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 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.
    +
    pla_num_entries
    +
    in file export.inc, method PlaExporter::pla_num_entries()
        Return the number of entries
    pla_num_entries
    in file export.inc, method PlaLdapExporter::pla_num_entries()
        Return the number of entries
    pla_num_entries
    in file export.inc, method PlaAbstractExporter::pla_num_entries()
        Return the number of entries
    -
    pla_num_entries
    -
    in file export.inc, method PlaExporter::pla_num_entries()
        Return the number of entries
    pla_rdelete
    -
    in file rdelete.php, function pla_rdelete()
    +
    in file rdelete.php, function pla_rdelete()
    pla_reverse_dn
    -
    in file tree.inc, function pla_reverse_dn()
        Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last
    +
    in file tree.inc, function pla_reverse_dn()
        Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last
    posixAccount
    in file posixAccount.inc, class posixAccount
        Manages the object class "posixAccount" for users and hosts.
    posixGroup
    in file posixGroup.inc, class posixGroup
        Manages the object class "posixGroup" for groups.
    +
    postDeleteActions
    +
    in file baseModule.inc, method baseModule::postDeleteActions()
        Allows the module to run commands after the LDAP entry is deleted.
    +
    postModifyActions
    +
    in file posixAccount.inc, method posixAccount::postModifyActions()
        Allows the module to run commands after the LDAP entry was changed or created.
    +
    postModifyActions
    +
    in file quota.inc, method quota::postModifyActions()
        Allows the module to run commands after the LDAP entry is changed or created.
    +
    postModifyActions
    +
    in file baseModule.inc, method baseModule::postModifyActions()
        Allows the module to run commands after the LDAP entry is changed or created.
    +
    preDeleteActions
    +
    in file posixAccount.inc, method posixAccount::preDeleteActions()
        Allows the module to run commands before the LDAP entry is deleted.
    +
    preDeleteActions
    +
    in file baseModule.inc, method baseModule::preDeleteActions()
        Allows the module to run commands before the LDAP entry is deleted.
    +
    preDeleteActions
    +
    in file quota.inc, method quota::preDeleteActions()
        Allows the module to run commands before the LDAP entry is deleted.
    +
    preModifyActions
    +
    in file baseModule.inc, method baseModule::preModifyActions()
        Allows the module to run commands before the LDAP entry is changed or created.
    pretty_print_dn
    -
    in file tree.inc, function pretty_print_dn()
        Returns an HTML-beautified version of a DN.
    +
    in file tree.inc, function pretty_print_dn()
        Returns an HTML-beautified version of a DN.
    processAttributes
    -
    in file pdf.inc, function processAttributes()
        Processes width, height and alignment attributes.
    +
    in file pdf.inc, function processAttributes()
        Processes width, height and alignment attributes.
    processFormatTags
    -
    in file pdf.inc, function processFormatTags()
        Formats the XML code.
    +
    in file pdf.inc, function processFormatTags()
        Formats the XML code.
    processLine
    -
    in file pdf.inc, function processLine()
        Creates the XML code for an PDF entry.
    -
    process_attributes
    -
    in file posixAccount.inc, method posixAccount::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file sambaSamAccount.inc, method sambaSamAccount::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file sambaAccount.inc, method sambaAccount::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file sambaDomain.inc, method sambaDomain::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::process_attributes()
        Processes user input of the primary module page.
    +
    in file pdf.inc, function processLine()
        Creates the XML code for an PDF entry.
    process_attributes
    in file posixGroup.inc, method posixGroup::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    -
    in file quota.inc, method quota::process_attributes()
        Processes user input of the primary module page.
    +
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file sambaSamAccount.inc, method sambaSamAccount::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file sambaDomain.inc, method sambaDomain::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file ieee802device.inc, method ieee802Device::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file sambaAccount.inc, method sambaAccount::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file inetOrgPerson.inc, method inetOrgPerson::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file posixAccount.inc, method posixAccount::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    in file ldapPublicKey.inc, method ldapPublicKey::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    -
    in file kolabUser.inc, method kolabUser::process_attributes()
        Processes user input of the primary module page.
    +
    in file shadowAccount.inc, method shadowAccount::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    -
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::process_attributes()
        Processes user input of the primary module page.
    +
    in file quota.inc, method quota::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file kolabUser.inc, method kolabUser::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    in file account.inc, method account::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    in file nisMailAlias.inc, method nisMailAlias::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file ieee802device.inc, method ieee802Device::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file inetOrgPerson.inc, method inetOrgPerson::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file shadowAccount.inc, method shadowAccount::process_attributes()
        Processes user input of the primary module page.
    process_deleteUser
    in file kolabUser.inc, method kolabUser::process_deleteUser()
        Write variables into object and do some regex checks
    process_expire
    @@ -1832,6 +1895,8 @@
    in file inetOrgPerson.inc, method inetOrgPerson::process_photo()
        Sets a new photo.
    process_sambaUserWorkstations
    in file sambaSamAccount.inc, method sambaSamAccount::process_sambaUserWorkstations()
        Processes user input of the primary module page.
    +
    process_terminalServer
    +
    in file sambaSamAccount.inc, method sambaSamAccount::process_terminalServer()
        Processes user input of the terminal server page.
    process_time
    in file sambaSamAccount.inc, method sambaSamAccount::process_time()
        Processes user input of the time selection page.
    process_user
    @@ -1839,29 +1904,27 @@
    process_userWorkstations
    in file sambaAccount.inc, method sambaAccount::process_userWorkstations()
        Processes user input of the workstation selection page.
    pwd_disable
    -
    in file account.inc, function pwd_disable()
        Marks an password hash as disabled and returns the new hash string
    +
    in file account.inc, function pwd_disable()
        Marks an password hash as disabled and returns the new hash string
    pwd_enable
    -
    in file account.inc, function pwd_enable()
        Marks an password hash as enabled and returns the new hash string
    +
    in file account.inc, function pwd_enable()
        Marks an password hash as enabled and returns the new hash string
    pwd_hash
    -
    in file account.inc, function pwd_hash()
        Returns the hash value of a plain text password the hash algorithm depends on the configuration file
    +
    in file account.inc, function pwd_hash()
        Returns the hash value of a plain text password the hash algorithm depends on the configuration file
    pwd_is_enabled
    -
    in file account.inc, function pwd_is_enabled()
        Checks if a password hash is enabled/disabled
    +
    in file account.inc, function pwd_is_enabled()
        Checks if a password hash is enabled/disabled
    profmanage.php
    -
    procedural page profmanage.php
    +
    procedural page profmanage.php
    pdfdelete.php
    -
    procedural page pdfdelete.php
    +
    procedural page pdfdelete.php
    pdfmain.php
    -
    procedural page pdfmain.php
    +
    procedural page pdfmain.php
    pdfpage.php
    -
    procedural page pdfpage.php
    +
    procedural page pdfpage.php
    profiledelete.php
    -
    procedural page profiledelete.php
    +
    procedural page profiledelete.php
    profilemain.php
    -
    procedural page profilemain.php
    +
    procedural page profilemain.php
    profilepage.php
    -
    procedural page profilepage.php
    -
    profManage.php
    -
    procedural page profManage.php
    +
    procedural page profilepage.php
    top
    @@ -1876,10 +1939,8 @@
    in file export.inc, variable PlaLdapExporter::$queryFilter
    $query_filter
    in file export.inc, variable LdapExportInfo::$query_filter
    -
    $quota
    -
    in file quota.inc, variable quota::$quota
    quota.inc
    -
    procedural page quota.inc
    +
    procedural page quota.inc
    quota
    in file quota.inc, class quota
        Manages quotas for users and groups.
    @@ -1890,8 +1951,6 @@

    r

    -
    $rand
    -
    in file ldap.inc, variable Ldap::$rand
        Random number (changes on every page request)
    $rdn
    in file modules.inc, variable accountContainer::$rdn
        RDN attribute of this account
    $refresh
    @@ -1902,34 +1961,28 @@
    in file export.inc, variable PlaLdapExporter::$results
    $RIDbase
    in file account.inc, variable samba3domain::$RIDbase
        RID base to calculate RIDs, default 1000
    -
    $rids
    -
    in file sambaGroupMapping.inc, variable sambaGroupMapping::$rids
        Array of well known RIDs
    -
    $rids
    -
    in file sambaSamAccount.inc, variable sambaSamAccount::$rids
        array of well known rids
    -
    $rids
    -
    in file sambaAccount.inc, variable sambaAccount::$rids
        Array of well known rids
    $rMargin
    in file fpdf.php, variable FPDF::$rMargin
    +
    readTime
    +
    in file sambaMungedDial.inc, method sambaMungedDial::readTime()
        readTime
    real_attr_name
    -
    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 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.
    Rect
    in file fpdf.php, method FPDF::Rect()
    +
    refreshPrimaryGroupTranslation
    +
    in file user.inc, method lamUserList::refreshPrimaryGroupTranslation()
        Refreshes the GID to group name cache.
    refresh_cache
    in file cache.inc, method cache::refresh_cache()
        This function refreshes the cache.
    -
    reload
    -
    in file config.inc, method LAMCfgMain::reload()
        Reloads preferences from config file config.cfg
    -
    reload
    -
    in file config.inc, method LAMConfig::reload()
        Reloads preferences from config file
    removeAlias
    in file schema.inc, method AttributeType::removeAlias()
        Removes an attribute name from this attribute's alias array.
    remove_aliases
    -
    in file custom.php, function remove_aliases()
        Removes attributes from the array that are aliases for eachother
    -
    RndInt
    -
    in file account.inc, function RndInt()
        THIS FUNCTION GENERATES A RANDOM NUMBER THAT WILL BE USED TO RANDOMLY SELECT CHARACTERS.
    +
    in file custom.php, function remove_aliases()
        Removes attributes from the array that are aliases for eachother
    +
    replaceSpecialChars
    +
    in file quota.inc, method quota::replaceSpecialChars()
        Replaces special characters in HTML name values.
    rdelete.php
    -
    procedural page rdelete.php
    +
    procedural page rdelete.php
    refresh.php
    -
    procedural page refresh.php
    +
    procedural page refresh.php
    top
    @@ -1938,38 +1991,32 @@

    s

    -
    $sambaGroupTypes
    -
    in file sambaGroupMapping.inc, variable sambaGroupMapping::$sambaGroupTypes
        Array of sambaGroupTypes
    $sbox
    in file createntlm.inc, variable smbHash::$sbox
    $sc
    in file createntlm.inc, variable smbHash::$sc
    $scope
    -
    in file baseModule.inc, variable baseModule::$scope
        the account type of this module (user, group, host)
    +
    in file export.inc, variable PlaLdapExporter::$scope
    $scope
    in file export.inc, variable LdapExportInfo::$scope
    -
    $scope
    -
    in file export.inc, variable PlaLdapExporter::$scope
    $scriptPath
    in file config.inc, variable LAMConfig::$scriptPath
        Path to external lamdaemon script on server where it is executed
    +
    $scriptRights
    +
    in file config.inc, variable LAMConfig::$scriptRights
        The rights for the home directory
    $scriptServer
    -
    in file config.inc, variable LAMConfig::$scriptServer
        Server where lamdaemon script is executed
    +
    in file config.inc, variable LAMConfig::$scriptServer
        Servers where lamdaemon script is executed
    $searchAttribute
    in file selfService.inc, variable selfServiceProfile::$searchAttribute
        LDAP search attribute
    +
    $selfServiceSettings
    +
    in file baseModule.inc, variable baseModule::$selfServiceSettings
        self service settings of all modules
    $separator
    in file export.inc, variable PlaCSVExporter::$separator
        When doing an exporter, the method export need to be overriden.
    -
    $server
    -
    in file ldap.inc, variable Ldap::$server
        Server handle
    $ServerURL
    in file config.inc, variable LAMConfig::$ServerURL
        Server address (e.g. ldap://127.0.0.1:389)
    $serverURL
    in file selfService.inc, variable selfServiceProfile::$serverURL
        server address
    $sessionTimeout
    in file config.inc, variable LAMCfgMain::$sessionTimeout
        Time of inactivity before session times out (minutes)
    -
    $settings
    -
    in file config.inc, variable LAMConfig::$settings
        List of all settings in config file
    -
    $settings
    -
    in file config.inc, variable LAMCfgMain::$settings
        list of data fields to save in config file
    $SID
    in file account.inc, variable samba3domain::$SID
        Domain SID
    $sortColumn
    @@ -1980,8 +2027,6 @@
    in file fpdf.php, variable FPDF::$state
    $subject
    in file fpdf.php, variable FPDF::$subject
    -
    $subpage
    -
    in file modules.inc, variable accountContainer::$subpage
        This variable is set to the pagename of a subpage if it should be displayed
    $sub_str
    in file schema.inc, variable AttributeType::$sub_str
        Boolean: supports substring matching?
    $suffix
    @@ -1997,25 +2042,27 @@
    $syntax
    in file schema.inc, variable MatchingRule::$syntax
        This rule's syntax OID
    sambaAccount.inc
    -
    procedural page sambaAccount.inc
    +
    procedural page sambaAccount.inc
    sambaDomain.inc
    -
    procedural page sambaDomain.inc
    +
    procedural page sambaDomain.inc
    sambaGroupMapping.inc
    -
    procedural page sambaGroupMapping.inc
    +
    procedural page sambaGroupMapping.inc
    +
    sambaMungedDial.inc
    +
    procedural page sambaMungedDial.inc
    sambaSamAccount.inc
    -
    procedural page sambaSamAccount.inc
    +
    procedural page sambaSamAccount.inc
    shadowAccount.inc
    -
    procedural page shadowAccount.inc
    +
    procedural page shadowAccount.inc
    schema.inc
    -
    procedural page schema.inc
    +
    procedural page schema.inc
    security.inc
    -
    procedural page security.inc
    +
    procedural page security.inc
    selfService.inc
    -
    procedural page selfService.inc
    +
    procedural page selfService.inc
    status.inc
    -
    procedural page status.inc
    +
    procedural page status.inc
    smbDomain.inc
    -
    procedural page smbDomain.inc
    +
    procedural page smbDomain.inc
    samba3domain
    in file account.inc, class samba3domain
        Represents a Samba 3 domain entry
    sambaAccount
    @@ -2028,66 +2075,70 @@
    in file sambaGroupMapping.inc, method sambaGroupMapping::sambaGroupMapping()
        Creates a new module for Samba 3 groups.
    sambaGroupMapping
    in file sambaGroupMapping.inc, class sambaGroupMapping
        Manages the object class "sambaGroupMapping" for groups.
    -
    sambaSamAccount
    -
    in file sambaSamAccount.inc, method sambaSamAccount::sambaSamAccount()
        Creates a new sambaSamAccount object.
    +
    sambaMungedDial
    +
    in file sambaMungedDial.inc, class sambaMungedDial
        Manages terminal server settings for Samba 3.
    sambaSamAccount
    in file sambaSamAccount.inc, class sambaSamAccount
        Manages the object class "sambaSamAccount" for users and hosts.
    -
    save
    -
    in file config.inc, method LAMConfig::save()
        Saves preferences to config file
    +
    sambaSamAccount
    +
    in file sambaSamAccount.inc, method sambaSamAccount::sambaSamAccount()
        Creates a new sambaSamAccount object.
    +
    SAMBA_MUNGEDDIAL_FILEHEADER
    +
    in file sambaMungedDial.inc, constant SAMBA_MUNGEDDIAL_FILEHEADER
        File header
    +
    SAMBA_MUNGEDDIAL_FILEHEADER_OLD
    +
    in file sambaMungedDial.inc, constant SAMBA_MUNGEDDIAL_FILEHEADER_OLD
        File header for old format.
    save
    in file config.inc, method LAMCfgMain::save()
        Saves preferences to config file config.cfg
    +
    save
    +
    in file config.inc, method LAMConfig::save()
        Saves preferences to config file
    saveAccountProfile
    -
    in file profiles.inc, function saveAccountProfile()
        Saves an hash array (attribute => value) to an account profile
    +
    in file profiles.inc, function saveAccountProfile()
        Saves an hash array (attribute => value) to an account profile
    savePDFStructureDefinitions
    -
    in file pdfstruct.inc, function savePDFStructureDefinitions()
        Saves PDF structure definitions to XML file in format: <name>.<scope>.xml
    +
    in file pdfstruct.inc, function savePDFStructureDefinitions()
        Saves PDF structure definitions to XML file in format: <name>.<scope>.xml
    saveSelfServiceProfile
    -
    in file selfService.inc, function saveSelfServiceProfile()
        Saves a self service profile.
    +
    in file selfService.inc, function saveSelfServiceProfile()
        Saves a self service profile.
    saveSettings
    -
    in file confmain.php, function saveSettings()
        Saves the entered settings.
    +
    in file confmain.php, function saveSettings()
        Saves the entered settings.
    save_account
    in file modules.inc, method accountContainer::save_account()
        This function will save an account to the LDAP database.
    save_attributes
    -
    in file nisMailAlias.inc, method nisMailAlias::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    -
    save_attributes
    -
    in file inetOrgPerson.inc, method inetOrgPerson::save_attributes()
    +
    in file posixGroup.inc, method posixGroup::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    in file kolabUser.inc, method kolabUser::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    -
    in file account.inc, method account::save_attributes()
    +
    in file account.inc, method account::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    +
    save_attributes
    +
    in file nisMailAlias.inc, method nisMailAlias::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    +
    save_attributes
    +
    in file inetOrgPerson.inc, method inetOrgPerson::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    in file posixAccount.inc, method posixAccount::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    -
    in file baseModule.inc, method baseModule::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    +
    in file sambaSamAccount.inc, method sambaSamAccount::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    -
    in file sambaSamAccount.inc, method sambaSamAccount::save_attributes()
    -
    save_attributes
    -
    in file sambaAccount.inc, method sambaAccount::save_attributes()
    +
    in file sambaAccount.inc, method sambaAccount::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    in file shadowAccount.inc, method shadowAccount::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    -
    in file posixGroup.inc, method posixGroup::save_attributes()
    +
    in file baseModule.inc, method baseModule::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    -
    in file quota.inc, method quota::save_attributes()
    -
    save_attributes
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::save_attributes()
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_module_attributes
    in file modules.inc, method accountContainer::save_module_attributes()
        This function checks which LDAP attributes have changed while the account was edited.
    SchemaItem
    -
    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.
    -
    SchemaItem
    in file schema.inc, method SchemaItem::SchemaItem()
        Default constructor.
    +
    SchemaItem
    +
    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).
    +
    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
    +
    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.
    +
    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, method selfServiceProfile::selfServiceProfile()
        Constructor
    +
    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
    setAliases
    @@ -2096,10 +2147,24 @@
    in file fpdf.php, method FPDF::SetAuthor()
    SetAutoPageBreak
    in file fpdf.php, method FPDF::SetAutoPageBreak()
    +
    setBrokenConn
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setBrokenConn()
        sets Broken-Connection value: disconnect/reset
    SetCompression
    in file fpdf.php, method FPDF::SetCompression()
    +
    setConnectClientDrives
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setConnectClientDrives()
        sets connect-client-drive-at-logon value: enabled/disabled
    +
    setConnectClientPrinters
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setConnectClientPrinters()
        sets connect-client-printers-at-logon value: enabled/disabled
    SetCreator
    in file fpdf.php, method FPDF::SetCreator()
    +
    setCtxMaxConnectionTimeF
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setCtxMaxConnectionTimeF()
        SMARTY: sets the checkbox "Connection" to unchecked
    +
    setCtxMaxDisconnectionTimeF
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setCtxMaxDisconnectionTimeF()
        SMARTY: sets the checkbox "Disconnection" to unchecked
    +
    setCtxMaxIdleTimeF
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setCtxMaxIdleTimeF()
        SMARTY: sets the checkbox "Idle" to unchecked
    +
    setDefaultPrinter
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setDefaultPrinter()
        sets set-client-printer-to-default value: enabled/disabled
    setDescription
    in file schema.inc, method SchemaItem::setDescription()
    SetDisplayMode
    @@ -2112,12 +2177,14 @@
    in file fpdf.php, method FPDF::SetFont()
    SetFontSize
    in file fpdf.php, method FPDF::SetFontSize()
    +
    setInheritMode
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setInheritMode()
        sets Inherit-config-from-client value: enabled/disabled
    setIsSingleValue
    in file schema.inc, method AttributeType::setIsSingleValue()
        Sets whether this attribute is single-valued.
    SetKeywords
    in file fpdf.php, method FPDF::SetKeywords()
    setlanguage
    -
    in file config.inc, function setlanguage()
        Sets language settings for automatic translation
    +
    in file config.inc, function setlanguage()
        Sets language settings for automatic translation
    SetLeftMargin
    in file fpdf.php, method FPDF::SetLeftMargin()
    SetLineWidth
    @@ -2132,8 +2199,12 @@
    in file schema.inc, method SchemaItem::setOID()
    setOutputFormat
    in file export.inc, method PlaExporter::setOutputFormat()
        Set the carriage return /linefeed for the export
    +
    setReConn
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setReConn()
        sets Reconnection value: from any client/from previous client only
    SetRightMargin
    in file fpdf.php, method FPDF::SetRightMargin()
    +
    setShadow
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setShadow()
        sets shadow value
    SetSubject
    in file fpdf.php, method FPDF::SetSubject()
    setSupAttribute
    @@ -2144,6 +2215,8 @@
    in file fpdf.php, method FPDF::SetTitle()
    SetTopMargin
    in file fpdf.php, method FPDF::SetTopMargin()
    +
    setTsLogin
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setTsLogin()
        Sets Terminal-Server-Login value: enabled/disabled
    setType
    in file schema.inc, method AttributeType::setType()
        Sets this attribute's type.
    setUsedByAttrs
    @@ -2161,7 +2234,7 @@
    set_Adminstring
    in file config.inc, method LAMConfig::set_Adminstring()
        Sets the admin string
    set_cached_schema
    -
    in file schema.inc, function set_cached_schema()
        Caches the specified $schema_type.
    +
    in file schema.inc, function set_cached_schema()
        Caches the specified $schema_type.
    set_cacheTimeout
    in file config.inc, method LAMConfig::set_cacheTimeout()
        Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)
    set_defaultLanguage
    @@ -2175,11 +2248,13 @@
    set_Passwd
    in file config.inc, method LAMConfig::set_Passwd()
        Sets the preferences wizard password
    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.
    +
    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.
    set_scriptPath
    in file config.inc, method LAMConfig::set_scriptPath()
        Sets the path to the external script
    -
    set_scriptServer
    -
    in file config.inc, method LAMConfig::set_scriptServer()
        Sets the server of the external script
    +
    set_scriptRights
    +
    in file config.inc, method LAMConfig::set_scriptRights()
        Sets the rights for the home directory.
    +
    set_scriptServers
    +
    in file config.inc, method LAMConfig::set_scriptServers()
        Sets the servers of the external script
    set_ServerURL
    in file config.inc, method LAMConfig::set_ServerURL()
        Sets the server address
    set_Suffix
    @@ -2189,43 +2264,41 @@
    shadowAccount
    in file shadowAccount.inc, class shadowAccount
        Manages the object class "shadowAccount" for users.
    showColumnData
    -
    in file masscreate.php, function showColumnData()
        Prints the properties of one input field.
    +
    in file masscreate.php, function showColumnData()
        Prints the properties of one input field.
    showMainPage
    -
    in file masscreate.php, function showMainPage()
        Displays the acount type specific main page of the upload.
    +
    in file masscreate.php, function showMainPage()
        Displays the acount type specific main page of the upload.
    showPage
    in file lists.inc, method lamList::showPage()
        Prints the HTML code to display the list view.
    smbDomain
    in file smbDomain.inc, class smbDomain
        The account type for Samba domains.
    smbflag
    -
    in file account.inc, function smbflag()
        Takes a list of Samba flags and creates the corresponding flag string.
    +
    in file account.inc, function smbflag()
        Takes a list of Samba flags and creates the corresponding flag string.
    smbHash
    in file createntlm.inc, class smbHash
        Calculates NT and LM hashes.
    smb_hash
    -
    in file createntlm.inc, method smbHash::smb_hash()
    +
    in file createntlm.inc, method smbHash::smb_hash()
        smb_hash
    sortAttrs
    -
    in file tree.inc, function sortAttrs()
    +
    in file tree.inc, function sortAttrs()
    sortModules
    in file modules.inc, method accountContainer::sortModules()
        Sorts the module buttons for the account page.
    startSecureSession
    -
    in file security.inc, function startSecureSession()
        Starts a session and checks the environment.
    +
    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 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.
    +
    strhex
    +
    in file sambaMungedDial.inc, method sambaMungedDial::strhex()
        strhex
    strlen
    in file ufpdf.php, method UFPDF::strlen()
    str_to_key
    -
    in file createntlm.inc, method smbHash::str_to_key()
    +
    in file createntlm.inc, method smbHash::str_to_key()
        str_to_key
    Syntax
    in file schema.inc, class Syntax
        Represents an LDAP Syntax
    Syntax
    in file schema.inc, method Syntax::Syntax()
        Creates a new Syntax object from a raw LDAP syntax string.
    schema.php
    -
    procedural page schema.php
    -
    selfServiceLogin.php
    -
    procedural page selfServiceLogin.php
    -
    selfServiceMain.php
    -
    procedural page selfServiceMain.php
    +
    procedural page schema.php
    status-test.php
    -
    procedural page status-test.php
    +
    procedural page status-test.php
    top
    @@ -2236,44 +2309,38 @@
    $TextColor
    in file fpdf.php, variable FPDF::$TextColor
    -
    $time
    -
    in file cache.inc, variable cache::$time
        This is the last timestamp on which the LDAP cache has been refreshed
    $title
    in file fpdf.php, variable FPDF::$title
    $tMargin
    in file fpdf.php, variable FPDF::$tMargin
    -
    $trans_primary
    -
    in file user.inc, variable lamUserList::$trans_primary
        Controls if GID number is translated to group name
    -
    $trans_primary_hash
    -
    in file user.inc, variable lamUserList::$trans_primary_hash
        translates GID to group name
    $treesuffix
    in file config.inc, variable LAMConfig::$treesuffix
        LDAP suffix for tree view
    $type
    in file schema.inc, variable ObjectClass::$type
        one of STRUCTURAL, ABSTRACT, or AUXILIARY
    $type
    -
    in file schema.inc, variable AttributeType::$type
        A string description of the syntax type (taken from the LDAPSyntaxes)
    -
    $type
    in file lists.inc, variable lamList::$type
        Account type
    $type
    -
    in file modules.inc, variable accountContainer::$type
        This variale stores the account type.
    +
    in file schema.inc, variable AttributeType::$type
        A string description of the syntax type (taken from the LDAPSyntaxes)
    $typeSettings
    in file config.inc, variable LAMConfig::$typeSettings
        type settings
    tree.inc
    -
    procedural page tree.inc
    +
    procedural page tree.inc
    types.inc
    -
    procedural page types.inc
    +
    procedural page types.inc
    tools.php
    -
    procedural page tools.php
    +
    procedural page tools.php
    templates.inc
    -
    procedural page templates.inc
    +
    procedural page templates.inc
    tree.php
    -
    procedural page tree.php
    +
    procedural page tree.php
    tree_view.php
    -
    procedural page tree_view.php
    -
    Text
    -
    in file fpdf.php, method FPDF::Text()
    +
    procedural page tree_view.php
    Text
    in file ufpdf.php, method UFPDF::Text()
    +
    Text
    +
    in file fpdf.php, method FPDF::Text()
    +
    to8bit
    +
    in file sambaMungedDial.inc, method sambaMungedDial::to8bit()
        to8bit
    top
    @@ -2292,28 +2359,22 @@
    in file schema.inc, variable MatchingRuleUse::$used_by_attrs
        An array of attributeType names who make use of the mathingRule
    $used_in_object_classes
    in file schema.inc, variable AttributeType::$used_in_object_classes
        An array of objectClasses which use this attributeType (must be set by caller)
    -
    $username
    -
    in file ldap.inc, variable Ldap::$username
        LDAP username used for bind
    -
    $useunixpwd
    -
    in file sambaSamAccount.inc, variable sambaSamAccount::$useunixpwd
        use Unix password as samba password?
    -
    $useunixpwd
    -
    in file sambaAccount.inc, variable sambaAccount::$useunixpwd
        use Unix password as samba password?
    user.inc
    -
    procedural page user.inc
    +
    procedural page user.inc
    ufpdf.php
    -
    procedural page ufpdf.php
    +
    procedural page ufpdf.php
    userlink.php
    -
    procedural page userlink.php
    -
    update_confirm.php
    -
    procedural page update_confirm.php
    +
    procedural page userlink.php
    update.php
    -
    procedural page update.php
    +
    procedural page update.php
    +
    update_confirm.php
    +
    procedural page update_confirm.php
    UFPDF
    in file ufpdf.php, method UFPDF::UFPDF()
        *****************************************************************************
    UFPDF
    in file ufpdf.php, class UFPDF
        Main UFPDF class for creating Unicode PDF documents
    UFPDF_VERSION
    -
    in file ufpdf.php, constant UFPDF_VERSION
        *****************************************************************************
    +
    in file ufpdf.php, constant UFPDF_VERSION
        *****************************************************************************
    unsigned_shift_r
    in file createntlm.inc, method smbHash::unsigned_shift_r()
        Unsigned shift operation for 32bit values.
    updateCapabilities
    @@ -2338,14 +2399,14 @@
    $vcardMapping
    in file export.inc, variable PlaVcardExporter::$vcardMapping
    -
    verabi.php
    -
    procedural page verabi.php
    -
    verab.php
    -
    procedural page verab.php
    -
    verai.php
    -
    procedural page verai.php
    vera.php
    -
    procedural page vera.php
    +
    procedural page vera.php
    +
    verab.php
    +
    procedural page verab.php
    +
    verabi.php
    +
    procedural page verabi.php
    +
    verai.php
    +
    procedural page verai.php
    top
    @@ -2374,10 +2435,8 @@
    $x
    in file fpdf.php, variable FPDF::$x
    -
    $xmlParser
    -
    in file xml_parser.inc, variable xmlParser::$xmlParser
    xml_parser.inc
    -
    procedural page xml_parser.inc
    +
    procedural page xml_parser.inc
    x
    in file createntlm.inc, method smbHash::x()
        Fixes too large numbers
    xmlParser
    @@ -2433,9 +2492,9 @@
    _getfontpath
    in file fpdf.php, method FPDF::_getfontpath()
    _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".
    +
    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, function _get_schema_dn()
        Helper for _get_raw_schema() which fetches the DN of the schema object
    _newobj
    in file fpdf.php, method FPDF::_newobj()
    _out
    @@ -2493,7 +2552,7 @@ top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: Help ] + + + [ class tree: Help ] [ index: Help ] - [ all elements ] + [ all elements ]
    - [ class tree: LDAP ] + + + [ class tree: LDAP ] [ index: LDAP ] - [ all elements ] + [ all elements ]

    Element index for package LDAP

    - [ a ] [ c ] [ d ] [ e ] [ h ] - [ i ] [ l ] [ n ] - [ o ] - [ p ] - [ r ] [ s ] [ u ] [ _ ] @@ -86,23 +85,11 @@ top
    -
    - -
    -

    a

    -
    -
    $attributes
    -
    in file ldap.inc, variable Ldap::$attributes
        Array with all attribute strings from the LDAP server
    -
    -
    - top

    c

    -
    $conf
    -
    in file ldap.inc, variable Ldap::$conf
        Object of Config to access preferences
    close
    in file ldap.inc, method Ldap::close()
        Closes connection to server
    cmp_array
    @@ -144,15 +131,7 @@

    h

    hex2bin
    -
    in file ldap.inc, function hex2bin()
        Converts a HEX string to a binary value
    -
    -
    - top
    -
    - -
    -

    i

    -
    +
    in file ldap.inc, function hex2bin()
        Converts a HEX string to a binary value
    top
    @@ -166,7 +145,7 @@
    Ldap
    in file ldap.inc, class Ldap
        Ldap manages connection to LDAP and includes several helper functions.
    ldap.inc
    -
    procedural page ldap.inc
    +
    procedural page ldap.inc
    top
    @@ -180,43 +159,11 @@ top
    -
    - -
    -

    o

    -
    -
    $objectClasses
    -
    in file ldap.inc, variable Ldap::$objectClasses
        Array with all objectClass strings from the LDAP server
    -
    -
    - top
    -
    - -
    -

    p

    -
    -
    $password
    -
    in file ldap.inc, variable Ldap::$password
        LDAP password used for bind
    -
    -
    - top
    -
    - -
    -

    r

    -
    -
    $rand
    -
    in file ldap.inc, variable Ldap::$rand
        Random number (changes on every page request)
    -
    -
    - top

    s

    -
    $server
    -
    in file ldap.inc, variable Ldap::$server
        Server handle
    $supports_unix_hosts
    in file ldap.inc, variable Ldap::$supports_unix_hosts
        Host attribute in inetOrgPerson
    search_units
    @@ -231,8 +178,6 @@

    u

    -
    $username
    -
    in file ldap.inc, variable Ldap::$username
        LDAP username used for bind
    updateCapabilities
    in file ldap.inc, method Ldap::updateCapabilities()
        Updates the capabilities values (var $supports_*)
    updateClasses
    @@ -242,7 +187,7 @@ top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: PDF ] + + + [ class tree: PDF ] [ index: PDF ] - [ all elements ] + [ all elements ]
    @@ -248,7 +252,7 @@
    code2utf
    in file ufpdf.php, method UFPDF::code2utf()
    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 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.
    top
    @@ -264,7 +268,7 @@
    $DrawColor
    in file fpdf.php, variable FPDF::$DrawColor
    deletePDFStructureDefinition
    -
    in file pdfstruct.inc, function deletePDFStructureDefinition()
        Deletes XML file with PDF structure definitions.
    +
    in file pdfstruct.inc, function deletePDFStructureDefinition()
        Deletes XML file with PDF structure definitions.
    top
    @@ -318,9 +322,9 @@
    FPDF
    in file fpdf.php, class FPDF
        Main FPDF class for creating PDF documents
    FPDF_VERSION
    -
    in file fpdf.php, constant FPDF_VERSION
        *****************************************************************************
    +
    in file fpdf.php, constant FPDF_VERSION
        *****************************************************************************
    fpdf.php
    -
    procedural page fpdf.php
    +
    procedural page fpdf.php
    top
    @@ -330,11 +334,11 @@

    g

    getAvailableLogos
    -
    in file pdfstruct.inc, function getAvailableLogos()
        This function returns an array with all aviliable logo images.
    +
    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.
    +
    in file pdfstruct.inc, function getPDFStructureDefinitions()
        This function will return all available PDF structure definitions for the submitted account scope.
    getSectionHeadline
    -
    in file pdf.inc, function getSectionHeadline()
        Creates a section headline.
    +
    in file pdf.inc, function getSectionHeadline()
        Creates a section headline.
    GetStringWidth
    in file ufpdf.php, method UFPDF::GetStringWidth()
    GetStringWidth
    @@ -408,7 +412,7 @@
    lamPDF
    in file pdf.inc, class lamPDF
        Creates a LAM information page in PDF format.
    LAMPDF_LINEWIDTH
    -
    in file pdf.inc, constant LAMPDF_LINEWIDTH
        PDF line width
    +
    in file pdf.inc, constant LAMPDF_LINEWIDTH
        PDF line width
    Line
    in file fpdf.php, method FPDF::Line()
    Link
    @@ -416,7 +420,7 @@
    Ln
    in file fpdf.php, method FPDF::Ln()
    loadPDFStructureDefinitions
    -
    in file pdfstruct.inc, function loadPDFStructureDefinitions()
        This function is used to get pdf structure from xml file.
    +
    in file pdfstruct.inc, function loadPDFStructureDefinitions()
        This function is used to get pdf structure from xml file.
    top
    @@ -475,26 +479,26 @@
    in file pdf.inc, variable lamPDF::$page_definitions
        format settings for page layout
    $PDFVersion
    in file fpdf.php, variable FPDF::$PDFVersion
    -
    pdfstruct.inc
    -
    procedural page pdfstruct.inc
    pdf.inc
    -
    procedural page pdf.inc
    +
    procedural page pdf.inc
    +
    pdfstruct.inc
    +
    procedural page pdfstruct.inc
    PageNo
    in file fpdf.php, method FPDF::PageNo()
    parse
    in file xml_parser.inc, method xmlParser::parse()
    processAttributes
    -
    in file pdf.inc, function processAttributes()
        Processes width, height and alignment attributes.
    +
    in file pdf.inc, function processAttributes()
        Processes width, height and alignment attributes.
    processFormatTags
    -
    in file pdf.inc, function processFormatTags()
        Formats the XML code.
    +
    in file pdf.inc, function processFormatTags()
        Formats the XML code.
    processLine
    -
    in file pdf.inc, function processLine()
        Creates the XML code for an PDF entry.
    +
    in file pdf.inc, function processLine()
        Creates the XML code for an PDF entry.
    pdfdelete.php
    -
    procedural page pdfdelete.php
    +
    procedural page pdfdelete.php
    pdfmain.php
    -
    procedural page pdfmain.php
    +
    procedural page pdfmain.php
    pdfpage.php
    -
    procedural page pdfpage.php
    +
    procedural page pdfpage.php
    top
    @@ -520,7 +524,7 @@
    $subject
    in file fpdf.php, variable FPDF::$subject
    savePDFStructureDefinitions
    -
    in file pdfstruct.inc, function savePDFStructureDefinitions()
        Saves PDF structure definitions to XML file in format: <name>.<scope>.xml
    +
    in file pdfstruct.inc, function savePDFStructureDefinitions()
        Saves PDF structure definitions to XML file in format: <name>.<scope>.xml
    SetAuthor
    in file fpdf.php, method FPDF::SetAuthor()
    SetAutoPageBreak
    @@ -596,13 +600,13 @@
    $underline
    in file fpdf.php, variable FPDF::$underline
    ufpdf.php
    -
    procedural page ufpdf.php
    +
    procedural page ufpdf.php
    UFPDF
    in file ufpdf.php, method UFPDF::UFPDF()
        *****************************************************************************
    UFPDF
    in file ufpdf.php, class UFPDF
        Main UFPDF class for creating Unicode PDF documents
    UFPDF_VERSION
    -
    in file ufpdf.php, constant UFPDF_VERSION
        *****************************************************************************
    +
    in file ufpdf.php, constant UFPDF_VERSION
        *****************************************************************************
    utf8_substr
    in file ufpdf.php, method UFPDF::utf8_substr()
    utf8_to_codepoints
    @@ -617,14 +621,14 @@

    v

    -
    verabi.php
    -
    procedural page verabi.php
    -
    verab.php
    -
    procedural page verab.php
    -
    verai.php
    -
    procedural page verai.php
    vera.php
    -
    procedural page vera.php
    +
    procedural page vera.php
    +
    verab.php
    +
    procedural page verab.php
    +
    verabi.php
    +
    procedural page verabi.php
    +
    verai.php
    +
    procedural page verai.php
    top
    @@ -653,10 +657,8 @@
    $x
    in file fpdf.php, variable FPDF::$x
    -
    $xmlParser
    -
    in file xml_parser.inc, variable xmlParser::$xmlParser
    xml_parser.inc
    -
    procedural page xml_parser.inc
    +
    procedural page xml_parser.inc
    xmlParser
    in file xml_parser.inc, method xmlParser::xmlParser()
    xmlParser
    @@ -686,7 +688,7 @@ top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: configuration ] + + + [ class tree: configuration ] [ index: configuration ] - [ all elements ] + [ all elements ]
    @@ -85,7 +89,6 @@ [ l ] [ m ] [ p ] - [ r ] [ s ] [ t ] @@ -110,18 +113,20 @@
    $cachetimeout
    in file config.inc, variable LAMConfig::$cachetimeout
        LDAP cache timeout
    +
    checkChmod
    +
    in file config.inc, function checkChmod()
        Checks whether a specific flag in the rights string is set.
    config_showAccountModules
    -
    in file confmodules.php, function config_showAccountModules()
        Displays the module selection boxes and checks if dependencies are fulfilled.
    +
    in file confmodules.php, function config_showAccountModules()
        Displays the module selection boxes and checks if dependencies are fulfilled.
    config.inc
    -
    procedural page config.inc
    +
    procedural page config.inc
    conflogin.php
    -
    procedural page conflogin.php
    +
    procedural page conflogin.php
    confmain.php
    -
    procedural page confmain.php
    +
    procedural page confmain.php
    confmodules.php
    -
    procedural page confmodules.php
    +
    procedural page confmodules.php
    conftypes.php
    -
    procedural page conftypes.php
    +
    procedural page conftypes.php
    top
    @@ -153,7 +158,7 @@

    g

    getConfigProfiles
    -
    in file config.inc, function getConfigProfiles()
        Returns an array of string with all available configuration profiles (without .conf)
    +
    in file config.inc, function getConfigProfiles()
        Returns an array of string with all available configuration profiles (without .conf)
    get_AccountModules
    in file config.inc, method LAMConfig::get_AccountModules()
        Returns an array of all selected account modules
    get_ActiveTypes
    @@ -178,8 +183,10 @@
    in file config.inc, method LAMConfig::get_Passwd()
        Returns the password to access the preferences wizard
    get_scriptPath
    in file config.inc, method LAMConfig::get_scriptPath()
        Returns the path to the external script
    -
    get_scriptServer
    -
    in file config.inc, method LAMConfig::get_scriptServer()
        Returns the server of the external script
    +
    get_scriptRights
    +
    in file config.inc, method LAMConfig::get_scriptRights()
        Returns the chmod value for new home directories.
    +
    get_scriptServers
    +
    in file config.inc, method LAMConfig::get_scriptServers()
        Returns the servers of the external script as a Array
    get_ServerURL
    in file config.inc, method LAMConfig::get_ServerURL()
        Returns the server address as string
    get_Suffix
    @@ -194,8 +201,10 @@

    i

    +
    isWritable
    +
    in file config.inc, method LAMConfig::isWritable()
        Returns if the file can be written on the filesystem.
    index.php
    -
    procedural page index.php
    +
    procedural page index.php
    top
    @@ -217,7 +226,7 @@
    LAMConfig
    in file config.inc, class LAMConfig
        This class manages .conf files.
    LAMVersion
    -
    in file config.inc, function LAMVersion()
        Returns the version number of this LAM installation.
    +
    in file config.inc, function LAMVersion()
        Returns the version number of this LAM installation.
    top
    @@ -231,11 +240,11 @@
    $moduleSettings
    in file config.inc, variable LAMConfig::$moduleSettings
        module settings
    metaRefresh
    -
    in file config.inc, function metaRefresh()
        Prints a meta refresh page
    +
    in file config.inc, function metaRefresh()
        Prints a meta refresh page
    mainlogin.php
    -
    procedural page mainlogin.php
    +
    procedural page mainlogin.php
    mainmanage.php
    -
    procedural page mainmanage.php
    +
    procedural page mainmanage.php
    top
    @@ -249,19 +258,7 @@
    $password
    in file config.inc, variable LAMCfgMain::$password
        Password to change config.cfg
    profmanage.php
    -
    procedural page profmanage.php
    - - - top
    -
    - -
    -

    r

    -
    -
    reload
    -
    in file config.inc, method LAMCfgMain::reload()
        Reloads preferences from config file config.cfg
    -
    reload
    -
    in file config.inc, method LAMConfig::reload()
        Reloads preferences from config file
    +
    procedural page profmanage.php
    top
    @@ -272,24 +269,22 @@
    $scriptPath
    in file config.inc, variable LAMConfig::$scriptPath
        Path to external lamdaemon script on server where it is executed
    +
    $scriptRights
    +
    in file config.inc, variable LAMConfig::$scriptRights
        The rights for the home directory
    $scriptServer
    -
    in file config.inc, variable LAMConfig::$scriptServer
        Server where lamdaemon script is executed
    +
    in file config.inc, variable LAMConfig::$scriptServer
        Servers where lamdaemon script is executed
    $ServerURL
    in file config.inc, variable LAMConfig::$ServerURL
        Server address (e.g. ldap://127.0.0.1:389)
    $sessionTimeout
    in file config.inc, variable LAMCfgMain::$sessionTimeout
        Time of inactivity before session times out (minutes)
    -
    $settings
    -
    in file config.inc, variable LAMCfgMain::$settings
        list of data fields to save in config file
    -
    $settings
    -
    in file config.inc, variable LAMConfig::$settings
        List of all settings in config file
    save
    in file config.inc, method LAMCfgMain::save()
        Saves preferences to config file config.cfg
    save
    in file config.inc, method LAMConfig::save()
        Saves preferences to config file
    saveSettings
    -
    in file confmain.php, function saveSettings()
        Saves the entered settings.
    +
    in file confmain.php, function saveSettings()
        Saves the entered settings.
    setlanguage
    -
    in file config.inc, function setlanguage()
        Sets language settings for automatic translation
    +
    in file config.inc, function setlanguage()
        Sets language settings for automatic translation
    set_AccountModules
    in file config.inc, method LAMConfig::set_AccountModules()
        Sets the selected account modules
    set_ActiveTypes
    @@ -310,8 +305,10 @@
    in file config.inc, method LAMConfig::set_Passwd()
        Sets the preferences wizard password
    set_scriptPath
    in file config.inc, method LAMConfig::set_scriptPath()
        Sets the path to the external script
    -
    set_scriptServer
    -
    in file config.inc, method LAMConfig::set_scriptServer()
        Sets the server of the external script
    +
    set_scriptRights
    +
    in file config.inc, method LAMConfig::set_scriptRights()
        Sets the rights for the home directory.
    +
    set_scriptServers
    +
    in file config.inc, method LAMConfig::set_scriptServers()
        Sets the servers of the external script
    set_ServerURL
    in file config.inc, method LAMConfig::set_ServerURL()
        Sets the server address
    set_Suffix
    @@ -335,7 +332,7 @@ top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: lib ] + + + [ class tree: lib ] [ index: lib ] - [ all elements ] + [ all elements ]
    @@ -98,9 +102,9 @@

    _

    _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".
    +
    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, function _get_schema_dn()
        Helper for _get_raw_schema() which fetches the DN of the schema object
    __sleep
    in file cache.inc, method cache::__sleep()
        Encrypts LDAP cache before saving to session file.
    __wakeup
    @@ -115,8 +119,6 @@
    $aliases
    in file schema.inc, variable AttributeType::$aliases
        An array of alias attribute names, strings
    -
    $attributes
    -
    in file cache.inc, variable cache::$attributes
        This variable contains a list and their scope of attributes which should be cached
    addAlias
    in file schema.inc, method AttributeType::addAlias()
        Adds an attribute name to the alias array.
    addChildObjectClass
    @@ -132,19 +134,19 @@
    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'.
    +
    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 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.
    +
    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
    account.inc
    -
    procedural page account.inc
    +
    procedural page account.inc
    top
    @@ -156,17 +158,19 @@
    $children_objectclasses
    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.
    -
    cache
    in file cache.inc, method cache::cache()
        Constructor.
    +
    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
    +
    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 security.inc, function checkClientIP()
        Checks if the client's IP address is on the list of allowed IPs.
    +
    check_ip
    +
    in file account.inc, function check_ip()
        This function checks if the given IP ist valid.
    cmp_domain
    -
    in file account.inc, function cmp_domain()
        Helper function to sort the domains
    +
    in file account.inc, function cmp_domain()
        Helper function to sort the domains
    cache.inc
    -
    procedural page cache.inc
    +
    procedural page cache.inc
    top
    @@ -205,14 +209,12 @@

    g

    -
    genpasswd
    -
    in file account.inc, function genpasswd()
        This function will return a password with max. 8 characters.
    getAliases
    in file schema.inc, method AttributeType::getAliases()
        Gets the names of attributes that are an alias for this attribute (if any).
    getChildObjectClasses
    in file schema.inc, method ObjectClass::getChildObjectClasses()
        Returns the array of objectClass names which inherit from this objectClass.
    getdays
    -
    in file account.inc, function getdays()
        This function will return the days from 1.1.1970 until now.
    +
    in file account.inc, function getdays()
        This function will return the days from 1.1.1970 until now.
    getDescription
    in file schema.inc, method SchemaItem::getDescription()
    getEquality
    @@ -260,7 +262,7 @@
    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.
    getshells
    -
    in file account.inc, function getshells()
        Returns a list of shells listed in config/shells.
    +
    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
    @@ -288,21 +290,21 @@
    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
    +
    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.
    +
    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.
    +
    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.
    +
    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.
    +
    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.
    +
    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.
    +
    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 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.
    top
    @@ -336,7 +338,7 @@
    initVars
    in file schema.inc, method MatchingRule::initVars()
        Initialize the class' member variables
    in_array_ignore_case
    -
    in file account.inc, function in_array_ignore_case()
        Checks if a string exists in an array, ignoring case.
    +
    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
    @@ -349,14 +351,12 @@

    l

    -
    $ldapcache
    -
    in file cache.inc, variable cache::$ldapcache
        This variable contains the cache
    lmPassword
    -
    in file account.inc, function lmPassword()
        Generates the LM hash of a password.
    +
    in file account.inc, function lmPassword()
        Generates the LM hash of a password.
    logNewMessage
    -
    in file security.inc, function logNewMessage()
        Puts a new message in the log file.
    +
    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 security.inc, function logoffAndBackToLoginPage()
        Logs off the user and displays the login page.
    top
    @@ -398,7 +398,7 @@
    $name
    in file schema.inc, variable AttributeType::$name
        The name of this attributeType
    ntPassword
    -
    in file account.inc, function ntPassword()
        Generates the NT hash of a password.
    +
    in file account.inc, function ntPassword()
        Generates the NT hash of a password.
    top
    @@ -428,13 +428,13 @@

    p

    pwd_disable
    -
    in file account.inc, function pwd_disable()
        Marks an password hash as disabled and returns the new hash string
    +
    in file account.inc, function pwd_disable()
        Marks an password hash as disabled and returns the new hash string
    pwd_enable
    -
    in file account.inc, function pwd_enable()
        Marks an password hash as enabled and returns the new hash string
    +
    in file account.inc, function pwd_enable()
        Marks an password hash as enabled and returns the new hash string
    pwd_hash
    -
    in file account.inc, function pwd_hash()
        Returns the hash value of a plain text password the hash algorithm depends on the configuration file
    +
    in file account.inc, function pwd_hash()
        Returns the hash value of a plain text password the hash algorithm depends on the configuration file
    pwd_is_enabled
    -
    in file account.inc, function pwd_is_enabled()
        Checks if a password hash is enabled/disabled
    +
    in file account.inc, function pwd_is_enabled()
        Checks if a password hash is enabled/disabled
    top
    @@ -449,8 +449,6 @@
    in file cache.inc, method cache::refresh_cache()
        This function refreshes the cache.
    removeAlias
    in file schema.inc, method AttributeType::removeAlias()
        Removes an attribute name from this attribute's alias array.
    -
    RndInt
    -
    in file account.inc, function RndInt()
        THIS FUNCTION GENERATES A RANDOM NUMBER THAT WILL BE USED TO RANDOMLY SELECT CHARACTERS.
    top
    @@ -472,19 +470,19 @@
    $syntax
    in file schema.inc, variable AttributeType::$syntax
        The full syntax string, ie 1.2.3.4{16}
    schema.inc
    -
    procedural page schema.inc
    +
    procedural page schema.inc
    security.inc
    -
    procedural page security.inc
    +
    procedural page security.inc
    status.inc
    -
    procedural page status.inc
    +
    procedural page status.inc
    SchemaItem
    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.
    SchemaItem
    in file schema.inc, method SchemaItem::SchemaItem()
        Default constructor.
    SCHEMA_SESSION_CACHE_ENABLED
    -
    in file schema.inc, constant SCHEMA_SESSION_CACHE_ENABLED
        To enable/disable session-based schema caching (1: enabled, 0: disabled).
    +
    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
    +
    in file account.inc, function search_domains()
        Returns an array with all Samba 3 domain entries under the given suffix
    setAliases
    in file schema.inc, method AttributeType::setAliases()
        Sets this attribute's list of aliases.
    setDescription
    @@ -502,15 +500,15 @@
    setUsedByAttrs
    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.
    +
    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.
    +
    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.
    +
    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.
    +
    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 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
    @@ -523,8 +521,6 @@

    t

    -
    $time
    -
    in file cache.inc, variable cache::$time
        This is the last timestamp on which the LDAP cache has been refreshed
    $type
    in file schema.inc, variable ObjectClass::$type
        one of STRUCTURAL, ABSTRACT, or AUXILIARY
    $type
    @@ -550,7 +546,7 @@ top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: lists ] + + + [ class tree: lists ] [ index: lists ] - [ all elements ] + [ all elements ]
    @@ -151,19 +157,21 @@
    $attrArray
    in file lists.inc, variable lamList::$attrArray
        list of LDAP attributes
    arrayLower
    -
    in file tree.inc, function arrayLower() (subpackage: tree)
    -
    add_attr_form.php
    -
    procedural page add_attr_form.php (subpackage: tree)
    +
    in file tree.inc, function arrayLower()
    +
    array_stripslashes
    +
    in file tree.inc, function array_stripslashes()
        Strips all slashes from the specified array in place (pass by ref).
    add_attr.php
    -
    procedural page add_attr.php (subpackage: tree)
    -
    add_oclass_form.php
    -
    procedural page add_oclass_form.php (subpackage: tree)
    +
    procedural page add_attr.php
    +
    add_attr_form.php
    +
    procedural page add_attr_form.php
    add_oclass.php
    -
    procedural page add_oclass.php (subpackage: tree)
    -
    add_value_form.php
    -
    procedural page add_value_form.php (subpackage: tree)
    +
    procedural page add_oclass.php
    +
    add_oclass_form.php
    +
    procedural page add_oclass_form.php
    add_value.php
    -
    procedural page add_value.php (subpackage: tree)
    +
    procedural page add_value.php
    +
    add_value_form.php
    +
    procedural page add_value_form.php
    top
    @@ -173,7 +181,7 @@

    b

    build_initial_tree_icons
    -
    in file tree.inc, function build_initial_tree_icons() (subpackage: tree)
        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 build_initial_tree_icons()
        Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned
    top
    @@ -185,15 +193,15 @@
    cmp_array
    in file lists.inc, method lamList::cmp_array()
        Compare function used for usort-method
    collapse.php
    -
    procedural page collapse.php (subpackage: tree)
    -
    create_form.php
    -
    procedural page create_form.php (subpackage: tree)
    +
    procedural page collapse.php
    create.php
    -
    procedural page create.php (subpackage: tree)
    +
    procedural page create.php
    +
    create_form.php
    +
    procedural page create_form.php
    creation_template.php
    -
    procedural page creation_template.php (subpackage: tree)
    +
    procedural page creation_template.php
    custom.php
    -
    procedural page custom.php (subpackage: tree)
    +
    procedural page custom.php
    top
    @@ -204,26 +212,28 @@
    $descArray
    in file lists.inc, variable lamList::$descArray
        list of attribute descriptions
    +
    deletelink.php
    +
    procedural page deletelink.php
    dn_exists
    -
    in file tree.inc, function dn_exists() (subpackage: tree)
        Gets whether an entry exists based on its DN. If the entry exists, returns true. Otherwise returns false.
    +
    in file tree.inc, function dn_exists()
        Gets whether an entry exists based on its DN. If the entry exists, returns true. Otherwise returns false.
    draw_create_link
    -
    in file tree.php, function draw_create_link() (subpackage: tree)
    +
    in file tree.php, function draw_create_link()
    draw_formatted_dn
    -
    in file tree.inc, function draw_formatted_dn() (subpackage: tree)
        Gets a DN string using the user-configured tree_display_format string to format it.
    +
    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() (subpackage: tree)
        Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to specify how the images are to be displayed.
    +
    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() (subpackage: tree)
        Prints the HTML of the tree view.
    +
    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() (subpackage: tree)
        Recursively descend on the given dn and draw the tree in html
    -
    delete_attr.php
    -
    procedural page delete_attr.php (subpackage: tree)
    -
    delete_form.php
    -
    procedural page delete_form.php (subpackage: tree)
    +
    in file tree.php, function draw_tree_html()
        Recursively descend on the given dn and draw the tree in html
    delete.php
    -
    procedural page delete.php (subpackage: tree)
    +
    procedural page delete.php
    +
    delete_attr.php
    +
    procedural page delete_attr.php
    +
    delete_form.php
    +
    procedural page delete_form.php
    download_binary_attr.php
    -
    procedural page download_binary_attr.php (subpackage: tree)
    +
    procedural page download_binary_attr.php
    top
    @@ -235,13 +245,13 @@
    $entries
    in file lists.inc, variable lamList::$entries
        LDAP entries
    edit.php
    -
    procedural page edit.php (subpackage: tree)
    +
    procedural page edit.php
    expand.php
    -
    procedural page expand.php (subpackage: tree)
    -
    export_form.php
    -
    procedural page export_form.php (subpackage: tree)
    +
    procedural page expand.php
    export.php
    -
    procedural page export.php (subpackage: tree)
    +
    procedural page export.php
    +
    export_form.php
    +
    procedural page export_form.php
    top
    @@ -260,28 +270,32 @@

    g

    +
    groupRefreshPrimary
    +
    in file group.inc, method lamGroupList::groupRefreshPrimary()
        Refreshes the primary group members list.
    +
    groupSetUsePrimary
    +
    in file group.inc, method lamGroupList::groupSetUsePrimary()
        Checks if primary group members should be included.
    get_attr_select_html
    -
    in file custom.php, function get_attr_select_html() (subpackage: tree)
        Returns option values.
    +
    in file custom.php, function get_attr_select_html()
        Returns option values.
    get_binary_attr_select_html
    -
    in file custom.php, function get_binary_attr_select_html() (subpackage: tree)
        Returns option values.
    +
    in file custom.php, function get_binary_attr_select_html()
        Returns option values.
    get_container
    -
    in file tree.inc, function get_container() (subpackage: tree)
        Given a DN string, this returns the parent container portion of the string.
    +
    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() (subpackage: tree)
        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 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:
    get_enc_type
    -
    in file tree.inc, function get_enc_type() (subpackage: tree)
    +
    in file tree.inc, function get_enc_type()
    get_entry_system_attrs
    -
    in file tree.inc, function get_entry_system_attrs() (subpackage: tree)
        Gets the operational attributes for an entry. Given a DN, this function fetches that entry's
    +
    in file tree.inc, function get_entry_system_attrs()
        Gets the operational attributes for an entry. Given a DN, this function fetches that entry's
    get_icon
    -
    in file tree.inc, function get_icon() (subpackage: tree)
        Given a DN and server ID, this function reads the DN's objectClasses and
    +
    in file tree.inc, function get_icon()
        Given a DN and server ID, this function reads the DN's objectClasses and
    get_line_end_format
    -
    in file export_form.php, function get_line_end_format() (subpackage: tree)
        Helper functoin for fetching the line end format.
    +
    in file export_form.php, function get_line_end_format()
        Helper functoin for fetching the line end format.
    get_object_attr
    -
    in file tree.inc, function get_object_attr() (subpackage: tree)
        Much like get_object_attrs(), but only returns the values for one attribute of an object. Example calls:
    +
    in file tree.inc, function get_object_attr()
        Much like get_object_attrs(), but only returns the values for one attribute of an object. Example calls:
    get_object_attrs
    -
    in file tree.inc, function get_object_attrs() (subpackage: tree)
        Gets the attributes/values of an entry. Returns an associative array whose
    +
    in file tree.inc, function get_object_attrs()
        Gets the attributes/values of an entry. Returns an associative array whose
    get_rdn
    -
    in file tree.inc, function get_rdn() (subpackage: tree)
        Given a DN string, this returns the 'RDN' portion of the string.
    +
    in file tree.inc, function get_rdn()
        Given a DN string, this returns the 'RDN' portion of the string.
    top
    @@ -291,23 +305,23 @@

    i

    initialize_session_tree
    -
    in file tree.inc, function initialize_session_tree() (subpackage: tree)
        Checks and fixes an initial session's tree cache if needed.
    +
    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() (subpackage: tree)
        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.
    +
    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() (subpackage: tree)
        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_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_binary_option_required
    -
    in file add_attr.php, function is_binary_option_required() (subpackage: tree)
    +
    in file add_attr.php, function is_binary_option_required()
    is_dn_attr
    -
    in file tree.inc, function is_dn_attr() (subpackage: tree)
        Returns true if the attribute specified is required to take as input a DN.
    +
    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() (subpackage: tree)
        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.
    +
    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() (subpackage: tree)
        Get whether a string looks like an email address (user@example.com).
    +
    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() (subpackage: tree)
        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;
    +
    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() (subpackage: tree)
        Get whether a string looks like a web URL (http://www.example.com/)
    +
    in file tree.inc, function is_url_string()
        Get whether a string looks like a web URL (http://www.example.com/)
    top
    @@ -323,30 +337,32 @@
    lamGroupList
    in file group.inc, method lamGroupList::lamGroupList()
        Constructor
    lamHostList
    -
    in file host.inc, method lamHostList::lamHostList()
        Constructor
    -
    lamHostList
    in file host.inc, class lamHostList
        Generates the list view.
    -
    lamList
    -
    in file lists.inc, method lamList::lamList()
        Constructor
    +
    lamHostList
    +
    in file host.inc, method lamHostList::lamHostList()
        Constructor
    lamList
    in file lists.inc, class lamList
        Generates the list view.
    +
    lamList
    +
    in file lists.inc, method lamList::lamList()
        Constructor
    lamMailAliasList
    in file mailAlias.inc, class lamMailAliasList
        Generates the list view.
    lamMailAliasList
    in file mailAlias.inc, method lamMailAliasList::lamMailAliasList()
        Constructor
    lamSmbDomainList
    -
    in file smbDomain.inc, method lamSmbDomainList::lamSmbDomainList()
        Constructor
    -
    lamSmbDomainList
    in file smbDomain.inc, class lamSmbDomainList
        Generates the list view.
    +
    lamSmbDomainList
    +
    in file smbDomain.inc, method lamSmbDomainList::lamSmbDomainList()
        Constructor
    lamUserList
    in file user.inc, class lamUserList
        Generates the list view.
    lamUserList
    in file user.inc, method lamUserList::lamUserList()
        Constructor
    lists.inc
    -
    procedural page lists.inc
    +
    procedural page lists.inc
    listBuildFilter
    in file lists.inc, method lamList::listBuildFilter()
        Builds the regular expressions from the filter values.
    listDoPost
    +
    in file group.inc, method lamGroupList::listDoPost()
        Manages all POST actions (e.g. button pressed) for the account lists.
    +
    listDoPost
    in file user.inc, method lamUserList::listDoPost()
        Manages all POST actions (e.g. button pressed) for the account lists.
    listDoPost
    in file lists.inc, method lamList::listDoPost()
        Manages all POST actions (e.g. button pressed) for the account lists.
    @@ -357,23 +373,41 @@
    listGetAttributeDescriptionList
    in file lists.inc, method lamList::listGetAttributeDescriptionList()
        Returns an hash array containing with all attributes to be shown and their descriptions.
    listGetParams
    +
    in file group.inc, method lamGroupList::listGetParams()
        Sets some internal parameters.
    +
    listGetParams
    +
    in file user.inc, method lamUserList::listGetParams()
        Sets some internal parameters.
    +
    listGetParams
    in file lists.inc, method lamList::listGetParams()
        Sets some internal parameters.
    -
    listPrintButtons
    -
    in file user.inc, method lamUserList::listPrintButtons()
        Prints the create, delete and PDF buttons.
    +
    listPrintAdditionalOptions
    +
    in file user.inc, method lamUserList::listPrintAdditionalOptions()
        Prints additional option fields for specific object types.
    +
    listPrintAdditionalOptions
    +
    in file group.inc, method lamGroupList::listPrintAdditionalOptions()
        Prints additional option field for primary member display.
    +
    listPrintAdditionalOptions
    +
    in file lists.inc, method lamList::listPrintAdditionalOptions()
        Prints additional option fields for specific object types.
    listPrintButtons
    in file lists.inc, method lamList::listPrintButtons()
        Prints the create, delete and PDF buttons.
    listPrintHeader
    in file lists.inc, method lamList::listPrintHeader()
        Prints the HTML head.
    listPrintJavaScript
    in file lists.inc, method lamList::listPrintJavaScript()
        Prints JavaScript code needed for mouse-over effects.
    -
    listPrintTableBody
    -
    in file user.inc, method lamUserList::listPrintTableBody()
        Prints the entry list
    -
    listPrintTableBody
    -
    in file group.inc, method lamGroupList::listPrintTableBody()
        Prints the entry list
    +
    listPrintPDFButtons
    +
    in file lists.inc, method lamList::listPrintPDFButtons()
        Prints the PDF button bar.
    listPrintTableBody
    in file lists.inc, method lamList::listPrintTableBody()
        Prints the entry list
    +
    listPrintTableCellContent
    +
    in file group.inc, method lamGroupList::listPrintTableCellContent()
        Prints the content of a cell in the account list for a given LDAP entry and attribute.
    +
    listPrintTableCellContent
    +
    in file lists.inc, method lamList::listPrintTableCellContent()
        Prints the content of a cell in the account list for a given LDAP entry and attribute.
    +
    listPrintTableCellContent
    +
    in file user.inc, method lamUserList::listPrintTableCellContent()
        Prints the content of a cell in the account list for a given LDAP entry and attribute.
    listPrintTableHeader
    in file lists.inc, method lamList::listPrintTableHeader()
        Prints the attribute and filter row at the account table head
    +
    listPrintToolLinks
    +
    in file lists.inc, method lamList::listPrintToolLinks()
        Prints the tool image links (e.g. edit and delete) for each account.
    +
    listRefreshData
    +
    in file group.inc, method lamGroupList::listRefreshData()
        Rereads the entries from LDAP.
    +
    listRefreshData
    +
    in file user.inc, method lamUserList::listRefreshData()
        Rereads the entries from LDAP.
    listRefreshData
    in file lists.inc, method lamList::listRefreshData()
        Rereads the entries from LDAP.
    listShowOUSelection
    @@ -381,7 +415,7 @@
    listSort
    in file lists.inc, method lamList::listSort()
        Sorts an account list by a given attribute
    list.php
    -
    procedural page list.php
    +
    procedural page list.php
    top
    @@ -401,9 +435,9 @@

    n

    not_an_attr
    -
    in file add_attr_form.php, function not_an_attr() (subpackage: tree)
        Given an attribute $x, this returns true if it is NOT already specified in the current entry, returns false otherwise.
    +
    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.
    new_ou_template.php
    -
    procedural page new_ou_template.php (subpackage: tree)
    +
    procedural page new_ou_template.php
    top
    @@ -417,17 +451,17 @@
    $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() (subpackage: tree)
        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.
    +
    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() (subpackage: tree)
        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_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() (subpackage: tree)
        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 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.
    pla_rdelete
    -
    in file rdelete.php, function pla_rdelete() (subpackage: tree)
    +
    in file rdelete.php, function pla_rdelete()
    pla_reverse_dn
    -
    in file tree.inc, function pla_reverse_dn() (subpackage: tree)
        Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last
    +
    in file tree.inc, function pla_reverse_dn()
        Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last
    pretty_print_dn
    -
    in file tree.inc, function pretty_print_dn() (subpackage: tree)
        Returns an HTML-beautified version of a DN.
    +
    in file tree.inc, function pretty_print_dn()
        Returns an HTML-beautified version of a DN.
    top
    @@ -438,14 +472,16 @@
    $refresh
    in file lists.inc, variable lamList::$refresh
        refresh page switch
    +
    refreshPrimaryGroupTranslation
    +
    in file user.inc, method lamUserList::refreshPrimaryGroupTranslation()
        Refreshes the GID to group name cache.
    real_attr_name
    -
    in file tree.inc, function real_attr_name() (subpackage: tree)
        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 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() (subpackage: tree)
        Removes attributes from the array that are aliases for eachother
    +
    in file custom.php, function remove_aliases()
        Removes attributes from the array that are aliases for eachother
    rdelete.php
    -
    procedural page rdelete.php (subpackage: tree)
    +
    procedural page rdelete.php
    refresh.php
    -
    procedural page refresh.php (subpackage: tree)
    +
    procedural page refresh.php
    top
    @@ -459,11 +495,11 @@
    $suffix
    in file lists.inc, variable lamList::$suffix
        LDAP suffix
    search_username
    -
    in file userlink.php, function search_username()
        Searches LDAP for a specific user name (uid attribute) and returns its DN entry
    +
    in file userlink.php, function search_username()
        Searches LDAP for a specific user name (uid attribute) and returns its DN entry
    showPage
    in file lists.inc, method lamList::showPage()
        Prints the HTML code to display the list view.
    sortAttrs
    -
    in file tree.inc, function sortAttrs() (subpackage: tree)
    +
    in file tree.inc, function sortAttrs()
    top
    @@ -472,20 +508,16 @@

    t

    -
    $trans_primary
    -
    in file user.inc, variable lamUserList::$trans_primary
        Controls if GID number is translated to group name
    -
    $trans_primary_hash
    -
    in file user.inc, variable lamUserList::$trans_primary_hash
        translates GID to group name
    $type
    in file lists.inc, variable lamList::$type
        Account type
    tree.inc
    -
    procedural page tree.inc (subpackage: tree)
    +
    procedural page tree.inc
    templates.inc
    -
    procedural page templates.inc (subpackage: tree)
    +
    procedural page templates.inc
    tree.php
    -
    procedural page tree.php (subpackage: tree)
    +
    procedural page tree.php
    tree_view.php
    -
    procedural page tree_view.php (subpackage: tree)
    +
    procedural page tree_view.php
    top
    @@ -495,17 +527,17 @@

    u

    userlink.php
    -
    procedural page userlink.php
    -
    update_confirm.php
    -
    procedural page update_confirm.php (subpackage: tree)
    +
    procedural page userlink.php
    update.php
    -
    procedural page update.php (subpackage: tree)
    +
    procedural page update.php
    +
    update_confirm.php
    +
    procedural page update_confirm.php
    top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: main ] + + + [ class tree: main ] [ index: main ] - [ all elements ] + [ all elements ]
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -168,7 +175,7 @@
    accountContainer
    in file modules.inc, class accountContainer
        This class includes all modules and attributes of an account.
    account.inc
    -
    procedural page account.inc
    +
    procedural page account.inc
    top
    @@ -177,16 +184,12 @@

    b

    -
    $base
    -
    in file modules.inc, variable accountContainer::$base
        Name of accountContainer variable in session
    -
    $base
    -
    in file baseModule.inc, variable baseModule::$base
        name of parent accountContainer ($_SESSION[$base])
    -
    baseModule
    -
    in file baseModule.inc, class baseModule
        Parent class of all account modules
    baseModule
    in file baseModule.inc, method baseModule::baseModule()
        Creates a new base module class
    +
    baseModule
    +
    in file baseModule.inc, class baseModule
        Parent class of all account modules.
    buildUploadAccounts
    -
    in file modules.inc, function buildUploadAccounts()
        This function builds the LDAP accounts for the file upload.
    +
    in file modules.inc, function buildUploadAccounts()
        This function builds the LDAP accounts for the file upload.
    build_uploadAccounts
    in file posixGroup.inc, method posixGroup::build_uploadAccounts()
        In this function the LDAP account is built up.
    build_uploadAccounts
    @@ -218,7 +221,7 @@
    build_uploadAccounts
    in file kolabUser.inc, method kolabUser::build_uploadAccounts()
        In this function the LDAP account is built up.
    baseModule.inc
    -
    procedural page baseModule.inc
    +
    procedural page baseModule.inc
    top
    @@ -227,46 +230,44 @@

    c

    -
    $changegids
    -
    in file posixGroup.inc, variable posixGroup::$changegids
        change GIDs of users and hosts?
    -
    $clearTextPassword
    -
    in file posixAccount.inc, variable posixAccount::$clearTextPassword
    -
    $createhomedir
    -
    in file posixAccount.inc, variable posixAccount::$createhomedir
    -
    $current_page
    -
    in file modules.inc, variable accountContainer::$current_page
        This variable stores the name of the currently displayed page
    +
    $ctx
    +
    in file sambaMungedDial.inc, variable sambaMungedDial::$ctx
    +
    $ctxattributes
    +
    in file sambaMungedDial.inc, variable sambaMungedDial::$ctxattributes
    can_manage
    in file baseModule.inc, method baseModule::can_manage()
        Returns true if this module fits for the current scope.
    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
    +
    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 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 commands which should be executed.
    +
    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 commands which should be executed.
    +
    checkSelfServiceSettings
    +
    in file baseModule.inc, method baseModule::checkSelfServiceSettings()
        Checks if the self service settings are valid.
    check_configOptions
    in file baseModule.inc, method baseModule::check_configOptions()
        Checks input values of module settings.
    check_configOptions
    in file posixAccount.inc, method posixAccount::check_configOptions()
        Checks input values of module settings.
    check_module_conflicts
    -
    in file modules.inc, function check_module_conflicts()
        Checks if there are conflicts between modules
    +
    in file modules.inc, function check_module_conflicts()
        Checks if there are conflicts between modules
    check_module_depends
    -
    in file modules.inc, function check_module_depends()
        Checks if there are missing dependencies between modules.
    -
    check_profileOptions
    -
    in file baseModule.inc, method baseModule::check_profileOptions()
        Checks input values of account profiles.
    +
    in file modules.inc, function check_module_depends()
        Checks if there are missing dependencies between modules.
    check_profileOptions
    in file quota.inc, method quota::check_profileOptions()
        Checks input values of account profiles.
    +
    check_profileOptions
    +
    in file baseModule.inc, method baseModule::check_profileOptions()
        Checks input values of account profiles.
    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.
    createntlm.inc
    -
    procedural page createntlm.inc
    +
    procedural page createntlm.inc
    top
    @@ -275,56 +276,52 @@

    d

    -
    $deactivated
    -
    in file sambaSamAccount.inc, variable sambaSamAccount::$deactivated
        account deactivated?
    -
    $deactivated
    -
    in file sambaAccount.inc, variable sambaAccount::$deactivated
        account deactivated?
    -
    $dn
    -
    in file modules.inc, variable accountContainer::$dn
        DN suffix of the account
    $dn
    in file account.inc, variable samba3domain::$dn
        DN
    +
    $dn
    +
    in file modules.inc, variable accountContainer::$dn
        DN suffix of the account
    $dn_orig
    in file modules.inc, variable accountContainer::$dn_orig
        DN suffix of account when it was loaded
    +
    decode_munged
    +
    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 quota.inc, method quota::delete_attributes()
    -
    delete_attributes
    -
    in file posixGroup.inc, method posixGroup::delete_attributes()
    +
    in file posixGroup.inc, method posixGroup::delete_attributes()
        Checks if the group which should be deleted is still used as primary group.
    delete_attributes
    in file baseModule.inc, method baseModule::delete_attributes()
        Dummy function for modules which use no special options on account deletion.
    delete_attributes
    in file posixAccount.inc, method posixAccount::delete_attributes()
        Additional LDAP operations on delete.
    display_html_attributes
    -
    in file nisMailAlias.inc, method nisMailAlias::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    +
    in file quota.inc, method quota::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file posixAccount.inc, method posixAccount::display_html_attributes()
    +
    in file posixAccount.inc, method posixAccount::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file sambaAccount.inc, method sambaAccount::display_html_attributes()
    +
    in file posixGroup.inc, method posixGroup::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file quota.inc, method quota::display_html_attributes()
    +
    in file account.inc, method account::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file posixGroup.inc, method posixGroup::display_html_attributes()
    +
    in file ldapPublicKey.inc, method ldapPublicKey::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file sambaDomain.inc, method sambaDomain::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    +
    in file nisMailAlias.inc, method nisMailAlias::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file account.inc, method account::display_html_attributes()
    +
    in file sambaDomain.inc, method sambaDomain::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file ldapPublicKey.inc, method ldapPublicKey::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    +
    in file ieee802device.inc, method ieee802Device::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    -
    display_html_attributes
    -
    in file ieee802device.inc, method ieee802Device::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    +
    in file sambaSamAccount.inc, method sambaSamAccount::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    in file shadowAccount.inc, method shadowAccount::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    display_html_attributes
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::display_html_attributes()
    +
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file inetOrgPerson.inc, method inetOrgPerson::display_html_attributes()
    +
    in file inetOrgPerson.inc, method inetOrgPerson::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file sambaSamAccount.inc, method sambaSamAccount::display_html_attributes()
    +
    in file kolabUser.inc, method kolabUser::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_attributes
    -
    in file kolabUser.inc, method kolabUser::display_html_attributes()
        This function will create the meta HTML code to show a page with all attributes.
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::display_html_attributes()
        Returns the HTML meta data for the main account page.
    +
    display_html_attributes
    +
    in file sambaAccount.inc, method sambaAccount::display_html_attributes()
        Returns the HTML meta data for the main account page.
    display_html_delete
    -
    in file posixAccount.inc, method posixAccount::display_html_delete()
    +
    in file posixAccount.inc, method posixAccount::display_html_delete()
        Displays the delete homedir option for the delete page.
    display_html_delete
    in file baseModule.inc, method baseModule::display_html_delete()
        Dummy function for modules which do not print extra HTML code on account deletion.
    display_html_deleteUser
    @@ -336,30 +333,32 @@
    display_html_logonHours
    in file sambaSamAccount.inc, method sambaSamAccount::display_html_logonHours()
        This function will create the HTML page to edit logon hours.
    display_html_password
    -
    in file inetOrgPerson.inc, method inetOrgPerson::display_html_password()
        Displays the password changing dialog.
    +
    in file posixGroup.inc, method posixGroup::display_html_password()
        Displays the password changing dialog.
    display_html_password
    in file posixAccount.inc, method posixAccount::display_html_password()
        Displays the password changing dialog.
    display_html_password
    -
    in file posixGroup.inc, method posixGroup::display_html_password()
        Displays the password changing dialog.
    +
    in file inetOrgPerson.inc, method inetOrgPerson::display_html_password()
        Displays the password changing dialog.
    display_html_photo
    in file inetOrgPerson.inc, method inetOrgPerson::display_html_photo()
        Displays the photo upload page.
    display_html_sambaUserWorkstations
    -
    in file sambaSamAccount.inc, method sambaSamAccount::display_html_sambaUserWorkstations()
    +
    in file sambaSamAccount.inc, method sambaSamAccount::display_html_sambaUserWorkstations()
        This function will create the HTML page to edit the allowed workstations.
    +
    display_html_terminalServer
    +
    in file sambaSamAccount.inc, method sambaSamAccount::display_html_terminalServer()
        This function will create the HTML page to edit the terminal server options.
    display_html_time
    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.
    display_html_userWorkstations
    -
    in file sambaAccount.inc, method sambaAccount::display_html_userWorkstations()
    +
    in file sambaAccount.inc, method sambaAccount::display_html_userWorkstations()
        This function will create the HTML page to edit the allowed workstations.
    doHash
    in file createntlm.inc, method smbHash::doHash()
    doUploadPostActions
    -
    in file baseModule.inc, method baseModule::doUploadPostActions()
        This function executes one post upload action.
    -
    doUploadPostActions
    -
    in file modules.inc, function doUploadPostActions()
        This function executes one post upload action.
    +
    in file modules.inc, function doUploadPostActions()
        This function executes one post upload action.
    doUploadPostActions
    in file quota.inc, method quota::doUploadPostActions()
        This function executes one post upload action.
    doUploadPostActions
    +
    in file baseModule.inc, method baseModule::doUploadPostActions()
        This function executes one post upload action.
    +
    doUploadPostActions
    in file posixAccount.inc, method posixAccount::doUploadPostActions()
        This function executes one post upload action.
    @@ -369,10 +368,14 @@

    e

    +
    encode_munged
    +
    in file sambaMungedDial.inc, method sambaMungedDial::encode_munged()
        Encode full MungedDial-String
    +
    endian
    +
    in file sambaMungedDial.inc, method sambaMungedDial::endian()
        endian
    E_P16
    -
    in file createntlm.inc, method smbHash::E_P16()
    +
    in file createntlm.inc, method smbHash::E_P16()
        E_P16
    edit.php
    -
    procedural page edit.php
    +
    procedural page edit.php
    top
    @@ -391,28 +394,52 @@

    g

    -
    $groups
    -
    in file posixAccount.inc, variable posixAccount::$groups
    -
    $groups_orig
    -
    in file posixAccount.inc, variable posixAccount::$groups_orig
    +
    genTime
    +
    in file sambaMungedDial.inc, method sambaMungedDial::genTime()
        genTime
    +
    getAccountContainer
    +
    in file baseModule.inc, method baseModule::getAccountContainer()
        Returns the accountContainer object.
    +
    getAccountModule
    +
    in file modules.inc, method accountContainer::getAccountModule()
        Returns the account module with the given class name
    +
    getAccountModules
    +
    in file modules.inc, method accountContainer::getAccountModules()
        Returns the included account modules.
    +
    getAttributes
    +
    in file baseModule.inc, method baseModule::getAttributes()
        Returns the LDAP attributes which are managed in this module.
    getAvailableModules
    -
    in file modules.inc, function getAvailableModules()
        Returns an array with all available user module names
    +
    in file modules.inc, function getAvailableModules()
        Returns an array with all available user module names
    getAvailablePDFFields
    -
    in file modules.inc, function getAvailablePDFFields()
        Returns a list of available PDF entries.
    -
    getButtonStatus
    -
    in file account.inc, method account::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    -
    getButtonStatus
    -
    in file nisMailAlias.inc, method nisMailAlias::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    -
    getButtonStatus
    -
    in file inetOrgPerson.inc, method inetOrgPerson::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    +
    in file modules.inc, function getAvailablePDFFields()
        Returns a list of available PDF entries.
    +
    getBrokenConn
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getBrokenConn()
        gets Broken-Connection value: disconnect/reset
    getButtonStatus
    in file posixGroup.inc, method posixGroup::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    getButtonStatus
    in file baseModule.inc, method baseModule::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    +
    getButtonStatus
    +
    in file account.inc, method account::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    +
    getButtonStatus
    +
    in file inetOrgPerson.inc, method inetOrgPerson::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    +
    getButtonStatus
    +
    in file nisMailAlias.inc, method nisMailAlias::getButtonStatus()
        Controls if the module button the account page is visible and activated.
    +
    getClearTextPassword
    +
    in file posixAccount.inc, method posixAccount::getClearTextPassword()
        Returns the clear text password.
    getConfigOptions
    -
    in file modules.inc, function getConfigOptions()
        Returns a hash array (module name => elements) of all module options for the configuration page.
    +
    in file modules.inc, function getConfigOptions()
        Returns a hash array (module name => elements) of all module options for the configuration page.
    +
    getConnectClientDrives
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getConnectClientDrives()
        gets connect-client-drive-at-logon value: enabled/disabled
    +
    getConnectClientPrinters
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getConnectClientPrinters()
        gets connect-client-printers-at-logon value: enabled/disabled
    +
    getCtxMaxConnectionTimeF
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getCtxMaxConnectionTimeF()
        SMARTY: gets the checkbox state of "Connection"
    +
    getCtxMaxDisconnectionTimeF
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getCtxMaxDisconnectionTimeF()
        SMARTY: gets the checkbox state of "Disconnection"
    +
    getCtxMaxIdleTimeF
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getCtxMaxIdleTimeF()
        SMARTY: gets the checkbox state of "Idle"
    +
    getDefaultPrinter
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getDefaultPrinter()
        gets set-client-printer-to-default value: enabled/disabled
    getHelp
    -
    in file modules.inc, function getHelp()
        Returns a help entry from an account module.
    +
    in file modules.inc, function getHelp()
        Returns a help entry from an account module.
    +
    getInheritMode
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getInheritMode()
        gets Inherit-config-from-client value: enabled/disabled
    getLDAPAliases
    in file baseModule.inc, method baseModule::getLDAPAliases()
        Returns a list of aliases for LDAP attributes.
    getManagedAttributes
    @@ -420,125 +447,143 @@
    getManagedObjectClasses
    in file baseModule.inc, method baseModule::getManagedObjectClasses()
        Returns a list of managed object classes for this module.
    getModuleAlias
    -
    in file modules.inc, function getModuleAlias()
        Returns the alias name of a module
    +
    in file modules.inc, function getModuleAlias()
        Returns the alias name of a module
    getModulesDependencies
    -
    in file modules.inc, function getModulesDependencies()
        Returns a hash array (module name => dependencies) of all module dependencies
    +
    in file modules.inc, function getModulesDependencies()
        Returns a hash array (module name => dependencies) of all module dependencies
    +
    getMunged
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getMunged()
        Returns ready-to-run mungedDialString to be filled into ldap
    getNextGIDs
    in file posixGroup.inc, method posixGroup::getNextGIDs()
        Returns one or more free GID numbers.
    getNextUIDs
    in file posixAccount.inc, method posixAccount::getNextUIDs()
        Returns one or more free UID numbers.
    +
    getOnDemandFlags
    +
    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).
    +
    getParentDN
    +
    in file modules.inc, method accountContainer::getParentDN()
        Returns the parent DN of a given DN.
    getProfileOptions
    -
    in file modules.inc, function getProfileOptions()
        Returns the elements for the profile page.
    +
    in file modules.inc, function getProfileOptions()
        Returns the elements for the profile page.
    +
    getRDN
    +
    in file modules.inc, method accountContainer::getRDN()
        Returns the RDN part of a given DN.
    getRDNAttributes
    -
    in file modules.inc, function getRDNAttributes()
        Returns a list of LDAP attributes which can be used to form the RDN.
    -
    getRequiredExtensions
    -
    in file modules.inc, function getRequiredExtensions()
        Returns true if the module is a base module
    +
    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 baseModule.inc, method baseModule::getRequiredExtensions()
        Returns a list of required PHP extensions.
    +
    getRequiredExtensions
    +
    in file modules.inc, function getRequiredExtensions()
        Returns true if the module is a base module
    getSelfServiceFields
    in file baseModule.inc, method baseModule::getSelfServiceFields()
        Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    getSelfServiceOptions
    -
    in file inetOrgPerson.inc, method inetOrgPerson::getSelfServiceOptions()
        Returns the meta HTML code for each input field.
    -
    getSelfServiceOptions
    in file baseModule.inc, method baseModule::getSelfServiceOptions()
        Returns the meta HTML code for each input field.
    getSelfServiceOptions
    +
    in file inetOrgPerson.inc, method inetOrgPerson::getSelfServiceOptions()
        Returns the meta HTML code for each input field.
    +
    getSelfServiceOptions
    in file posixAccount.inc, method posixAccount::getSelfServiceOptions()
        Returns the meta HTML code for each input field.
    getSelfServiceSearchAttributes
    in file baseModule.inc, method baseModule::getSelfServiceSearchAttributes()
        Returns a list of possible search attributes for the self service.
    +
    getSelfServiceSettings
    +
    in file baseModule.inc, method baseModule::getSelfServiceSettings()
        Returns a list of self service configuration settings.
    +
    getShadow
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getShadow()
        gets shadow value (enum): 0-4
    +
    getTsLogin
    +
    in file sambaMungedDial.inc, method sambaMungedDial::getTsLogin()
        Gets Terminal-Server-Login value: enabled/disabled
    getUploadColumns
    -
    in file modules.inc, function getUploadColumns()
        Returns an array containing all input columns for the file upload.
    +
    in file modules.inc, function getUploadColumns()
        Returns an array containing all input columns for the file upload.
    get_alias
    in file baseModule.inc, method baseModule::get_alias()
        Returns an alias name for the module.
    get_configOptions
    -
    in file posixGroup.inc, method posixGroup::get_configOptions()
        Returns a list of elements for the configuration.
    -
    get_configOptions
    in file baseModule.inc, method baseModule::get_configOptions()
        Returns a list of elements for the configuration.
    +
    get_configOptions
    +
    in file posixGroup.inc, method posixGroup::get_configOptions()
        Returns a list of elements for the configuration.
    get_dependencies
    in file baseModule.inc, method baseModule::get_dependencies()
        This function returns a list with all depending and conflicting modules.
    get_help
    in file baseModule.inc, method baseModule::get_help()
        This function return the help entry array for a specific help id. Normally this->meta can be used.
    get_ldap_filter
    -
    in file modules.inc, function get_ldap_filter()
        Returns the LDAP filter used by the account lists
    +
    in file modules.inc, function get_ldap_filter()
        Returns the LDAP filter used by the account lists
    get_ldap_filter
    in file baseModule.inc, method baseModule::get_ldap_filter()
        returns an LDAP filter for the account lists
    get_metaData
    -
    in file account.inc, method account::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file nisMailAlias.inc, method nisMailAlias::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file baseModule.inc, method baseModule::get_metaData()
        Dummy function, meta data is provided by sub classes.
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    in file sambaAccount.inc, method sambaAccount::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    in file quota.inc, method quota::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    -
    in file sambaDomain.inc, method sambaDomain::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file kolabUser.inc, method kolabUser::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file inetOrgPerson.inc, method inetOrgPerson::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    in file posixGroup.inc, method posixGroup::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    +
    in file baseModule.inc, method baseModule::get_metaData()
        Dummy function, meta data is provided by sub classes.
    +
    get_metaData
    in file shadowAccount.inc, method shadowAccount::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    -
    in file ldapPublicKey.inc, method ldapPublicKey::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    -
    in file ieee802device.inc, method ieee802Device::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_metaData
    in file sambaSamAccount.inc, method sambaSamAccount::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    -
    in file posixAccount.inc, method posixAccount::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    in file account.inc, method account::get_metaData()
        Returns meta data that is interpreted by parent class
    get_metaData
    -
    in file posixGroup.inc, method posixGroup::get_metaData()
        Returns meta data that is interpreted by parent class
    -
    get_pdfEntries
    -
    in file sambaAccount.inc, method sambaAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file sambaSamAccount.inc, method sambaSamAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file shadowAccount.inc, method shadowAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file sambaDomain.inc, method sambaDomain::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file quota.inc, method quota::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file posixGroup.inc, method posixGroup::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file account.inc, method account::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file kolabUser.inc, method kolabUser::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file ldapPublicKey.inc, method ldapPublicKey::get_pdfEntries()
        Returns a list of PDF entries
    -
    get_pdfEntries
    -
    in file ieee802device.inc, method ieee802Device::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file inetOrgPerson.inc, method inetOrgPerson::get_pdfEntries()
        Returns the PDF entries for this module.
    -
    get_pdfEntries
    -
    in file modules.inc, method accountContainer::get_pdfEntries()
        Returns a list of possible PDF entries for this account.
    -
    get_pdfEntries
    -
    in file posixAccount.inc, method posixAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    in file inetOrgPerson.inc, method inetOrgPerson::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file ieee802device.inc, method ieee802Device::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file sambaDomain.inc, method sambaDomain::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file nisMailAlias.inc, method nisMailAlias::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file ldapPublicKey.inc, method ldapPublicKey::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file kolabUser.inc, method kolabUser::get_metaData()
        Returns meta data that is interpreted by parent class
    +
    get_metaData
    +
    in file posixAccount.inc, method posixAccount::get_metaData()
        Returns meta data that is interpreted by parent class
    get_pdfEntries
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_pdfEntries()
        Returns the PDF entries for this module.
    get_pdfEntries
    +
    in file ieee802device.inc, method ieee802Device::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file account.inc, method account::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file shadowAccount.inc, method shadowAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file sambaSamAccount.inc, method sambaSamAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file ldapPublicKey.inc, method ldapPublicKey::get_pdfEntries()
        Returns a list of PDF entries
    +
    get_pdfEntries
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    in file nisMailAlias.inc, method nisMailAlias::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file kolabUser.inc, method kolabUser::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file posixGroup.inc, method posixGroup::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file quota.inc, method quota::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file posixAccount.inc, method posixAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file inetOrgPerson.inc, method inetOrgPerson::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file sambaAccount.inc, method sambaAccount::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file sambaDomain.inc, method sambaDomain::get_pdfEntries()
        Returns the PDF entries for this module.
    +
    get_pdfEntries
    +
    in file modules.inc, method accountContainer::get_pdfEntries()
        Returns a list of possible PDF entries for this account.
    get_pdfFields
    in file baseModule.inc, method baseModule::get_pdfFields()
        Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    get_pdf_entries
    in file baseModule.inc, method baseModule::get_pdf_entries()
        Returns a hastable with all entries that may be printed out in the PDF. The
    get_profileOptions
    +
    in file quota.inc, method quota::get_profileOptions()
        Returns a list of elements for the account profiles.
    +
    get_profileOptions
    in file sambaSamAccount.inc, method sambaSamAccount::get_profileOptions()
        Returns a list of elements for the account profiles.
    get_profileOptions
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::get_profileOptions()
        Returns a list of elements for the account profiles.
    +
    in file posixAccount.inc, method posixAccount::get_profileOptions()
        Returns a list of elements for the account profiles.
    get_profileOptions
    in file baseModule.inc, method baseModule::get_profileOptions()
        Returns a list of elements for the account profiles.
    get_profileOptions
    -
    in file quota.inc, method quota::get_profileOptions()
        Returns a list of elements for the account profiles.
    -
    get_profileOptions
    -
    in file posixAccount.inc, method posixAccount::get_profileOptions()
        Returns a list of elements for the account profiles.
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::get_profileOptions()
        Returns a list of elements for the account profiles.
    get_RDNAttributes
    in file baseModule.inc, method baseModule::get_RDNAttributes()
        Returns a list of possible LDAP attributes which can be used to form the RDN.
    get_scope
    @@ -559,8 +604,8 @@

    h

    -
    $hex2bitstring
    -
    in file sambaSamAccount.inc, variable sambaSamAccount::$hex2bitstring
        HEX to binary conversion table
    +
    hexstr
    +
    in file sambaMungedDial.inc, method sambaMungedDial::hexstr()
        hexstr
    top
    @@ -569,8 +614,6 @@

    i

    -
    $invitationPolicies
    -
    in file kolabUser.inc, variable kolabUser::$invitationPolicies
        list of invitation policies
    $isNewAccount
    in file modules.inc, variable accountContainer::$isNewAccount
        True if this is a newly created account
    ieee802Device
    @@ -578,31 +621,33 @@
    inetLocalMailRecipient
    in file inetLocalMailRecipient.inc, class inetLocalMailRecipient
        Provides mail routing for users.
    inetOrgPerson
    -
    in file inetOrgPerson.inc, class inetOrgPerson
        This class contains all account LDAP attributes and funtioncs required to deal with inetOrgPerson.
    +
    in file inetOrgPerson.inc, class inetOrgPerson
        This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).
    init
    -
    in file sambaSamAccount.inc, method sambaSamAccount::init()
        Initializes the module after it became part of an accountContainer
    -
    init
    -
    in file posixAccount.inc, method posixAccount::init()
    -
    init
    -
    in file quota.inc, method quota::init()
    +
    in file posixGroup.inc, method posixGroup::init()
        This functin will be called when the module will be loaded *
    init
    in file sambaAccount.inc, method sambaAccount::init()
        Initializes the module after it became part of an accountContainer
    init
    in file sambaGroupMapping.inc, method sambaGroupMapping::init()
        Initializes the module after it became part of an accountContainer
    init
    -
    in file posixGroup.inc, method posixGroup::init()
        This functin will be called when the module will be loaded *
    +
    in file sambaSamAccount.inc, method sambaSamAccount::init()
        Initializes the module after it became part of an accountContainer
    init
    in file baseModule.inc, method baseModule::init()
        Initializes the module after it became part of an accountContainer
    +
    init
    +
    in file posixAccount.inc, method posixAccount::init()
        Initializes the module after it became part of an accountContainer
    +
    initQuotas
    +
    in file quota.inc, method quota::initQuotas()
        Initializes the quota values.
    is_base_module
    -
    in file modules.inc, function is_base_module()
        Returns true if the module is a base module
    +
    in file modules.inc, function is_base_module()
        Returns true if the module is a base module
    is_base_module
    in file baseModule.inc, method baseModule::is_base_module()
        Returns true if this module is enough to provide a sensible account.
    +
    is_samba_path
    +
    in file sambaMungedDial.inc, method sambaMungedDial::is_samba_path()
        Checks if this is a valid Samba path.
    ieee802device.inc
    -
    procedural page ieee802device.inc
    +
    procedural page ieee802device.inc
    inetLocalMailRecipient.inc
    -
    procedural page inetLocalMailRecipient.inc
    +
    procedural page inetLocalMailRecipient.inc
    inetOrgPerson.inc
    -
    procedural page inetOrgPerson.inc
    +
    procedural page inetOrgPerson.inc
    top
    @@ -616,7 +661,7 @@
    kolabUser
    in file kolabUser.inc, class kolabUser
        Manages Kolab user accounts.
    kolabUser.inc
    -
    procedural page kolabUser.inc
    +
    procedural page kolabUser.inc
    top
    @@ -626,47 +671,45 @@

    l

    lamdaemon
    -
    in file lamdaemon.inc, function lamdaemon()
        Sends commands to lamdaemon script.
    +
    in file lamdaemon.inc, function lamdaemon()
        Sends commands to lamdaemon script.
    lamdaemonSSH
    -
    in file lamdaemon.inc, function lamdaemonSSH()
        Sends commands to lamdaemon script via PHP SSH functions.
    +
    in file lamdaemon.inc, function lamdaemonSSH()
        Sends commands to lamdaemon script via PHP SSH functions.
    ldapPublicKey
    in file ldapPublicKey.inc, class ldapPublicKey
        Manages SSH public keys.
    lamdaemon.inc
    -
    procedural page lamdaemon.inc
    +
    procedural page lamdaemon.inc
    ldapPublicKey.inc
    -
    procedural page ldapPublicKey.inc
    +
    procedural page ldapPublicKey.inc
    lmhash
    in file createntlm.inc, method smbHash::lmhash()
        Calculates the LM hash of a given password.
    +
    load
    +
    in file sambaMungedDial.inc, method sambaMungedDial::load()
        function takes a base64-encoded sambaMungedDial
    load_account
    in file modules.inc, method accountContainer::load_account()
        Loads an LDAP account with the given DN.
    load_attributes
    -
    in file sambaSamAccount.inc, method sambaSamAccount::load_attributes()
    +
    in file sambaSamAccount.inc, method sambaSamAccount::load_attributes()
        This function loads the LDAP attributes for this module.
    load_attributes
    -
    in file quota.inc, method quota::load_attributes()
    -
    load_attributes
    -
    in file sambaAccount.inc, method sambaAccount::load_attributes()
    +
    in file sambaAccount.inc, method sambaAccount::load_attributes()
        This function loads the LDAP attributes for this module.
    load_attributes
    in file posixAccount.inc, method posixAccount::load_attributes()
        This function loads all needed LDAP attributes.
    load_attributes
    in file baseModule.inc, method baseModule::load_attributes()
        This function loads the LDAP attributes for 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 baseModule.inc, method baseModule::load_Messages()
        This function fills the $messages variable with output messages from this module.
    -
    load_Messages
    in file kolabUser.inc, method kolabUser::load_Messages()
        This function fills the error message array with messages
    load_Messages
    +
    in file quota.inc, method quota::load_Messages()
        this functin fills the error message array with messages
    +
    load_Messages
    +
    in file sambaAccount.inc, method sambaAccount::load_Messages()
        this functin fills the error message array with messages
    +
    load_Messages
    in file sambaDomain.inc, method sambaDomain::load_Messages()
        This function fills the error message array with messages
    load_Messages
    in file sambaGroupMapping.inc, method sambaGroupMapping::load_Messages()
        this functin fills the error message array with messages
    load_Messages
    -
    in file shadowAccount.inc, method shadowAccount::load_Messages()
        This function builds up the message array.
    +
    in file posixGroup.inc, method posixGroup::load_Messages()
        This function fills the $messages variable with output messages from this module.
    load_Messages
    in file sambaSamAccount.inc, method sambaSamAccount::load_Messages()
        this functin fills the error message array with messages
    load_Messages
    -
    in file posixGroup.inc, method posixGroup::load_Messages()
        This function fills the $messages variable with output messages from this module.
    -
    load_Messages
    -
    in file quota.inc, method quota::load_Messages()
        this functin fills the error message array with messages
    +
    in file shadowAccount.inc, method shadowAccount::load_Messages()
        This function builds up the message array.
    load_Messages
    in file ieee802device.inc, method ieee802Device::load_Messages()
        This function fills the error message array with messages
    load_Messages
    @@ -674,25 +717,27 @@
    load_Messages
    in file inetOrgPerson.inc, method inetOrgPerson::load_Messages()
        This function fills the message array.
    load_Messages
    -
    in file account.inc, method account::load_Messages()
        This function fills the message array.
    +
    in file baseModule.inc, method baseModule::load_Messages()
        This function fills the $messages variable with output messages from this module.
    load_Messages
    in file nisMailAlias.inc, method nisMailAlias::load_Messages()
        This function fills the error message array with messages
    load_Messages
    in file posixAccount.inc, method posixAccount::load_Messages()
        This function fills the error message array with messages.
    +
    load_Messages
    +
    in file account.inc, method account::load_Messages()
        This function fills the message array.
    load_profile
    in file sambaSamAccount.inc, method sambaSamAccount::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 shadowAccount.inc, method shadowAccount::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.
    +
    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 baseModule.inc, method baseModule::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.
    +
    in file sambaAccount.inc, method sambaAccount::load_profile()
        Loads the values of an account profile into internal variables.
    lshift
    in file createntlm.inc, method smbHash::lshift()
    @@ -707,42 +752,38 @@
    in file baseModule.inc, variable baseModule::$messages
        contains all error messages of a module
    $meta
    in file baseModule.inc, variable baseModule::$meta
        includes all meta data provided by the sub class
    -
    $module
    -
    in file modules.inc, variable accountContainer::$module
        This is an array with all module objects
    $moduleSettings
    in file baseModule.inc, variable baseModule::$moduleSettings
        configuration settings of all modules
    modules.inc
    -
    procedural page modules.inc
    -
    module_complete
    -
    in file quota.inc, method quota::module_complete()
    -
    module_complete
    -
    in file posixGroup.inc, method posixGroup::module_complete()
        This functions is used to check if all settings for this module have been made.
    -
    module_complete
    -
    in file sambaAccount.inc, method sambaAccount::module_complete()
        This functions returns true if all needed settings are done
    -
    module_complete
    -
    in file sambaSamAccount.inc, method sambaSamAccount::module_complete()
        This functions is used to check if all settings for this module have been made.
    -
    module_complete
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::module_complete()
    +
    procedural page modules.inc
    module_complete
    in file posixAccount.inc, method posixAccount::module_complete()
        This functions is used to check if all settings for this module have been made.
    module_complete
    in file baseModule.inc, method baseModule::module_complete()
        This functions is used to check if all settings for this module have been made.
    module_complete
    -
    in file inetOrgPerson.inc, method inetOrgPerson::module_complete()
        This functions return true if all needed settings are done.
    +
    in file sambaAccount.inc, method sambaAccount::module_complete()
        This functions returns true if all needed settings are done
    +
    module_complete
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::module_complete()
        This functions is used to check if all settings for this module have been made.
    module_complete
    in file account.inc, method account::module_complete()
        This functions returns true if all needed settings are done.
    module_complete
    +
    in file posixGroup.inc, method posixGroup::module_complete()
        This functions is used to check if all settings for this module have been made.
    +
    module_complete
    in file kolabUser.inc, method kolabUser::module_complete()
        This function returns true if all needed settings are done.
    +
    module_complete
    +
    in file inetOrgPerson.inc, method inetOrgPerson::module_complete()
        This functions return true if all needed settings are done.
    module_ready
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::module_ready()
    -
    module_ready
    -
    in file baseModule.inc, method baseModule::module_ready()
        This function is used to check if this module page can be displayed.
    -
    module_ready
    -
    in file sambaAccount.inc, method sambaAccount::module_ready()
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::module_ready()
        This function is used to check if this module page can be displayed.
    module_ready
    in file sambaSamAccount.inc, method sambaSamAccount::module_ready()
        This function is used to check if this module page can be displayed.
    module_ready
    -
    in file quota.inc, method quota::module_ready()
    +
    in file baseModule.inc, method baseModule::module_ready()
        This function is used to check if this module page can be displayed.
    +
    module_ready
    +
    in file sambaAccount.inc, method sambaAccount::module_ready()
        This function is used to check if this module page can be displayed.
    +
    module_ready
    +
    in file quota.inc, method quota::module_ready()
        This function is used to check if this module page can be displayed.
    +
    munge
    +
    in file sambaMungedDial.inc, method sambaMungedDial::munge()
        Setup parameter given by paramName to MungedDial-Format
    mxor
    in file createntlm.inc, method smbHash::mxor()
    @@ -761,16 +802,8 @@
    in file account.inc, variable samba3domain::$nextRID
        Next RID
    $nextUserRID
    in file account.inc, variable samba3domain::$nextUserRID
        Next user RID
    -
    $noexpire
    -
    in file sambaSamAccount.inc, variable sambaSamAccount::$noexpire
        password does not expire?
    -
    $noexpire
    -
    in file sambaAccount.inc, variable sambaAccount::$noexpire
        password does not expire?
    -
    $nopwd
    -
    in file sambaSamAccount.inc, variable sambaSamAccount::$nopwd
        use no password?
    -
    $nopwd
    -
    in file sambaAccount.inc, variable sambaAccount::$nopwd
        use no password?
    nisMailAlias.inc
    -
    procedural page nisMailAlias.inc
    +
    procedural page nisMailAlias.inc
    new_account
    in file modules.inc, method accountContainer::new_account()
        This function will prepare the object for a new account.
    nisMailAlias
    @@ -785,8 +818,6 @@

    o

    -
    $order
    -
    in file modules.inc, variable accountContainer::$order
        Module order
    $orig
    in file baseModule.inc, variable baseModule::$orig
        contains all ldap attributes which are loaded from ldap
    @@ -810,47 +841,63 @@
    $perm6
    in file createntlm.inc, variable smbHash::$perm6
    posixAccount.inc
    -
    procedural page posixAccount.inc
    +
    procedural page posixAccount.inc
    posixGroup.inc
    -
    procedural page posixGroup.inc
    +
    procedural page posixGroup.inc
    parseHtml
    -
    in file modules.inc, function parseHtml()
        Takes a list of meta-HTML elements and prints the equivalent HTML output.
    +
    in file modules.inc, function parseHtml()
        Takes a list of meta-HTML elements and prints the equivalent HTML output.
    permute
    in file createntlm.inc, method smbHash::permute()
    posixAccount
    in file posixAccount.inc, class posixAccount
        Manages the object class "posixAccount" for users and hosts.
    posixGroup
    in file posixGroup.inc, class posixGroup
        Manages the object class "posixGroup" for groups.
    +
    postDeleteActions
    +
    in file baseModule.inc, method baseModule::postDeleteActions()
        Allows the module to run commands after the LDAP entry is deleted.
    +
    postModifyActions
    +
    in file baseModule.inc, method baseModule::postModifyActions()
        Allows the module to run commands after the LDAP entry is changed or created.
    +
    postModifyActions
    +
    in file quota.inc, method quota::postModifyActions()
        Allows the module to run commands after the LDAP entry is changed or created.
    +
    postModifyActions
    +
    in file posixAccount.inc, method posixAccount::postModifyActions()
        Allows the module to run commands after the LDAP entry was changed or created.
    +
    preDeleteActions
    +
    in file posixAccount.inc, method posixAccount::preDeleteActions()
        Allows the module to run commands before the LDAP entry is deleted.
    +
    preDeleteActions
    +
    in file quota.inc, method quota::preDeleteActions()
        Allows the module to run commands before the LDAP entry is deleted.
    +
    preDeleteActions
    +
    in file baseModule.inc, method baseModule::preDeleteActions()
        Allows the module to run commands before the LDAP entry is deleted.
    +
    preModifyActions
    +
    in file baseModule.inc, method baseModule::preModifyActions()
        Allows the module to run commands before the LDAP entry is changed or created.
    +
    process_attributes
    +
    in file shadowAccount.inc, method shadowAccount::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file posixGroup.inc, method posixGroup::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file sambaSamAccount.inc, method sambaSamAccount::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    in file sambaAccount.inc, method sambaAccount::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    +
    in file sambaDomain.inc, method sambaDomain::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    in file quota.inc, method quota::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    in file ieee802device.inc, method ieee802Device::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    -
    in file sambaDomain.inc, method sambaDomain::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file shadowAccount.inc, method shadowAccount::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file sambaSamAccount.inc, method sambaSamAccount::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file posixAccount.inc, method posixAccount::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file posixGroup.inc, method posixGroup::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file inetOrgPerson.inc, method inetOrgPerson::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    in file ldapPublicKey.inc, method ldapPublicKey::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    +
    in file account.inc, method account::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    in file kolabUser.inc, method kolabUser::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    -
    in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::process_attributes()
        Processes user input of the primary module page.
    +
    in file posixAccount.inc, method posixAccount::process_attributes()
        Processes user input of the primary module page.
    +
    process_attributes
    +
    in file inetOrgPerson.inc, method inetOrgPerson::process_attributes()
        Processes user input of the primary module page.
    process_attributes
    in file nisMailAlias.inc, method nisMailAlias::process_attributes()
        Processes user input of the primary module page.
    -
    process_attributes
    -
    in file account.inc, method account::process_attributes()
        Processes user input of the primary module page.
    process_deleteUser
    in file kolabUser.inc, method kolabUser::process_deleteUser()
        Write variables into object and do some regex checks
    process_expire
    @@ -860,15 +907,17 @@
    process_logonHours
    in file sambaSamAccount.inc, method sambaSamAccount::process_logonHours()
        Processes user input of the logon hours page.
    process_password
    -
    in file posixAccount.inc, method posixAccount::process_password()
        Processes user input of the password page.
    +
    in file inetOrgPerson.inc, method inetOrgPerson::process_password()
        Sets a new password.
    process_password
    in file posixGroup.inc, method posixGroup::process_password()
        Processes user input of the password page.
    process_password
    -
    in file inetOrgPerson.inc, method inetOrgPerson::process_password()
        Sets a new password.
    +
    in file posixAccount.inc, method posixAccount::process_password()
        Processes user input of the password page.
    process_photo
    in file inetOrgPerson.inc, method inetOrgPerson::process_photo()
        Sets a new photo.
    process_sambaUserWorkstations
    in file sambaSamAccount.inc, method sambaSamAccount::process_sambaUserWorkstations()
        Processes user input of the primary module page.
    +
    process_terminalServer
    +
    in file sambaSamAccount.inc, method sambaSamAccount::process_terminalServer()
        Processes user input of the terminal server page.
    process_time
    in file sambaSamAccount.inc, method sambaSamAccount::process_time()
        Processes user input of the time selection page.
    process_user
    @@ -883,10 +932,8 @@

    q

    -
    $quota
    -
    in file quota.inc, variable quota::$quota
    quota.inc
    -
    procedural page quota.inc
    +
    procedural page quota.inc
    quota
    in file quota.inc, class quota
        Manages quotas for users and groups.
    @@ -901,12 +948,10 @@
    in file modules.inc, variable accountContainer::$rdn
        RDN attribute of this account
    $RIDbase
    in file account.inc, variable samba3domain::$RIDbase
        RID base to calculate RIDs, default 1000
    -
    $rids
    -
    in file sambaSamAccount.inc, variable sambaSamAccount::$rids
        array of well known rids
    -
    $rids
    -
    in file sambaAccount.inc, variable sambaAccount::$rids
        Array of well known rids
    -
    $rids
    -
    in file sambaGroupMapping.inc, variable sambaGroupMapping::$rids
        Array of well known RIDs
    +
    readTime
    +
    in file sambaMungedDial.inc, method sambaMungedDial::readTime()
        readTime
    +
    replaceSpecialChars
    +
    in file quota.inc, method quota::replaceSpecialChars()
        Replaces special characters in HTML name values.
    top
    @@ -915,82 +960,108 @@

    s

    -
    $sambaGroupTypes
    -
    in file sambaGroupMapping.inc, variable sambaGroupMapping::$sambaGroupTypes
        Array of sambaGroupTypes
    $sbox
    in file createntlm.inc, variable smbHash::$sbox
    $sc
    in file createntlm.inc, variable smbHash::$sc
    -
    $scope
    -
    in file baseModule.inc, variable baseModule::$scope
        the account type of this module (user, group, host)
    +
    $selfServiceSettings
    +
    in file baseModule.inc, variable baseModule::$selfServiceSettings
        self service settings of all modules
    $SID
    in file account.inc, variable samba3domain::$SID
        Domain SID
    -
    $subpage
    -
    in file modules.inc, variable accountContainer::$subpage
        This variable is set to the pagename of a subpage if it should be displayed
    sambaAccount.inc
    -
    procedural page sambaAccount.inc
    +
    procedural page sambaAccount.inc
    sambaDomain.inc
    -
    procedural page sambaDomain.inc
    +
    procedural page sambaDomain.inc
    sambaGroupMapping.inc
    -
    procedural page sambaGroupMapping.inc
    +
    procedural page sambaGroupMapping.inc
    +
    sambaMungedDial.inc
    +
    procedural page sambaMungedDial.inc
    sambaSamAccount.inc
    -
    procedural page sambaSamAccount.inc
    +
    procedural page sambaSamAccount.inc
    shadowAccount.inc
    -
    procedural page shadowAccount.inc
    +
    procedural page shadowAccount.inc
    samba3domain
    in file account.inc, class samba3domain
        Represents a Samba 3 domain entry
    sambaAccount
    -
    in file sambaAccount.inc, class sambaAccount
        Manages the object class "sambaAccount" for users and hosts.
    -
    sambaAccount
    in file sambaAccount.inc, method sambaAccount::sambaAccount()
        Creates a new sambaAccount object.
    +
    sambaAccount
    +
    in file sambaAccount.inc, class sambaAccount
        Manages the object class "sambaAccount" for users and hosts.
    sambaDomain
    in file sambaDomain.inc, class sambaDomain
        Manages Samba 3 domain entries.
    sambaGroupMapping
    in file sambaGroupMapping.inc, method sambaGroupMapping::sambaGroupMapping()
        Creates a new module for Samba 3 groups.
    sambaGroupMapping
    in file sambaGroupMapping.inc, class sambaGroupMapping
        Manages the object class "sambaGroupMapping" for groups.
    +
    sambaMungedDial
    +
    in file sambaMungedDial.inc, class sambaMungedDial
        Manages terminal server settings for Samba 3.
    sambaSamAccount
    in file sambaSamAccount.inc, class sambaSamAccount
        Manages the object class "sambaSamAccount" for users and hosts.
    sambaSamAccount
    in file sambaSamAccount.inc, method sambaSamAccount::sambaSamAccount()
        Creates a new sambaSamAccount object.
    +
    SAMBA_MUNGEDDIAL_FILEHEADER
    +
    in file sambaMungedDial.inc, constant SAMBA_MUNGEDDIAL_FILEHEADER
        File header
    +
    SAMBA_MUNGEDDIAL_FILEHEADER_OLD
    +
    in file sambaMungedDial.inc, constant SAMBA_MUNGEDDIAL_FILEHEADER_OLD
        File header for old format.
    save_account
    in file modules.inc, method accountContainer::save_account()
        This function will save an account to the LDAP database.
    save_attributes
    -
    in file sambaSamAccount.inc, method sambaSamAccount::save_attributes()
    +
    in file posixAccount.inc, method posixAccount::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    -
    in file sambaGroupMapping.inc, method sambaGroupMapping::save_attributes()
    +
    in file sambaGroupMapping.inc, method sambaGroupMapping::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    -
    in file shadowAccount.inc, method shadowAccount::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    -
    save_attributes
    -
    in file posixGroup.inc, method posixGroup::save_attributes()
    +
    in file sambaSamAccount.inc, method sambaSamAccount::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    in file baseModule.inc, method baseModule::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    -
    in file sambaAccount.inc, method sambaAccount::save_attributes()
    +
    in file account.inc, method account::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    +
    save_attributes
    +
    in file shadowAccount.inc, method shadowAccount::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    +
    save_attributes
    +
    in file posixGroup.inc, method posixGroup::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    +
    save_attributes
    +
    in file inetOrgPerson.inc, method inetOrgPerson::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    +
    save_attributes
    +
    in file sambaAccount.inc, method sambaAccount::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    in file kolabUser.inc, method kolabUser::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    save_attributes
    in file nisMailAlias.inc, method nisMailAlias::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    -
    save_attributes
    -
    in file posixAccount.inc, method posixAccount::save_attributes()
        Returns a list of modifications which have to be made to the LDAP account.
    -
    save_attributes
    -
    in file quota.inc, method quota::save_attributes()
    -
    save_attributes
    -
    in file account.inc, method account::save_attributes()
    -
    save_attributes
    -
    in file inetOrgPerson.inc, method inetOrgPerson::save_attributes()
    save_module_attributes
    in file modules.inc, method accountContainer::save_module_attributes()
        This function checks which LDAP attributes have changed while the account was edited.
    +
    setBrokenConn
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setBrokenConn()
        sets Broken-Connection value: disconnect/reset
    +
    setConnectClientDrives
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setConnectClientDrives()
        sets connect-client-drive-at-logon value: enabled/disabled
    +
    setConnectClientPrinters
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setConnectClientPrinters()
        sets connect-client-printers-at-logon value: enabled/disabled
    +
    setCtxMaxConnectionTimeF
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setCtxMaxConnectionTimeF()
        SMARTY: sets the checkbox "Connection" to unchecked
    +
    setCtxMaxDisconnectionTimeF
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setCtxMaxDisconnectionTimeF()
        SMARTY: sets the checkbox "Disconnection" to unchecked
    +
    setCtxMaxIdleTimeF
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setCtxMaxIdleTimeF()
        SMARTY: sets the checkbox "Idle" to unchecked
    +
    setDefaultPrinter
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setDefaultPrinter()
        sets set-client-printer-to-default value: enabled/disabled
    +
    setInheritMode
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setInheritMode()
        sets Inherit-config-from-client value: enabled/disabled
    +
    setReConn
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setReConn()
        sets Reconnection value: from any client/from previous client only
    +
    setShadow
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setShadow()
        sets shadow value
    +
    setTsLogin
    +
    in file sambaMungedDial.inc, method sambaMungedDial::setTsLogin()
        Sets Terminal-Server-Login value: enabled/disabled
    shadowAccount
    in file shadowAccount.inc, class shadowAccount
        Manages the object class "shadowAccount" for users.
    smbHash
    in file createntlm.inc, class smbHash
        Calculates NT and LM hashes.
    smb_hash
    -
    in file createntlm.inc, method smbHash::smb_hash()
    +
    in file createntlm.inc, method smbHash::smb_hash()
        smb_hash
    sortModules
    in file modules.inc, method accountContainer::sortModules()
        Sorts the module buttons for the account page.
    +
    strhex
    +
    in file sambaMungedDial.inc, method sambaMungedDial::strhex()
        strhex
    str_to_key
    -
    in file createntlm.inc, method smbHash::str_to_key()
    +
    in file createntlm.inc, method smbHash::str_to_key()
        str_to_key
    top
    @@ -999,8 +1070,8 @@

    t

    -
    $type
    -
    in file modules.inc, variable accountContainer::$type
        This variale stores the account type.
    +
    to8bit
    +
    in file sambaMungedDial.inc, method sambaMungedDial::to8bit()
        to8bit
    top
    @@ -1009,10 +1080,6 @@

    u

    -
    $useunixpwd
    -
    in file sambaSamAccount.inc, variable sambaSamAccount::$useunixpwd
        use Unix password as samba password?
    -
    $useunixpwd
    -
    in file sambaAccount.inc, variable sambaAccount::$useunixpwd
        use Unix password as samba password?
    unsigned_shift_r
    in file createntlm.inc, method smbHash::unsigned_shift_r()
        Unsigned shift operation for 32bit values.
    @@ -1030,7 +1097,7 @@ top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:34 +0100 by phpDocumentor 1.4.0
    - [ class tree: profiles ] + + + [ class tree: profiles ] [ index: profiles ] - [ all elements ] + [ all elements ]
    - [ class tree: selfService ] + + + [ class tree: selfService ] [ index: selfService ] - [ all elements ] + [ all elements ]

    Element index for package selfService

    - [ a ] [ c ] [ g ] [ i ] [ l ] [ m ] - [ p ] [ s ] -
    - -
    -

    a

    -
    -
    adminLogin.php
    -
    procedural page adminLogin.php
    -
    adminMain.php
    -
    procedural page adminMain.php
    -
    -
    - top

    c

    checkSelfServiceOptions
    -
    in file selfService.inc, function checkSelfServiceOptions()
        Checks if all input values are correct and returns the LDAP commands which should be executed.
    +
    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
    top
    @@ -106,13 +88,15 @@

    g

    getSelfServiceFieldSettings
    -
    in file selfService.inc, function getSelfServiceFieldSettings()
        Returns the field settings for the self service.
    +
    in file selfService.inc, function getSelfServiceFieldSettings()
        Returns the field settings for the self service.
    getSelfServiceOptions
    -
    in file selfService.inc, function getSelfServiceOptions()
        Returns meta HTML code for each self service field.
    +
    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)
    +
    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.
    +
    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.
    top
    @@ -124,7 +108,7 @@
    $inputFields
    in file selfService.inc, variable selfServiceProfile::$inputFields
        input fields
    isLAMProVersion
    -
    in file selfService.inc, function isLAMProVersion()
        Returns if this is a LAM Pro installation.
    +
    in file selfService.inc, function isLAMProVersion()
        Returns if this is a LAM Pro installation.
    top
    @@ -144,7 +128,7 @@
    $loginCaption
    in file selfService.inc, variable selfServiceProfile::$loginCaption
        describing text for user login
    loadSelfServiceProfile
    -
    in file selfService.inc, function loadSelfServiceProfile()
        Loads all settings of a self service profile.
    +
    in file selfService.inc, function loadSelfServiceProfile()
        Loads all settings of a self service profile.
    top
    @@ -155,16 +139,8 @@
    $mainPageText
    in file selfService.inc, variable selfServiceProfile::$mainPageText
        describing text for self service main page
    -
    - - top
    -
    - -
    -

    p

    -
    -
    profManage.php
    -
    procedural page profManage.php
    +
    $moduleSettings
    +
    in file selfService.inc, variable selfServiceProfile::$moduleSettings
        configuration settings of modules
    top
    @@ -178,23 +154,19 @@
    $serverURL
    in file selfService.inc, variable selfServiceProfile::$serverURL
        server address
    selfService.inc
    -
    procedural page selfService.inc
    +
    procedural page selfService.inc
    saveSelfServiceProfile
    -
    in file selfService.inc, function saveSelfServiceProfile()
        Saves a self service profile.
    -
    selfServiceProfile
    -
    in file selfService.inc, class selfServiceProfile
        Includes all settings of a self service profile.
    +
    in file selfService.inc, function saveSelfServiceProfile()
        Saves a self service profile.
    selfServiceProfile
    in file selfService.inc, method selfServiceProfile::selfServiceProfile()
        Constructor
    -
    selfServiceLogin.php
    -
    procedural page selfServiceLogin.php
    -
    selfServiceMain.php
    -
    procedural page selfServiceMain.php
    +
    selfServiceProfile
    +
    in file selfService.inc, class selfServiceProfile
        Includes all settings of a self service profile.
    top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: tests ] + + + [ class tree: tests ] [ index: tests ] - [ all elements ] + [ all elements ]
    - [ class tree: tools ] + + + [ class tree: tools ] [ index: tools ] - [ all elements ] + [ all elements ]
    @@ -146,7 +150,7 @@
    displayExportInfo
    in file export.inc, method PlaLdifExporter::displayExportInfo()
    display_main
    -
    in file ou_edit.php, function display_main()
    +
    in file ou_edit.php, function display_main()
    top
    @@ -176,7 +180,7 @@
    export
    in file export.inc, method PlaExporter::export()
        Abstract method use to export data.
    export.inc
    -
    procedural page export.inc
    +
    procedural page export.inc
    top
    @@ -186,7 +190,7 @@

    g

    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.
    +
    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.
    top
    @@ -208,15 +212,15 @@
    $indent_step
    in file export.inc, variable PlaDsmlExporter::$indent_step
    is_browser_os_mac
    -
    in file export.inc, function is_browser_os_mac()
        Determines whether the browser's operating system is Macintosh.
    +
    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).
    +
    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.
    +
    in file export.inc, function is_browser_os_windows()
        Determines whether the browser's operating system is Windows.
    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.
    index.php
    -
    procedural page index.php
    +
    procedural page index.php
    top
    @@ -228,7 +232,7 @@
    $ldap_info
    in file export.inc, variable PlaLdapExporter::$ldap_info
    lamTestLamdaemon
    -
    in file lamdaemonTest.php, function lamTestLamdaemon()
        Runs a test case of lamdaemon.
    +
    in file lamdaemonTest.php, function lamTestLamdaemon()
        Runs a test case of lamdaemon.
    LdapEscape
    in file export.inc, method PlaCSVExporter::LdapEscape()
    LdapExportInfo
    @@ -236,7 +240,7 @@
    LdapExportInfo
    in file export.inc, method LdapExportInfo::LdapExportInfo()
        Create a new LdapExportInfo object
    lamdaemonTest.php
    -
    procedural page lamdaemonTest.php
    +
    procedural page lamdaemonTest.php
    top
    @@ -256,11 +260,11 @@
    MyCutsomExporter
    in file export.inc, method MyCustomExporter::MyCutsomExporter()
    massBuildAccounts.php
    -
    procedural page massBuildAccounts.php
    +
    procedural page massBuildAccounts.php
    masscreate.php
    -
    procedural page masscreate.php
    +
    procedural page masscreate.php
    massDoUpload.php
    -
    procedural page massDoUpload.php
    +
    procedural page massDoUpload.php
    top
    @@ -280,7 +284,7 @@

    o

    ou_edit.php
    -
    procedural page ou_edit.php
    +
    procedural page ou_edit.php
    top
    @@ -386,11 +390,11 @@
    setOutputFormat
    in file export.inc, method PlaExporter::setOutputFormat()
        Set the carriage return /linefeed for the export
    showColumnData
    -
    in file masscreate.php, function showColumnData()
        Prints the properties of one input field.
    +
    in file masscreate.php, function showColumnData()
        Prints the properties of one input field.
    showMainPage
    -
    in file masscreate.php, function showMainPage()
        Displays the acount type specific main page of the upload.
    +
    in file masscreate.php, function showMainPage()
        Displays the acount type specific main page of the upload.
    schema.php
    -
    procedural page schema.php
    +
    procedural page schema.php
    top
    @@ -400,7 +404,7 @@

    t

    tools.php
    -
    procedural page tools.php
    +
    procedural page tools.php
    top
    @@ -416,7 +420,7 @@ top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: types ] + + + [ class tree: types ] [ index: types ] - [ all elements ] + [ all elements ]
    @@ -79,7 +83,6 @@ [ b ] [ g ] [ h ] - [ i ] [ m ] [ s ] [ t ] @@ -93,7 +96,7 @@
    baseType
    in file baseType.inc, class baseType
        This is the parent class of all account types.
    baseType.inc
    -
    procedural page baseType.inc
    +
    procedural page baseType.inc
    top
    @@ -121,7 +124,7 @@
    getDefaultListAttributes
    in file user.inc, method user::getDefaultListAttributes()
        Returns the default attribute list for this account type.
    getDefaultListAttributes
    -
    in file types.inc, function getDefaultListAttributes()
        Returns the default attribute list for an account type.
    +
    in file types.inc, function getDefaultListAttributes()
        Returns the default attribute list for an account type.
    getDefaultListAttributes
    in file mailAlias.inc, method mailAlias::getDefaultListAttributes()
        Returns the default attribute list for this account type.
    getDefaultListAttributes
    @@ -141,7 +144,7 @@
    getDescription
    in file host.inc, method host::getDescription()
        Returns the description of this account type.
    getListAttributeDescriptions
    -
    in file types.inc, function getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    +
    in file types.inc, function getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    getListAttributeDescriptions
    in file group.inc, method group::getListAttributeDescriptions()
        Returns a list of attributes which have a translated description.
    getListAttributeDescriptions
    @@ -157,7 +160,7 @@
    getListClassName
    in file group.inc, method group::getListClassName()
        Returns the class name for the list object.
    getListClassName
    -
    in file types.inc, function getListClassName()
        Returns the class name for the list object.
    +
    in file types.inc, function getListClassName()
        Returns the class name for the list object.
    getListClassName
    in file user.inc, method user::getListClassName()
        Returns the class name for the list object.
    getListClassName
    @@ -169,15 +172,15 @@
    getListClassName
    in file mailAlias.inc, method mailAlias::getListClassName()
        Returns the class name for the list object.
    getTypeAlias
    -
    in file types.inc, function getTypeAlias()
        Returns the alias name of an account type.
    +
    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.
    +
    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.
    +
    in file types.inc, function getTypes()
        Returns a list of available account types.
    group
    in file group.inc, class group
        The account type for group accounts (e.g. Unix and Samba).
    group.inc
    -
    procedural page group.inc
    +
    procedural page group.inc
    top
    @@ -189,15 +192,7 @@
    host
    in file host.inc, class host
        The account type for host accounts (e.g. Samba).
    host.inc
    -
    procedural page host.inc
    - - - top
    -
    - -
    -

    i

    -
    +
    procedural page host.inc
    top
    @@ -207,7 +202,7 @@

    m

    mailAlias.inc
    -
    procedural page mailAlias.inc
    +
    procedural page mailAlias.inc
    mailAlias
    in file mailAlias.inc, class mailAlias
        The account type for mail aliases.
    @@ -219,7 +214,7 @@

    s

    smbDomain.inc
    -
    procedural page smbDomain.inc
    +
    procedural page smbDomain.inc
    smbDomain
    in file smbDomain.inc, class smbDomain
        The account type for Samba domains.
    @@ -231,7 +226,7 @@

    t

    types.inc
    -
    procedural page types.inc
    +
    procedural page types.inc
    top
    @@ -241,7 +236,7 @@

    u

    user.inc
    -
    procedural page user.inc
    +
    procedural page user.inc
    user
    in file user.inc, class user
        The account type for user accounts (e.g. Unix, Samba and Kolab).
    @@ -249,7 +244,7 @@ top

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: PDF ] + + + [ class tree: PDF ] [ index: PDF ] - [ all elements ] + [ all elements ]
    - [ class tree: default ] - [ index: default ] - [ all elements ] + + [ all elements ]
    - [ class tree: Help ] + + + [ class tree: Help ] [ index: Help ] - [ all elements ] + [ all elements ]
    - [ class tree: LDAP ] + + + [ class tree: LDAP ] [ index: LDAP ] - [ all elements ] + [ all elements ]
    @@ -60,10 +64,11 @@

    LDAP Account Manager - Documentation

    Welcome to LDAP!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: PDF ] + + + [ class tree: PDF ] [ index: PDF ] - [ all elements ] + [ all elements ]
    @@ -85,10 +89,11 @@

    LDAP Account Manager - Documentation

    Welcome to PDF!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: configuration ] + + + [ class tree: configuration ] [ index: configuration ] - [ all elements ] + [ all elements ]
    @@ -77,10 +81,11 @@

    LDAP Account Manager - Documentation

    Welcome to configuration!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: lib ] + + + [ class tree: lib ] [ index: lib ] - [ all elements ] + [ all elements ]
    @@ -75,10 +79,11 @@

    LDAP Account Manager - Documentation

    Welcome to lib!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: lists ] + + + [ class tree: lists ] [ index: lists ] - [ all elements ] + [ all elements ]
    @@ -127,10 +133,11 @@

    LDAP Account Manager - Documentation

    Welcome to lists!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: main ] + + + [ class tree: main ] [ index: main ] - [ all elements ] + [ all elements ]
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -116,10 +123,11 @@

    LDAP Account Manager - Documentation

    Welcome to modules!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: profiles ] + + + [ class tree: profiles ] [ index: profiles ] - [ all elements ] + [ all elements ]
    - [ class tree: selfService ] + + + [ class tree: selfService ] [ index: selfService ] - [ all elements ] + [ all elements ]
    @@ -70,10 +64,11 @@

    LDAP Account Manager - Documentation

    Welcome to selfService!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: tests ] + + + [ class tree: tests ] [ index: tests ] - [ all elements ] + [ all elements ]
    - [ class tree: tools ] + + + [ class tree: tools ] [ index: tools ] - [ all elements ] + [ all elements ]
    @@ -84,10 +88,11 @@

    LDAP Account Manager - Documentation

    Welcome to tools!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: types ] + + + [ class tree: types ] [ index: types ] - [ all elements ] + [ all elements ]
    @@ -77,10 +81,11 @@

    LDAP Account Manager - Documentation

    Welcome to types!

    -This documentation was generated by phpDocumentor v1.2.3
    +This documentation was generated by phpDocumentor v1.4.0
    +

    - Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:35 +0100 by phpDocumentor 1.4.0
    - [ class tree: lib ] + + + [ class tree: lib ] [ index: lib ] - [ all elements ] + [ all elements ]
    @@ -76,7 +80,6 @@ Source Location: /lib/schema.inc

    - diff --git a/lam-web/developers/phpdoc/lib/MatchingRule.html b/lam-web/developers/phpdoc/lib/MatchingRule.html index cc4af15d..daaa1b40 100644 --- a/lam-web/developers/phpdoc/lib/MatchingRule.html +++ b/lam-web/developers/phpdoc/lib/MatchingRule.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -160,7 +163,6 @@ Source Location: /lib/schema.inc

    -

    Inherited Variables

    @@ -168,15 +170,13 @@ Source Location: /lib/schema.inc

    SchemaItem::$description - -
    +
    SchemaItem::$oid - -
    +
    @@ -191,42 +191,36 @@ Source Location: /lib/schema.inc

    SchemaItem::SchemaItem() -
    Default constructor.
    SchemaItem::getDescription() -
    SchemaItem::getOID() -
    SchemaItem::initVars() -
    Initialize class members to default values.
    SchemaItem::setDescription() -
    SchemaItem::setOID() -
    @@ -503,7 +497,7 @@ Represents an LDAP AttributeType



    AttributeType AttributeType( -mixed + $raw_ldap_attr_string)

    @@ -511,8 +505,16 @@ $raw_ldap_attr_string) Creates a new AttributeType objcet from a raw LDAP AttributeType string.



    - - +

    Parameters:

    +
    + + + + + + +
      $raw_ldap_attr_string  
    +

    [ Top ]

    @@ -530,8 +532,6 @@ $new_alias_name) Adds an attribute name to the alias array.



    - -

    Parameters:

    @@ -559,8 +559,6 @@ $object_class_name) Adds an objectClass name to this attribute's list of "required by" objectClasses, that is the list of objectClasses which must have this attribute.



    - -

    Parameters:

    @@ -588,8 +586,6 @@ $object_class_name) Adds an objectClass name to this attribute's list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.



    - -

    Parameters:

    @@ -625,8 +621,6 @@ $object_class_name)

    - -
    [ Top ]

    @@ -643,8 +637,6 @@ $object_class_name) Gets this attribute's equality string



    - -
    [ Top ]

    @@ -670,8 +662,6 @@ $object_class_name)

    - -
    [ Top ]

    @@ -697,8 +687,6 @@ $object_class_name)

    - -
    [ Top ]

    @@ -715,8 +703,6 @@ $object_class_name) Gets whether this attribute has been flagged as obsolete by the LDAP server



    - -
    [ Top ]

    @@ -742,8 +728,6 @@ $object_class_name)

    - -
    [ Top ]

    @@ -769,8 +753,6 @@ $object_class_name)

    - -
    [ Top ]

    @@ -787,8 +769,6 @@ $object_class_name) Gets this attribute's name



    - -
    [ Top ]

    @@ -805,8 +785,6 @@ $object_class_name) Gets this attribute's ordering specification.



    - -
    [ Top ]

    @@ -832,8 +810,6 @@ $object_class_name)

    - -
    [ Top ]

    @@ -850,8 +826,6 @@ $object_class_name) Gets this attribute's substring matching specification



    - -
    [ Top ]

    @@ -868,8 +842,6 @@ $object_class_name) Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.



    - -
    [ Top ]

    @@ -895,8 +867,6 @@ $object_class_name)

    - -
    [ Top ]

    @@ -922,8 +892,6 @@ $object_class_name)

    - -
    [ Top ]

    @@ -949,8 +917,6 @@ $object_class_name)

    - -
    [ Top ]

    @@ -967,8 +933,6 @@ $object_class_name) Gets this attribute's usage string as defined by the LDAP server



    - -
    [ Top ]

    @@ -994,8 +958,6 @@ $object_class_name)

    - -
    [ Top ]

    @@ -1011,9 +973,7 @@ $object_class_name) Initialize the class' member variables



    - -Overrides SchemaItem::initVars() (Initialize class members to default values.)

    - + Overrides SchemaItem::initVars() (Initialize class members to default values.)

    [ Top ]

    @@ -1040,8 +1000,6 @@ $attr_name)

    - -

    Parameters:

    @@ -1078,8 +1036,6 @@ $remove_alias_name)

    - -

    Parameters:

    @@ -1107,8 +1063,6 @@ $new_aliases) Sets this attribute's list of aliases.



    - -

    Parameters:

    @@ -1136,8 +1090,6 @@ $is_single_value) Sets whether this attribute is single-valued.



    - -

    Parameters:

    @@ -1165,8 +1117,6 @@ $new_name) Sets this attriute's name.



    - -

    Parameters:

    @@ -1194,8 +1144,6 @@ $new_sup_attr) Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).



    - -

    Parameters:

    @@ -1223,8 +1171,6 @@ $new_type) Sets this attribute's type.



    - -

    Parameters:

    @@ -1242,7 +1188,7 @@ $new_type)

    - Documentation generated on Wed, 15 Nov 2006 18:01:04 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:11:07 +0100 by phpDocumentor 1.4.0
    - [ class tree: lib ] + + + [ class tree: lib ] [ index: lib ] - [ all elements ] + [ all elements ]
    @@ -76,7 +80,6 @@ Source Location: /lib/schema.inc

    - diff --git a/lam-web/developers/phpdoc/lib/MatchingRuleUse.html b/lam-web/developers/phpdoc/lib/MatchingRuleUse.html index 4d54aec5..8b46e67e 100644 --- a/lam-web/developers/phpdoc/lib/MatchingRuleUse.html +++ b/lam-web/developers/phpdoc/lib/MatchingRuleUse.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -126,7 +129,6 @@ Source Location: /lib/schema.inc

    -

    Inherited Variables

    @@ -134,15 +136,13 @@ Source Location: /lib/schema.inc

    SchemaItem::$description - -
    +
    SchemaItem::$oid - -
    +
    @@ -157,42 +157,36 @@ Source Location: /lib/schema.inc

    SchemaItem::SchemaItem() -
    Default constructor.
    SchemaItem::getDescription() -
    SchemaItem::getOID() -
    SchemaItem::initVars() -
    Initialize class members to default values.
    SchemaItem::setDescription() -
    SchemaItem::setOID() -
    @@ -289,7 +283,7 @@ Represents an LDAP MatchingRule



    MatchingRule MatchingRule( -mixed + $raw_ldap_matching_rule_string)

    @@ -297,8 +291,16 @@ $raw_ldap_matching_rule_string) Creates a new MatchingRule object from a raw LDAP MatchingRule string.



    - - +

    Parameters:

    +
    + + + + + + +
      $raw_ldap_matching_rule_string  
    +

    [ Top ]

    @@ -308,7 +310,7 @@ $raw_ldap_matching_rule_string)
    true addUsedByAttr( -mixed + $new_attr_name)

    @@ -325,8 +327,16 @@ $new_attr_name)

    - - +

    Parameters:

    +
    + + + + + + +
      $new_attr_name  
    +

    [ Top ]

    @@ -352,8 +362,6 @@ $new_attr_name)

    - -
    [ Top ]

    @@ -379,8 +387,6 @@ $new_attr_name)

    - -
    [ Top ]

    @@ -406,8 +412,6 @@ $new_attr_name)

    - -
    [ Top ]

    @@ -423,9 +427,7 @@ $new_attr_name) Initialize the class' member variables



    - -Overrides SchemaItem::initVars() (Initialize class members to default values.)

    - + Overrides SchemaItem::initVars() (Initialize class members to default values.)

    [ Top ]

    @@ -443,8 +445,6 @@ $attrs) Sets the list of used_by_attrs to the array specified by $attrs;



    - -

    Parameters:

    @@ -462,7 +462,7 @@ $attrs)

    - Documentation generated on Wed, 15 Nov 2006 18:01:05 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:11:08 +0100 by phpDocumentor 1.4.0
    - [ class tree: lib ] + + + [ class tree: lib ] [ index: lib ] - [ all elements ] + [ all elements ]
    diff --git a/lam-web/developers/phpdoc/lib/ObjectClass.html b/lam-web/developers/phpdoc/lib/ObjectClass.html index 6f3914ec..b78a8a2c 100644 --- a/lam-web/developers/phpdoc/lib/ObjectClass.html +++ b/lam-web/developers/phpdoc/lib/ObjectClass.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -76,7 +80,6 @@ Source Location: /lib/schema.inc

    -
    @@ -121,7 +124,6 @@ Source Location: /lib/schema.inc

    -

    Inherited Variables

    @@ -129,15 +131,13 @@ Source Location: /lib/schema.inc

    SchemaItem::$description - -
    +
    SchemaItem::$oid - -
    +
    @@ -152,42 +152,36 @@ Source Location: /lib/schema.inc

    SchemaItem::SchemaItem() -
    Default constructor.
    SchemaItem::getDescription() -
    SchemaItem::getOID() -
    SchemaItem::initVars() -
    Initialize class members to default values.
    SchemaItem::setDescription() -
    SchemaItem::setOID() -
    @@ -254,7 +248,7 @@ Represents an LDAP schema matchingRuleUse entry



    MatchingRuleUse MatchingRuleUse( -mixed + $raw_matching_rule_use_string)

    @@ -262,8 +256,16 @@ $raw_matching_rule_use_string)

    - - +

    Parameters:

    +
    + + + + + + +
      $raw_matching_rule_use_string  
    +

    [ Top ]

    @@ -289,8 +291,6 @@ $raw_matching_rule_use_string)

    - -
    [ Top ]

    @@ -316,8 +316,6 @@ $raw_matching_rule_use_string)

    - -
    [ Top ]

    @@ -333,9 +331,7 @@ $raw_matching_rule_use_string) Initialize the class' member variables



    - -Overrides SchemaItem::initVars() (Initialize class members to default values.)

    - + Overrides SchemaItem::initVars() (Initialize class members to default values.)

    [ Top ]

    @@ -343,7 +339,7 @@ Overrides SchemaItem::initVars()
    - [ class tree: lib ] + + + [ class tree: lib ] [ index: lib ] - [ all elements ] + [ all elements ]
    @@ -76,7 +80,6 @@ Source Location: /lib/schema.inc

    - diff --git a/lam-web/developers/phpdoc/lib/ObjectClassAttribute.html b/lam-web/developers/phpdoc/lib/ObjectClassAttribute.html index e9313625..613b870c 100644 --- a/lam-web/developers/phpdoc/lib/ObjectClassAttribute.html +++ b/lam-web/developers/phpdoc/lib/ObjectClassAttribute.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -136,7 +139,6 @@ Source Location: /lib/schema.inc

    -

    Inherited Variables

    @@ -144,15 +146,13 @@ Source Location: /lib/schema.inc

    SchemaItem::$description - -
    +
    SchemaItem::$oid - -
    +
    @@ -167,42 +167,36 @@ Source Location: /lib/schema.inc

    SchemaItem::SchemaItem() -
    Default constructor.
    SchemaItem::getDescription() -
    SchemaItem::getOID() -
    SchemaItem::initVars() -
    Initialize class members to default values.
    SchemaItem::setDescription() -
    SchemaItem::setOID() -
    @@ -344,7 +338,7 @@ Represents an LDAP objectClass



    ObjectClass ObjectClass( -mixed + $raw_ldap_schema_string)

    @@ -352,8 +346,16 @@ $raw_ldap_schema_string) Creates a new ObjectClass object given a raw LDAP objectClass string.



    - - +

    Parameters:

    +
    + + + + + + +
      $raw_ldap_schema_string  
    +

    [ Top ]

    @@ -380,8 +382,6 @@ $object_class_name)

    - -

    Parameters:

    @@ -409,8 +409,6 @@ $new_may_attrs) Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.



    - -

    Parameters:

    @@ -438,8 +436,6 @@ $new_must_attrs) Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.



    - -

    Parameters:

    @@ -475,8 +471,6 @@ $new_must_attrs)

    - -
    [ Top ]

    @@ -493,8 +487,6 @@ $new_must_attrs) Gets whether this objectClass is flagged as obsolete by the LDAP server.



    - -
    [ Top ]

    @@ -530,8 +522,6 @@ $oclasses = null])

    - -

    Parameters:

    @@ -580,8 +570,6 @@ $oclasses = NULL])

    - -

    Parameters:

    @@ -627,8 +615,6 @@ $oclasses = null])

    - -

    Parameters:

    @@ -674,8 +660,6 @@ $oclasses = NULL])

    - -

    Parameters:

    @@ -711,8 +695,6 @@ $oclasses = NULL])

    - -
    [ Top ]

    @@ -738,8 +720,6 @@ $oclasses = NULL])

    - -
    [ Top ]

    @@ -756,8 +736,6 @@ $oclasses = NULL]) Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.



    - -
    [ Top ]

    @@ -773,9 +751,7 @@ $oclasses = NULL]) Initialize the class' member variables



    - -Overrides SchemaItem::initVars() (Initialize class members to default values.)

    - + Overrides SchemaItem::initVars() (Initialize class members to default values.)

    [ Top ]

    @@ -783,7 +759,7 @@ Overrides SchemaItem::initVars()
    - [ class tree: lib ] + + + [ class tree: lib ] [ index: lib ] - [ all elements ] + [ all elements ]
    diff --git a/lam-web/developers/phpdoc/lib/SchemaItem.html b/lam-web/developers/phpdoc/lib/SchemaItem.html index e87472aa..5027fb77 100644 --- a/lam-web/developers/phpdoc/lib/SchemaItem.html +++ b/lam-web/developers/phpdoc/lib/SchemaItem.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -76,7 +80,6 @@ Source Location: /lib/schema.inc

    -
    @@ -120,7 +123,6 @@ Source Location: /lib/schema.inc

    -

    @@ -188,8 +190,6 @@ $source) Creates a new ObjectClassAttribute with specified name and source objectClass.



    - -

    Parameters:

    @@ -221,8 +221,6 @@ $source) Gets this attribute's name



    - -
    [ Top ]

    @@ -239,8 +237,6 @@ $source) Gets the name of the ObjectClass which originally specified this attribute.



    - -
    [ Top ]

    @@ -248,7 +244,7 @@ $source)

    - Documentation generated on Wed, 15 Nov 2006 18:01:06 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:11:09 +0100 by phpDocumentor 1.4.0
    - [ class tree: lib ] + + + [ class tree: lib ] [ index: lib ] - [ all elements ] + [ all elements ]
    @@ -76,7 +80,6 @@ Source Location: /lib/schema.inc

    - diff --git a/lam-web/developers/phpdoc/lib/Syntax.html b/lam-web/developers/phpdoc/lib/Syntax.html index 999e6d96..fa682140 100644 --- a/lam-web/developers/phpdoc/lib/Syntax.html +++ b/lam-web/developers/phpdoc/lib/Syntax.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ @@ -24,8 +26,8 @@
    @@ -119,7 +122,6 @@ Source Location: /lib/schema.inc

    -

    Child classes:

    @@ -214,8 +216,6 @@ Generic parent class for all schema items. A schema item is an ObjectClass, an Default constructor.



    - -
    [ Top ]

    @@ -232,8 +232,6 @@ Generic parent class for all schema items. A schema item is an ObjectClass, an

    - -
    [ Top ]

    @@ -250,8 +248,6 @@ Generic parent class for all schema items. A schema item is an ObjectClass, an

    - -
    [ Top ]

    @@ -290,8 +286,6 @@ Generic parent class for all schema items. A schema item is an ObjectClass, an

    - -
    [ Top ]

    @@ -301,7 +295,7 @@ Generic parent class for all schema items. A schema item is an ObjectClass, an
    void setDescription( -mixed + $new_desc)

    @@ -309,8 +303,16 @@ $new_desc)

    - - +

    Parameters:

    +
    + + + + + + +
      $new_desc  
    +

    [ Top ]

    @@ -320,7 +322,7 @@ $new_desc)
    void setOID( -mixed + $new_oid)

    @@ -328,8 +330,16 @@ $new_oid)

    - - +

    Parameters:

    +
    + + + + + + +
      $new_oid  
    +

    [ Top ]

    @@ -337,7 +347,7 @@ $new_oid)

    - Documentation generated on Wed, 15 Nov 2006 18:01:06 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:11:09 +0100 by phpDocumentor 1.4.0
    - [ class tree: lib ] + + + [ class tree: lib ] [ index: lib ] - [ all elements ] + [ all elements ]
    diff --git a/lam-web/developers/phpdoc/lib/_lib---account.inc.html b/lam-web/developers/phpdoc/lib/_lib---account.inc.html new file mode 100644 index 00000000..797f047c --- /dev/null +++ b/lam-web/developers/phpdoc/lib/_lib---account.inc.html @@ -0,0 +1,605 @@ + + +Docs for page account.inc + + + + +
    @@ -76,7 +80,6 @@ Source Location: /lib/schema.inc

    -
    @@ -112,7 +115,6 @@ Source Location: /lib/schema.inc

    -

    Inherited Variables

    @@ -120,15 +122,13 @@ Source Location: /lib/schema.inc

    SchemaItem::$description - -
    +
    SchemaItem::$oid - -
    +
    @@ -143,42 +143,36 @@ Source Location: /lib/schema.inc

    SchemaItem::SchemaItem() -
    Default constructor.
    SchemaItem::getDescription() -
    SchemaItem::getOID() -
    SchemaItem::initVars() -
    Initialize class members to default values.
    SchemaItem::setDescription() -
    SchemaItem::setOID() -
    @@ -210,7 +204,7 @@ Represents an LDAP Syntax



    Syntax Syntax( -mixed + $raw_ldap_syntax_string)

    @@ -218,8 +212,16 @@ $raw_ldap_syntax_string) Creates a new Syntax object from a raw LDAP syntax string.



    - - +

    Parameters:

    +
    + + + + + + +
      $raw_ldap_syntax_string  
    +

    [ Top ]

    @@ -235,9 +237,7 @@ $raw_ldap_syntax_string) Initializes the class' member variables



    - -Overrides SchemaItem::initVars() (Initialize class members to default values.)

    - + Overrides SchemaItem::initVars() (Initialize class members to default values.)

    [ Top ]

    @@ -245,7 +245,7 @@ Overrides SchemaItem::initVars()
    + + + + + + + + +
    lib
    + + + [ class tree: lib ] + [ index: lib ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: account.inc

    +Source Location: /lib/account.inc

    + +
    +
    + +
    +

    Classes:

    +
    samba3domain
    +
    Represents a Samba 3 domain entry
    +


    + +

    Page Details:

    +This provides several helper function for the account modules.



    +

    Tags:

    +
    + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("createntlm.inc") [line 34]
    +Needed to calculate Samba passwords

    +

    +

    +
    +
    + +

    array_delete [line 71]

    +
    +
    +
    + array array_delete( +array $values, array $array) +
    +

    + + This function will return all values from $array without values of $values.



    +

    Tags:

    +
    + + + + +
    return:  list of remaining values
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    array  $values  list of values which should be removed
    array  $array  list of original values
    +
    [ Top ]


    +
    +
    + +

    check_ip [line 508]

    +
    +
    +
    + boolean check_ip( +IP $ip, [check_subnet $subnet = false]) +
    +

    + + This function checks if the given IP ist valid.



    +

    Tags:

    +
    + + + + +
    return:  true or false
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    IP  $ip  
    check_subnet  $subnet  true for subnets, else false
    +
    [ Top ]


    +
    +
    + +

    cmp_domain [line 323]

    +
    +
    +
    + integer cmp_domain( +string $a, string $b) +
    +

    + + Helper function to sort the domains



    +

    Tags:

    +
    + + + + +
    return:  0 if equal, 1 if $a is greater, -1 if $b is greater
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    string  $a  first argument to compare
    string  $b  second argument to compare
    +
    [ Top ]


    +
    +
    + +

    getdays [line 104]

    +
    +
    +
    + number getdays( +) +
    +

    + + This function will return the days from 1.1.1970 until now.



    +

    Tags:

    +
    + + + + +
    return:  of days
    +
    +

    + +
    [ Top ]


    +
    +
    + +

    getshells [line 42]

    +
    +
    +
    + array getshells( +) +
    +

    + + Returns a list of shells listed in config/shells.



    +

    Tags:

    +
    + + + + +
    return:  list of shell names
    +
    +

    + +
    [ Top ]


    +
    +
    + +

    get_preg [line 366]

    +
    +
    +
    + boolean get_preg( +string $argument, string $regexp) +
    +

    + + Checks if a given value matches the selected regular expression.



    +

    Tags:

    +
    + + + + +
    return:  true if matches, otherwise false
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    string  $argument  value to check
    string  $regexp  pattern name
    +
    [ Top ]


    +
    +
    + +

    in_array_ignore_case [line 87]

    +
    +
    +
    + void in_array_ignore_case( + $needle, $haystack) +
    +

    + + Checks if a string exists in an array, ignoring case.



    + +

    Parameters

    + + + + + + + + + + + +
      $needle  
      $haystack  
    +
    [ Top ]


    +
    +
    + +

    lmPassword [line 139]

    +
    +
    +
    + string lmPassword( +string $password) +
    +

    + + Generates the LM hash of a password.



    +

    Tags:

    +
    + + + + +
    return:  password hash
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $password  password original password
    +
    [ Top ]


    +
    +
    + +

    ntPassword [line 150]

    +
    +
    +
    + string ntPassword( +string $password) +
    +

    + + Generates the NT hash of a password.



    +

    Tags:

    +
    + + + + +
    return:  password hash
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $password  password original password
    +
    [ Top ]


    +
    +
    + +

    pwd_disable [line 247]

    +
    +
    +
    + string pwd_disable( +string $hash) +
    +

    + + Marks an password hash as disabled and returns the new hash string



    +

    Tags:

    +
    + + + + +
    return:  disabled hash value
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $hash  hash value to disable
    +
    [ Top ]


    +
    +
    + +

    pwd_enable [line 222]

    +
    +
    +
    + string pwd_enable( +string $hash) +
    +

    + + Marks an password hash as enabled and returns the new hash string



    +

    Tags:

    +
    + + + + +
    return:  enabled password hash
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $hash  hash value to enable
    +
    [ Top ]


    +
    +
    + +

    pwd_hash [line 167]

    +
    +
    +
    + string pwd_hash( +string $password, [boolean $enabled = true], [string $hashType = 'SSHA']) +
    +

    + + Returns the hash value of a plain text password the hash algorithm depends on the configuration file



    +

    Tags:

    +
    + + + + +
    return:  the password hash
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    string  $password  the password string
    boolean  $enabled  marks the hash as enabled/disabled (e.g. by prefixing "!")
    string  $hashType  password hash type (CRYPT, SHA, SSHA, MD5, SMD5, PLAIN)
    +
    [ Top ]


    +
    +
    + +

    pwd_is_enabled [line 272]

    +
    +
    +
    + boolean pwd_is_enabled( +string $hash) +
    +

    + + Checks if a password hash is enabled/disabled



    +

    Tags:

    +
    + + + + +
    return:  true if the password is marked as enabled
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $hash  password hash to check
    +
    [ Top ]


    +
    +
    + +

    search_domains [line 289]

    +
    +
    +
    + array search_domains( +) +
    +

    + + Returns an array with all Samba 3 domain entries under the given suffix



    +

    Tags:

    +
    + + + + +
    return:  list of samba3domain objects
    +
    +

    + +
    [ Top ]


    +
    +
    + +

    smbflag [line 116]

    +
    +
    +
    + string smbflag( +array $input) +
    +

    + + Takes a list of Samba flags and creates the corresponding flag string.



    +

    Tags:

    +
    + + + + +
    return:  Samba flag string
    +
    +

    + +

    Parameters

    + + + + + + +
    array  $input  is an array of Samba flags (e.g. X or D)
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:37 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lib/_lib---cache.inc.html b/lam-web/developers/phpdoc/lib/_lib---cache.inc.html new file mode 100644 index 00000000..e3c3c073 --- /dev/null +++ b/lam-web/developers/phpdoc/lib/_lib---cache.inc.html @@ -0,0 +1,123 @@ + + +Docs for page cache.inc + + + + + + + + + + + + + +
    lib
    + + + [ class tree: lib ] + [ index: lib ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: cache.inc

    +Source Location: /lib/cache.inc

    + +
    +
    + +
    +

    Classes:

    +
    cache
    +
    This class contains all functions which are needed to manage the LDAP cache.
    +


    + +

    Page Details:

    +Provides a cache for LDAP attributes.



    +

    Tags:

    +
    + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('ldap.inc') [line 34]
    +en/decryption functions

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:40 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lib/_lib---schema.inc.html b/lam-web/developers/phpdoc/lib/_lib---schema.inc.html new file mode 100644 index 00000000..9a77395d --- /dev/null +++ b/lam-web/developers/phpdoc/lib/_lib---schema.inc.html @@ -0,0 +1,595 @@ + + +Docs for page schema.inc + + + + + + + + + + + + + +
    lib
    + + + [ class tree: lib ] + [ index: lib ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: schema.inc

    +Source Location: /lib/schema.inc

    + +
    +
    + +
    +

    Classes:

    +
    SchemaItem
    +
    Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.
    +
    ObjectClass
    +
    Represents an LDAP objectClass
    +
    ObjectClassAttribute
    +
    A simple class for representing AttributeTypes used only by the ObjectClass class.
    +
    AttributeType
    +
    Represents an LDAP AttributeType
    +
    Syntax
    +
    Represents an LDAP Syntax
    +
    MatchingRule
    +
    Represents an LDAP MatchingRule
    +
    MatchingRuleUse
    +
    Represents an LDAP schema matchingRuleUse entry
    +


    + +

    Page Details:

    +Classes and functions for fetching and parsing schema from an LDAP server.



    +

    Tags:

    +
    + + + + + + + +
    author:  The phpLDAPadmin development team
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +

    SCHEMA_SESSION_CACHE_ENABLED [line 34]

    +
    +
    +
    + SCHEMA_SESSION_CACHE_ENABLED = 1 +
    +
    + + To enable/disable session-based schema caching (1: enabled, 0: disabled).


    +
    +
    [ Top ]


    +
    +
    + +

    add_aliases_to_attrs [line 1702]

    +
    +
    +
    + void add_aliases_to_attrs( + &$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'.

    This function will create a unique entry for 'gn' and 'givenName'.




    + +

    Parameters

    + + + + + + +
      &$attrs  
    +
    [ Top ]


    +
    +
    + +

    add_sup_to_attrs [line 1727]

    +
    +
    +
    + void add_sup_to_attrs( + &$attrs, &$attrs_oid) +
    +

    + + Adds inherited values to each attributeType specified by the SUP directive.

    Supports infinite levels of inheritance. Bug 856832: require a second paramter that has all attributes indexed by OID




    + +

    Parameters

    + + + + + + + + + + + +
      &$attrs  
      &$attrs_oid  
    +
    [ Top ]


    +
    +
    + +

    cached_schema_available [line 1936]

    +
    +
    +
    + void cached_schema_available( + $schema_type) +
    +

    + + 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.




    + +

    Parameters

    + + + + + + +
      $schema_type  
    +
    [ Top ]


    +
    +
    + +

    get_cached_schema [line 1973]

    +
    +
    +
    + void get_cached_schema( + $schema_type) +
    +

    + + 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.




    + +

    Parameters

    + + + + + + +
      $schema_type  
    +
    [ Top ]


    +
    +
    + +

    get_schema_attribute [line 1589]

    +
    +
    +
    + AttributeType get_schema_attribute( + $attr_name, [string $dn = null], [ $use_cache = true], string $oclass_name) +
    +

    + + Gets a single AttributeType object specified by name.



    +

    Tags:

    +
    + + + + + + + + + + +
    return:  The specified AttributeType object or false on error.
    see:  get_schema_attributes()
    see:  AttributeType
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + +
    string  $oclass_name  The name of the AttributeType to fetch.
    string  $dn  (optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should).
      $attr_name  
      $use_cache  
    +
    [ Top ]


    +
    +
    + +

    get_schema_attributes [line 1610]

    +
    +
    +
    + array get_schema_attributes( +[string $dn = null], [ $use_cache = true]) +
    +

    + + 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).
      $use_cache  
    +
    [ Top ]


    +
    +
    + +

    get_schema_matching_rules [line 1841]

    +
    +
    +
    + void get_schema_matching_rules( +[ $dn = null], [ $use_cache = true]) +
    +

    + + Returns an array of MatchingRule objects for the specified server.

    The key of each entry is the OID of the matching rule.




    + +

    Parameters

    + + + + + + + + + + + +
      $dn  
      $use_cache  
    +
    [ Top ]


    +
    +
    + +

    get_schema_objectclass [line 1565]

    +
    +
    +
    + ObjectClass get_schema_objectclass( +string $oclass_name, [string $dn = null], [ $use_cache = true]) +
    +

    + + Gets a single ObjectClass object specified by name.



    +

    Tags:

    +
    + + + + + + + + + + +
    return:  The specified ObjectClass object or false on error.
    see:  get_schema_objectclasses()
    see:  ObjectClass
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    string  $oclass_name  The name of the objectClass to fetch.
    string  $dn  (optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should).
      $use_cache  
    +
    [ Top ]


    +
    +
    + +

    get_schema_objectclasses [line 1525]

    +
    +
    +
    + array get_schema_objectclasses( +[string $dn = null], [ $use_cache = true]) +
    +

    + + 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.



    +

    Tags:

    +
    + + + + + + + + + + +
    return:  An array of ObjectClass objects.
    see:  get_schema_objectclass()
    see:  ObjectClass
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    string  $dn  (optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should).
      $use_cache  
    +
    [ Top ]


    +
    +
    + +

    get_schema_syntaxes [line 1895]

    +
    +
    +
    + void get_schema_syntaxes( +[ $dn = null], [ $use_cache = true]) +
    +

    + + 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.



    + +

    Parameters

    + + + + + + + + + + + +
      $dn  
      $use_cache  
    +
    [ Top ]


    +
    +
    + +

    set_cached_schema [line 2004]

    +
    +
    +
    + void set_cached_schema( + $schema_type, $schema_items) +
    +

    + + Caches the specified $schema_type.

    $schema_items should be an array of SchemaItem instances (ie, an array of ObjectClass, AttributeType, LDAPSyntax, MatchingRuleUse, or MatchingRule objects.

    Returns true on success of false on failure.




    + +

    Parameters

    + + + + + + + + + + + +
      $schema_type  
      $schema_items  
    +
    [ Top ]


    +
    +
    + +

    set_schema_cache_unavailable [line 2033]

    +
    +
    +
    + void 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.



    + +
    [ Top ]


    +
    +
    + +

    _get_raw_schema [line 1334]

    +
    +
    +
    + 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)
    +
    [ Top ]


    +
    +
    + +

    _get_schema_dn [line 1267]

    +
    +
    +
    + string _get_schema_dn( +string $dn, [bool $debug = false]) +
    +

    + + 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. :)
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:07 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lib/_lib---security.inc.html b/lam-web/developers/phpdoc/lib/_lib---security.inc.html new file mode 100644 index 00000000..edafe060 --- /dev/null +++ b/lam-web/developers/phpdoc/lib/_lib---security.inc.html @@ -0,0 +1,189 @@ + + +Docs for page security.inc + + + + + + + + + + + + + +
    lib
    + + + [ class tree: lib ] + [ index: lib ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: security.inc

    +Source Location: /lib/security.inc

    + +
    +
    + + +

    Page Details:

    +This file includes functions to perform several security checks on each page load.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('ldap.inc') [line 34]
    +ldap connection

    include_once('config.inc') [line 32]
    +configuration options

    +

    +

    +
    +
    + +

    checkClientIP [line 75]

    +
    +
    +
    + void checkClientIP( +) +
    +

    + + Checks if the client's IP address is on the list of allowed IPs.

    The script is stopped if the host is not valid.




    + +
    [ Top ]


    +
    +
    + +

    logNewMessage [line 150]

    +
    +
    +
    + void logNewMessage( +string $level, string $message) +
    +

    + + Puts a new message in the log file.



    + +

    Parameters

    + + + + + + + + + + + +
    string  $level  log level (LOG_NOTICE, LOG_WARNING, LOG_ERR)
    string  $message  log message
    +
    [ Top ]


    +
    +
    + +

    logoffAndBackToLoginPage [line 103]

    +
    +
    +
    + void logoffAndBackToLoginPage( +) +
    +

    + + Logs off the user and displays the login page.



    + +
    [ Top ]


    +
    +
    + +

    startSecureSession [line 43]

    +
    +
    +
    + void startSecureSession( +) +
    +

    + + Starts a session and checks the environment.

    The script is stopped if one of the checks fail.




    + +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:09 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lib/_lib---status.inc.html b/lam-web/developers/phpdoc/lib/_lib---status.inc.html new file mode 100644 index 00000000..1a6d7ff6 --- /dev/null +++ b/lam-web/developers/phpdoc/lib/_lib---status.inc.html @@ -0,0 +1,149 @@ + + +Docs for page status.inc + + + + + + + + + + + + + +
    lib
    + + + [ class tree: lib ] + [ index: lib ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: status.inc

    +Source Location: /lib/status.inc

    + +
    +
    + + +

    Page Details:

    +LDAP Account Manager status messages.



    +

    Tags:

    +
    + + + + +
    author:  Michael Duergner
    +
    +

    +

    +

    +
    +
    + +

    StatusMessage [line 50]

    +
    +
    +
    + void StatusMessage( +string $MessageTyp, string $MessageHeadline, [string $MessageText = ''], [array $MessageVariables = array()]) +
    +

    + + 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.
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:11 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lib/cache.html b/lam-web/developers/phpdoc/lib/cache.html index c6a60664..da2ba0e5 100644 --- a/lam-web/developers/phpdoc/lib/cache.html +++ b/lam-web/developers/phpdoc/lib/cache.html @@ -12,9 +12,11 @@
    - [ class tree: lib ] + + + [ class tree: lib ] [ index: lib ] - [ all elements ] + [ all elements ]
    @@ -76,7 +80,6 @@ Source Location: /lib/cache.inc

    - -
    @@ -92,14 +95,6 @@ Source Location: /lib/cache.inc

    -

    Variables

    - -
    @@ -128,67 +123,16 @@ Source Location: /lib/cache.inc

    -

    Class Details

    -[line 40]
    +[line 42]
    This class contains all functions which are needed to manage the LDAP cache.



    [ Top ]

    -
    - -

    Class Variables

    -
    - -

    -

    $attributes =

    -

    [line 45]

    - This variable contains a list and their scope of attributes which should be cached

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $ldapcache =

    -

    [line 43]

    - This variable contains the cache

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $time =

    -

    [line 47]

    - This is the last timestamp on which the LDAP cache has been refreshed

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    -


    @@ -197,7 +141,7 @@ This class contains all functions which are needed to manage the LDAP cache.
    -

    constructor cache [line 54]

    +

    constructor cache [line 56]

    @@ -218,13 +162,11 @@ This class contains all functions which are needed to manage the LDAP cache.

    - -
    [ Top ]

    -

    method add_cache [line 64]

    +

    method add_cache [line 66]

    @@ -237,8 +179,6 @@ $attributes) This function adds attributes to the cache.



    - -

    Parameters:

    @@ -253,7 +193,7 @@ $attributes)
    -

    method findgroups [line 236]

    +

    method findgroups [line 241]

    @@ -274,13 +214,11 @@ $attributes)

    - -
    [ Top ]

    -

    method getgid [line 218]

    +

    method getgid [line 223]

    @@ -302,8 +240,6 @@ $groupname)

    - -

    Parameters:

    @@ -318,7 +254,7 @@ $groupname)
    -

    method getgrnam [line 254]

    +

    method getgrnam [line 259]

    @@ -340,8 +276,6 @@ $gidNumber)

    - -

    Parameters:

    @@ -356,7 +290,7 @@ $gidNumber)
    -

    method get_cache [line 93]

    +

    method get_cache [line 95]

    @@ -380,8 +314,6 @@ $scopelist)

    - -

    Parameters:

    @@ -406,7 +338,7 @@ $scopelist)
    -

    method in_cache [line 138]

    +

    method in_cache [line 140]

    @@ -421,8 +353,6 @@ $scopelist) This function returns the DN if an LDAP entry with $attribute=$value is found.



    - -

    Parameters:

    @@ -447,7 +377,7 @@ $scopelist)
    -

    method refresh_cache [line 173]

    +

    method refresh_cache [line 175]

    @@ -460,8 +390,6 @@ $rebuild = false]) This function refreshes the cache.



    - -

    Parameters:

    @@ -476,7 +404,7 @@ $rebuild = false])
    -

    method __sleep [line 272]

    +

    method __sleep [line 277]

    @@ -24,8 +26,8 @@
    @@ -497,13 +425,11 @@ $rebuild = false])

    - -
    [ Top ]

    -

    method __wakeup [line 281]

    +

    method __wakeup [line 286]

    diff --git a/lam-web/developers/phpdoc/lists/_lib---lists.inc.html b/lam-web/developers/phpdoc/lists/_lib---lists.inc.html new file mode 100644 index 00000000..6cd35d43 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/_lib---lists.inc.html @@ -0,0 +1,176 @@ + + +Docs for page lists.inc + + + + +
    @@ -515,8 +441,6 @@ $rebuild = false]) Decrypts LDAP cache after loading from session file.



    - -
    [ Top ]

    @@ -524,7 +448,7 @@ $rebuild = false])

    - Documentation generated on Wed, 15 Nov 2006 18:00:38 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:40 +0100 by phpDocumentor 1.4.0
    + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: lists.inc

    +Source Location: /lib/lists.inc

    + +
    +
    + +
    +

    Classes:

    +
    lamList
    +
    Generates the list view.
    +


    + +

    Page Details:

    +This file includes functions to manage the list views.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("types.inc") [line 33]
    +Used to get type information.

    include_once("pdfstruct.inc") [line 35]
    +Used to get PDF information.

    include_once("pdf.inc") [line 37]
    +Used to create PDF files.

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:55 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/_templates---lists---deletelink.php.html b/lam-web/developers/phpdoc/lists/_templates---lists---deletelink.php.html new file mode 100644 index 00000000..9315de24 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/_templates---lists---deletelink.php.html @@ -0,0 +1,171 @@ + + +Docs for page deletelink.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: deletelink.php

    +Source Location: /templates/lists/deletelink.php

    + +
    +
    + + +

    Page Details:

    +This page will redirect to delete.php if the given user is valid.

    It is called from the list views via the delete links.




    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../../lib/security.inc") [line 34]
    +security functions

    include_once("../../lib/ldap.inc") [line 36]
    +Needed to find DNs of users

    include_once("../../lib/status.inc") [line 38]
    +Used to display error messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:44 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/_templates---lists---list.php.html b/lam-web/developers/phpdoc/lists/_templates---lists---list.php.html new file mode 100644 index 00000000..f115def0 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/_templates---lists---list.php.html @@ -0,0 +1,171 @@ + + +Docs for page list.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: list.php

    +Source Location: /templates/lists/list.php

    + +
    +
    + + +

    Page Details:

    +This file shows the list views.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../../lib/security.inc") [line 33]
    +security functions

    include_once("../../lib/types.inc") [line 35]
    +Used to get type information.

    include_once("../../lib/config.inc") [line 37]
    +Access to configuration options

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:55 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/_templates---lists---userlink.php.html b/lam-web/developers/phpdoc/lists/_templates---lists---userlink.php.html new file mode 100644 index 00000000..0a90abac --- /dev/null +++ b/lam-web/developers/phpdoc/lists/_templates---lists---userlink.php.html @@ -0,0 +1,203 @@ + + +Docs for page userlink.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: userlink.php

    +Source Location: /templates/lists/userlink.php

    + +
    +
    + + +

    Page Details:

    +This page will redirect to account/edit.php if the given user is valid.

    It is called from listgroups.php via the memberUID links.




    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../../lib/security.inc") [line 34]
    +security functions

    include_once("../../lib/ldap.inc") [line 36]
    +Needed to find DNs of users

    include_once("../../lib/status.inc") [line 38]
    +Used to display error messages

    +

    +

    +
    +
    + +

    search_username [line 77]

    +
    +
    +
    + string search_username( +string $name) +
    +

    + + Searches LDAP for a specific user name (uid attribute) and returns its DN entry



    +

    Tags:

    +
    + + + + +
    return:  DN
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $name  user name
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:16 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/lamGroupList.html b/lam-web/developers/phpdoc/lists/lamGroupList.html index b2977cae..681a708b 100644 --- a/lam-web/developers/phpdoc/lists/lamGroupList.html +++ b/lam-web/developers/phpdoc/lists/lamGroupList.html @@ -12,9 +12,11 @@
    - [ class tree: lists ] + + + [ class tree: lists ] [ index: lists ] - [ all elements ] + [ all elements ]
    @@ -128,7 +134,6 @@ Source Location: /lib/types/group.inc

    - @@ -168,7 +179,6 @@ Source Location: /lib/types/group.inc

    -
    @@ -156,7 +161,13 @@ Source Location: /lib/types/group.inc

    Methods

    Inherited Variables

    @@ -176,85 +186,73 @@ Source Location: /lib/types/group.inc

    lamList::$attrArray - -
    +
    lamList::$descArray - -
    +
    lamList::$entries - -
    +
    lamList::$filterText - -
    +
    lamList::$labels - -
    +
    lamList::$maxPageEntries - -
    +
    lamList::$page - -
    +
    lamList::$possibleSuffixes - -
    +
    lamList::$refresh - -
    +
    lamList::$sortColumn - -
    +
    lamList::$suffix - -
    +
    lamList::$type - -
    +
    @@ -269,119 +267,126 @@ Source Location: /lib/types/group.inc

    lamList::lamList() -
    Constructor
    lamList::cmp_array() -
    Compare function used for usort-method
    lamList::listBuildFilter() -
    Builds the regular expressions from the filter values.
    lamList::listDoPost() -
    Manages all POST actions (e.g. button pressed) for the account lists.
    lamList::listDrawNavigationBar() -
    Draws a navigation bar to switch between pages
    lamList::listFilterAccounts() -
    Removes all entries which do not fit to the filter.
    lamList::listGetAttributeDescriptionList() -
    Returns an hash array containing with all attributes to be shown and their descriptions.
    lamList::listGetParams() -
    Sets some internal parameters. +
    +
    + lamList::listPrintAdditionalOptions() +
    +
    + Prints additional option fields for specific object types.
    lamList::listPrintButtons() -
    Prints the create, delete and PDF buttons.
    lamList::listPrintHeader() -
    Prints the HTML head.
    lamList::listPrintJavaScript() -
    Prints JavaScript code needed for mouse-over effects. +
    +
    + lamList::listPrintPDFButtons() +
    +
    + Prints the PDF button bar.
    lamList::listPrintTableBody() -
    Prints the entry list +
    +
    + lamList::listPrintTableCellContent() +
    +
    + Prints the content of a cell in the account list for a given LDAP entry and attribute.
    lamList::listPrintTableHeader() -
    Prints the attribute and filter row at the account table head +
    +
    + lamList::listPrintToolLinks() +
    +
    + Prints the tool image links (e.g. edit and delete) for each account.
    lamList::listRefreshData() -
    Rereads the entries from LDAP.
    lamList::listShowOUSelection() -
    Prints a combobox with possible sub-DNs.
    lamList::listSort() -
    Sorts an account list by a given attribute
    lamList::showPage() -
    Prints the HTML code to display the list view. @@ -396,7 +401,7 @@ Source Location: /lib/types/group.inc

    Class Details

    -[line 99]
    +[line 100]
    Generates the list view.



    Tags:

    @@ -417,7 +422,7 @@ Generates the list view.




    -

    constructor lamGroupList [line 107]

    +

    constructor lamGroupList [line 118]

    diff --git a/lam-web/developers/phpdoc/lists/lamHostList.html b/lam-web/developers/phpdoc/lists/lamHostList.html index 5c795bcf..bfa556f4 100644 --- a/lam-web/developers/phpdoc/lists/lamHostList.html +++ b/lam-web/developers/phpdoc/lists/lamHostList.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -439,8 +444,6 @@ $type)

    - -

    Parameters:

    @@ -454,40 +457,152 @@ $type)
    [ Top ]

    - -

    method listPrintTableBody [line 123]

    + +

    method groupRefreshPrimary [line 255]

    - void listPrintTableBody( -array -$info) + void groupRefreshPrimary( +)

    - Prints the entry list



    + Refreshes the primary group members list.



    -Overrides lamList::listPrintTableBody() (Prints the entry list)

    +
    [ Top ]
    +
    +
    + +

    method groupSetUsePrimary [line 290]

    +
    +
    +
    + void groupSetUsePrimary( +) +
    +

    + + Checks if primary group members should be included.



    + +
    [ Top ]
    +
    +
    + +

    method listDoPost [line 132]

    +
    +
    +
    + void listDoPost( +) +
    +

    + + Manages all POST actions (e.g. button pressed) for the account lists.



    + + Overrides lamList::listDoPost() (Manages all POST actions (e.g. button pressed) for the account lists.)

    +
    [ Top ]
    +
    +
    + +

    method listGetParams [line 147]

    +
    +
    +
    + void listGetParams( +) +
    +

    + + Sets some internal parameters.



    + + Overrides lamList::listGetParams() (Sets some internal parameters.)

    +
    [ Top ]
    +
    +
    + +

    method listPrintAdditionalOptions [line 158]

    +
    +
    +
    + void listPrintAdditionalOptions( +) +
    +

    + + Prints additional option field for primary member display.



    + + Overrides lamList::listPrintAdditionalOptions() (Prints additional option fields for specific object types.)

    +
    [ Top ]
    +
    +
    + +

    method listPrintTableCellContent [line 178]

    +
    +
    +
    + void listPrintTableCellContent( + +&$entry, +&$attribute, array +$entry, string +$attribute) +
    +

    + + Prints the content of a cell in the account list for a given LDAP entry and attribute.



    + + Overrides lamList::listPrintTableCellContent() (Prints the content of a cell in the account list for a given LDAP entry and attribute.)

    Parameters:

    - - + + + + + + + + + + + + + + + + +
    array  $info  entries$entry  LDAP attributes
    string  $attribute  attribute name
      &$entry  
      &$attribute  

    [ Top ]
    +
    + +

    method listRefreshData [line 245]

    +
    +
    +
    + void listRefreshData( +) +
    +

    + + Rereads the entries from LDAP.



    + + Overrides lamList::listRefreshData() (Rereads the entries from LDAP.)

    +
    [ Top ]
    +


    - Documentation generated on Wed, 15 Nov 2006 18:00:46 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:49 +0100 by phpDocumentor 1.4.0
    - [ class tree: lists ] + + + [ class tree: lists ] [ index: lists ] - [ all elements ] + [ all elements ]
    @@ -128,7 +134,6 @@ Source Location: /lib/types/host.inc

    - diff --git a/lam-web/developers/phpdoc/lists/lamList.html b/lam-web/developers/phpdoc/lists/lamList.html index 097120f6..d2055f52 100644 --- a/lam-web/developers/phpdoc/lists/lamList.html +++ b/lam-web/developers/phpdoc/lists/lamList.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -167,7 +172,6 @@ Source Location: /lib/types/host.inc

    -

    Inherited Variables

    @@ -175,85 +179,73 @@ Source Location: /lib/types/host.inc

    lamList::$attrArray - -
    +
    lamList::$descArray - -
    +
    lamList::$entries - -
    +
    lamList::$filterText - -
    +
    lamList::$labels - -
    +
    lamList::$maxPageEntries - -
    +
    lamList::$page - -
    +
    lamList::$possibleSuffixes - -
    +
    lamList::$refresh - -
    +
    lamList::$sortColumn - -
    +
    lamList::$suffix - -
    +
    lamList::$type - -
    +
    @@ -268,119 +260,126 @@ Source Location: /lib/types/host.inc

    lamList::lamList() -
    Constructor
    lamList::cmp_array() -
    Compare function used for usort-method
    lamList::listBuildFilter() -
    Builds the regular expressions from the filter values.
    lamList::listDoPost() -
    Manages all POST actions (e.g. button pressed) for the account lists.
    lamList::listDrawNavigationBar() -
    Draws a navigation bar to switch between pages
    lamList::listFilterAccounts() -
    Removes all entries which do not fit to the filter.
    lamList::listGetAttributeDescriptionList() -
    Returns an hash array containing with all attributes to be shown and their descriptions.
    lamList::listGetParams() -
    Sets some internal parameters. +
    +
    + lamList::listPrintAdditionalOptions() +
    +
    + Prints additional option fields for specific object types.
    lamList::listPrintButtons() -
    Prints the create, delete and PDF buttons.
    lamList::listPrintHeader() -
    Prints the HTML head.
    lamList::listPrintJavaScript() -
    Prints JavaScript code needed for mouse-over effects. +
    +
    + lamList::listPrintPDFButtons() +
    +
    + Prints the PDF button bar.
    lamList::listPrintTableBody() -
    Prints the entry list +
    +
    + lamList::listPrintTableCellContent() +
    +
    + Prints the content of a cell in the account list for a given LDAP entry and attribute.
    lamList::listPrintTableHeader() -
    Prints the attribute and filter row at the account table head +
    +
    + lamList::listPrintToolLinks() +
    +
    + Prints the tool image links (e.g. edit and delete) for each account.
    lamList::listRefreshData() -
    Rereads the entries from LDAP.
    lamList::listShowOUSelection() -
    Prints a combobox with possible sub-DNs.
    lamList::listSort() -
    Sorts an account list by a given attribute
    lamList::showPage() -
    Prints the HTML code to display the list view. @@ -438,8 +437,6 @@ $type)

    - -

    Parameters:

    @@ -457,7 +454,7 @@ $type)

    - Documentation generated on Wed, 15 Nov 2006 18:00:47 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:50 +0100 by phpDocumentor 1.4.0
    - [ class tree: lists ] + + + [ class tree: lists ] [ index: lists ] - [ all elements ] + [ all elements ]
    @@ -128,7 +134,6 @@ Source Location: /lib/lists.inc

    -
    @@ -178,11 +183,15 @@ Source Location: /lib/lists.inc

  • listFilterAccounts
  • listGetAttributeDescriptionList
  • listGetParams
  • +
  • listPrintAdditionalOptions
  • listPrintButtons
  • listPrintHeader
  • listPrintJavaScript
  • +
  • listPrintPDFButtons
  • listPrintTableBody
  • +
  • listPrintTableCellContent
  • listPrintTableHeader
  • +
  • listPrintToolLinks
  • listRefreshData
  • listShowOUSelection
  • listSort
  • @@ -196,12 +205,11 @@ Source Location: /lib/lists.inc

    -

    Child classes:

    -
    lamMailAliasList
    +
    lamGroupList
    Generates the list view.
    @@ -209,11 +217,11 @@ Source Location: /lib/lists.inc

    Generates the list view.
    -
    lamSmbDomainList
    +
    lamMailAliasList
    Generates the list view.
    -
    lamGroupList
    +
    lamSmbDomainList
    Generates the list view.
    @@ -460,8 +468,6 @@ $type)

    - -

    Parameters:

    @@ -476,12 +482,14 @@ $type)
    -

    method cmp_array [line 254]

    +

    method cmp_array [line 265]

    integer cmp_array( -array + +&$a, +&$b, array $a, array $b)
    @@ -499,8 +507,6 @@ $b)

    - -

    Parameters:

    @@ -513,6 +519,16 @@ $b) + + + + + + + + + +
    array   $b   second row which is compared
      &$a  
      &$b  

    @@ -520,7 +536,7 @@ $b)
    -

    method listBuildFilter [line 158]

    +

    method listBuildFilter [line 167]

    @@ -541,13 +557,11 @@ $b)

    - -
    [ Top ]

    -

    method listDoPost [line 415]

    +

    method listDoPost [line 449]

    @@ -560,18 +574,20 @@ $b)

    Overridden in child classes as:

    +
    lamGroupList::listDoPost()
    +
    Manages all POST actions (e.g. button pressed) for the account lists.
    +
    +
    lamUserList::listDoPost()
    Manages all POST actions (e.g. button pressed) for the account lists.

    - -
    [ Top ]

    -

    method listDrawNavigationBar [line 274]

    +

    method listDrawNavigationBar [line 284]

    @@ -584,8 +600,6 @@ $count) Draws a navigation bar to switch between pages



    - -

    Parameters:

    @@ -600,7 +614,7 @@ $count)
    -

    method listFilterAccounts [line 201]

    +

    method listFilterAccounts [line 211]

    @@ -621,13 +635,11 @@ $count)

    - -
    [ Top ]

    -

    method listGetAttributeDescriptionList [line 576]

    +

    method listGetAttributeDescriptionList [line 633]

    @@ -648,13 +660,11 @@ $count)

    - -
    [ Top ]

    -

    method listGetParams [line 610]

    +

    method listGetParams [line 667]

    @@ -665,14 +675,48 @@ $count) Sets some internal parameters.



    +

    Overridden in child classes as:
    +

    +
    lamGroupList::listGetParams()
    +
    Sets some internal parameters.
    +
    +
    +
    lamUserList::listGetParams()
    +
    Sets some internal parameters.
    +
    +

    +
    [ Top ]
    + +
    + +

    method listPrintAdditionalOptions [line 729]

    +
    +
    +
    + void listPrintAdditionalOptions( +) +
    +

    + + Prints additional option fields for specific object types.



    - +

    Overridden in child classes as:
    +

    +
    lamGroupList::listPrintAdditionalOptions()
    +
    Prints additional option field for primary member display.
    +
    +
    +
    lamUserList::listPrintAdditionalOptions()
    +
    Prints additional option fields for specific object types.
    +
    +

    +
    [ Top ]

    -

    method listPrintButtons [line 504]

    +

    method listPrintButtons [line 539]

    @@ -684,15 +728,7 @@ $createOnly) Prints the create, delete and PDF buttons.



    -

    Overridden in child classes as:
    -

    -
    lamUserList::listPrintButtons()
    -
    Prints the create, delete and PDF buttons.
    -
    -

    - -

    Parameters:

    @@ -707,7 +743,7 @@ $createOnly)
    -

    method listPrintHeader [line 527]

    +

    method listPrintHeader [line 576]

    @@ -719,13 +755,11 @@ $createOnly) Prints the HTML head.



    - -
    [ Top ]

    -

    method listPrintJavaScript [line 539]

    +

    method listPrintJavaScript [line 588]

    @@ -737,37 +771,40 @@ $createOnly) Prints JavaScript code needed for mouse-over effects.



    +
    [ Top ]
    + +
    + +

    method listPrintPDFButtons [line 559]

    +
    +
    +
    + void listPrintPDFButtons( +) +
    +

    + + Prints the PDF button bar.



    - +
    [ Top ]

    -

    method listPrintTableBody [line 361]

    +

    method listPrintTableBody [line 367]

    void listPrintTableBody( -array + +&$info, array $info)

    Prints the entry list



    -

    Overridden in child classes as:
    -

    -
    lamGroupList::listPrintTableBody()
    -
    Prints the entry list
    -
    -
    -
    lamUserList::listPrintTableBody()
    -
    Prints the entry list
    -
    -

    - -

    Parameters:

    @@ -775,6 +812,66 @@ $info) + + + + + + +
    array   $info   entries
      &$info  
    +

    +
    [ Top ]
    +
    +
    + +

    method listPrintTableCellContent [line 430]

    +
    +
    +
    + void listPrintTableCellContent( + +&$entry, +&$attribute, array +$entry, string +$attribute) +
    +

    + + Prints the content of a cell in the account list for a given LDAP entry and attribute.



    + +

    Overridden in child classes as:
    +

    +
    lamGroupList::listPrintTableCellContent()
    +
    Prints the content of a cell in the account list for a given LDAP entry and attribute.
    +
    +
    +
    lamUserList::listPrintTableCellContent()
    +
    Prints the content of a cell in the account list for a given LDAP entry and attribute.
    +
    +

    + +

    Parameters:

    +
    + + + + + + + + + + + + + + + + + + + +
    array  $entry  LDAP attributes
    string  $attribute  attribute name
      &$entry  
      &$attribute  

    @@ -782,7 +879,7 @@ $info)

    -

    method listPrintTableHeader [line 314]

    +

    method listPrintTableHeader [line 320]

    @@ -794,13 +891,38 @@ $info) Prints the attribute and filter row at the account table head



    +
    [ Top ]
    + +
    + +

    method listPrintToolLinks [line 413]

    +
    +
    +
    + void listPrintToolLinks( +$account) +
    +

    + + Prints the tool image links (e.g. edit and delete) for each account.

    $account array LDAP attributes




    + +

    Parameters:

    +
    + + + + + + +
      $account  
    +

    [ Top ]

    -

    method listRefreshData [line 638]

    +

    method listRefreshData [line 696]

    @@ -811,14 +933,22 @@ $info) Rereads the entries from LDAP.



    +

    Overridden in child classes as:
    +

    +
    lamGroupList::listRefreshData()
    +
    Rereads the entries from LDAP.
    +
    +
    +
    lamUserList::listRefreshData()
    +
    Rereads the entries from LDAP.
    +
    +

    - -
    [ Top ]

    -

    method listShowOUSelection [line 482]

    +

    method listShowOUSelection [line 519]

    diff --git a/lam-web/developers/phpdoc/lists/lamMailAliasList.html b/lam-web/developers/phpdoc/lists/lamMailAliasList.html index 81fc65e7..44eeb7c7 100644 --- a/lam-web/developers/phpdoc/lists/lamMailAliasList.html +++ b/lam-web/developers/phpdoc/lists/lamMailAliasList.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -830,18 +960,17 @@ $info) Prints a combobox with possible sub-DNs.



    - -
    [ Top ]

    -

    method listSort [line 235]

    +

    method listSort [line 246]

    array listSort( -array + +&$info, array $info)

    @@ -858,8 +987,6 @@ $info)

    - -

    Parameters:

    @@ -867,6 +994,11 @@ $info) + + + + +
    array   $info   the account list
      &$info  

    @@ -886,8 +1018,6 @@ $info) Prints the HTML code to display the list view.



    - -
    [ Top ]

    @@ -895,7 +1025,7 @@ $info)

    - Documentation generated on Wed, 15 Nov 2006 18:00:51 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:55 +0100 by phpDocumentor 1.4.0
    - [ class tree: lists ] + + + [ class tree: lists ] [ index: lists ] - [ all elements ] + [ all elements ]
    @@ -128,7 +134,6 @@ Source Location: /lib/types/mailAlias.inc

    - diff --git a/lam-web/developers/phpdoc/lists/lamSmbDomainList.html b/lam-web/developers/phpdoc/lists/lamSmbDomainList.html index 7340eed6..10dc36bd 100644 --- a/lam-web/developers/phpdoc/lists/lamSmbDomainList.html +++ b/lam-web/developers/phpdoc/lists/lamSmbDomainList.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -167,7 +172,6 @@ Source Location: /lib/types/mailAlias.inc

    -

    Inherited Variables

    @@ -175,85 +179,73 @@ Source Location: /lib/types/mailAlias.inc

    lamList::$attrArray - -
    +
    lamList::$descArray - -
    +
    lamList::$entries - -
    +
    lamList::$filterText - -
    +
    lamList::$labels - -
    +
    lamList::$maxPageEntries - -
    +
    lamList::$page - -
    +
    lamList::$possibleSuffixes - -
    +
    lamList::$refresh - -
    +
    lamList::$sortColumn - -
    +
    lamList::$suffix - -
    +
    lamList::$type - -
    +
    @@ -268,119 +260,126 @@ Source Location: /lib/types/mailAlias.inc

    lamList::lamList() -
    Constructor
    lamList::cmp_array() -
    Compare function used for usort-method
    lamList::listBuildFilter() -
    Builds the regular expressions from the filter values.
    lamList::listDoPost() -
    Manages all POST actions (e.g. button pressed) for the account lists.
    lamList::listDrawNavigationBar() -
    Draws a navigation bar to switch between pages
    lamList::listFilterAccounts() -
    Removes all entries which do not fit to the filter.
    lamList::listGetAttributeDescriptionList() -
    Returns an hash array containing with all attributes to be shown and their descriptions.
    lamList::listGetParams() -
    Sets some internal parameters. +
    +
    + lamList::listPrintAdditionalOptions() +
    +
    + Prints additional option fields for specific object types.
    lamList::listPrintButtons() -
    Prints the create, delete and PDF buttons.
    lamList::listPrintHeader() -
    Prints the HTML head.
    lamList::listPrintJavaScript() -
    Prints JavaScript code needed for mouse-over effects. +
    +
    + lamList::listPrintPDFButtons() +
    +
    + Prints the PDF button bar.
    lamList::listPrintTableBody() -
    Prints the entry list +
    +
    + lamList::listPrintTableCellContent() +
    +
    + Prints the content of a cell in the account list for a given LDAP entry and attribute.
    lamList::listPrintTableHeader() -
    Prints the attribute and filter row at the account table head +
    +
    + lamList::listPrintToolLinks() +
    +
    + Prints the tool image links (e.g. edit and delete) for each account.
    lamList::listRefreshData() -
    Rereads the entries from LDAP.
    lamList::listShowOUSelection() -
    Prints a combobox with possible sub-DNs.
    lamList::listSort() -
    Sorts an account list by a given attribute
    lamList::showPage() -
    Prints the HTML code to display the list view. @@ -438,8 +437,6 @@ $type)

    - -

    Parameters:

    @@ -457,7 +454,7 @@ $type)

    - Documentation generated on Wed, 15 Nov 2006 18:00:52 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:56 +0100 by phpDocumentor 1.4.0
    - [ class tree: lists ] + + + [ class tree: lists ] [ index: lists ] - [ all elements ] + [ all elements ]
    @@ -128,7 +134,6 @@ Source Location: /lib/types/smbDomain.inc

    - diff --git a/lam-web/developers/phpdoc/lists/lamUserList.html b/lam-web/developers/phpdoc/lists/lamUserList.html index 5b089018..d9d0c2dc 100644 --- a/lam-web/developers/phpdoc/lists/lamUserList.html +++ b/lam-web/developers/phpdoc/lists/lamUserList.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -167,7 +172,6 @@ Source Location: /lib/types/smbDomain.inc

    -

    Inherited Variables

    @@ -175,85 +179,73 @@ Source Location: /lib/types/smbDomain.inc

    lamList::$attrArray - -
    +
    lamList::$descArray - -
    +
    lamList::$entries - -
    +
    lamList::$filterText - -
    +
    lamList::$labels - -
    +
    lamList::$maxPageEntries - -
    +
    lamList::$page - -
    +
    lamList::$possibleSuffixes - -
    +
    lamList::$refresh - -
    +
    lamList::$sortColumn - -
    +
    lamList::$suffix - -
    +
    lamList::$type - -
    +
    @@ -268,119 +260,126 @@ Source Location: /lib/types/smbDomain.inc

    lamList::lamList() -
    Constructor
    lamList::cmp_array() -
    Compare function used for usort-method
    lamList::listBuildFilter() -
    Builds the regular expressions from the filter values.
    lamList::listDoPost() -
    Manages all POST actions (e.g. button pressed) for the account lists.
    lamList::listDrawNavigationBar() -
    Draws a navigation bar to switch between pages
    lamList::listFilterAccounts() -
    Removes all entries which do not fit to the filter.
    lamList::listGetAttributeDescriptionList() -
    Returns an hash array containing with all attributes to be shown and their descriptions.
    lamList::listGetParams() -
    Sets some internal parameters. +
    +
    + lamList::listPrintAdditionalOptions() +
    +
    + Prints additional option fields for specific object types.
    lamList::listPrintButtons() -
    Prints the create, delete and PDF buttons.
    lamList::listPrintHeader() -
    Prints the HTML head.
    lamList::listPrintJavaScript() -
    Prints JavaScript code needed for mouse-over effects. +
    +
    + lamList::listPrintPDFButtons() +
    +
    + Prints the PDF button bar.
    lamList::listPrintTableBody() -
    Prints the entry list +
    +
    + lamList::listPrintTableCellContent() +
    +
    + Prints the content of a cell in the account list for a given LDAP entry and attribute.
    lamList::listPrintTableHeader() -
    Prints the attribute and filter row at the account table head +
    +
    + lamList::listPrintToolLinks() +
    +
    + Prints the tool image links (e.g. edit and delete) for each account.
    lamList::listRefreshData() -
    Rereads the entries from LDAP.
    lamList::listShowOUSelection() -
    Prints a combobox with possible sub-DNs.
    lamList::listSort() -
    Sorts an account list by a given attribute
    lamList::showPage() -
    Prints the HTML code to display the list view. @@ -438,8 +437,6 @@ $type)

    - -

    Parameters:

    @@ -457,7 +454,7 @@ $type)

    - Documentation generated on Wed, 15 Nov 2006 18:01:08 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:11:11 +0100 by phpDocumentor 1.4.0
    - [ class tree: lists ] + + + [ class tree: lists ] [ index: lists ] - [ all elements ] + [ all elements ]
    @@ -128,7 +134,6 @@ Source Location: /lib/types/user.inc

    - - @@ -177,7 +178,6 @@ Source Location: /lib/types/user.inc

    -
    @@ -150,13 +155,6 @@ Source Location: /lib/types/user.inc

    -

    Variables

    - -
    @@ -164,8 +162,11 @@ Source Location: /lib/types/user.inc

    Inherited Variables

    @@ -185,85 +185,73 @@ Source Location: /lib/types/user.inc

    lamList::$attrArray - -
    +
    lamList::$descArray - -
    +
    lamList::$entries - -
    +
    lamList::$filterText - -
    +
    lamList::$labels - -
    +
    lamList::$maxPageEntries - -
    +
    lamList::$page - -
    +
    lamList::$possibleSuffixes - -
    +
    lamList::$refresh - -
    +
    lamList::$sortColumn - -
    +
    lamList::$suffix - -
    +
    lamList::$type - -
    +
    @@ -278,119 +266,126 @@ Source Location: /lib/types/user.inc

    lamList::lamList() -
    Constructor
    lamList::cmp_array() -
    Compare function used for usort-method
    lamList::listBuildFilter() -
    Builds the regular expressions from the filter values.
    lamList::listDoPost() -
    Manages all POST actions (e.g. button pressed) for the account lists.
    lamList::listDrawNavigationBar() -
    Draws a navigation bar to switch between pages
    lamList::listFilterAccounts() -
    Removes all entries which do not fit to the filter.
    lamList::listGetAttributeDescriptionList() -
    Returns an hash array containing with all attributes to be shown and their descriptions.
    lamList::listGetParams() -
    Sets some internal parameters. +
    +
    + lamList::listPrintAdditionalOptions() +
    +
    + Prints additional option fields for specific object types.
    lamList::listPrintButtons() -
    Prints the create, delete and PDF buttons.
    lamList::listPrintHeader() -
    Prints the HTML head.
    lamList::listPrintJavaScript() -
    Prints JavaScript code needed for mouse-over effects. +
    +
    + lamList::listPrintPDFButtons() +
    +
    + Prints the PDF button bar.
    lamList::listPrintTableBody() -
    Prints the entry list +
    +
    + lamList::listPrintTableCellContent() +
    +
    + Prints the content of a cell in the account list for a given LDAP entry and attribute.
    lamList::listPrintTableHeader() -
    Prints the attribute and filter row at the account table head +
    +
    + lamList::listPrintToolLinks() +
    +
    + Prints the tool image links (e.g. edit and delete) for each account.
    lamList::listRefreshData() -
    Rereads the entries from LDAP.
    lamList::listShowOUSelection() -
    Prints a combobox with possible sub-DNs.
    lamList::listSort() -
    Sorts an account list by a given attribute
    lamList::showPage() -
    Prints the HTML code to display the list view. @@ -405,7 +400,7 @@ Source Location: /lib/types/user.inc

    Class Details

    -[line 105]
    +[line 106]
    Generates the list view.



    Tags:

    @@ -418,41 +413,6 @@ Generates the list view.





    [ Top ]

    -
    - -

    Class Variables

    -
    - -

    -

    $trans_primary =  false

    -

    [line 108]

    - Controls if GID number is translated to group name

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $trans_primary_hash = array()

    -

    [line 111]

    - translates GID to group name

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    -


    @@ -461,7 +421,7 @@ Generates the list view.




    -

    constructor lamUserList [line 119]

    +

    constructor lamUserList [line 120]

    @@ -24,8 +26,8 @@
    @@ -483,8 +443,6 @@ $type)

    - -

    Parameters:

    @@ -499,7 +457,7 @@ $type)
    -

    method listDoPost [line 133]

    +

    method listDoPost [line 134]

    diff --git a/lam-web/developers/phpdoc/lists/tree/_lib---tree.inc.html b/lam-web/developers/phpdoc/lists/tree/_lib---tree.inc.html new file mode 100644 index 00000000..4fbb8eb4 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_lib---tree.inc.html @@ -0,0 +1,1194 @@ + + +Docs for page tree.inc + + + + +
    @@ -510,67 +468,116 @@ $type) Manages all POST actions (e.g. button pressed) for the account lists.



    - -Overrides lamList::listDoPost() (Manages all POST actions (e.g. button pressed) for the account lists.)

    - + Overrides lamList::listDoPost() (Manages all POST actions (e.g. button pressed) for the account lists.)

    [ Top ]

    - -

    method listPrintButtons [line 230]

    + +

    method listGetParams [line 145]

    - void listPrintButtons( -boolean -$createOnly) + void listGetParams( +)

    - Prints the create, delete and PDF buttons.



    + Sets some internal parameters.



    - -Overrides lamList::listPrintButtons() (Prints the create, delete and PDF buttons.)

    - -

    Parameters:

    -
    - - - - - - -
    boolean  $createOnly  true if only the create button should be displayed
    -

    + Overrides lamList::listGetParams() (Sets some internal parameters.)

    [ Top ]

    - -

    method listPrintTableBody [line 161]

    + +

    method listPrintAdditionalOptions [line 230]

    - void listPrintTableBody( -array -$info) + void listPrintAdditionalOptions( +)

    - Prints the entry list



    + Prints additional option fields for specific object types.



    + Overrides lamList::listPrintAdditionalOptions() (Prints additional option fields for specific object types.)

    +
    [ Top ]
    +
    +
    + +

    method listPrintTableCellContent [line 187]

    +
    +
    +
    + void listPrintTableCellContent( + +&$entry, +&$attribute, array +$entry, string +$attribute) +
    +

    -Overrides lamList::listPrintTableBody() (Prints the entry list)

    + Prints the content of a cell in the account list for a given LDAP entry and attribute.



    + Overrides lamList::listPrintTableCellContent() (Prints the content of a cell in the account list for a given LDAP entry and attribute.)

    Parameters:

    - - + + + + + + + + + + + + + + + + +
    array  $info  entries$entry  LDAP attributes
    string  $attribute  attribute name
      &$entry  
      &$attribute  

    +
    [ Top ]
    +
    +
    + +

    method listRefreshData [line 156]

    +
    +
    +
    + void listRefreshData( +) +
    +

    + + Rereads the entries from LDAP.



    + + Overrides lamList::listRefreshData() (Rereads the entries from LDAP.)

    +
    [ Top ]
    +
    +
    + +

    method refreshPrimaryGroupTranslation [line 166]

    +
    +
    +
    + void refreshPrimaryGroupTranslation( +) +
    +

    + + Refreshes the GID to group name cache.



    + +
    [ Top ]

    @@ -578,7 +585,7 @@ Overrides lamList::list
    + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: tree.inc

    +Source Location: /lib/tree.inc

    + +
    +
    + + +

    Page Details:

    +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




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    +

    +
    +
    + +

    arrayLower [line 935]

    +
    +
    +
    + void arrayLower( + $array) +
    +

    + +

    + +

    Parameters

    + + + + + + +
      $array  
    +
    [ Top ]


    +
    +
    + +

    array_stripslashes [line 61]

    +
    +
    +
    + void array_stripslashes( + &$array, Array $array) +
    +

    + + Strips all slashes from the specified array in place (pass by ref).



    + +

    Parameters

    + + + + + + + + + + + +
    Array  $array  The array to strip slashes from, typically one of $_GET, $_POST, or $_COOKIE.
      &$array  
    +
    [ Top ]


    +
    +
    + +

    build_initial_tree_icons [line 204]

    +
    +
    +
    + void build_initial_tree_icons( +) +
    +

    + + 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:

    1.    Array
    2. +
    3.     (
    4. +
    5.       [0=> Array
    6. +
    7.           (
    8. +
    9.              [dc=example,dc=com=> "dcobject.png"
    10. +
    11.           )
    12. +
    13.       [1=> Array
    14. +
    15.             [o=Corporation=> "o.png"
    16. +
    17.           )
    18. +
    19.      )
    20. +
    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.




    + +
    [ Top ]


    +
    +
    + +

    dn_exists [line 223]

    +
    +
    +
    + bool dn_exists( +string $dn) +
    +

    + + Gets whether an entry exists based on its DN. If the entry exists, returns true. Otherwise returns false.



    + +

    Parameters

    + + + + + + +
    string  $dn  The DN of the entry of interest.
    +
    [ Top ]


    +
    +
    + +

    draw_formatted_dn [line 671]

    +
    +
    +
    + void draw_formatted_dn( + $dn) +
    +

    + + Gets a DN string using the user-configured tree_display_format string to format it.



    + +

    Parameters

    + + + + + + +
      $dn  
    +
    [ Top ]


    +
    +
    + +

    draw_jpeg_photos [line 1146]

    +
    +
    +
    + void draw_jpeg_photos( +string $dn, [string $attr_name = 'jpegPhoto'], [bool $draw_delete_buttons = false], [bool $draw_bytes_and_size = true], [string $table_html_attrs = 'align=&quot;left&quot;'], [ $img_html_attrs = '']) +
    +

    + + Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to specify how the images are to be displayed.

    Usage Examples:

    1.     draw_jpeg_photos0"cn=Bob,ou=People,dc=example,dc=com""jpegPhoto" truefalse"border: 1px; width: 150px" );
    2. +
    3.     draw_jpeg_photos1"cn=Fred,ou=People,dc=example,dc=com" );
    4. +




    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    string  $dn  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.
      $img_html_attrs  
    +
    [ Top ]


    +
    +
    + +

    draw_server_tree [line 73]

    +
    +
    +
    + void draw_server_tree( +) +
    +

    + + Prints the HTML of the tree view.



    + +
    [ Top ]


    +
    +
    + +

    get_container [line 1324]

    +
    +
    +
    + string get_container( +string $dn) +
    +

    + + Given a DN string, this returns the parent container portion of the string.

    For example. given 'cn=Manager,dc=example,dc=com', this function returns 'dc=example,dc=com'.




    +

    Tags:

    +
    + + + + + + + +
    return:  The container
    see:  get_rdn()
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $dn  The DN whose container string to return.
    +
    [ Top ]


    +
    +
    + +

    get_container_contents [line 269]

    +
    +
    +
    + array get_container_contents( +string $dn, [int $size_limit = 0], [string $filter = '(objectClass=*)']) +
    +

    + + 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:

    1.  dc=example,dc=com
    2. +
    3.    ou=People
    4. +
    5.       cn=Dave
    6. +
    7.       cn=Fred
    8. +
    9.       cn=Joe
    10. +
    11.       ou=More People
    12. +
    13.          cn=Mark
    14. +
    15.          cn=Bob
    16. +

    Calling

    1. get_container_contents"ou=people,dc=example,dc=com" )
    2. +
    would return the following list:

    1.   cn=Dave
    2. +
    3.   cn=Fred
    4. +
    5.   cn=Joe
    6. +
    7.   ou=More People
    8. +




    +

    Tags:

    +
    + + + + +
    return:  An array of DN strings listing the immediate children of the specified entry.
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    string  $dn  The DN of the entry whose children to return.
    int  $size_limit  (optional) The maximum number of entries to return. If unspecified, no limit is applied to the number of entries in the returned.
    string  $filter  (optional) An LDAP filter to apply when fetching children, example: "(objectClass=inetOrgPerson)"
    +
    [ Top ]


    +
    +
    + +

    get_enc_type [line 1116]

    +
    +
    +
    + void get_enc_type( + $user_password) +
    +

    + +

    + +

    Parameters

    + + + + + + +
      $user_password  
    +
    [ Top ]


    +
    +
    + +

    get_entry_system_attrs [line 907]

    +
    +
    +
    + array get_entry_system_attrs( +string $dn, [int $deref = LDAP_DEREF_NEVER]) +
    +

    + + 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:

    1.   Array
    2. +
    3.   (
    4. +
    5.     [creatorsName=> Array
    6. +
    7.         (
    8. +
    9.            [0=> "cn=Admin,dc=example,dc=com"
    10. +
    11.         )
    12. +
    13.     [createTimeStamp]=> Array
    14. +
    15.         (
    16. +
    17.            [0=> "10401040130"
    18. +
    19.         )
    20. +
    21.     [hasSubordinates=> Array
    22. +
    23.         (
    24. +
    25.            [0=> "FALSE"
    26. +
    27.         )
    28. +
    29.   )
    30. +




    +

    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.
    +
    [ Top ]


    +
    +
    + +

    get_icon [line 306]

    +
    +
    +
    + string get_icon( +string $dn) +
    +

    + + 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.




    + +

    Parameters

    + + + + + + +
    string  $dn  The DN of the entry whose icon you wish to fetch.
    +
    [ Top ]


    +
    +
    + +

    get_object_attr [line 450]

    +
    +
    +
    + void get_object_attr( +string $dn, string $attr, bool $lower_case_attr_names) +
    +

    + + Much like get_object_attrs(), but only returns the values for one attribute of an object. Example calls:

    1.  print_rget_object_attr0"cn=Bob,ou=people,dc=example,dc=com""sn" ) );
    2. +
    3.  // prints:
    4. +
    5.  //  Array
    6. +
    7.  //    (
    8. +
    9.  //       [0] => "Smith"
    10. +
    11.  //    )
    12. +
    13.  
    14. +
    15.  print_rget_object_attr0"cn=Bob,ou=people,dc=example,dc=com""objectClass" ) );
    16. +
    17.  // prints:
    18. +
    19.  //  Array
    20. +
    21.  //    (
    22. +
    23.  //       [0] => "top"
    24. +
    25.  //       [1] => "person"
    26. +
    27.  //    )
    28. +




    +

    Tags:

    +
    + + + + +
    see:  get_object_attrs()
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    string  $dn  The distinguished name (DN) of the entry whose attributes/values to fetch.
    string  $attr  The attribute whose value(s) to return (ie, "objectClass", "cn", "userPassword")
    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.
    +
    [ Top ]


    +
    +
    + +

    get_object_attrs [line 745]

    +
    +
    +
    + array get_object_attrs( +string $dn, [bool $lower_case_attr_names = false], [int $deref = LDAP_DEREF_NEVER]) +
    +

    + + 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.

    Sample return value of

    1. get_object_attrs0"cn=Bob,ou=pepole,dc=example,dc=com" )
    2. +

    1.  Array
    2. +
    3.   (
    4. +
    5.    [objectClass=> Array
    6. +
    7.        (
    8. +
    9.            [0=> person
    10. +
    11.            [1=> top
    12. +
    13.        )
    14. +
    15.    [cn=> Array
    16. +
    17.        (
    18. +
    19.            [0=> Bob
    20. +
    21.        )
    22. +
    23.    [sn=> Array
    24. +
    25.        (
    26. +
    27.            [0=> Jones
    28. +
    29.        )
    30. +
    31.    [dn=> Array
    32. +
    33.        (
    34. +
    35.             [0=> cn=Bob,ou=pepole,dc=example,dc=com
    36. +
    37.        )
    38. +
    39.   )
    40. +




    +

    Tags:

    +
    + + + + + + + +
    see:  get_object_attr()
    see:  get_entry_system_attrs()
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    string  $dn  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.
    +
    [ Top ]


    +
    +
    + +

    get_rdn [line 484]

    +
    +
    +
    + string get_rdn( +string $dn, [bool $include_attrs = 0]) +
    +

    + + Given a DN string, this returns the 'RDN' portion of the string.

    For example. given 'cn=Manager,dc=example,dc=com', this function returns 'cn=Manager' (it is really the exact opposite of get_container()).




    +

    Tags:

    +
    + + + + + + + +
    return:  The RDN
    see:  get_container()
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    string  $dn  The DN whose RDN to return.
    bool  $include_attrs  If true, include attributes in the RDN string. See http://php.net/ldap_explode_dn for details
    +
    [ Top ]


    +
    +
    + +

    initialize_session_tree [line 167]

    +
    +
    +
    + void initialize_session_tree( +) +
    +

    + + 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.




    + +
    [ Top ]


    +
    +
    + +

    is_attr_binary [line 797]

    +
    +
    +
    + bool is_attr_binary( +string $attr_name) +
    +

    + + 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.



    +

    Tags:

    +
    + + + + +
    see:  is_jpeg_photo()
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $attr_name  The name of the attribute to test.
    +
    [ Top ]


    +
    +
    + +

    is_attr_boolean [line 983]

    +
    +
    +
    + bool is_attr_boolean( +string $attr_name) +
    +

    + + 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.



    + +

    Parameters

    + + + + + + +
    string  $attr_name  The name of the attribute to test.
    +
    [ Top ]


    +
    +
    + +

    is_dn_attr [line 1090]

    +
    +
    +
    + bool is_dn_attr( +string $attr_name) +
    +

    + + Returns true if the attribute specified is required to take as input a DN.

    Some examples include 'distinguishedName', 'member' and 'uniqueMember'.




    + +

    Parameters

    + + + + + + +
    string  $attr_name  The name of the attribute of interest (case insensitive)
    +
    [ Top ]


    +
    +
    + +

    is_jpeg_photo [line 951]

    +
    +
    +
    + bool is_jpeg_photo( +string $attr_name) +
    +

    + + 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.



    +

    Tags:

    +
    + + + + +
    see:  draw_jpeg_photos()
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $attr_name  The name of the attribute to test.
    +
    [ Top ]


    +
    +
    + +

    is_mail_string [line 1003]

    +
    +
    +
    + bool is_mail_string( +string $str) +
    +

    + + Get whether a string looks like an email address (user@example.com).



    +

    Tags:

    +
    + + + + +
    return:  Returns true if the specified string looks like an email address or false otherwise.
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $str  The string to analyze.
    +
    [ Top ]


    +
    +
    + +

    is_multi_line_attr [line 1051]

    +
    +
    +
    + bool is_multi_line_attr( +string $attr_name, [string $val = null]) +
    +

    + + 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;

    Usage example:

    1.   ifis_muli_line_attr"postalAddress" ) )
    2. +
    3.       echo "<textarea name=\"postalAddress\"></textarea>";
    4. +
    5.   else
    6. +
    7.       echo "<input name=\"postalAddress\" type=\"text\">";
    8. +




    + +

    Parameters

    + + + + + + + + + + + +
    string  $attr_name  The name of the attribute of interestd (case insensivite)
    string  $val  (optional) The current value of the attribute (speeds up the process by searching for carriage returns already in the attribute value)
    +
    [ Top ]


    +
    +
    + +

    is_url_string [line 1019]

    +
    +
    +
    + bool is_url_string( +string $str) +
    +

    + + Get whether a string looks like a web URL (http://www.example.com/)



    +

    Tags:

    +
    + + + + +
    return:  Returns true if the specified string looks like a web URL or false otherwise.
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $str  The string to analyze.
    +
    [ Top ]


    +
    +
    + +

    pla_compare_dns [line 586]

    +
    +
    +
    + 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:

    1.        ou=people,dc=example,dc=com
    2. +
    3.        cn=Admin,ou=People,dc=example,dc=com
    4. +
    5.        cn=Joe,ou=people,dc=example,dc=com
    6. +
    7.        dc=example,dc=com
    8. +
    9.        cn=Fred,ou=people,dc=example,dc=org
    10. +
    11.        cn=Dave,ou=people,dc=example,dc=org
    12. +
    Will be sorted thus using usort( $list, "pla_compare_dns" ):
    1.        dc=com
    2. +
    3.        dc=example,dc=com
    4. +
    5.        ou=people,dc=example,dc=com
    6. +
    7.        cn=Admin,ou=People,dc=example,dc=com
    8. +
    9.        cn=Joe,ou=people,dc=example,dc=com
    10. +
    11.        cn=Dave,ou=people,dc=example,dc=org
    12. +
    13.        cn=Fred,ou=people,dc=example,dc=org
    14. +




    + +

    Parameters

    + + + + + + + + + + + +
    string  $dn1  The first of two DNs to compare
    string  $dn2  The second of two DNs to compare
    +
    [ Top ]


    +
    +
    + +

    pla_explode_dn [line 516]

    +
    +
    +
    + array pla_explode_dn( +string $dn, [ $with_attributes = 0], int $with_attriutes) +
    +

    + + 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:
    1.    Array
    2. +
    3.     (
    4. +
    5.        [0=> uid=ppratt
    6. +
    7.        [1=> ou=People
    8. +
    9.        [2=> dc=example
    10. +
    11.        [3=> dc=com
    12. +
    13.     )
    14. +
    +
    +

    + +

    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)
      $with_attributes  
    +
    [ Top ]


    +
    +
    + +

    pla_ldap_search [line 1250]

    +
    +
    +
    + void pla_ldap_search( +string $filter, [string $base_dn = null], [array $attrs = array()], [string $scope = 'sub'], [bool $sort_results = true], [int $deref = LDAP_DEREF_ALWAYS]) +
    +

    + + 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.

    Example usage:

    1.  $samba_users ldap_search0"(&(objectClass=sambaAccount)(objectClass=posixAccount))",
    2. +
    3.                               "ou=People,dc=example,dc=com"array"uid""homeDirectory" ) );
    4. +
    5.  print_r$samba_users );
    6. +
    7.  // prints (for example):
    8. +
    9.  //  Array
    10. +
    11.  //    (
    12. +
    13.  //       [uid=jsmith,ou=People,dc=example,dc=com] => Array
    14. +
    15.  //           (
    16. +
    17.  //               [dn] => "uid=jsmith,ou=People,dc=example,dc=com"
    18. +
    19.  //               [uid] => "jsmith"
    20. +
    21.  //               [homeDirectory] => "\\server\jsmith"
    22. +
    23.  //           )
    24. +
    25.  //       [uid=byoung,ou=People,dc=example,dc=com] => Array
    26. +
    27.  //           (
    28. +
    29.  //               [dn] => "uid=byoung,ou=Samba,ou=People,dc=example,dc=com"
    30. +
    31.  //               [uid] => "byoung"
    32. +
    33.  //               [homeDirectory] => "\\server\byoung"
    34. +
    35.  //           )
    36. +
    37.  //    )
    38. +

    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.
    +
    [ Top ]


    +
    +
    + +

    pla_reverse_dn [line 652]

    +
    +
    +
    + string pla_reverse_dn( +string $dn) +
    +

    + + Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last

    For example:

    1.    cn=Brigham,ou=People,dc=example,dc=com
    2. +
    Becomes:
    1.    dc=com,dc=example,ou=People,cn=Brigham
    2. +
    This makes it possible to sort lists of DNs such that they are grouped by container.




    +

    Tags:

    +
    + + + + + + + +
    return:  The reversed DN
    see:  pla_compare_dns()
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $dn  The DN to reverse
    +
    [ Top ]


    +
    +
    + +

    pretty_print_dn [line 541]

    +
    +
    +
    + string pretty_print_dn( +string $dn) +
    +

    + + Returns an HTML-beautified version of a DN.

    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.




    + +

    Parameters

    + + + + + + +
    string  $dn  The DN to pretty-print.
    +
    [ Top ]


    +
    +
    + +

    real_attr_name [line 870]

    +
    +
    +
    + string real_attr_name( +string $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.



    + +

    Parameters

    + + + + + + +
    string  $attr_name  The name of the attribute to examine.
    +
    [ Top ]


    +
    +
    + +

    sortAttrs [line 1029]

    +
    +
    +
    + void sortAttrs( + $a, $b) +
    +

    + +

    + +

    Parameters

    + + + + + + + + + + + +
      $a  
      $b  
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:12 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_attr.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_attr.php.html new file mode 100644 index 00000000..00c6bc74 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_attr.php.html @@ -0,0 +1,200 @@ + + +Docs for page add_attr.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: add_attr.php

    +Source Location: /templates/tree/add_attr.php

    + +
    +
    + + +

    Page Details:

    +Adds an attribute/value pair to an object

    Variables that come in as POST vars:

    • dn
    • attr
    • val
    • binary




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/tree.inc') [line 49]
    +tree functions

    include_once('../../lib/config.inc') [line 51]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 53]
    +LDAP functions

    include_once('../../lib/account.inc') [line 57]
    +common functions

    include_once('../../lib/security.inc') [line 47]
    +security functions

    include_once('../../lib/status.inc') [line 55]
    +status messages

    +

    +

    +
    +
    + +

    is_binary_option_required [line 137]

    +
    +
    +
    + void is_binary_option_required( + $attr) +
    +

    + +

    + +

    Parameters

    + + + + + + +
      $attr  
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:38 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_attr_form.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_attr_form.php.html new file mode 100644 index 00000000..4917f94d --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_attr_form.php.html @@ -0,0 +1,199 @@ + + +Docs for page add_attr_form.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: add_attr_form.php

    +Source Location: /templates/tree/add_attr_form.php

    + +
    +
    + + +

    Page Details:

    +Displays a form for adding an attribute/value to an LDAP entry.

    Variables that come in as GET vars:

    • dn (rawurlencoded)




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/tree.inc') [line 46]
    +tree functions

    include_once('../../lib/security.inc') [line 44]
    +security functions

    include_once('../../lib/config.inc') [line 48]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 50]
    +LDAP functions

    include_once('../../lib/status.inc') [line 52]
    +status messages

    +

    +

    +
    +
    + +

    not_an_attr [line 188]

    +
    +
    +
    + void not_an_attr( + $x) +
    +

    + + Given an attribute $x, this returns true if it is NOT already specified in the current entry, returns false otherwise.



    + +

    Parameters

    + + + + + + +
      $x  
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:38 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_oclass.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_oclass.php.html new file mode 100644 index 00000000..9ad92260 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_oclass.php.html @@ -0,0 +1,176 @@ + + +Docs for page add_oclass.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: add_oclass.php

    +Source Location: /templates/tree/add_oclass.php

    + +
    +
    + + +

    Page Details:

    +Adds an objectClass to the specified dn.

    Variables that come in as POST vars:

    Note, this does not do any schema violation checking. That is performed in add_oclass_form.php.

    Vars that come in as POST:

    • dn (rawurlencoded)
    • new_oclass
    • new_attrs (array, if any)




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 49]
    +security functions

    include_once('../../lib/tree.inc') [line 51]
    +tree functions

    include_once('../../lib/config.inc') [line 53]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 55]
    +LDAP functions

    include_once('../../lib/status.inc') [line 57]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:38 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_oclass_form.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_oclass_form.php.html new file mode 100644 index 00000000..783467fa --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_oclass_form.php.html @@ -0,0 +1,176 @@ + + +Docs for page add_oclass_form.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: add_oclass_form.php

    +Source Location: /templates/tree/add_oclass_form.php

    + +
    +
    + + +

    Page Details:

    +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.

    Variables that come in as POST vars:

    • dn (rawurlencoded)
    • new_oclass




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 50]
    +security functions

    include_once('../../lib/tree.inc') [line 52]
    +tree functions

    include_once('../../lib/config.inc') [line 54]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 56]
    +LDAP functions

    include_once('../../lib/status.inc') [line 58]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:38 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_value.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_value.php.html new file mode 100644 index 00000000..85f05d5f --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_value.php.html @@ -0,0 +1,176 @@ + + +Docs for page add_value.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: add_value.php

    +Source Location: /templates/tree/add_value.php

    + +
    +
    + + +

    Page Details:

    +Adds a value to an attribute for a given dn.

    Variables that come in as POST vars:

    • dn (rawurlencoded)
    • attr (rawurlencoded) the attribute to which we are adding a value
    • new_value (form element)
    • binary
    On success, redirect to the edit_dn page. On failure, echo an error.




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 49]
    +security functions

    include_once('../../lib/tree.inc') [line 51]
    +tree functions

    include_once('../../lib/config.inc') [line 53]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 55]
    +LDAP functions

    include_once('../../lib/status.inc') [line 57]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:38 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_value_form.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_value_form.php.html new file mode 100644 index 00000000..62c769eb --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_value_form.php.html @@ -0,0 +1,176 @@ + + +Docs for page add_value_form.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: add_value_form.php

    +Source Location: /templates/tree/add_value_form.php

    + +
    +
    + + +

    Page Details:

    +add_value_form.php Displays a form to allow the user to enter a new value to add to the existing list of values for a multi-valued attribute.

    Variables that come in as GET vars:

    • dn (rawurlencoded)
    • attr (rawurlencoded) the attribute to which we are adding a value




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 46]
    +security functions

    include_once('../../lib/tree.inc') [line 48]
    +tree functions

    include_once('../../lib/config.inc') [line 50]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 52]
    +LDAP functions

    include_once('../../lib/status.inc') [line 54]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:38 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---collapse.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---collapse.php.html new file mode 100644 index 00000000..9fd43e85 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---collapse.php.html @@ -0,0 +1,175 @@ + + +Docs for page collapse.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: collapse.php

    +Source Location: /templates/tree/collapse.php

    + +
    +
    + + +

    Page Details:

    +This script alters the session variable 'tree', collapsing it at the dn specified in the query string.

    Variables that come in as GET vars:

    • dn (rawurlencoded)
    • server_id
    Note: this script is equal and opposite to expand.php




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 48]
    +security functions

    include_once('../../lib/tree.inc') [line 50]
    +tree functions

    include_once('../../lib/config.inc') [line 52]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 54]
    +LDAP functions

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:41 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---create.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---create.php.html new file mode 100644 index 00000000..07382d05 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---create.php.html @@ -0,0 +1,177 @@ + + +Docs for page create.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: create.php

    +Source Location: /templates/tree/create.php

    + +
    +
    + + +

    Page Details:

    +Creates a new object.

    Variables that come in as POST vars:

    • new_dn
    • attrs (an array of attributes)
    • vals (an array of values for the above attrs)
    • required_attrs (an array with indices being the attributes, + and the values being their respective values)
    • object_classes (rawurlencoded, and serialized array of objectClasses)




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 49]
    +security functions

    include_once('../../lib/tree.inc') [line 51]
    +tree functions

    include_once('../../lib/config.inc') [line 53]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 55]
    +LDAP functions

    include_once('../../lib/status.inc') [line 57]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:43 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---create_form.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---create_form.php.html new file mode 100644 index 00000000..60a1014d --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---create_form.php.html @@ -0,0 +1,177 @@ + + +Docs for page create_form.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: create_form.php

    +Source Location: /templates/tree/create_form.php

    + +
    +
    + + +

    Page Details:

    +The menu where the user chooses an RDN, Container, and Template for creating a new entry.

    After submitting this form, the user is taken to their chosen Template handler.

    Variables that come in as GET vars

    • container (rawurlencoded) (optional)




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/tree.inc') [line 47]
    +tree functions

    include_once('../../lib/security.inc') [line 45]
    +security functions

    include_once('../../lib/config.inc') [line 49]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 51]
    +LDAP functions

    include_once('templates/templates.inc') [line 55]
    +template configuration

    include_once('../../lib/status.inc') [line 53]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:44 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---creation_template.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---creation_template.php.html new file mode 100644 index 00000000..b25ede71 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---creation_template.php.html @@ -0,0 +1,178 @@ + + +Docs for page creation_template.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: creation_template.php

    +Source Location: /templates/tree/creation_template.php

    + +
    +
    + + +

    Page Details:

    +This file simply acts as a plugin grabber for the creator templates in the directory templates/creation/

    Expected POST vars: template




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include($handler) [line 93]
    +include_once('../../lib/config.inc') [line 48]
    +access to configuration

    include_once('../../lib/security.inc') [line 44]
    +security functions

    include_once('../../lib/tree.inc') [line 46]
    +tree functions

    include_once('../../lib/ldap.inc') [line 50]
    +LDAP functions

    include_once('templates/templates.inc') [line 54]
    +template configuration

    include_once('../../lib/status.inc') [line 52]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:44 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---delete.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---delete.php.html new file mode 100644 index 00000000..ca041e24 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---delete.php.html @@ -0,0 +1,176 @@ + + +Docs for page delete.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: delete.php

    +Source Location: /templates/tree/delete.php

    + +
    +
    + + +

    Page Details:

    +Deletes a DN and presents a "job's done" message.

    Variables that come in as POST vars:

    • dn (rawurlencoded)




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 44]
    +security functions

    include_once('../../lib/tree.inc') [line 46]
    +tree functions

    include_once('../../lib/config.inc') [line 48]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 50]
    +LDAP functions

    include_once('../../lib/status.inc') [line 52]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:44 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---delete_attr.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---delete_attr.php.html new file mode 100644 index 00000000..f2ff8d85 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---delete_attr.php.html @@ -0,0 +1,176 @@ + + +Docs for page delete_attr.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: delete_attr.php

    +Source Location: /templates/tree/delete_attr.php

    + +
    +
    + + +

    Page Details:

    +Deletes an attribute from an entry with NO confirmation.

    On success, redirect to edit.php On failure, echo an error.




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 44]
    +security functions

    include_once('../../lib/tree.inc') [line 46]
    +tree functions

    include_once('../../lib/config.inc') [line 48]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 50]
    +LDAP functions

    include_once('../../lib/status.inc') [line 52]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:44 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---delete_form.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---delete_form.php.html new file mode 100644 index 00000000..888b18ad --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---delete_form.php.html @@ -0,0 +1,176 @@ + + +Docs for page delete_form.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: delete_form.php

    +Source Location: /templates/tree/delete_form.php

    + +
    +
    + + +

    Page Details:

    +Displays a last chance confirmation form to delete a dn.

    Variables that come in as GET vars:

    • dn (rawurlencoded)




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 44]
    +security functions

    include_once('../../lib/tree.inc') [line 46]
    +tree functions

    include_once('../../lib/config.inc') [line 48]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 50]
    +LDAP functions

    include_once('../../lib/status.inc') [line 52]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:45 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---download_binary_attr.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---download_binary_attr.php.html new file mode 100644 index 00000000..3e43e747 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---download_binary_attr.php.html @@ -0,0 +1,176 @@ + + +Docs for page download_binary_attr.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: download_binary_attr.php

    +Source Location: /templates/tree/download_binary_attr.php

    + +
    +
    + + +

    Page Details:

    +Used to send binary values to user.



    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 41]
    +security functions

    include_once('../../lib/tree.inc') [line 43]
    +tree functions

    include_once('../../lib/config.inc') [line 45]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 47]
    +LDAP functions

    include_once('../../lib/status.inc') [line 49]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:45 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---edit.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---edit.php.html new file mode 100644 index 00000000..fc812b31 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---edit.php.html @@ -0,0 +1,177 @@ + + +Docs for page edit.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: edit.php

    +Source Location: /templates/tree/edit.php

    + +
    +
    + + +

    Page Details:

    +Displays the specified dn from the specified server for editing

    Variables that come in as GET vars:

    • dn (rawurlencoded)
    • modified_attrs (optional) an array of attributes to highlight as + they were changed by the last operation




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 46]
    +security functions

    include_once('../../lib/tree.inc') [line 48]
    +tree functions

    include_once('../../lib/config.inc') [line 50]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 52]
    +LDAP functions

    include_once('../../lib/status.inc') [line 54]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:45 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---expand.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---expand.php.html new file mode 100644 index 00000000..53ea00d7 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---expand.php.html @@ -0,0 +1,175 @@ + + +Docs for page expand.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: expand.php

    +Source Location: /templates/tree/expand.php

    + +
    +
    + + +

    Page Details:

    +This script alters the session variable 'tree', expanding it at the dn specified in the query string.

    Variables that come in as GET vars:

    • dn (rawurlencoded)
    Note: this script is equal and opposite to collapse.php




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 47]
    +security functions

    include_once('../../lib/tree.inc') [line 49]
    +tree functions

    include_once('../../lib/config.inc') [line 51]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 53]
    +LDAP functions

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:45 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---export.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---export.php.html new file mode 100644 index 00000000..bd8a9763 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---export.php.html @@ -0,0 +1,177 @@ + + +Docs for page export.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: export.php

    +Source Location: /templates/tree/export.php

    + +
    +
    + + +

    Page Details:

    +

    +

    Tags:

    +
    + + + + + + + +
    author:  The phpLDAPadmin development team
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/ldap.inc') [line 47]
    +LDAP functions

    include_once('../../lib/config.inc') [line 45]
    +access to configuration

    include_once('../../lib/status.inc') [line 49]
    +status messages

    include_once('../../lib/security.inc') [line 39]
    +security functions

    require('../../lib/export.inc') [line 41]
    +export functions

    require('../../lib/tree.inc') [line 43]
    +common functions

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:47 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---export_form.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---export_form.php.html new file mode 100644 index 00000000..df5e45fe --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---export_form.php.html @@ -0,0 +1,200 @@ + + +Docs for page export_form.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: export_form.php

    +Source Location: /templates/tree/export_form.php

    + +
    +
    + + +

    Page Details:

    +export_form.php --------------------

    Html form to choose an export format(ldif,...)




    +

    Tags:

    +
    + + + + + + + +
    author:  The phpLDAPadmin development team
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 44]
    +security functions

    include_once('../../lib/config.inc') [line 48]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 50]
    +LDAP functions

    include_once('../../lib/status.inc') [line 52]
    +status messages

    require('../../lib/export.inc') [line 46]
    +export functions

    +

    +

    +
    +
    + +

    get_line_end_format [line 181]

    +
    +
    +
    + String get_line_end_format( +) +
    +

    + + Helper functoin for fetching the line end format.



    +

    Tags:

    +
    + + + + +
    return:  'win', 'unix', or 'mac' based on the user's browser..
    +
    +

    + +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:47 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---rdelete.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---rdelete.php.html new file mode 100644 index 00000000..bbd73517 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---rdelete.php.html @@ -0,0 +1,199 @@ + + +Docs for page rdelete.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: rdelete.php

    +Source Location: /templates/tree/rdelete.php

    + +
    +
    + + +

    Page Details:

    +Recursively deletes the specified DN and all of its children Variables that come in as POST vars:
    • dn (rawurlencoded)




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/tree.inc') [line 45]
    +tree functions

    include_once('../../lib/security.inc') [line 43]
    +security functions

    include_once('../../lib/config.inc') [line 47]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 49]
    +LDAP functions

    include_once('../../lib/status.inc') [line 51]
    +status messages

    +

    +

    +
    +
    + +

    pla_rdelete [line 126]

    +
    +
    +
    + void pla_rdelete( + $dn) +
    +

    + +

    + +

    Parameters

    + + + + + + +
      $dn  
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:03 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---refresh.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---refresh.php.html new file mode 100644 index 00000000..2da7f230 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---refresh.php.html @@ -0,0 +1,175 @@ + + +Docs for page refresh.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: refresh.php

    +Source Location: /templates/tree/refresh.php

    + +
    +
    + + +

    Page Details:

    +This script alters the session variable 'tree', by re-querying the LDAP server to grab the contents of every expanded container.

    Variables that come in as GET vars:




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 44]
    +security functions

    include_once('../../lib/tree.inc') [line 46]
    +tree functions

    include_once('../../lib/config.inc') [line 48]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 50]
    +LDAP functions

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:03 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---creation---custom.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---creation---custom.php.html new file mode 100644 index 00000000..6b15e63a --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---creation---custom.php.html @@ -0,0 +1,247 @@ + + +Docs for page custom.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: custom.php

    +Source Location: /templates/tree/templates/creation/custom.php

    + +
    +
    + + +

    Page Details:

    +Creates custom LDAP objects.



    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    +

    +
    +
    + +

    get_attr_select_html [line 245]

    +
    +
    +
    + void get_attr_select_html( + $all_attrs, [ $highlight_attr = null]) +
    +

    + + Returns option values.



    + +

    Parameters

    + + + + + + + + + + + +
      $all_attrs  
      $highlight_attr  
    +
    [ Top ]


    +
    +
    + +

    get_binary_attr_select_html [line 264]

    +
    +
    +
    + void get_binary_attr_select_html( + $binary_attrs, [ $highlight_attr = null]) +
    +

    + + Returns option values.



    + +

    Parameters

    + + + + + + + + + + + +
      $binary_attrs  
      $highlight_attr  
    +
    [ Top ]


    +
    +
    + +

    remove_aliases [line 285]

    +
    +
    +
    + void remove_aliases( + &$attribute_list) +
    +

    + + Removes attributes from the array that are aliases for eachother

    (just removes the second instance of the aliased attr)




    + +

    Parameters

    + + + + + + +
      &$attribute_list  
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:44 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---creation---new_ou_template.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---creation---new_ou_template.php.html new file mode 100644 index 00000000..06e57a39 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---creation---new_ou_template.php.html @@ -0,0 +1,168 @@ + + +Docs for page new_ou_template.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: new_ou_template.php

    +Source Location: /templates/tree/templates/creation/new_ou_template.php

    + +
    +
    + + +

    Page Details:

    +Creates new OUs.



    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:58 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---templates.inc.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---templates.inc.html new file mode 100644 index 00000000..1c6eaa82 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---templates.inc.html @@ -0,0 +1,168 @@ + + +Docs for page templates.inc + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: templates.inc

    +Source Location: /templates/tree/templates/templates.inc

    + +
    +
    + + +

    Page Details:

    +Configuration for creation templates.



    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:12 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---tree.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---tree.php.html new file mode 100644 index 00000000..35e2e988 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---tree.php.html @@ -0,0 +1,236 @@ + + +Docs for page tree.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: tree.php

    +Source Location: /templates/tree/tree.php

    + +
    +
    + + +

    Page Details:

    +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




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 47]
    +security functions

    include_once('../../lib/tree.inc') [line 49]
    +tree functions

    include_once('../../lib/ldap.inc') [line 53]
    +LDAP functions

    include_once('../../lib/config.inc') [line 51]
    +access to configuration

    +

    +

    +
    +
    + +

    draw_create_link [line 175]

    +
    +
    +
    + void draw_create_link( + $rdn, $level, $encoded_dn) +
    +

    + +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
      $rdn  
      $level  
      $encoded_dn  
    +
    [ Top ]


    +
    +
    + +

    draw_tree_html [line 102]

    +
    +
    +
    + void draw_tree_html( + $dn, [ $level = 0]) +
    +

    + + Recursively descend on the given dn and draw the tree in html



    + +

    Parameters

    + + + + + + + + + + + +
      $dn  
      $level  
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:14 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---tree_view.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---tree_view.php.html new file mode 100644 index 00000000..c687d2dd --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---tree_view.php.html @@ -0,0 +1,172 @@ + + +Docs for page tree_view.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: tree_view.php

    +Source Location: /templates/tree/tree_view.php

    + +
    +
    + + +

    Page Details:

    +This file includes the main frame of the LDAP browser.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 34]
    +security functions

    include_once('../../lib/tree.inc') [line 36]
    +tree functions

    include_once('../../lib/config.inc') [line 38]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 40]
    +LDAP functions

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:15 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---update.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---update.php.html new file mode 100644 index 00000000..5764ebd2 --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---update.php.html @@ -0,0 +1,176 @@ + + +Docs for page update.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: update.php

    +Source Location: /templates/tree/update.php

    + +
    +
    + + +

    Page Details:

    +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.




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 57]
    +security functions

    include_once('../../lib/tree.inc') [line 59]
    +tree functions

    include_once('../../lib/config.inc') [line 61]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 63]
    +LDAP functions

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:15 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/lists/tree/_templates---tree---update_confirm.php.html b/lam-web/developers/phpdoc/lists/tree/_templates---tree---update_confirm.php.html new file mode 100644 index 00000000..75c5d51d --- /dev/null +++ b/lam-web/developers/phpdoc/lists/tree/_templates---tree---update_confirm.php.html @@ -0,0 +1,176 @@ + + +Docs for page update_confirm.php + + + + + + + + + + + + + +
    lists
    + + + [ class tree: lists ] + [ index: lists ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: update_confirm.php

    +Source Location: /templates/tree/update_confirm.php

    + +
    +
    + + +

    Page Details:

    +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.




    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/security.inc') [line 45]
    +security functions

    include_once('../../lib/tree.inc') [line 47]
    +tree functions

    include_once('../../lib/config.inc') [line 49]
    +access to configuration

    include_once('../../lib/ldap.inc') [line 51]
    +LDAP functions

    include_once('../../lib/account.inc') [line 53]
    +common functions

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:15 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/main/_templates---delete.php.html b/lam-web/developers/phpdoc/main/_templates---delete.php.html new file mode 100644 index 00000000..307c6c04 --- /dev/null +++ b/lam-web/developers/phpdoc/main/_templates---delete.php.html @@ -0,0 +1,178 @@ + + +Docs for page delete.php + + + + + + + + + + + + + +
    main
    + + + [ class tree: main ] + [ index: main ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: delete.php

    +Source Location: /templates/delete.php

    + +
    +
    + + +

    Page Details:

    +Used to delete accounts from LDAP tree.



    +

    Tags:

    +
    + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../lib/status.inc') [line 41]
    +message displaying

    include_once("../lib/security.inc") [line 35]
    +security functions

    include_once('../lib/config.inc') [line 39]
    +current configuration options

    include_once('../lib/ldap.inc') [line 43]
    +LDAP connection

    include_once('../lib/modules.inc') [line 47]
    +module interface

    include_once('../lib/lamdaemon.inc') [line 45]
    +lamdaemon interface

    include_once('../lib/account.inc') [line 37]
    +account functions

    +

    +

    +
    +
    + +

    deleteDN [line 266]

    +
    +
    +
    + array deleteDN( +string $dn) +
    +

    + + Deletes a DN and all child entries.



    +

    Tags:

    +
    + + + + +
    return:  error messages
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $dn  DN to delete
    +
    [ Top ]


    +
    +
    + +

    getChildCount [line 250]

    +
    +
    +
    + interger getChildCount( +string $dn) +
    +

    + + Returns the number of child entries of a DN.



    +

    Tags:

    +
    + + + + +
    return:  number of childs
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $dn  DN of parent
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:44 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/main/_templates---initsuff.php.html b/lam-web/developers/phpdoc/main/_templates---initsuff.php.html new file mode 100644 index 00000000..9bafe006 --- /dev/null +++ b/lam-web/developers/phpdoc/main/_templates---initsuff.php.html @@ -0,0 +1,108 @@ + + +Docs for page initsuff.php + + + + + + + + + + + + + +
    main
    + + + [ class tree: main ] + [ index: main ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: initsuff.php

    +Source Location: /templates/initsuff.php

    + +
    +
    + + +

    Page Details:

    +Creates main suffixes if they are missing.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../lib/security.inc") [line 32]
    +security functions

    include_once("../lib/config.inc") [line 34]
    +access to configuration settings

    include_once("../lib/ldap.inc") [line 36]
    +LDAP access

    include_once("../lib/status.inc") [line 38]
    +status messages

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:53 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/main/_templates---login.php.html b/lam-web/developers/phpdoc/main/_templates---login.php.html new file mode 100644 index 00000000..f91fed05 --- /dev/null +++ b/lam-web/developers/phpdoc/main/_templates---login.php.html @@ -0,0 +1,132 @@ + + +Docs for page login.php + + + + + + + + + + + + + +
    main
    + + + [ class tree: main ] + [ index: main ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: login.php

    +Source Location: /templates/login.php

    + +
    +
    + + +

    Page Details:

    +Login form of LDAP Account Manager.



    +

    Tags:

    +
    + + + + +
    author:  Michael Duergner
    +
    +

    +

    Includes:

    +
    +include_once("../lib/status.inc") [line 32]
    +status messages

    include_once("../lib/security.inc") [line 34]
    +security functions

    include_once("../lib/config.inc") [line 99]
    +access to configuration options

    include_once("../lib/ldap.inc") [line 378]
    +include_once("../lib/selfService.inc") [line 36]
    +self service functions

    +

    +

    +
    +
    + +

    display_LoginPage [line 109]

    +
    +
    +
    + void display_LoginPage( +object $config_object) +
    +

    + + Displays the login window.



    + +

    Parameters

    + + + + + + +
    object  $config_object  current active configuration
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:56 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/main/_templates---logout.php.html b/lam-web/developers/phpdoc/main/_templates---logout.php.html new file mode 100644 index 00000000..c9378507 --- /dev/null +++ b/lam-web/developers/phpdoc/main/_templates---logout.php.html @@ -0,0 +1,107 @@ + + +Docs for page logout.php + + + + + + + + + + + + + +
    main
    + + + [ class tree: main ] + [ index: main ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: logout.php

    +Source Location: /templates/logout.php

    + +
    +
    + + +

    Page Details:

    +User is logged off from LDAP server, session is destroyed.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../lib/security.inc") [line 39]
    +security functions

    include_once("../lib/status.inc") [line 41]
    +Used to display status messages

    include_once("../lib/ldap.inc") [line 43]
    +LDAP settings are deleted at logout

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:56 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/main/_templates---main.php.html b/lam-web/developers/phpdoc/main/_templates---main.php.html new file mode 100644 index 00000000..6a14a1aa --- /dev/null +++ b/lam-web/developers/phpdoc/main/_templates---main.php.html @@ -0,0 +1,106 @@ + + +Docs for page main.php + + + + + + + + + + + + + +
    main
    + + + [ class tree: main ] + [ index: main ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: main.php

    +Source Location: /templates/main.php

    + +
    +
    + + +

    Page Details:

    +This is the main window. The user and group lists will be shown in this frameset.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../lib/cache.inc') [line 32]
    +LDAP attibute cache

    include_once('../lib/config.inc') [line 34]
    +config object

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:56 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/main/_templates---main_header.php.html b/lam-web/developers/phpdoc/main/_templates---main_header.php.html new file mode 100644 index 00000000..83dff39a --- /dev/null +++ b/lam-web/developers/phpdoc/main/_templates---main_header.php.html @@ -0,0 +1,107 @@ + + +Docs for page main_header.php + + + + + + + + + + + + + +
    main
    + + + [ class tree: main ] + [ index: main ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: main_header.php

    +Source Location: /templates/main_header.php

    + +
    +
    + + +

    Page Details:

    +Head frame in main window, includes links to lists etc.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../lib/security.inc") [line 32]
    +security functions

    include_once("../lib/config.inc") [line 34]
    +access to configuration options

    include_once("../lib/selfService.inc") [line 36]
    +self service functions

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:57 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/media/style.css b/lam-web/developers/phpdoc/media/style.css index 5859cc8c..bc65d896 100644 --- a/lam-web/developers/phpdoc/media/style.css +++ b/lam-web/developers/phpdoc/media/style.css @@ -144,7 +144,7 @@ ul { } /* Syntax highlighting */ -.src-code { background-color: #f5f5f5; border: 1px solid #ccc9a4; padding: 0px; margin : 0px; +.src-code { background-color: #f5f5f5; border: 1px solid #ccc9a4; padding: 0 0 0 1em; margin : 0px; font-family: 'Courier New', Courier, monospace; font-weight: normal; } .src-line { font-family: 'Courier New', Courier, monospace; font-weight: normal; } diff --git a/lam-web/developers/phpdoc/modules/_lib---baseModule.inc.html b/lam-web/developers/phpdoc/modules/_lib---baseModule.inc.html new file mode 100644 index 00000000..1c8433e4 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---baseModule.inc.html @@ -0,0 +1,160 @@ + + +Docs for page baseModule.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: baseModule.inc

    +Source Location: /lib/baseModule.inc

    + +
    +
    + +
    +

    Classes:

    +
    baseModule
    +
    Parent class of all account modules.
    +


    + +

    Page Details:

    +This is the parent class for all account modules.

    It implements the complete module interface and uses meta-data provided by the account modules for its functions.




    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:39 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---createntlm.inc.html b/lam-web/developers/phpdoc/modules/_lib---createntlm.inc.html new file mode 100644 index 00000000..4ab48a77 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---createntlm.inc.html @@ -0,0 +1,160 @@ + + +Docs for page createntlm.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: createntlm.inc

    +Source Location: /lib/createntlm.inc

    + +
    +
    + +
    +

    Classes:

    +
    smbHash
    +
    Calculates NT and LM hashes.
    +


    + +

    Page Details:

    +This class provides functions to calculate Samba NT and LM hashes.

    The code is a conversion from createntlm.pl (Benjamin Kuit) and smbdes.c/md4.c (Andrew Tridgell).




    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:43 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---lamdaemon.inc.html b/lam-web/developers/phpdoc/modules/_lib---lamdaemon.inc.html new file mode 100644 index 00000000..70ae29f9 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---lamdaemon.inc.html @@ -0,0 +1,235 @@ + + +Docs for page lamdaemon.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: lamdaemon.inc

    +Source Location: /lib/lamdaemon.inc

    + +
    +
    + + +

    Page Details:

    +This file includes functions to control lamdaemon.



    +

    Tags:

    +
    + + + + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    author:  Thomas Manninger
    +
    +

    +

    +

    +
    +
    + +

    lamdaemon [line 42]

    +
    +
    +
    + array lamdaemon( +array $commands, string $server) +
    +

    + + Sends commands to lamdaemon script.



    +

    Tags:

    +
    + + + + +
    return:  Output of lamdaemon
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    array  $commands  List of command lines
    string  $server  remote server
    +
    [ Top ]


    +
    +
    + +

    lamdaemonSSH [line 97]

    +
    +
    +
    + array lamdaemonSSH( +array $commands, string $server) +
    +

    + + Sends commands to lamdaemon script via PHP SSH functions.



    +

    Tags:

    +
    + + + + +
    return:  Output of lamdaemon
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    array  $commands  List of command lines
    string  $server  remote server
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:54 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---account.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---account.inc.html new file mode 100644 index 00000000..c2a0c56f --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---account.inc.html @@ -0,0 +1,166 @@ + + +Docs for page account.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: account.inc

    +Source Location: /lib/modules/account.inc

    + +
    +
    + +
    +

    Classes:

    +
    account
    +
    Manages the object class "account" for users and hosts.
    +


    + +

    Page Details:

    +Manages the object class "account" for users and hosts.



    +

    Tags:

    +
    + + + + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    author:  Michael Duergner
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:36 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---ieee802device.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---ieee802device.inc.html new file mode 100644 index 00000000..9bc95315 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---ieee802device.inc.html @@ -0,0 +1,160 @@ + + +Docs for page ieee802device.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: ieee802device.inc

    +Source Location: /lib/modules/ieee802device.inc

    + +
    +
    + +
    +

    Classes:

    +
    ieee802Device
    +
    Provides MAC addresses for hosts.
    +


    + +

    Page Details:

    +Provides MAC addresses for hosts.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:50 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---inetLocalMailRecipient.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---inetLocalMailRecipient.inc.html new file mode 100644 index 00000000..27ee5063 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---inetLocalMailRecipient.inc.html @@ -0,0 +1,160 @@ + + +Docs for page inetLocalMailRecipient.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: inetLocalMailRecipient.inc

    +Source Location: /lib/modules/inetLocalMailRecipient.inc

    + +
    +
    + +
    +

    Classes:

    +
    inetLocalMailRecipient
    +
    Provides mail routing for users.
    +


    + +

    Page Details:

    +Provides mail routing for user accounts.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:51 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---inetOrgPerson.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---inetOrgPerson.inc.html new file mode 100644 index 00000000..fb901e4a --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---inetOrgPerson.inc.html @@ -0,0 +1,166 @@ + + +Docs for page inetOrgPerson.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: inetOrgPerson.inc

    +Source Location: /lib/modules/inetOrgPerson.inc

    + +
    +
    + +
    +

    Classes:

    +
    inetOrgPerson
    +
    This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).
    +


    + +

    Page Details:

    +Manages the atrributes of object class inetOrgPerson.



    +

    Tags:

    +
    + + + + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    author:  Michael Duergner
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:52 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---kolabUser.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---kolabUser.inc.html new file mode 100644 index 00000000..7ea991ed --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---kolabUser.inc.html @@ -0,0 +1,160 @@ + + +Docs for page kolabUser.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: kolabUser.inc

    +Source Location: /lib/modules/kolabUser.inc

    + +
    +
    + +
    +

    Classes:

    +
    kolabUser
    +
    Manages Kolab user accounts.
    +


    + +

    Page Details:

    +Manages Kolab user accounts.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:53 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---ldapPublicKey.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---ldapPublicKey.inc.html new file mode 100644 index 00000000..afee7d52 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---ldapPublicKey.inc.html @@ -0,0 +1,163 @@ + + +Docs for page ldapPublicKey.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: ldapPublicKey.inc

    +Source Location: /lib/modules/ldapPublicKey.inc

    + +
    +
    + +
    +

    Classes:

    +
    ldapPublicKey
    +
    Manages SSH public keys.
    +


    + +

    Page Details:

    +Manages SSH public keys.



    +

    Tags:

    +
    + + + + + + + +
    author:  Roland Gruber
    author:  Andrew Dibble <adibble@mobitv.com>
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:54 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---nisMailAlias.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---nisMailAlias.inc.html new file mode 100644 index 00000000..d646a03f --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---nisMailAlias.inc.html @@ -0,0 +1,160 @@ + + +Docs for page nisMailAlias.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: nisMailAlias.inc

    +Source Location: /lib/modules/nisMailAlias.inc

    + +
    +
    + +
    +

    Classes:

    +
    nisMailAlias
    +
    Provides NIS mail alias management.
    +


    + +

    Page Details:

    +Provides NIS mail alias management.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:58 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---posixAccount.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---posixAccount.inc.html new file mode 100644 index 00000000..8884c65e --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---posixAccount.inc.html @@ -0,0 +1,169 @@ + + +Docs for page posixAccount.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: posixAccount.inc

    +Source Location: /lib/modules/posixAccount.inc

    + +
    +
    + +
    +

    Classes:

    +
    posixAccount
    +
    Manages the object class "posixAccount" for users and hosts.
    +


    + +

    Page Details:

    +Manages Unix accounts for users and hosts.



    +

    Tags:

    +
    + + + + + + + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    author:  Michael Duergner
    author:  Thomas Manninger
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:59 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---posixGroup.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---posixGroup.inc.html new file mode 100644 index 00000000..02d0ef61 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---posixGroup.inc.html @@ -0,0 +1,166 @@ + + +Docs for page posixGroup.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: posixGroup.inc

    +Source Location: /lib/modules/posixGroup.inc

    + +
    +
    + +
    +

    Classes:

    +
    posixGroup
    +
    Manages the object class "posixGroup" for groups.
    +


    + +

    Page Details:

    +Manages Unix accounts for groups.



    +

    Tags:

    +
    + + + + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    author:  Michael Duergner
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:00 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---quota.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---quota.inc.html new file mode 100644 index 00000000..39f0e64e --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---quota.inc.html @@ -0,0 +1,166 @@ + + +Docs for page quota.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: quota.inc

    +Source Location: /lib/modules/quota.inc

    + +
    +
    + +
    +

    Classes:

    +
    quota
    +
    Manages quotas for users and groups.
    +


    + +

    Page Details:

    +Manages quotas for users and groups.



    +

    Tags:

    +
    + + + + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    author:  Michael Duergner
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:02 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---sambaAccount.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---sambaAccount.inc.html new file mode 100644 index 00000000..e85ce1bd --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---sambaAccount.inc.html @@ -0,0 +1,166 @@ + + +Docs for page sambaAccount.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: sambaAccount.inc

    +Source Location: /lib/modules/sambaAccount.inc

    + +
    +
    + +
    +

    Classes:

    +
    sambaAccount
    +
    Manages the object class "sambaAccount" for users and hosts.
    +


    + +

    Page Details:

    +Manages Samba 2 accounts for users and hosts.



    +

    Tags:

    +
    + + + + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    author:  Michael Duergner
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:03 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---sambaDomain.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---sambaDomain.inc.html new file mode 100644 index 00000000..193cbd00 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---sambaDomain.inc.html @@ -0,0 +1,160 @@ + + +Docs for page sambaDomain.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: sambaDomain.inc

    +Source Location: /lib/modules/sambaDomain.inc

    + +
    +
    + +
    +

    Classes:

    +
    sambaDomain
    +
    Manages Samba 3 domain entries.
    +


    + +

    Page Details:

    +Manages Samba 3 domain entries.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:04 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---sambaGroupMapping.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---sambaGroupMapping.inc.html new file mode 100644 index 00000000..0e1d0b47 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---sambaGroupMapping.inc.html @@ -0,0 +1,166 @@ + + +Docs for page sambaGroupMapping.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: sambaGroupMapping.inc

    +Source Location: /lib/modules/sambaGroupMapping.inc

    + +
    +
    + +
    +

    Classes:

    +
    sambaGroupMapping
    +
    Manages the object class "sambaGroupMapping" for groups.
    +


    + +

    Page Details:

    +Manages Samba 3 accounts for groups.



    +

    Tags:

    +
    + + + + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    author:  Michael Duergner
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:04 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html new file mode 100644 index 00000000..e71ca506 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html @@ -0,0 +1,186 @@ + + +Docs for page sambaMungedDial.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: sambaMungedDial.inc

    +Source Location: /lib/modules/sambaSamAccount/sambaMungedDial.inc

    + +
    +
    + +
    +

    Classes:

    +
    sambaMungedDial
    +
    Manages terminal server settings for Samba 3.
    +


    + +

    Page Details:

    +Manages terminal server settings for Samba 3.



    +

    Tags:

    +
    + + + + +
    author:  Cajus Pollmeier
    +
    +

    +

    +

    +
    + +

    SAMBA_MUNGEDDIAL_FILEHEADER [line 32]

    +
    +
    +
    + SAMBA_MUNGEDDIAL_FILEHEADER = "20002000200020002000200020002000"."20002000200020002000200020002000"."20002000200020002000200020002000"."20002000200020002000200020002000"."20002000200020002000200020002000"."20002000200020002000200020002000"."5000" +
    +
    + + File header


    +
    +
    [ Top ]


    +
    + +

    SAMBA_MUNGEDDIAL_FILEHEADER_OLD [line 43]

    +
    +
    +
    + SAMBA_MUNGEDDIAL_FILEHEADER_OLD = "6d000800200020002000200020002000"."20002000200020002000200020002000"."20002000200020002000200064000100"."20002000200020002000200020002000"."20002000200020002000200020002000"."20002000200020002000200020002000"."50001000" +
    +
    + + File header for old format.


    +
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:05 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---sambaSamAccount.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---sambaSamAccount.inc.html new file mode 100644 index 00000000..96778839 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---sambaSamAccount.inc.html @@ -0,0 +1,170 @@ + + +Docs for page sambaSamAccount.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: sambaSamAccount.inc

    +Source Location: /lib/modules/sambaSamAccount.inc

    + +
    +
    + +
    +

    Classes:

    +
    sambaSamAccount
    +
    Manages the object class "sambaSamAccount" for users and hosts.
    +


    + +

    Page Details:

    +Manages Samba 3 accounts for users and hosts.



    +

    Tags:

    +
    + + + + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    author:  Michael Duergner
    +
    +

    +

    Includes:

    +
    +include_once('sambaSamAccount/sambaMungedDial.inc') [line 35]
    +terminals server options

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:06 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---shadowAccount.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---shadowAccount.inc.html new file mode 100644 index 00000000..c4f0ba47 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules---shadowAccount.inc.html @@ -0,0 +1,166 @@ + + +Docs for page shadowAccount.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: shadowAccount.inc

    +Source Location: /lib/modules/shadowAccount.inc

    + +
    +
    + +
    +

    Classes:

    +
    shadowAccount
    +
    Manages the object class "shadowAccount" for users.
    +


    + +

    Page Details:

    +Manages Unix shadow accounts for users.



    +

    Tags:

    +
    + + + + + + + + + + +
    author:  Tilo Lutz
    author:  Roland Gruber
    author:  Michael Duergner
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:10 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_lib---modules.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules.inc.html new file mode 100644 index 00000000..42213d29 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_lib---modules.inc.html @@ -0,0 +1,881 @@ + + +Docs for page modules.inc + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: modules.inc

    +Source Location: /lib/modules.inc

    + +
    +
    + +
    +

    Classes:

    +
    accountContainer
    +
    This class includes all modules and attributes of an account.
    +


    + +

    Page Details:

    +Interface between modules and other parts of LAM.



    +

    Tags:

    +
    + + + + + + + + + + +
    author:  Tilo Lutz
    author:  Michael Duergner
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("lamdaemon.inc") [line 43]
    +lamdaemon functions

    include_once("baseModule.inc") [line 39]
    +parent class of account modules

    include_once("cache.inc") [line 35]
    +LDAP caches

    include_once("account.inc") [line 37]
    +some helper functions

    include_once($modulesINC_dirname.'/'.$entry) [line 55]
    +This includes all module files.

    include_once("ldap.inc") [line 41]
    +access to LDAP server

    include_once("security.inc") [line 45]
    +security functions

    +

    +

    +
    +
    + +

    buildUploadAccounts [line 396]

    +
    +
    +
    + mixed buildUploadAccounts( +string $scope, array $data, array $ids) +
    +

    + + This function builds the LDAP accounts for the file upload.

    If there are problems status messages will be printed automatically.




    +

    Tags:

    +
    + + + + +
    return:  array including accounts or false if there were errors
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    string  $scope  account type
    array  $data  array containing one account in each element
    array  $ids  array(<column_name> => <column number>)
    +
    [ Top ]


    +
    +
    + +

    checkConfigOptions [line 319]

    +
    +
    +
    + array checkConfigOptions( +array $scopes, array $options) +
    +

    + + Checks if the configuration options are valid



    +

    Tags:

    +
    + + + + +
    return:  list of error messages
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    array  $scopes  hash array (module name => array(account types))
    array  $options  hash array containing all options (name => array(...))
    +
    [ Top ]


    +
    +
    + +

    checkProfileOptions [line 285]

    +
    +
    +
    + array checkProfileOptions( +string $scope, array $options) +
    +

    + + Checks if the profile options are valid



    +

    Tags:

    +
    + + + + +
    return:  list of error messages
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    string  $scope  account type (user, group, host)
    array  $options  hash array containing all options (name => array(...))
    +
    [ Top ]


    +
    +
    + +

    check_module_conflicts [line 229]

    +
    +
    +
    + boolean check_module_conflicts( +array $selected, array $deps) +
    +

    + + Checks if there are conflicts between modules



    +

    Tags:

    +
    + + + + +
    return:  false if no conflict was found, otherwise an array of array(selected module, conflicting module) if conflicts were found
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    array  $selected  selected module names
    array  $deps  module dependencies
    +
    [ Top ]


    +
    +
    + +

    check_module_depends [line 188]

    +
    +
    +
    + mixed check_module_depends( +array $selected, array $deps) +
    +

    + + Checks if there are missing dependencies between modules.



    +

    Tags:

    +
    + + + + +
    return:  false if no misssing dependency was found, otherwise an array of array(selected module, depending module) if missing dependencies were found
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    array  $selected  selected module names
    array  $deps  module dependencies
    +
    [ Top ]


    +
    +
    + +

    doUploadPostActions [line 476]

    +
    +
    +
    + array doUploadPostActions( +string $scope, array $data, array $ids, array $failed) +
    +

    + + 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
    +
    [ Top ]


    +
    +
    + +

    getAvailableModules [line 248]

    +
    +
    +
    + array getAvailableModules( +string $scope) +
    +

    + + Returns an array with all available user module names



    +

    Tags:

    +
    + + + + +
    return:  list of possible modules
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $scope  account type (user, group, host)
    +
    [ Top ]


    +
    +
    + +

    getAvailablePDFFields [line 350]

    +
    +
    +
    + array getAvailablePDFFields( +string $scope) +
    +

    + + Returns a list of available PDF entries.



    +

    Tags:

    +
    + + + + +
    return:  PDF entries
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $scope  account type (user, group, host)
    +
    [ Top ]


    +
    +
    + +

    getConfigOptions [line 302]

    +
    +
    +
    + array getConfigOptions( +array $scopes) +
    +

    + + Returns a hash array (module name => elements) of all module options for the configuration page.



    +

    Tags:

    +
    + + + + +
    return:  configuration options
    +
    +

    + +

    Parameters

    + + + + + + +
    array  $scopes  hash array (module name => array(account types))
    +
    [ Top ]


    +
    +
    + +

    getHelp [line 339]

    +
    +
    +
    + array getHelp( +string $module, string $helpID, [ $scope = '']) +
    +

    + + Returns a help entry from an account module.



    +

    Tags:

    +
    + + + + +
    return:  help entry
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    string  $helpID  help identifier
    string  $module  module name
      $scope  
    +
    [ Top ]


    +
    +
    + +

    getModuleAlias [line 65]

    +
    +
    +
    + string getModuleAlias( +string $name, string $scope) +
    +

    + + Returns the alias name of a module



    +

    Tags:

    +
    + + + + +
    return:  alias name
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    string  $name  the module name
    string  $scope  the account type ("user", "group", "host")
    +
    [ Top ]


    +
    +
    + +

    getModulesDependencies [line 170]

    +
    +
    +
    + array getModulesDependencies( +string $scope) +
    +

    + + 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.




    +

    Tags:

    +
    + + + + +
    return:  dependencies
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $scope  the account type (user, group, host)
    +
    [ Top ]


    +
    +
    + +

    getProfileOptions [line 268]

    +
    +
    +
    + array getProfileOptions( +string $scope) +
    +

    + + Returns the elements for the profile page.



    +

    Tags:

    +
    + + + + +
    return:  profile elements
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $scope  account type (user, group, host)
    +
    [ Top ]


    +
    +
    + +

    getRDNAttributes [line 120]

    +
    +
    +
    + array getRDNAttributes( +string $scope) +
    +

    + + Returns a list of LDAP attributes which can be used to form the RDN.

    The list is already sorted by the priority given by the nodules.




    +

    Tags:

    +
    + + + + +
    return:  list of LDAP attributes
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $scope  account type (user, group, host)
    +
    [ Top ]


    +
    +
    + +

    getRequiredExtensions [line 512]

    +
    +
    +
    + array getRequiredExtensions( +) +
    +

    + + Returns true if the module is a base module



    +

    Tags:

    +
    + + + + +
    return:  required extensions
    +
    +

    + +
    [ Top ]


    +
    +
    + +

    getUploadColumns [line 376]

    +
    +
    +
    + array getUploadColumns( +string $scope) +
    +

    + + 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
    )




    +

    Tags:

    +
    + + + + +
    return:  column list
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $scope  account type
    +
    [ Top ]


    +
    +
    + +

    get_ldap_filter [line 88]

    +
    +
    +
    + string get_ldap_filter( +string $scope) +
    +

    + + Returns the LDAP filter used by the account lists



    +

    Tags:

    +
    + + + + +
    return:  LDAP filter
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $scope  the account type ("user", "group", "host")
    +
    [ Top ]


    +
    +
    + +

    is_base_module [line 77]

    +
    +
    +
    + boolean is_base_module( +string $name, string $scope) +
    +

    + + Returns true if the module is a base module



    +

    Tags:

    +
    + + + + +
    return:  true if base module
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    string  $name  the module name
    string  $scope  the account type ("user", "group", "host")
    +
    [ Top ]


    +
    +
    + +

    parseHtml [line 540]

    +
    +
    +
    + array parseHtml( +string $module, array $input, array $values, boolean $restricted, &$tabindex, &$tabindexLink, string $scope, integer $tabindex, integer $tabindexLink) +
    +

    + + Takes a list of meta-HTML elements and prints the equivalent HTML output.



    +

    Tags:

    +
    + + + + +
    return:  List of input field names and their type (name => type)
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    string  $module  Name of account module
    array  $input  List of meta-HTML elements
    array  $values  List of values which override the defaults in $input (name => value)
    boolean  $restricted  If true then no buttons will be displayed
    integer  $tabindex  Start value of tabulator index for input fields
    integer  $tabindexLink  Start value of tabulator index for links
    string  $scope  Account type
      &$tabindex  
      &$tabindexLink  
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:57 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/_templates---account---edit.php.html b/lam-web/developers/phpdoc/modules/_templates---account---edit.php.html new file mode 100644 index 00000000..a86c85ff --- /dev/null +++ b/lam-web/developers/phpdoc/modules/_templates---account---edit.php.html @@ -0,0 +1,164 @@ + + +Docs for page edit.php + + + + + + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: edit.php

    +Source Location: /templates/account/edit.php

    + +
    +
    + + +

    Page Details:

    +Displays the account detail page.



    +

    Tags:

    +
    + + + + +
    author:  Tilo Lutz
    +
    +

    +

    Includes:

    +
    +include_once('../../lib/config.inc') [line 36]
    +configuration options

    include_once("../../lib/security.inc") [line 34]
    +security functions

    include_once('../../lib/profiles.inc') [line 38]
    +functions to load and save profiles

    include_once('../../lib/status.inc') [line 40]
    +Return error-message

    include_once('../../lib/modules.inc') [line 44]
    +module functions

    include_once('../../lib/pdf.inc') [line 42]
    +Return a pdf-file

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:45 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/modules/account.html b/lam-web/developers/phpdoc/modules/account.html index 8ff2a8ee..db5534f7 100644 --- a/lam-web/developers/phpdoc/modules/account.html +++ b/lam-web/developers/phpdoc/modules/account.html @@ -12,9 +12,11 @@
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/account.inc

    -
    @@ -160,7 +166,6 @@ Source Location: /lib/modules/account.inc

    -

    Inherited Variables

    @@ -168,50 +173,37 @@ Source Location: /lib/modules/account.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -226,266 +218,282 @@ Source Location: /lib/modules/account.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -500,7 +508,7 @@ Source Location: /lib/modules/account.inc

    Class Details

    -[line 38]
    +[line 39]
    Manages the object class "account" for users and hosts.



    [ Top ]

    @@ -512,15 +520,16 @@ Manages the object class "account" for users and hosts.

    -

    method build_uploadAccounts [line 230]

    +

    method build_uploadAccounts [line 249]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -535,9 +544,7 @@ $ids, array


    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -555,6 +562,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -562,25 +574,32 @@ Overrides
    baseMo

    -

    method display_html_attributes [line 192]

    +

    method display_html_attributes [line 211]

    - void display_html_attributes( + array display_html_attributes( )

    -

    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    -

    method getButtonStatus [line 138]

    +

    method getButtonStatus [line 153]

    @@ -600,14 +619,12 @@ Overrides baseMo

    - -Overrides
    baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

    - + Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

    [ Top ]

    -

    method get_metaData [line 45]

    +

    method get_metaData [line 46]

    @@ -627,14 +644,12 @@ Overrides baseModule:

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 215]

    +

    method get_pdfEntries [line 234]

    @@ -655,13 +670,11 @@ Overrides baseModule::ge

    - -

    -

    method load_Messages [line 115]

    +

    method load_Messages [line 130]

    @@ -672,14 +685,12 @@ Overrides baseModule::ge This function fills the message array.



    - -Overrides
    baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method module_complete [line 127]

    +

    method module_complete [line 142]

    @@ -699,14 +710,12 @@ Overrides baseModule::l

    - -Overrides
    baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    - + Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    [ Top ]

    -

    method process_attributes [line 174]

    +

    method process_attributes [line 192]

    diff --git a/lam-web/developers/phpdoc/modules/accountContainer.html b/lam-web/developers/phpdoc/modules/accountContainer.html index e4739468..0e40f82f 100644 --- a/lam-web/developers/phpdoc/modules/accountContainer.html +++ b/lam-web/developers/phpdoc/modules/accountContainer.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -727,26 +736,31 @@ Overrides baseModule:

    - -

    -

    method save_attributes [line 157]

    +

    method save_attributes [line 175]

    - void save_attributes( + array save_attributes( )

    -

    - - -Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    + 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.)

    [ Top ]

    @@ -754,7 +768,7 @@ Overrides baseModule:
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules.inc

    - @@ -158,6 +158,10 @@ Source Location: /lib/modules.inc

  • accountContainer
  • continue_main
  • fixLDAPAttributes
  • +
  • getAccountModule
  • +
  • getAccountModules
  • +
  • getParentDN
  • +
  • getRDN
  • get_pdfEntries
  • get_type
  • load_account
  • @@ -180,14 +184,13 @@ Source Location: /lib/modules.inc

    -
    @@ -138,16 +144,10 @@ Source Location: /lib/modules.inc


    Class Details

    -[line 709]
    +[line 730]
    This class includes all modules and attributes of an account.



    [ Top ]

    @@ -198,7 +201,7 @@ This class includes all modules and attributes of an account.

    <

    $attributes =

    -

    [line 737]

    +

    [line 759]

    Array of all used attributes

    Syntax is attribute => array ( objectClass => MUST or MAY, ...)



    @@ -213,38 +216,8 @@ This class includes all modules and attributes of an account.

    <

    $attributes_orig =

    -

    [line 758]

    +

    [line 780]

    original LDAP attributes when account was loaded from LDAP

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $base =

    -

    [line 764]

    - Name of accountContainer variable in session

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $current_page =

    -

    [line 767]

    - This variable stores the name of the currently displayed page


    @@ -258,7 +231,7 @@ This class includes all modules and attributes of an account.

    <

    $dn =

    -

    [line 749]

    +

    [line 771]

    DN suffix of the account


    @@ -273,7 +246,7 @@ This class includes all modules and attributes of an account.

    <

    $dn_orig =

    -

    [line 752]

    +

    [line 774]

    DN suffix of account when it was loaded


    @@ -288,38 +261,8 @@ This class includes all modules and attributes of an account.

    <

    $isNewAccount =

    -

    [line 773]

    +

    [line 795]

    True if this is a newly created account

    -
    -
    -
    - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $module =

    -

    [line 746]

    - This is an array with all module objects

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $order =

    -

    [line 761]

    - Module order


    @@ -333,38 +276,8 @@ This class includes all modules and attributes of an account.

    <

    $rdn =

    -

    [line 755]

    +

    [line 777]

    RDN attribute of this account

    -
    -
    -
    - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $subpage =

    -

    [line 770]

    - This variable is set to the pagename of a subpage if it should be displayed

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $type =

    -

    [line 743]

    - This variale stores the account type.

    Currently "user", "group" and "host" are supported.



    @@ -384,7 +297,7 @@ This class includes all modules and attributes of an account.

    <
    -

    constructor accountContainer [line 716]

    +

    constructor accountContainer [line 738]

    @@ -398,8 +311,6 @@ $base) Constructor



    - -

    Parameters:

    @@ -419,7 +330,7 @@ $base)
    -

    method continue_main [line 789]

    +

    method continue_main [line 834]

    @@ -431,13 +342,11 @@ $base) This function is called when the user clicks on any button on the account pages.

    It prints the HTML code of each account page.




    - -
    [ Top ]

    -

    method fixLDAPAttributes [line 1207]

    +

    method fixLDAPAttributes [line 1273]

    @@ -460,8 +369,6 @@ $modules)

    - -

    Parameters:

    @@ -479,9 +386,142 @@ $modules)
    [ Top ]
    +
    + +

    method getAccountModule [line 803]

    +
    +
    +
    + baseModule getAccountModule( +string +$name) +
    +

    + + Returns the account module with the given class name



    +

    Tags:

    +
    + + + + +
    return:  account module
    +
    +

    + + +

    Parameters:

    +
    + + + + + + +
    string  $name  class name (e.g. posixAccount)
    +

    +
    [ Top ]
    +
    +
    + +

    method getAccountModules [line 817]

    +
    +
    +
    + array getAccountModules( +) +
    +

    + + Returns the included account modules.



    +

    Tags:

    +
    + + + + +
    return:  modules
    +
    +

    + + +
    [ Top ]
    +
    +
    + +

    method getParentDN [line 1606]

    +
    +
    +
    + String getParentDN( +String +$dn) +
    +

    + + Returns the parent DN of a given DN.



    +

    Tags:

    +
    + + + + +
    return:  DN
    +
    +

    + + +

    Parameters:

    +
    + + + + + + +
    String  $dn  DN
    +

    +
    [ Top ]
    +
    +
    + +

    method getRDN [line 1594]

    +
    +
    +
    + String getRDN( +String +$dn) +
    +

    + + Returns the RDN part of a given DN.



    +

    Tags:

    +
    + + + + +
    return:  RDN
    +
    +

    + + +

    Parameters:

    +
    + + + + + + +
    String  $dn  DN
    +

    +
    [ Top ]
    +

    -

    method get_pdfEntries [line 1523]

    +

    method get_pdfEntries [line 1517]

    @@ -502,13 +542,11 @@ $modules)

    - -
    [ Top ]

    -

    method get_type [line 781]

    +

    method get_type [line 826]

    @@ -529,13 +567,11 @@ $modules)

    - -
    [ Top ]

    -

    method load_account [line 1148]

    +

    method load_account [line 1214]

    @@ -557,8 +593,6 @@ $dn)

    - -

    Parameters:

    @@ -573,7 +607,7 @@ $dn)
    -

    method new_account [line 1280]

    +

    method new_account [line 1346]

    @@ -585,13 +619,11 @@ $dn) This function will prepare the object for a new account.



    - -
    [ Top ]

    -

    method save_account [line 1309]

    +

    method save_account [line 1375]

    @@ -612,13 +644,11 @@ $dn)

    - -
    [ Top ]

    -

    method save_module_attributes [line 1074]

    +

    method save_module_attributes [line 1136]

    @@ -641,8 +671,6 @@ $orig)

    - -

    Parameters:

    @@ -662,7 +690,7 @@ $orig)
    -

    method sortModules [line 1536]

    +

    method sortModules [line 1530]

    @@ -674,13 +702,11 @@ $orig) Sorts the module buttons for the account page.



    - -
    [ Top ]

    -

    method __sleep [line 1599]

    +

    method __sleep [line 1617]

    @@ -701,13 +727,11 @@ $orig)

    - -
    [ Top ]

    -

    method __wakeup [line 1611]

    +

    method __wakeup [line 1629]

    diff --git a/lam-web/developers/phpdoc/modules/baseModule.html b/lam-web/developers/phpdoc/modules/baseModule.html index 98f821fd..9dedf599 100644 --- a/lam-web/developers/phpdoc/modules/baseModule.html +++ b/lam-web/developers/phpdoc/modules/baseModule.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -719,8 +743,6 @@ $orig) Decrypts sensitive data after accountContainer was loaded from session.



    - -
    [ Top ]

    @@ -728,7 +750,7 @@ $orig)

    - Documentation generated on Wed, 15 Nov 2006 18:00:54 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:57 +0100 by phpDocumentor 1.4.0
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,18 +124,20 @@ Source Location: /lib/baseModule.inc

    - @@ -137,12 +146,11 @@ Source Location: /lib/baseModule.inc

    Variables

    @@ -154,19 +162,24 @@ Source Location: /lib/baseModule.inc

  • build_uploadAccounts
  • can_manage
  • checkSelfServiceOptions
  • +
  • checkSelfServiceSettings
  • check_configOptions
  • check_profileOptions
  • delete_attributes
  • display_html_delete
  • doUploadPostActions
  • +
  • getAccountContainer
  • +
  • getAttributes
  • getButtonStatus
  • getLDAPAliases
  • getManagedAttributes
  • getManagedObjectClasses
  • +
  • getOriginalAttributes
  • getRequiredExtensions
  • getSelfServiceFields
  • getSelfServiceOptions
  • getSelfServiceSearchAttributes
  • +
  • getSelfServiceSettings
  • get_alias
  • get_configOptions
  • get_dependencies
  • @@ -187,6 +200,10 @@ Source Location: /lib/baseModule.inc

  • load_profile
  • module_complete
  • module_ready
  • +
  • postDeleteActions
  • +
  • postModifyActions
  • +
  • preDeleteActions
  • +
  • preModifyActions
  • save_attributes
  • @@ -197,7 +214,6 @@ Source Location: /lib/baseModule.inc

    Class Overview


    -
    Parent class of all account modules


    - +
    Parent class of all account modules.


    +

    Author(s):

    +
      +
    +
    - @@ -274,7 +290,16 @@ Source Location: /lib/baseModule.inc

    Class Details

    [line 40]
    -Parent class of all account modules



    +Parent class of all account modules.



    +

    Tags:

    +
    +

    Child classes:

    @@ -210,6 +226,30 @@ Source Location: /lib/baseModule.inc

    Provides MAC addresses for hosts.
    +
    inetLocalMailRecipient
    +
    Provides mail routing for users.
    +
    +
    +
    inetOrgPerson
    +
    This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).
    +
    +
    +
    kolabUser
    +
    Manages Kolab user accounts.
    +
    +
    +
    ldapPublicKey
    +
    Manages SSH public keys.
    +
    +
    +
    nisMailAlias
    +
    Provides NIS mail alias management.
    +
    +
    +
    posixAccount
    +
    Manages the object class "posixAccount" for users and hosts.
    +
    +
    posixGroup
    Manages the object class "posixGroup" for groups.
    @@ -222,45 +262,21 @@ Source Location: /lib/baseModule.inc

    Manages the object class "sambaAccount" for users and hosts.
    -
    sambaSamAccount
    -
    Manages the object class "sambaSamAccount" for users and hosts.
    -
    -
    -
    posixAccount
    -
    Manages the object class "posixAccount" for users and hosts.
    -
    -
    -
    kolabUser
    -
    Manages Kolab user accounts.
    +
    sambaDomain
    +
    Manages Samba 3 domain entries.
    sambaGroupMapping
    Manages the object class "sambaGroupMapping" for groups.
    +
    sambaSamAccount
    +
    Manages the object class "sambaSamAccount" for users and hosts.
    +
    +
    shadowAccount
    Manages the object class "shadowAccount" for users.
    -
    -
    ldapPublicKey
    -
    Manages SSH public keys.
    -
    -
    -
    sambaDomain
    -
    Manages Samba 3 domain entries.
    -
    -
    -
    inetOrgPerson
    -
    This class contains all account LDAP attributes and funtioncs required to deal with inetOrgPerson.
    -
    -
    -
    inetLocalMailRecipient
    -
    Provides mail routing for users.
    -
    -
    -
    nisMailAlias
    -
    Provides NIS mail alias management.
    -
    + + + +
    abstract:  
    + +

    [ Top ]


    @@ -284,23 +309,17 @@ Parent class of all account modules



    $attributes =

    -

    [line 55]

    - contains all ldap attributes which should be written

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $base =

    -

    [line 52]

    - name of parent accountContainer ($_SESSION[$base])

    +

    [line 58]

    + contains all ldap attributes which should be written



    +

    Tags:

    +
    + + + + +
    access:  protected
    +
    +
    @@ -314,8 +333,17 @@ Parent class of all account modules



    $messages =

    -

    [line 61]

    - contains all error messages of a module

    +

    [line 64]

    + contains all error messages of a module



    +

    Tags:

    +
    +
    + + + +
    access:  protected
    +
    +
    @@ -330,7 +358,16 @@ Parent class of all account modules



    $meta =

    [line 43]

    - includes all meta data provided by the sub class

    + includes all meta data provided by the sub class



    +

    Tags:

    +
    +
    + + + +
    access:  protected
    +
    +
    @@ -345,7 +382,16 @@ Parent class of all account modules



    $moduleSettings =

    [line 49]

    - configuration settings of all modules

    + configuration settings of all modules



    +

    Tags:

    +
    +
    + + + +
    access:  protected
    +
    +
    @@ -359,8 +405,17 @@ Parent class of all account modules



    $orig =

    -

    [line 58]

    - contains all ldap attributes which are loaded from ldap

    +

    [line 61]

    + contains all ldap attributes which are loaded from ldap



    +

    Tags:

    +
    +
    + + + +
    access:  protected
    +
    +
    @@ -371,11 +426,20 @@ Parent class of all account modules





    [ Top ]

    - +

    -

    $scope =

    -

    [line 46]

    - the account type of this module (user, group, host)

    +

    $selfServiceSettings =

    +

    [line 52]

    + self service settings of all modules



    +

    Tags:

    +
    + + + + +
    access:  protected
    +
    +
    @@ -395,7 +459,7 @@ Parent class of all account modules




    -

    constructor baseModule [line 68]

    +

    constructor baseModule [line 71]

    @@ -408,8 +472,6 @@ $scope) Creates a new base module class



    - -

    Parameters:

    @@ -424,15 +486,16 @@ $scope)
    -

    method build_uploadAccounts [line 490]

    +

    method build_uploadAccounts [line 495]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -457,6 +520,30 @@ $ids, array
    In this function the LDAP account is built up.
    +
    inetLocalMailRecipient::build_uploadAccounts()
    +
    In this function the LDAP account is built up.
    +
    +
    +
    inetOrgPerson::build_uploadAccounts()
    +
    In this function the LDAP account is built up.
    +
    +
    +
    kolabUser::build_uploadAccounts()
    +
    In this function the LDAP account is built up.
    +
    +
    +
    ldapPublicKey::build_uploadAccounts()
    +
    In this function the LDAP account is built up.
    +
    +
    +
    nisMailAlias::build_uploadAccounts()
    +
    In this function the LDAP account is built up.
    +
    +
    +
    posixAccount::build_uploadAccounts()
    +
    In this function the LDAP account is built up.
    +
    +
    posixGroup::build_uploadAccounts()
    In this function the LDAP account is built up.
    @@ -465,15 +552,7 @@ $ids, array
    In this function the LDAP account is built up.
    -
    sambaSamAccount::build_uploadAccounts()
    -
    In this function the LDAP account is built up.
    -
    -
    -
    posixAccount::build_uploadAccounts()
    -
    In this function the LDAP account is built up.
    -
    -
    -
    kolabUser::build_uploadAccounts()
    +
    sambaDomain::build_uploadAccounts()
    In this function the LDAP account is built up.
    @@ -481,33 +560,15 @@ $ids, array
    In this function the LDAP account is built up.
    +
    sambaSamAccount::build_uploadAccounts()
    +
    In this function the LDAP account is built up.
    +
    +
    shadowAccount::build_uploadAccounts()
    In this function the LDAP account is built up.
    -
    -
    -
    ldapPublicKey::build_uploadAccounts()
    -
    In this function the LDAP account is built up.
    -
    -
    -
    sambaDomain::build_uploadAccounts()
    -
    In this function the LDAP account is built up.
    -
    -
    -
    inetOrgPerson::build_uploadAccounts()
    -
    In this function the LDAP account is built up.
    -
    -
    -
    inetLocalMailRecipient::build_uploadAccounts()
    -
    In this function the LDAP account is built up.
    -
    -
    -
    nisMailAlias::build_uploadAccounts()
    -
    In this function the LDAP account is built up.

    - -

    Parameters:

    @@ -525,6 +586,11 @@ $ids, array + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -532,7 +598,7 @@ $ids, array

    -

    method can_manage [line 155]

    +

    method can_manage [line 160]

    @@ -553,13 +619,11 @@ $ids, array

    - -
    [ Top ]

    -

    method checkSelfServiceOptions [line 684]

    +

    method checkSelfServiceOptions [line 726]

    @@ -583,7 +647,7 @@ $attributes)

    Overridden in child classes as:

    -
    sambaSamAccount::checkSelfServiceOptions()
    +
    inetOrgPerson::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
    @@ -591,13 +655,11 @@ $attributes)
    Checks if all input values are correct and returns the LDAP commands which should be executed.
    -
    inetOrgPerson::checkSelfServiceOptions()
    +
    sambaSamAccount::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.

    - -

    Parameters:

    @@ -615,9 +677,45 @@ $attributes)
    [ Top ]
    +
    + +

    method checkSelfServiceSettings [line 747]

    +
    +
    +
    + array checkSelfServiceSettings( +array +$options) +
    +

    + + Checks if the self service settings are valid.



    +

    Tags:

    +
    + + + + +
    return:  error messages
    +
    +

    + + +

    Parameters:

    +
    + + + + + + +
    array  $options  settings
    +

    +
    [ Top ]
    +

    -

    method check_configOptions [line 350]

    +

    method check_configOptions [line 355]

    @@ -646,8 +744,6 @@ $options)

    - -

    Parameters:

    @@ -667,7 +763,7 @@ $options)
    -

    method check_profileOptions [line 235]

    +

    method check_profileOptions [line 240]

    @@ -695,8 +791,6 @@ $options)

    - -

    Parameters:

    @@ -711,7 +805,7 @@ $options)
    -

    method delete_attributes [line 586]

    +

    method delete_attributes [line 628]

    @@ -733,26 +827,20 @@ $options)

    Overridden in child classes as:

    -
    posixGroup::delete_attributes()
    -
    -
    -
    -
    quota::delete_attributes()
    -
    -
    -
    posixAccount::delete_attributes()
    Additional LDAP operations on delete.
    +
    +
    +
    posixGroup::delete_attributes()
    +
    Checks if the group which should be deleted is still used as primary group.

    - -
    [ Top ]

    -

    method display_html_delete [line 595]

    +

    method display_html_delete [line 637]

    @@ -775,17 +863,15 @@ $options)

    Overridden in child classes as:

    posixAccount::display_html_delete()
    -
    +
    Displays the delete homedir option for the delete page.

    - -
    [ Top ]

    -

    method doUploadPostActions [line 558]

    +

    method doUploadPostActions [line 563]

    @@ -793,8 +879,9 @@ $options) array $data, array $ids, array -$failed, array -&$temp) +$failed, +&$temp, array +$temp)

    @@ -811,17 +898,15 @@ $failed, array

    Overridden in child classes as:

    -
    quota::doUploadPostActions()
    +
    posixAccount::doUploadPostActions()
    This function executes one post upload action.
    -
    posixAccount::doUploadPostActions()
    +
    quota::doUploadPostActions()
    This function executes one post upload action.

    - -

    Parameters:

    @@ -844,14 +929,75 @@ $failed, array + + + + +
    array   $temp   variable to store temporary data between two post actions
      &$temp  

    [ Top ]
    +
    + +

    method getAccountContainer [line 758]

    +
    +
    +
    + accountContainer getAccountContainer( +) +
    +

    + + Returns the accountContainer object.



    +

    Tags:

    +
    + + + + + + + +
    return:  accountContainer object
    access:  protected
    +
    +

    + + +
    [ Top ]
    +
    +
    + +

    method getAttributes [line 772]

    +
    +
    +
    + array getAttributes( +) +
    +

    + + Returns the LDAP attributes which are managed in this module.



    +

    Tags:

    +
    + + + + + + + +
    return:  attributes
    access:  public
    +
    +

    + + +
    [ Top ]
    +

    -

    method getButtonStatus [line 540]

    +

    method getButtonStatus [line 545]

    @@ -877,26 +1023,24 @@ $failed, array
    Controls if the module button the account page is visible and activated.
    -
    posixGroup::getButtonStatus()
    -
    Controls if the module button the account page is visible and activated.
    -
    -
    inetOrgPerson::getButtonStatus()
    Controls if the module button the account page is visible and activated.
    nisMailAlias::getButtonStatus()
    Controls if the module button the account page is visible and activated.
    +
    +
    +
    posixGroup::getButtonStatus()
    +
    Controls if the module button the account page is visible and activated.

    - -
    [ Top ]

    -

    method getLDAPAliases [line 616]

    +

    method getLDAPAliases [line 658]

    @@ -917,13 +1061,11 @@ $failed, array

    - -
    [ Top ]

    -

    method getManagedAttributes [line 627]

    +

    method getManagedAttributes [line 669]

    @@ -944,13 +1086,11 @@ $failed, array

    - -
    [ Top ]

    -

    method getManagedObjectClasses [line 605]

    +

    method getManagedObjectClasses [line 647]

    @@ -971,13 +1111,39 @@ $failed, array

    +
    [ Top ]
    + +
    + +

    method getOriginalAttributes [line 781]

    +
    +
    +
    + array getOriginalAttributes( +) +
    +

    + + Returns the LDAP attributes which are managed in this module (with unchanged values).



    +

    Tags:

    +
    + + + + + + + +
    return:  attributes
    access:  public
    +
    +

    - +
    [ Top ]

    -

    method getRequiredExtensions [line 637]

    +

    method getRequiredExtensions [line 679]

    @@ -998,13 +1164,11 @@ $failed, array

    - -
    [ Top ]

    -

    method getSelfServiceFields [line 658]

    +

    method getSelfServiceFields [line 700]

    @@ -1025,13 +1189,11 @@ $failed, array

    - -
    [ Top ]

    -

    method getSelfServiceOptions [line 672]

    +

    method getSelfServiceOptions [line 714]

    @@ -1055,17 +1217,15 @@ $attributes)

    Overridden in child classes as:

    -
    posixAccount::getSelfServiceOptions()
    +
    inetOrgPerson::getSelfServiceOptions()
    Returns the meta HTML code for each input field.
    -
    inetOrgPerson::getSelfServiceOptions()
    +
    posixAccount::getSelfServiceOptions()
    Returns the meta HTML code for each input field.

    - -

    Parameters:

    @@ -1085,7 +1245,7 @@ $attributes)
    -

    method getSelfServiceSearchAttributes [line 647]

    +

    method getSelfServiceSearchAttributes [line 689]

    @@ -1106,13 +1266,36 @@ $attributes)

    +
    [ Top ]
    + +
    + +

    method getSelfServiceSettings [line 736]

    +
    +
    +
    + array getSelfServiceSettings( +) +
    +

    + + Returns a list of self service configuration settings.



    +

    Tags:

    +
    + + + + +
    return:  settings
    +
    +

    - +
    [ Top ]

    -

    method get_alias [line 190]

    +

    method get_alias [line 195]

    @@ -1133,13 +1316,11 @@ $attributes)

    - -
    [ Top ]

    -

    method get_configOptions [line 334]

    +

    method get_configOptions [line 339]

    @@ -1168,8 +1349,6 @@ $allScopes)

    - -

    Parameters:

    @@ -1189,7 +1368,7 @@ $allScopes)
    -

    method get_dependencies [line 214]

    +

    method get_dependencies [line 219]

    @@ -1210,13 +1389,11 @@ $allScopes)

    - -
    [ Top ]

    -

    method get_help [line 504]

    +

    method get_help [line 509]

    @@ -1239,8 +1416,6 @@ $scope)

    - -

    Parameters:

    @@ -1260,7 +1435,7 @@ $scope)
    -

    method get_ldap_filter [line 177]

    +

    method get_ldap_filter [line 182]

    @@ -1281,13 +1456,11 @@ $scope)

    - -
    [ Top ]

    -

    method get_metaData [line 137]

    +

    method get_metaData [line 142]

    @@ -1317,6 +1490,30 @@ $scope)
    Returns meta data that is interpreted by parent class
    +
    inetLocalMailRecipient::get_metaData()
    +
    Returns meta data that is interpreted by parent class
    +
    +
    +
    inetOrgPerson::get_metaData()
    +
    Returns meta data that is interpreted by parent class
    +
    +
    +
    kolabUser::get_metaData()
    +
    Returns meta data that is interpreted by parent class
    +
    +
    +
    ldapPublicKey::get_metaData()
    +
    Returns meta data that is interpreted by parent class
    +
    +
    +
    nisMailAlias::get_metaData()
    +
    Returns meta data that is interpreted by parent class
    +
    +
    +
    posixAccount::get_metaData()
    +
    Returns meta data that is interpreted by parent class
    +
    +
    posixGroup::get_metaData()
    Returns meta data that is interpreted by parent class
    @@ -1329,15 +1526,7 @@ $scope)
    Returns meta data that is interpreted by parent class
    -
    sambaSamAccount::get_metaData()
    -
    Returns meta data that is interpreted by parent class
    -
    -
    -
    posixAccount::get_metaData()
    -
    Returns meta data that is interpreted by parent class
    -
    -
    -
    kolabUser::get_metaData()
    +
    sambaDomain::get_metaData()
    Returns meta data that is interpreted by parent class
    @@ -1345,38 +1534,20 @@ $scope)
    Returns meta data that is interpreted by parent class
    +
    sambaSamAccount::get_metaData()
    +
    Returns meta data that is interpreted by parent class
    +
    +
    shadowAccount::get_metaData()
    Returns meta data that is interpreted by parent class
    -
    -
    -
    ldapPublicKey::get_metaData()
    -
    Returns meta data that is interpreted by parent class
    -
    -
    -
    sambaDomain::get_metaData()
    -
    Returns meta data that is interpreted by parent class
    -
    -
    -
    inetOrgPerson::get_metaData()
    -
    Returns meta data that is interpreted by parent class
    -
    -
    -
    inetLocalMailRecipient::get_metaData()
    -
    Returns meta data that is interpreted by parent class
    -
    -
    -
    nisMailAlias::get_metaData()
    -
    Returns meta data that is interpreted by parent class

    - -
    [ Top ]

    -

    method get_pdfFields [line 434]

    +

    method get_pdfFields [line 439]

    @@ -1398,8 +1569,6 @@ $scope)

    - -

    Parameters:

    @@ -1414,7 +1583,7 @@ $scope)
    -

    method get_pdf_entries [line 449]

    +

    method get_pdf_entries [line 454]

    @@ -1436,8 +1605,6 @@ $scope = 'user'])

    - -

    Parameters:

    @@ -1452,7 +1619,7 @@ $scope = 'user'])
    -

    method get_profileOptions [line 224]

    +

    method get_profileOptions [line 229]

    @@ -1474,30 +1641,28 @@ $scope = 'user'])

    Overridden in child classes as:

    -
    quota::get_profileOptions()
    -
    Returns a list of elements for the account profiles.
    -
    -
    -
    sambaSamAccount::get_profileOptions()
    -
    Returns a list of elements for the account profiles.
    -
    -
    posixAccount::get_profileOptions()
    Returns a list of elements for the account profiles.
    +
    quota::get_profileOptions()
    +
    Returns a list of elements for the account profiles.
    +
    +
    sambaGroupMapping::get_profileOptions()
    Returns a list of elements for the account profiles.
    +
    +
    +
    sambaSamAccount::get_profileOptions()
    +
    Returns a list of elements for the account profiles.

    - -
    [ Top ]

    -

    method get_RDNAttributes [line 204]

    +

    method get_RDNAttributes [line 209]

    @@ -1518,13 +1683,11 @@ $scope = 'user'])

    - -
    [ Top ]

    -

    method get_scope [line 146]

    +

    method get_scope [line 151]

    @@ -1545,13 +1708,11 @@ $scope = 'user'])

    - -
    [ Top ]

    -

    method get_uploadColumns [line 467]

    +

    method get_uploadColumns [line 472]

    @@ -1578,13 +1739,11 @@ $scope = 'user'])

    - -
    [ Top ]

    -

    method get_uploadPreDepends [line 477]

    +

    method get_uploadPreDepends [line 482]

    @@ -1605,13 +1764,11 @@ $scope = 'user'])

    - -
    [ Top ]

    -

    method init [line 86]

    +

    method init [line 91]

    @@ -1625,33 +1782,27 @@ $base)

    Overridden in child classes as:

    -
    posixGroup::init()
    -
    This functin will be called when the module will be loaded *
    +
    posixAccount::init()
    +
    Initializes the module after it became part of an accountContainer
    -
    quota::init()
    -
    +
    posixGroup::init()
    +
    This functin will be called when the module will be loaded *
    sambaAccount::init()
    Initializes the module after it became part of an accountContainer
    -
    sambaSamAccount::init()
    +
    sambaGroupMapping::init()
    Initializes the module after it became part of an accountContainer
    -
    posixAccount::init()
    -
    -
    -
    -
    sambaGroupMapping::init()
    +
    sambaSamAccount::init()
    Initializes the module after it became part of an accountContainer

    - -

    Parameters:

    @@ -1666,7 +1817,7 @@ $base)
    -

    method is_base_module [line 167]

    +

    method is_base_module [line 172]

    @@ -1687,13 +1838,11 @@ $base)

    - -
    [ Top ]

    -

    method load_attributes [line 105]

    +

    method load_attributes [line 110]

    @@ -1707,25 +1856,19 @@ $attributes)

    Overridden in child classes as:

    -
    quota::load_attributes()
    -
    -
    -
    -
    sambaAccount::load_attributes()
    -
    -
    -
    -
    sambaSamAccount::load_attributes()
    -
    -
    -
    posixAccount::load_attributes()
    This function loads all needed LDAP attributes.
    +
    +
    +
    sambaAccount::load_attributes()
    +
    This function loads the LDAP attributes for this module.
    +
    +
    +
    sambaSamAccount::load_attributes()
    +
    This function loads the LDAP attributes for this module.

    - -

    Parameters:

    @@ -1740,7 +1883,7 @@ $attributes)
    -

    method load_Messages [line 78]

    +

    method load_Messages [line 83]

    @@ -1750,6 +1893,15 @@ $attributes)

    This function fills the $messages variable with output messages from this module.



    +

    Tags:

    +
    + + + + +
    access:  protected
    +
    +

    Overridden in child classes as:

    @@ -1761,6 +1913,26 @@ $attributes)
    This function fills the error message array with messages
    +
    inetLocalMailRecipient::load_Messages()
    +
    This function fills the error message array with messages
    +
    +
    +
    inetOrgPerson::load_Messages()
    +
    This function fills the message array.
    +
    +
    +
    kolabUser::load_Messages()
    +
    This function fills the error message array with messages
    +
    +
    +
    nisMailAlias::load_Messages()
    +
    This function fills the error message array with messages
    +
    +
    +
    posixAccount::load_Messages()
    +
    This function fills the error message array with messages.
    +
    +
    posixGroup::load_Messages()
    This function fills the $messages variable with output messages from this module.
    @@ -1773,15 +1945,7 @@ $attributes)
    this functin fills the error message array with messages
    -
    sambaSamAccount::load_Messages()
    -
    this functin fills the error message array with messages
    -
    -
    -
    posixAccount::load_Messages()
    -
    This function fills the error message array with messages.
    -
    -
    -
    kolabUser::load_Messages()
    +
    sambaDomain::load_Messages()
    This function fills the error message array with messages
    @@ -1789,34 +1953,20 @@ $attributes)
    this functin fills the error message array with messages
    +
    sambaSamAccount::load_Messages()
    +
    this functin fills the error message array with messages
    +
    +
    shadowAccount::load_Messages()
    This function builds up the message array.
    -
    -
    -
    sambaDomain::load_Messages()
    -
    This function fills the error message array with messages
    -
    -
    -
    inetOrgPerson::load_Messages()
    -
    This function fills the message array.
    -
    -
    -
    inetLocalMailRecipient::load_Messages()
    -
    This function fills the error message array with messages
    -
    -
    -
    nisMailAlias::load_Messages()
    -
    This function fills the error message array with messages

    - -
    [ Top ]

    -

    method load_profile [line 316]

    +

    method load_profile [line 321]

    @@ -1830,6 +1980,10 @@ $profile)

    Overridden in child classes as:

    +
    posixAccount::load_profile()
    +
    Loads the values of an account profile into internal variables.
    +
    +
    quota::load_profile()
    Loads the values of an account profile into internal variables.
    @@ -1838,25 +1992,19 @@ $profile)
    Loads the values of an account profile into internal variables.
    -
    sambaSamAccount::load_profile()
    -
    Loads the values of an account profile into internal variables.
    -
    -
    -
    posixAccount::load_profile()
    -
    Loads the values of an account profile into internal variables.
    -
    -
    sambaGroupMapping::load_profile()
    Loads the values of an account profile into internal variables.
    +
    sambaSamAccount::load_profile()
    +
    Loads the values of an account profile into internal variables.
    +
    +
    shadowAccount::load_profile()
    Loads the values of an account profile into internal variables.

    - -

    Parameters:

    @@ -1871,7 +2019,7 @@ $profile)
    -

    method module_complete [line 531]

    +

    method module_complete [line 536]

    @@ -1897,46 +2045,36 @@ $profile)
    This functions returns true if all needed settings are done.
    -
    posixGroup::module_complete()
    -
    This functions is used to check if all settings for this module have been made.
    -
    -
    -
    quota::module_complete()
    -
    -
    -
    -
    sambaAccount::module_complete()
    -
    This functions returns true if all needed settings are done
    -
    -
    -
    sambaSamAccount::module_complete()
    -
    This functions is used to check if all settings for this module have been made.
    -
    -
    -
    posixAccount::module_complete()
    -
    This functions is used to check if all settings for this module have been made.
    +
    inetOrgPerson::module_complete()
    +
    This functions return true if all needed settings are done.
    kolabUser::module_complete()
    This function returns true if all needed settings are done.
    -
    sambaGroupMapping::module_complete()
    -
    +
    posixAccount::module_complete()
    +
    This functions is used to check if all settings for this module have been made.
    -
    inetOrgPerson::module_complete()
    -
    This functions return true if all needed settings are done.
    +
    posixGroup::module_complete()
    +
    This functions is used to check if all settings for this module have been made.
    +
    +
    +
    sambaAccount::module_complete()
    +
    This functions returns true if all needed settings are done
    +
    +
    +
    sambaGroupMapping::module_complete()
    +
    This functions is used to check if all settings for this module have been made.

    - -
    [ Top ]

    -

    method module_ready [line 522]

    +

    method module_ready [line 527]

    @@ -1959,29 +2097,151 @@ $profile)

    Overridden in child classes as:

    quota::module_ready()
    -
    +
    This function is used to check if this module page can be displayed.
    sambaAccount::module_ready()
    -
    +
    This function is used to check if this module page can be displayed.
    +
    +
    +
    sambaGroupMapping::module_ready()
    +
    This function is used to check if this module page can be displayed.
    sambaSamAccount::module_ready()
    This function is used to check if this module page can be displayed.
    +

    + +
    [ Top ]
    + +
    + +

    method postDeleteActions [line 619]

    +
    +
    +
    + void postDeleteActions( +) +
    +

    + + Allows the module to run commands after the LDAP entry is deleted.



    + + +
    [ Top ]
    +
    +
    + +

    method postModifyActions [line 602]

    +
    +
    +
    + void postModifyActions( +boolean +$newAccount) +
    +

    + + Allows the module to run commands after the LDAP entry is changed or created.



    + +

    Overridden in child classes as:

    -
    sambaGroupMapping::module_ready()
    -
    +
    posixAccount::postModifyActions()
    +
    Allows the module to run commands after the LDAP entry was changed or created.
    +
    +
    +
    quota::postModifyActions()
    +
    Allows the module to run commands after the LDAP entry is changed or created.

    +

    Parameters:

    +
    + + + + + + +
    boolean  $newAccount  new account
    +

    +
    [ Top ]
    +
    +
    + +

    method preDeleteActions [line 612]

    +
    +
    +
    + true, preDeleteActions( +) +
    +

    + + Allows the module to run commands before the LDAP entry is deleted.

    An error message should be printed if the function returns false.




    +

    Tags:

    +
    + + + + +
    return:  if no problems occured
    +
    +

    +

    Overridden in child classes as:
    +

    +
    posixAccount::preDeleteActions()
    +
    Allows the module to run commands before the LDAP entry is deleted.
    +
    +
    +
    quota::preDeleteActions()
    +
    Allows the module to run commands before the LDAP entry is deleted.
    +
    +

    + +
    [ Top ]
    +
    +
    + +

    method preModifyActions [line 593]

    +
    +
    +
    + true, preModifyActions( +boolean +$newAccount) +
    +

    + + Allows the module to run commands before the LDAP entry is changed or created.

    An error message should be printed if the function returns false.




    +

    Tags:

    +
    + + + + +
    return:  if no problems occured
    +
    +

    + +

    Parameters:

    +
    + + + + + + +
    boolean  $newAccount  new account
    +

    [ Top ]

    -

    method save_attributes [line 577]

    +

    method save_attributes [line 582]

    diff --git a/lam-web/developers/phpdoc/modules/ieee802Device.html b/lam-web/developers/phpdoc/modules/ieee802Device.html index b8c318ae..33194128 100644 --- a/lam-web/developers/phpdoc/modules/ieee802Device.html +++ b/lam-web/developers/phpdoc/modules/ieee802Device.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -2004,26 +2264,10 @@ $profile)

    Overridden in child classes as:

    account::save_attributes()
    -
    +
    Returns a list of modifications which have to be made to the LDAP account.
    -
    posixGroup::save_attributes()
    -
    -
    -
    -
    quota::save_attributes()
    -
    -
    -
    -
    sambaAccount::save_attributes()
    -
    -
    -
    -
    sambaSamAccount::save_attributes()
    -
    -
    -
    -
    posixAccount::save_attributes()
    +
    inetOrgPerson::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
    @@ -2031,25 +2275,35 @@ $profile)
    Returns a list of modifications which have to be made to the LDAP account.
    +
    nisMailAlias::save_attributes()
    +
    Returns a list of modifications which have to be made to the LDAP account.
    +
    +
    +
    posixAccount::save_attributes()
    +
    Returns a list of modifications which have to be made to the LDAP account.
    +
    +
    +
    posixGroup::save_attributes()
    +
    Returns a list of modifications which have to be made to the LDAP account.
    +
    +
    +
    sambaAccount::save_attributes()
    +
    Returns a list of modifications which have to be made to the LDAP account.
    +
    +
    sambaGroupMapping::save_attributes()
    -
    +
    Returns a list of modifications which have to be made to the LDAP account.
    +
    +
    +
    sambaSamAccount::save_attributes()
    +
    Returns a list of modifications which have to be made to the LDAP account.
    shadowAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
    -
    -
    -
    inetOrgPerson::save_attributes()
    -
    -
    -
    -
    nisMailAlias::save_attributes()
    -
    Returns a list of modifications which have to be made to the LDAP account.

    - -
    [ Top ]

    @@ -2057,7 +2311,7 @@ $profile)

    - Documentation generated on Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:39 +0100 by phpDocumentor 1.4.0
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/ieee802device.inc

    -
    @@ -157,7 +163,6 @@ Source Location: /lib/modules/ieee802device.inc

    -

    Inherited Variables

    @@ -165,50 +170,37 @@ Source Location: /lib/modules/ieee802device.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -223,266 +215,282 @@ Source Location: /lib/modules/ieee802device.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -509,15 +517,16 @@ Provides MAC addresses for hosts.




    -

    method build_uploadAccounts [line 160]

    +

    method build_uploadAccounts [line 161]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -532,9 +541,7 @@ $ids, array


    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -552,6 +559,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -559,20 +571,27 @@ Overrides
    baseMo
    -

    method display_html_attributes [line 92]

    +

    method display_html_attributes [line 93]

    - void display_html_attributes( + array display_html_attributes( )

    - This function will create the meta HTML code to show a page with all attributes.



    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    @@ -597,14 +616,12 @@ Overrides baseMo

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 189]

    +

    method get_pdfEntries [line 190]

    @@ -625,8 +642,6 @@ Overrides baseModule::ge

    - -

    @@ -642,14 +657,12 @@ Overrides baseModule::ge This function fills the error message array with messages



    - -Overrides
    baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method process_attributes [line 118]

    +

    method process_attributes [line 119]

    diff --git a/lam-web/developers/phpdoc/modules/inetLocalMailRecipient.html b/lam-web/developers/phpdoc/modules/inetLocalMailRecipient.html index 4f4918ff..e5e60caa 100644 --- a/lam-web/developers/phpdoc/modules/inetLocalMailRecipient.html +++ b/lam-web/developers/phpdoc/modules/inetLocalMailRecipient.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -670,8 +683,6 @@ Overrides baseModule::l

    - -

    @@ -679,7 +690,7 @@ Overrides baseModule::l
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/inetLocalMailRecipient.inc

    -
    @@ -157,7 +163,6 @@ Source Location: /lib/modules/inetLocalMailRecipient.inc

    -

    Inherited Variables

    @@ -165,50 +170,37 @@ Source Location: /lib/modules/inetLocalMailRecipient.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -223,266 +215,282 @@ Source Location: /lib/modules/inetLocalMailRecipient.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -509,15 +517,16 @@ Provides mail routing for users.




    -

    method build_uploadAccounts [line 251]

    +

    method build_uploadAccounts [line 253]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -532,9 +541,7 @@ $ids, array


    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -552,6 +559,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -559,20 +571,27 @@ Overrides
    baseMo
    -

    method display_html_attributes [line 131]

    +

    method display_html_attributes [line 133]

    - void display_html_attributes( + array display_html_attributes( )

    - This function will create the meta HTML code to show a page with all attributes.



    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    @@ -597,14 +616,12 @@ Overrides baseMo

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 304]

    +

    method get_pdfEntries [line 306]

    @@ -625,8 +642,6 @@ Overrides baseModule::ge

    - -

    @@ -642,14 +657,12 @@ Overrides baseModule::ge This function fills the error message array with messages



    - -Overrides
    baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method process_attributes [line 173]

    +

    method process_attributes [line 175]

    diff --git a/lam-web/developers/phpdoc/modules/inetOrgPerson.html b/lam-web/developers/phpdoc/modules/inetOrgPerson.html index 1659862c..ce7b943c 100644 --- a/lam-web/developers/phpdoc/modules/inetOrgPerson.html +++ b/lam-web/developers/phpdoc/modules/inetOrgPerson.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -670,8 +683,6 @@ Overrides baseModule::l

    - -

    @@ -679,7 +690,7 @@ Overrides baseModule::l
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/inetOrgPerson.inc

    -
    @@ -125,7 +131,7 @@ Source Location: /lib/modules/inetOrgPerson.inc

    baseModule
        |
        --inetOrgPerson

    -
    This class contains all account LDAP attributes and funtioncs required to deal with inetOrgPerson.


    +
    This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).


    @@ -166,7 +172,6 @@ Source Location: /lib/modules/inetOrgPerson.inc

    -

    Inherited Variables

    @@ -174,50 +179,37 @@ Source Location: /lib/modules/inetOrgPerson.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -232,266 +224,282 @@ Source Location: /lib/modules/inetOrgPerson.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -507,7 +515,7 @@ Source Location: /lib/modules/inetOrgPerson.inc

    Class Details

    [line 38]
    -This class contains all account LDAP attributes and funtioncs required to deal with inetOrgPerson.



    +This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).



    [ Top ]

    @@ -518,15 +526,16 @@ This class contains all account LDAP attributes and funtioncs required to deal
    -

    method build_uploadAccounts [line 837]

    +

    method build_uploadAccounts [line 925]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -541,9 +550,7 @@ $ids, array


    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -561,6 +568,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -568,7 +580,7 @@ Overrides
    baseMo
    -

    method checkSelfServiceOptions [line 1145]

    +

    method checkSelfServiceOptions [line 1308]

    @@ -590,9 +602,7 @@ $attributes)

    - -Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP commands which should be executed.)

    - + Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP commands which should be executed.)

    Parameters:

    @@ -612,25 +622,32 @@ Overrides bas
    -

    method display_html_attributes [line 545]

    +

    method display_html_attributes [line 594]

    - void display_html_attributes( + array display_html_attributes( )

    -

    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    -

    method display_html_password [line 749]

    +

    method display_html_password [line 834]

    @@ -651,13 +668,11 @@ Overrides bas

    - -

    -

    method display_html_photo [line 789]

    +

    method display_html_photo [line 874]

    @@ -678,13 +693,11 @@ Overrides bas

    - -

    -

    method getButtonStatus [line 391]

    +

    method getButtonStatus [line 429]

    @@ -704,14 +717,12 @@ Overrides bas

    - -Overrides
    baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

    - + Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

    [ Top ]

    -

    method getSelfServiceOptions [line 1053]

    +

    method getSelfServiceOptions [line 1167]

    @@ -733,9 +744,7 @@ $attributes)

    - -Overrides baseModule::getSelfServiceOptions() (Returns the meta HTML code for each input field.)

    - + Overrides baseModule::getSelfServiceOptions() (Returns the meta HTML code for each input field.)

    Parameters:

    @@ -755,7 +764,7 @@ Overrides baseM
    -

    method get_metaData [line 85]

    +

    method get_metaData [line 89]

    @@ -775,14 +784,12 @@ Overrides baseM

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 808]

    +

    method get_pdfEntries [line 893]

    @@ -803,8 +810,6 @@ Overrides baseModule::ge

    - -

    @@ -820,14 +825,12 @@ Overrides baseModule::ge This function fills the message array.



    - -Overrides
    baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method module_complete [line 374]

    +

    method module_complete [line 412]

    @@ -847,14 +850,12 @@ Overrides baseModule::l

    - -Overrides
    baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    - + Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    [ Top ]

    -

    method process_attributes [line 448]

    +

    method process_attributes [line 489]

    @@ -875,13 +876,11 @@ Overrides baseModule:

    - -

    -

    method process_password [line 727]

    +

    method process_password [line 812]

    @@ -893,13 +892,11 @@ Overrides baseModule: Sets a new password.



    - -

    -

    method process_photo [line 769]

    +

    method process_photo [line 854]

    diff --git a/lam-web/developers/phpdoc/modules/kolabUser.html b/lam-web/developers/phpdoc/modules/kolabUser.html index a3dca8c1..2384f043 100644 --- a/lam-web/developers/phpdoc/modules/kolabUser.html +++ b/lam-web/developers/phpdoc/modules/kolabUser.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -911,26 +908,31 @@ Overrides baseModule: Sets a new photo.



    - -

    -

    method save_attributes [line 410]

    +

    method save_attributes [line 451]

    - void save_attributes( + array save_attributes( )

    -

    - - -Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    + 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.)

    [ Top ]

    @@ -938,7 +940,7 @@ Overrides baseModule:
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/kolabUser.inc

    - -
    @@ -135,12 +141,6 @@ Source Location: /lib/modules/kolabUser.inc

    -

    Variables

    - -
    @@ -168,7 +168,6 @@ Source Location: /lib/modules/kolabUser.inc

    -

    Inherited Variables

    @@ -176,50 +175,37 @@ Source Location: /lib/modules/kolabUser.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -234,266 +220,282 @@ Source Location: /lib/modules/kolabUser.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -512,26 +514,6 @@ Source Location: /lib/modules/kolabUser.inc

    Manages Kolab user accounts.



    [ Top ]

    -
    - -

    Class Variables

    -
    - -

    -

    $invitationPolicies =

    -

    [line 38]

    - list of invitation policies

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    -


    @@ -553,8 +535,6 @@ $scope) Creates a new kolabUser object.



    - -

    Parameters:

    @@ -569,15 +549,16 @@ $scope)
    -

    method build_uploadAccounts [line 604]

    +

    method build_uploadAccounts [line 610]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -592,9 +573,7 @@ $ids, array


    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -612,6 +591,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -619,25 +603,32 @@ Overrides
    baseMo
    -

    method display_html_attributes [line 262]

    +

    method display_html_attributes [line 264]

    - void display_html_attributes( + array display_html_attributes( )

    - This function will create the meta HTML code to show a page with all attributes.



    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    -

    method display_html_deleteUser [line 556]

    +

    method display_html_deleteUser [line 560]

    @@ -649,8 +640,6 @@ Overrides baseMo This function will create the meta HTML code to show a page to delete accounts.



    - -

    @@ -675,14 +664,12 @@ Overrides baseMo

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 742]

    +

    method get_pdfEntries [line 748]

    @@ -703,8 +690,6 @@ Overrides baseModule::ge

    - -

    @@ -720,14 +705,12 @@ Overrides baseModule::ge This function fills the error message array with messages



    - -Overrides
    baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method module_complete [line 583]

    +

    method module_complete [line 587]

    @@ -747,14 +730,12 @@ Overrides baseModule::l

    - -Overrides
    baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    - + Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    [ Top ]

    -

    method process_attributes [line 412]

    +

    method process_attributes [line 416]

    @@ -775,13 +756,11 @@ Overrides baseModule:

    - -

    -

    method process_deleteUser [line 571]

    +

    method process_deleteUser [line 575]

    diff --git a/lam-web/developers/phpdoc/modules/ldapPublicKey.html b/lam-web/developers/phpdoc/modules/ldapPublicKey.html index 84cf077b..e2a8adb3 100644 --- a/lam-web/developers/phpdoc/modules/ldapPublicKey.html +++ b/lam-web/developers/phpdoc/modules/ldapPublicKey.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -793,8 +772,6 @@ Overrides baseModule: Write variables into object and do some regex checks



    - -

    @@ -819,9 +796,7 @@ Overrides baseModule:

    - -Overrides
    baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    - + Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    [ Top ]

    @@ -829,7 +804,7 @@ Overrides baseModule:
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/ldapPublicKey.inc

    -
    @@ -156,7 +162,6 @@ Source Location: /lib/modules/ldapPublicKey.inc

    -

    Inherited Variables

    @@ -164,50 +169,37 @@ Source Location: /lib/modules/ldapPublicKey.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -222,266 +214,282 @@ Source Location: /lib/modules/ldapPublicKey.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -508,15 +516,16 @@ Manages SSH public keys.




    -

    method build_uploadAccounts [line 138]

    +

    method build_uploadAccounts [line 140]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -531,9 +540,7 @@ $ids, array


    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -551,6 +558,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -558,20 +570,27 @@ Overrides
    baseMo
    -

    method display_html_attributes [line 85]

    +

    method display_html_attributes [line 87]

    - void display_html_attributes( + array display_html_attributes( )

    - This function will create the meta HTML code to show a page with all attributes.



    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    @@ -596,14 +615,12 @@ Overrides baseMo

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 158]

    +

    method get_pdfEntries [line 160]

    @@ -615,13 +632,11 @@ Overrides baseModule::ge Returns a list of PDF entries



    - -

    -

    method process_attributes [line 111]

    +

    method process_attributes [line 113]

    diff --git a/lam-web/developers/phpdoc/modules/nisMailAlias.html b/lam-web/developers/phpdoc/modules/nisMailAlias.html index 170838aa..b0b1bf2e 100644 --- a/lam-web/developers/phpdoc/modules/nisMailAlias.html +++ b/lam-web/developers/phpdoc/modules/nisMailAlias.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -642,8 +657,6 @@ Overrides baseModule::ge

    - -

    @@ -651,7 +664,7 @@ Overrides baseModule::ge
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/nisMailAlias.inc

    -
    @@ -159,7 +165,6 @@ Source Location: /lib/modules/nisMailAlias.inc

    -

    Inherited Variables

    @@ -167,50 +172,37 @@ Source Location: /lib/modules/nisMailAlias.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -225,266 +217,282 @@ Source Location: /lib/modules/nisMailAlias.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -511,15 +519,16 @@ Provides NIS mail alias management.




    -

    method build_uploadAccounts [line 228]

    +

    method build_uploadAccounts [line 230]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -534,9 +543,7 @@ $ids, array


    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -554,6 +561,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -561,25 +573,32 @@ Overrides
    baseMo
    -

    method display_html_attributes [line 129]

    +

    method display_html_attributes [line 131]

    - void display_html_attributes( + array display_html_attributes( )

    - This function will create the meta HTML code to show a page with all attributes.



    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    -

    method getButtonStatus [line 209]

    +

    method getButtonStatus [line 211]

    @@ -599,9 +618,7 @@ Overrides baseMo

    - -Overrides
    baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

    - + Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

    [ Top ]

    @@ -626,14 +643,12 @@ Overrides baseModule:

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 267]

    +

    method get_pdfEntries [line 269]

    @@ -654,8 +669,6 @@ Overrides baseModule::ge

    - -

    @@ -671,14 +684,12 @@ Overrides baseModule::ge This function fills the error message array with messages



    - -Overrides
    baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method process_attributes [line 160]

    +

    method process_attributes [line 162]

    diff --git a/lam-web/developers/phpdoc/modules/posixAccount.html b/lam-web/developers/phpdoc/modules/posixAccount.html index 2785b1e6..c2ac0c36 100644 --- a/lam-web/developers/phpdoc/modules/posixAccount.html +++ b/lam-web/developers/phpdoc/modules/posixAccount.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -699,8 +710,6 @@ Overrides baseModule::l

    - -

    @@ -725,9 +734,7 @@ Overrides baseModule::l

    - -Overrides
    baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    - + Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    [ Top ]

    @@ -735,7 +742,7 @@ Overrides baseModule:
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/posixAccount.inc

    - -
    @@ -135,15 +141,6 @@ Source Location: /lib/modules/posixAccount.inc

    -

    Variables

    - -
    @@ -159,6 +156,7 @@ Source Location: /lib/modules/posixAccount.inc

  • display_html_group
  • display_html_password
  • doUploadPostActions
  • +
  • getClearTextPassword
  • getNextUIDs
  • getSelfServiceOptions
  • get_metaData
  • @@ -169,6 +167,8 @@ Source Location: /lib/modules/posixAccount.inc

  • load_Messages
  • load_profile
  • module_complete
  • +
  • postModifyActions
  • +
  • preDeleteActions
  • process_attributes
  • process_group
  • process_password
  • @@ -184,7 +184,6 @@ Source Location: /lib/modules/posixAccount.inc

    -

    Inherited Variables

    @@ -192,50 +191,37 @@ Source Location: /lib/modules/posixAccount.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -250,266 +236,282 @@ Source Location: /lib/modules/posixAccount.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -524,75 +526,10 @@ Source Location: /lib/modules/posixAccount.inc

    Class Details

    -[line 38]
    +[line 40]
    Manages the object class "posixAccount" for users and hosts.



    [ Top ]

    -
    - -

    Class Variables

    -
    - -

    -

    $clearTextPassword =

    -

    [line 46]

    - -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $createhomedir =

    -

    [line 45]

    - -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $groups =

    -

    [line 43]

    - -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $groups_orig =

    -

    [line 44]

    - -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    -


    @@ -601,15 +538,16 @@ Manages the object class "posixAccount" for users and hosts.

    -

    method build_uploadAccounts [line 1098]

    +

    method build_uploadAccounts [line 1254]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -624,9 +562,7 @@ $ids, array


    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -644,6 +580,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -651,7 +592,7 @@ Overrides
    baseMo

    -

    method checkASCII [line 730]

    +

    method checkASCII [line 853]

    @@ -673,8 +614,6 @@ $attribute)

    - -

    Parameters:

    @@ -689,7 +628,7 @@ $attribute)
    -

    method checkSelfServiceOptions [line 1521]

    +

    method checkSelfServiceOptions [line 1698]

    @@ -711,9 +650,7 @@ $attributes)

    - -Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP commands which should be executed.)

    - + Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP commands which should be executed.)

    Parameters:

    @@ -733,7 +670,7 @@ Overrides bas
    -

    method check_configOptions [line 1039]

    +

    method check_configOptions [line 1195]

    @@ -755,9 +692,7 @@ $options)

    - -Overrides baseModule::check_configOptions() (Checks input values of module settings.)

    - + Overrides baseModule::check_configOptions() (Checks input values of module settings.)

    Parameters:

    @@ -777,7 +712,7 @@ Overrides baseMod
    -

    method delete_attributes [line 502]

    +

    method delete_attributes [line 574]

    @@ -797,50 +732,62 @@ Overrides baseMod

    - -Overrides
    baseModule::delete_attributes() (Dummy function for modules which use no special options on account deletion.)

    - + Overrides baseModule::delete_attributes() (Dummy function for modules which use no special options on account deletion.)

    [ Top ]

    -

    method display_html_attributes [line 794]

    +

    method display_html_attributes [line 918]

    - void display_html_attributes( + array display_html_attributes( )

    -

    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    -

    method display_html_delete [line 872]

    +

    method display_html_delete [line 1024]

    - void display_html_delete( + meta display_html_delete( )

    -

    - - -Overrides baseModule::display_html_delete() (Dummy function for modules which do not print extra HTML code on account deletion.)

    + Displays the delete homedir option for the delete page.



    +

    Tags:

    +
    + + + + +
    return:  HTML code
    +
    +

    + Overrides baseModule::display_html_delete() (Dummy function for modules which do not print extra HTML code on account deletion.)

    [ Top ]

    -

    method display_html_group [line 887]

    +

    method display_html_group [line 1039]

    @@ -861,13 +808,11 @@ Overrides baseMod

    - -

    -

    method display_html_password [line 932]

    +

    method display_html_password [line 1084]

    @@ -888,13 +833,11 @@ Overrides baseMod

    - -

    -

    method doUploadPostActions [line 1353]

    +

    method doUploadPostActions [line 1506]

    @@ -902,8 +845,9 @@ Overrides baseMod array $data, array $ids, array -$failed, array -&$temp) +$failed, +&$temp, array +$temp)

    @@ -918,9 +862,7 @@ $failed, array


    - -Overrides baseModule::doUploadPostActions() (This function executes one post upload action.)

    - + Overrides baseModule::doUploadPostActions() (This function executes one post upload action.)

    Parameters:

    @@ -943,21 +885,55 @@ Overrides baseMod + + + + +
    array   $temp   variable to store temporary data between two post actions
      &$temp  

    +
    + +

    method getClearTextPassword [line 1727]

    +
    +
    +
    + string getClearTextPassword( +) +
    +

    + + Returns the clear text password.



    +

    Tags:

    +
    + + + + + + + +
    return:  password
    access:  public
    +
    +

    + + +
    [ Top ]
    +

    -

    method getNextUIDs [line 1435]

    +

    method getNextUIDs [line 1612]

    mixed getNextUIDs( integer -$count, array -&$errors) +$count, +&$errors, array +$errors)

    @@ -973,8 +949,6 @@ $count, array

    - -

    Parameters:

    @@ -987,6 +961,11 @@ $count, array + + + + +
    array   $errors   list of error messages where errors can be added
      &$errors  

    @@ -994,7 +973,7 @@ $count, array

    -

    method getSelfServiceOptions [line 1501]

    +

    method getSelfServiceOptions [line 1678]

    @@ -1016,9 +995,7 @@ $attributes)

    - -Overrides baseModule::getSelfServiceOptions() (Returns the meta HTML code for each input field.)

    - + Overrides baseModule::getSelfServiceOptions() (Returns the meta HTML code for each input field.)

    Parameters:

    @@ -1038,7 +1015,7 @@ Overrides baseM
    -

    method get_metaData [line 98]

    +

    method get_metaData [line 102]

    @@ -1058,14 +1035,12 @@ Overrides baseM

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 1014]

    +

    method get_pdfEntries [line 1170]

    @@ -1086,13 +1061,11 @@ Overrides baseModule::ge

    - -

    -

    method get_profileOptions [line 954]

    +

    method get_profileOptions [line 1106]

    @@ -1112,33 +1085,39 @@ Overrides baseModule::ge

    - -Overrides
    baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

    - + Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

    [ Top ]

    -

    method init [line 396]

    +

    method init [line 428]

    void init( -mixed +string $base)

    -

    - - -Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

    + Initializes the module after it became part of an accountContainer



    + Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

    +

    Parameters:

    +
    + + + + + + +
    string  $base  the name of the accountContainer object ($_SESSION[$base])
    +

    [ Top ]

    -

    method load_attributes [line 428]

    +

    method load_attributes [line 460]

    @@ -1150,9 +1129,7 @@ $attr) This function loads all needed LDAP attributes.



    - -Overrides baseModule::load_attributes() (This function loads the LDAP attributes for this module.)

    - + Overrides baseModule::load_attributes() (This function loads the LDAP attributes for this module.)

    Parameters:

    @@ -1167,7 +1144,7 @@ Overrides baseModule:
    -

    method load_Messages [line 51]

    +

    method load_Messages [line 54]

    @@ -1178,14 +1155,12 @@ Overrides baseModule: This function fills the error message array with messages.



    - -Overrides
    baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method load_profile [line 992]

    +

    method load_profile [line 1148]

    @@ -1197,9 +1172,7 @@ $profile) Loads the values of an account profile into internal variables.



    - -Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)

    - + Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)

    Parameters:

    @@ -1214,7 +1187,7 @@ Overrides baseModule::lo
    -

    method module_complete [line 414]

    +

    method module_complete [line 446]

    @@ -1234,14 +1207,64 @@ Overrides baseModule::lo

    + Overrides
    baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    +
    [ Top ]
    + +
    + +

    method postModifyActions [line 536]

    +
    +
    +
    + void postModifyActions( +boolean +$newAccount) +
    +

    -Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    + Allows the module to run commands after the LDAP entry was changed or created.



    + Overrides baseModule::postModifyActions() (Allows the module to run commands after the LDAP entry is changed or created.)

    +

    Parameters:

    +
    + + + + + + +
    boolean  $newAccount  new account
    +

    +
    [ Top ]
    +
    +
    + +

    method preDeleteActions [line 592]

    +
    +
    +
    + true, preDeleteActions( +) +
    +

    + + Allows the module to run commands before the LDAP entry is deleted.

    An error message should be printed if the function returns false.




    +

    Tags:

    +
    + + + + +
    return:  if no problems occured
    +
    +

    + + Overrides baseModule::preDeleteActions() (Allows the module to run commands before the LDAP entry is deleted.)

    [ Top ]

    -

    method process_attributes [line 521]

    +

    method process_attributes [line 626]

    @@ -1262,13 +1285,11 @@ Overrides baseModule:

    - -

    -

    method process_group [line 755]

    +

    method process_group [line 878]

    @@ -1289,13 +1310,11 @@ Overrides baseModule:

    - -

    -

    method process_password [line 772]

    +

    method process_password [line 895]

    @@ -1316,13 +1335,11 @@ Overrides baseModule:

    - -

    -

    method save_attributes [line 454]

    +

    method save_attributes [line 487]

    diff --git a/lam-web/developers/phpdoc/modules/posixGroup.html b/lam-web/developers/phpdoc/modules/posixGroup.html index 0f591741..fe51fa77 100644 --- a/lam-web/developers/phpdoc/modules/posixGroup.html +++ b/lam-web/developers/phpdoc/modules/posixGroup.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -1342,9 +1359,7 @@ Overrides baseModule:

    - -Overrides
    baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    - + Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    [ Top ]

    @@ -1352,7 +1367,7 @@ Overrides baseModule:
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/posixGroup.inc

    - -
    @@ -135,12 +141,6 @@ Source Location: /lib/modules/posixGroup.inc

    -

    Variables

    - -
    @@ -174,7 +174,6 @@ Source Location: /lib/modules/posixGroup.inc

    -

    Inherited Variables

    @@ -182,50 +181,37 @@ Source Location: /lib/modules/posixGroup.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -240,266 +226,282 @@ Source Location: /lib/modules/posixGroup.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -518,26 +520,6 @@ Source Location: /lib/modules/posixGroup.inc

    Manages the object class "posixGroup" for groups.



    [ Top ]

    -
    - -

    Class Variables

    -
    - -

    -

    $changegids =

    -

    [line 42]

    - change GIDs of users and hosts?

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    -


    @@ -553,8 +535,9 @@ Manages the object class "posixGroup" for groups.


    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -569,9 +552,7 @@ $ids, array

    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -589,6 +570,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -596,43 +582,57 @@ Overrides
    baseMo
    -

    method delete_attributes [line 125]

    +

    method delete_attributes [line 130]

    - void delete_attributes( + List delete_attributes( )

    -

    - - -Overrides baseModule::delete_attributes() (Dummy function for modules which use no special options on account deletion.)

    + Checks if the group which should be deleted is still used as primary group.



    +

    Tags:

    +
    + + + + +
    return:  of LDAP operations, same as for save_attributes()
    +
    +

    + Overrides baseModule::delete_attributes() (Dummy function for modules which use no special options on account deletion.)

    [ Top ]

    -

    method display_html_attributes [line 146]

    +

    method display_html_attributes [line 152]

    - void display_html_attributes( + array display_html_attributes( )

    -

    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    -

    method display_html_password [line 249]

    +

    method display_html_password [line 255]

    @@ -653,13 +653,11 @@ Overrides baseModul

    - -

    -

    method display_html_user [line 202]

    +

    method display_html_user [line 208]

    @@ -680,13 +678,11 @@ Overrides baseModul

    - -

    -

    method getButtonStatus [line 495]

    +

    method getButtonStatus [line 501]

    @@ -706,21 +702,20 @@ Overrides baseModul

    - -Overrides
    baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

    - + Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

    [ Top ]

    -

    method getNextGIDs [line 728]

    +

    method getNextGIDs [line 720]

    mixed getNextGIDs( integer -$count, array -&$errors) +$count, +&$errors, array +$errors)

    @@ -736,8 +731,6 @@ $count, array

    - -

    Parameters:

    @@ -750,6 +743,11 @@ $count, array + + + + +
    array   $errors   list of error messages where errors can be added
      &$errors  

    @@ -757,7 +755,7 @@ $count, array

    -

    method get_configOptions [line 410]

    +

    method get_configOptions [line 416]

    @@ -779,9 +777,7 @@ $allScopes)

    - -Overrides baseModule::get_configOptions() (Returns a list of elements for the configuration.)

    - + Overrides baseModule::get_configOptions() (Returns a list of elements for the configuration.)

    Parameters:

    @@ -801,7 +797,7 @@ Overrides baseModul
    -

    method get_metaData [line 271]

    +

    method get_metaData [line 277]

    @@ -821,14 +817,12 @@ Overrides baseModul

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 431]

    +

    method get_pdfEntries [line 437]

    @@ -849,32 +843,38 @@ Overrides baseModule::ge

    - -

    -

    method init [line 441]

    +

    method init [line 447]

    void init( -mixed + $base)

    This functin will be called when the module will be loaded *



    - -Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

    - + Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

    +

    Parameters:

    +
    + + + + + + +
      $base  
    +

    [ Top ]

    -

    method load_Messages [line 451]

    +

    method load_Messages [line 457]

    @@ -885,14 +885,12 @@ Overrides baseModule::init() This function fills the $messages variable with output messages from this module.



    - -Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method module_complete [line 476]

    +

    method module_complete [line 482]

    @@ -912,14 +910,12 @@ Overrides baseModule::l

    - -Overrides
    baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    - + Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    [ Top ]

    -

    method process_attributes [line 513]

    +

    method process_attributes [line 519]

    @@ -940,13 +936,11 @@ Overrides baseModule:

    - -

    -

    method process_password [line 659]

    +

    method process_password [line 665]

    @@ -967,13 +961,11 @@ Overrides baseModule:

    - -

    -

    method process_user [line 640]

    +

    method process_user [line 646]

    diff --git a/lam-web/developers/phpdoc/modules/quota.html b/lam-web/developers/phpdoc/modules/quota.html index a9ec58e0..3459bb8c 100644 --- a/lam-web/developers/phpdoc/modules/quota.html +++ b/lam-web/developers/phpdoc/modules/quota.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -994,26 +986,31 @@ Overrides baseModule:

    - -

    -

    method save_attributes [line 681]

    +

    method save_attributes [line 690]

    - void save_attributes( + array save_attributes( )

    -

    - - -Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    + 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.)

    [ Top ]

    @@ -1021,7 +1018,7 @@ Overrides baseModule:
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/quota.inc

    - - @@ -173,7 +172,6 @@ Source Location: /lib/modules/quota.inc

    -
    @@ -135,33 +141,26 @@ Source Location: /lib/modules/quota.inc

    -

    Variables

    - -

    Methods

    Inherited Variables

    @@ -181,50 +179,37 @@ Source Location: /lib/modules/quota.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -239,266 +224,282 @@ Source Location: /lib/modules/quota.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -517,26 +518,6 @@ Source Location: /lib/modules/quota.inc

    Manages quotas for users and groups.



    [ Top ]

    -
    - -

    Class Variables

    -
    - -

    -

    $quota =

    -

    [line 172]

    - -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    -


    @@ -545,7 +526,7 @@ Manages quotas for users and groups.




    -

    method check_profileOptions [line 395]

    +

    method check_profileOptions [line 473]

    @@ -566,9 +547,7 @@ $options)

    - -Overrides baseModule::check_profileOptions() (Checks input values of account profiles.)

    - + Overrides baseModule::check_profileOptions() (Checks input values of account profiles.)

    Parameters:

    @@ -581,45 +560,34 @@ Overrides baseMo
    -
    - -

    method delete_attributes [line 257]

    -
    -
    -
    - void delete_attributes( -) -
    -

    - -

    - - -Overrides baseModule::delete_attributes() (Dummy function for modules which use no special options on account deletion.)

    - -
    [ Top ]
    -

    -

    method display_html_attributes [line 308]

    +

    method display_html_attributes [line 333]

    - void display_html_attributes( + array display_html_attributes( )

    -

    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    -

    method doUploadPostActions [line 510]

    +

    method doUploadPostActions [line 627]

    @@ -627,8 +595,9 @@ Overrides baseModul array $data, array $ids, array -$failed, array -&$temp) +$failed, +&$temp, array +$temp)

    @@ -643,9 +612,7 @@ $failed, array


    - -Overrides baseModule::doUploadPostActions() (This function executes one post upload action.)

    - + Overrides baseModule::doUploadPostActions() (This function executes one post upload action.)

    Parameters:

    @@ -668,6 +635,11 @@ Overrides baseMod + + + + +
    array   $temp   variable to store temporary data between two post actions
      &$temp  

    @@ -695,14 +667,12 @@ Overrides
    baseMod

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 437]

    +

    method get_pdfEntries [line 529]

    @@ -723,13 +693,11 @@ Overrides baseModule::ge

    - -

    -

    method get_profileOptions [line 352]

    +

    method get_profileOptions [line 416]

    @@ -749,14 +717,12 @@ Overrides baseModule::ge

    - -Overrides
    baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

    - + Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

    [ Top ]

    -

    method get_uploadColumns [line 476]

    +

    method get_uploadColumns [line 583]

    @@ -776,47 +742,23 @@ Overrides baseModu

    - -Overrides
    baseModule::get_uploadColumns() (Returns an array containing all input columns for the file upload.)

    - + Overrides baseModule::get_uploadColumns() (Returns an array containing all input columns for the file upload.)

    [ Top ]

    - -

    method init [line 130]

    + +

    method initQuotas [line 150]

    - void init( -mixed -$base) + void initQuotas( +)

    -

    + Initializes the quota values.



    -Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

    - -
    [ Top ]
    -
    -
    - -

    method load_attributes [line 191]

    -
    -
    -
    - void load_attributes( -mixed -$attr) -
    -

    - -

    - - -Overrides baseModule::load_attributes() (This function loads the LDAP attributes for this module.)

    -
    [ Top ]

    @@ -832,14 +774,12 @@ Overrides baseModule: this functin fills the error message array with messages



    - -Overrides
    baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method load_profile [line 422]

    +

    method load_profile [line 507]

    @@ -851,9 +791,7 @@ $profile) Loads the values of an account profile into internal variables.



    - -Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)

    - + Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)

    Parameters:

    @@ -867,44 +805,85 @@ Overrides baseModule::lo
    - -

    method module_complete [line 183]

    + +

    method module_ready [line 189]

    - void module_complete( + boolean module_ready( )

    -

    - - -Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    + This function is used to check if this module page can be displayed.

    It returns false if a module depends on data from other modules which was not yet entered.




    +

    Tags:

    +
    + + + + +
    return:  true, if page can be displayed
    +
    +

    + Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)

    [ Top ]

    - -

    method module_ready [line 174]

    + +

    method postModifyActions [line 206]

    - void module_ready( + void postModifyActions( +boolean +$newAccount) +
    +

    + + Allows the module to run commands after the LDAP entry is changed or created.



    + + Overrides baseModule::postModifyActions() (Allows the module to run commands after the LDAP entry is changed or created.)

    +

    Parameters:

    +
    + + + + + + +
    boolean  $newAccount  new account
    +

    +
    [ Top ]
    +
    +
    + +

    method preDeleteActions [line 245]

    +
    +
    +
    + true, preDeleteActions( )

    -

    - - -Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)

    + Allows the module to run commands before the LDAP entry is deleted.

    An error message should be printed if the function returns false.




    +

    Tags:

    +
    + + + + +
    return:  if no problems occured
    +
    +

    + Overrides baseModule::preDeleteActions() (Allows the module to run commands before the LDAP entry is deleted.)

    [ Top ]

    -

    method process_attributes [line 276]

    +

    method process_attributes [line 286]

    diff --git a/lam-web/developers/phpdoc/modules/samba3domain.html b/lam-web/developers/phpdoc/modules/samba3domain.html index 97576e34..61c4d0bf 100644 --- a/lam-web/developers/phpdoc/modules/samba3domain.html +++ b/lam-web/developers/phpdoc/modules/samba3domain.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -925,26 +904,42 @@ Overrides baseModule::mo

    - -

    - -

    method save_attributes [line 231]

    + +

    method replaceSpecialChars [line 406]

    - void save_attributes( -) + string replaceSpecialChars( +string +$input)

    -

    + Replaces special characters in HTML name values.



    +

    Tags:

    +
    + + + + +
    return:  output string
    +
    +

    -Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    - +

    Parameters:

    +
    + + + + + + +
    string  $input  input string
    +

    [ Top ]

    @@ -952,7 +947,7 @@ Overrides baseModule:
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    diff --git a/lam-web/developers/phpdoc/modules/sambaAccount.html b/lam-web/developers/phpdoc/modules/sambaAccount.html index 4e70b822..a0775435 100644 --- a/lam-web/developers/phpdoc/modules/sambaAccount.html +++ b/lam-web/developers/phpdoc/modules/sambaAccount.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -117,7 +124,6 @@ Source Location: /lib/account.inc

    -
    @@ -158,14 +164,13 @@ Source Location: /lib/account.inc

    -

    Class Details

    -[line 433]
    +[line 335]
    Represents a Samba 3 domain entry



    [ Top ]

    @@ -176,8 +181,17 @@ Represents a Samba 3 domain entry



    $dn =

    -

    [line 436]

    - DN

    +

    [line 338]

    + DN



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    +
    @@ -191,8 +205,17 @@ Represents a Samba 3 domain entry



    $name =

    -

    [line 439]

    - Domain name

    +

    [line 341]

    + Domain name



    +

    Tags:

    +
    +
    + + + +
    access:  public
    +
    +
    @@ -206,8 +229,17 @@ Represents a Samba 3 domain entry



    $nextGroupRID =

    -

    [line 451]

    - Next group RID

    +

    [line 353]

    + Next group RID



    +

    Tags:

    +
    +
    + + + +
    access:  public
    +
    +
    @@ -221,8 +253,17 @@ Represents a Samba 3 domain entry



    $nextRID =

    -

    [line 445]

    - Next RID

    +

    [line 347]

    + Next RID



    +

    Tags:

    +
    +
    + + + +
    access:  public
    +
    +
    @@ -236,8 +277,17 @@ Represents a Samba 3 domain entry



    $nextUserRID =

    -

    [line 448]

    - Next user RID

    +

    [line 350]

    + Next user RID



    +

    Tags:

    +
    +
    + + + +
    access:  public
    +
    +
    @@ -251,8 +301,17 @@ Represents a Samba 3 domain entry



    $RIDbase =  1000

    -

    [line 454]

    - RID base to calculate RIDs, default 1000

    +

    [line 356]

    + RID base to calculate RIDs, default 1000



    +

    Tags:

    +
    +
    + + + +
    access:  public
    +
    +
    @@ -266,8 +325,17 @@ Represents a Samba 3 domain entry



    $SID =

    -

    [line 442]

    - Domain SID

    +

    [line 344]

    + Domain SID



    +

    Tags:

    +
    +
    + + + +
    access:  public
    +
    +
    @@ -284,7 +352,7 @@ Represents a Samba 3 domain entry




    - Documentation generated on Wed, 15 Nov 2006 18:00:35 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:37 +0100 by phpDocumentor 1.4.0
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/sambaAccount.inc

    - -
    @@ -135,16 +141,6 @@ Source Location: /lib/modules/sambaAccount.inc

    -

    Variables

    - -
    @@ -176,7 +172,6 @@ Source Location: /lib/modules/sambaAccount.inc

    -

    Inherited Variables

    @@ -184,50 +179,37 @@ Source Location: /lib/modules/sambaAccount.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -242,266 +224,282 @@ Source Location: /lib/modules/sambaAccount.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -520,86 +518,6 @@ Source Location: /lib/modules/sambaAccount.inc

    Manages the object class "sambaAccount" for users and hosts.



    [ Top ]

    -
    - -

    Class Variables

    -
    - -

    -

    $deactivated =

    -

    [line 433]

    - account deactivated?

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $noexpire =

    -

    [line 431]

    - password does not expire?

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $nopwd =

    -

    [line 429]

    - use no password?

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $rids =

    -

    [line 436]

    - Array of well known rids

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $useunixpwd =

    -

    [line 427]

    - use Unix password as samba password?

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    -


    @@ -621,8 +539,6 @@ $scope) Creates a new sambaAccount object.



    - -

    Parameters:

    @@ -637,15 +553,16 @@ $scope)
    -

    method build_uploadAccounts [line 872]

    +

    method build_uploadAccounts [line 905]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -660,9 +577,7 @@ $ids, array


    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -680,6 +595,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -687,38 +607,52 @@ Overrides
    baseMo
    -

    method display_html_attributes [line 696]

    +

    method display_html_attributes [line 722]

    - void display_html_attributes( + array display_html_attributes( )

    -

    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    -

    method display_html_userWorkstations [line 819]

    +

    method display_html_userWorkstations [line 852]

    - void display_html_userWorkstations( + array display_html_userWorkstations( )

    -

    + This function will create the HTML page to edit the allowed workstations.



    +

    Tags:

    +
    + + + + +
    return:  meta HTML code
    +
    +

    - -
    [ Top ]

    @@ -743,14 +677,12 @@ Overrides baseMo

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 853]

    +

    method get_pdfEntries [line 886]

    @@ -771,8 +703,6 @@ Overrides baseModule::ge

    - -

    @@ -789,9 +719,7 @@ $base) Initializes the module after it became part of an accountContainer



    - -Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

    - + Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

    Parameters:

    @@ -806,21 +734,35 @@ Overrides baseModule::init()
    -

    method load_attributes [line 458]

    +

    method load_attributes [line 467]

    void load_attributes( -mixed -$attr) + +$attr, array +$attributes)

    -

    - - -Overrides baseModule::load_attributes() (This function loads the LDAP attributes for this module.)

    + This function loads the LDAP attributes for this module.



    + Overrides baseModule::load_attributes() (This function loads the LDAP attributes for this module.)

    +

    Parameters:

    +
    + + + + + + + + + + + +
    array  $attributes  attribute list
      $attr  
    +

    [ Top ]

    @@ -836,14 +778,12 @@ Overrides baseModule: this functin fills the error message array with messages



    - -Overrides
    baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method load_profile [line 1122]

    +

    method load_profile [line 1155]

    @@ -855,9 +795,7 @@ $profile) Loads the values of an account profile into internal variables.



    - -Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)

    - + Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)

    Parameters:

    @@ -872,7 +810,7 @@ Overrides baseModule::lo
    -

    method module_complete [line 449]

    +

    method module_complete [line 456]

    @@ -892,32 +830,37 @@ Overrides baseModule::lo

    - -Overrides
    baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    - + Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    [ Top ]

    -

    method module_ready [line 438]

    +

    method module_ready [line 444]

    - void module_ready( + boolean module_ready( )

    -

    - - -Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)

    + This function is used to check if this module page can be displayed.

    It returns false if a module depends on data from other modules which was not yet entered.




    +

    Tags:

    +
    + + + + +
    return:  true, if page can be displayed
    +
    +

    + Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)

    [ Top ]

    -

    method process_attributes [line 504]

    +

    method process_attributes [line 522]

    @@ -938,13 +881,11 @@ Overrides baseModule::mo

    - -

    -

    method process_userWorkstations [line 648]

    +

    method process_userWorkstations [line 673]

    diff --git a/lam-web/developers/phpdoc/modules/sambaDomain.html b/lam-web/developers/phpdoc/modules/sambaDomain.html index 45cf445b..5a4d5431 100644 --- a/lam-web/developers/phpdoc/modules/sambaDomain.html +++ b/lam-web/developers/phpdoc/modules/sambaDomain.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -965,26 +906,31 @@ Overrides baseModule::mo

    - -

    -

    method save_attributes [line 478]

    +

    method save_attributes [line 490]

    - void save_attributes( + array save_attributes( )

    -

    - - -Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    + 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.)

    [ Top ]

    @@ -992,7 +938,7 @@ Overrides baseModule:
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/sambaDomain.inc

    -
    @@ -157,7 +163,6 @@ Source Location: /lib/modules/sambaDomain.inc

    -

    Inherited Variables

    @@ -165,50 +170,37 @@ Source Location: /lib/modules/sambaDomain.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -223,266 +215,282 @@ Source Location: /lib/modules/sambaDomain.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -509,15 +517,16 @@ Manages Samba 3 domain entries.




    -

    method build_uploadAccounts [line 501]

    +

    method build_uploadAccounts [line 547]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -532,9 +541,7 @@ $ids, array


    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -552,6 +559,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -559,20 +571,27 @@ Overrides
    baseMo
    -

    method display_html_attributes [line 206]

    +

    method display_html_attributes [line 209]

    - void display_html_attributes( + array display_html_attributes( )

    - This function will create the meta HTML code to show a page with all attributes.



    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    @@ -597,14 +616,12 @@ Overrides baseMo

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 580]

    +

    method get_pdfEntries [line 626]

    @@ -625,8 +642,6 @@ Overrides baseModule::ge

    - -

    @@ -642,14 +657,12 @@ Overrides baseModule::ge This function fills the error message array with messages



    - -Overrides
    baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method process_attributes [line 350]

    +

    method process_attributes [line 391]

    diff --git a/lam-web/developers/phpdoc/modules/sambaGroupMapping.html b/lam-web/developers/phpdoc/modules/sambaGroupMapping.html index 605e9000..d03a6e6f 100644 --- a/lam-web/developers/phpdoc/modules/sambaGroupMapping.html +++ b/lam-web/developers/phpdoc/modules/sambaGroupMapping.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -670,8 +683,6 @@ Overrides baseModule::l

    - -

    @@ -679,7 +690,7 @@ Overrides baseModule::l
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/sambaGroupMapping.inc

    - -
    @@ -135,13 +141,6 @@ Source Location: /lib/modules/sambaGroupMapping.inc

    -

    Variables

    - -
    @@ -171,7 +170,6 @@ Source Location: /lib/modules/sambaGroupMapping.inc

    -

    Inherited Variables

    @@ -179,50 +177,37 @@ Source Location: /lib/modules/sambaGroupMapping.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -237,266 +222,282 @@ Source Location: /lib/modules/sambaGroupMapping.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -515,41 +516,6 @@ Source Location: /lib/modules/sambaGroupMapping.inc

    Manages the object class "sambaGroupMapping" for groups.



    [ Top ]

    -
    - -

    Class Variables

    -
    - -

    -

    $rids =

    -

    [line 43]

    - Array of well known RIDs

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $sambaGroupTypes =

    -

    [line 45]

    - Array of sambaGroupTypes

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    -


    @@ -571,8 +537,6 @@ $scope) Creates a new module for Samba 3 groups.



    - -

    Parameters:

    @@ -594,8 +558,9 @@ $scope)array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -610,9 +575,7 @@ $ids, array

    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -630,6 +593,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -637,25 +605,32 @@ Overrides
    baseMo
    -

    method display_html_attributes [line 170]

    +

    method display_html_attributes [line 171]

    - void display_html_attributes( + array display_html_attributes( )

    -

    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    -

    method get_metaData [line 232]

    +

    method get_metaData [line 238]

    @@ -675,14 +650,12 @@ Overrides baseMo

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 322]

    +

    method get_pdfEntries [line 328]

    @@ -703,13 +676,11 @@ Overrides baseModule::ge

    - -

    -

    method get_profileOptions [line 336]

    +

    method get_profileOptions [line 342]

    @@ -729,9 +700,7 @@ Overrides baseModule::ge

    - -Overrides
    baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

    - + Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

    [ Top ]

    @@ -748,9 +717,7 @@ $base) Initializes the module after it became part of an accountContainer



    - -Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

    - + Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

    Parameters:

    @@ -765,7 +732,7 @@ Overrides baseModule::init()
    -

    method load_Messages [line 374]

    +

    method load_Messages [line 380]

    @@ -776,14 +743,12 @@ Overrides baseModule::init() this functin fills the error message array with messages



    - -Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method load_profile [line 359]

    +

    method load_profile [line 365]

    @@ -24,8 +26,8 @@
    @@ -795,9 +760,7 @@ $profile) Loads the values of an account profile into internal variables.



    - -Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)

    - + Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)

    Parameters:

    @@ -812,43 +775,57 @@ Overrides baseModule::lo
    -

    method module_complete [line 384]

    +

    method module_complete [line 392]

    - void module_complete( + boolean module_complete( )

    -

    - - -Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    + This functions is used to check if all settings for this module have been made.



    +

    Tags:

    +
    + + + + +
    return:  true, if settings are complete
    +
    +

    + Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    [ Top ]

    -

    method module_ready [line 392]

    +

    method module_ready [line 406]

    - void module_ready( + boolean module_ready( )

    -

    - - -Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)

    + This function is used to check if this module page can be displayed.

    It returns false if a module depends on data from other modules which was not yet entered.




    +

    Tags:

    +
    + + + + +
    return:  true, if page can be displayed
    +
    +

    + Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)

    [ Top ]

    -

    method process_attributes [line 404]

    +

    method process_attributes [line 419]

    diff --git a/lam-web/developers/phpdoc/modules/sambaMungedDial.html b/lam-web/developers/phpdoc/modules/sambaMungedDial.html new file mode 100644 index 00000000..1eef5939 --- /dev/null +++ b/lam-web/developers/phpdoc/modules/sambaMungedDial.html @@ -0,0 +1,1138 @@ + + +Docs For Class sambaMungedDial + + + + +
    @@ -869,26 +846,31 @@ Overrides baseModule::mo

    - -

    -

    method save_attributes [line 455]

    +

    method save_attributes [line 476]

    - void save_attributes( + array save_attributes( )

    -

    - - -Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    + 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.)

    [ Top ]

    @@ -896,7 +878,7 @@ Overrides baseModule:
    + + + + + + + + +
    modules
    + + + [ class tree: modules ] + [ index: modules ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Class: sambaMungedDial

    +Source Location: /lib/modules/sambaSamAccount/sambaMungedDial.inc

    + + + + + + + + + + +
    + +

    Class Overview

    +

    +
    Manages terminal server settings for Samba 3.


    +

    Author(s):

    +
      +
    • Cajus Pollmeier
    • +
    + + + + + + + +
    +

    Variables

    + +
    +

    Methods

    + +
    +
    + + + + + + + + +
    +
    + + +

    Class Details

    +
    +[line 57]
    +Manages terminal server settings for Samba 3.



    +

    Tags:

    +
    + + + + +
    author:  Cajus Pollmeier
    +
    +


    +
    [ Top ]

    + +
    + +

    Class Variables

    +
    + +

    +

    $ctx = array(
    +     'CtxCfgPresent' =>              '551e0bb0',
    +     'CtxCfgFlags1' =>                '00e00010',
    +     'CtxCallback' =>                '',
    +     'CtxShadow' =>                   '01000000',
    +     'CtxMaxConnectionTime' =>      '',
    +     'CtxMaxDisconnectionTime' =>   '',
    +     'CtxMaxIdleTime' =>             '',
    +     'CtxKeyboardLayout' =>           '',
    +     'CtxMinEncryptionLevel' =>     '00',
    +     'CtxWorkDirectory' =>            '',
    +     'CtxNWLogonServer' =>            '',  
    +     'CtxWFHomeDir' =>                 '',
    +     'CtxWFHomeDirDrive' =>          '',
    +     'CtxWFProfilePath' =>            '',
    +     'CtxInitialProgram' =>           '',
    +     'CtxCallbackNumber' =>          '')

    +

    [line 60]

    +

    +

    Tags:

    +
    + + + + +
    access:  public
    +
    + +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    + +

    +

    $ctxattributes = array("CtxCfgPresent", "CtxCfgFlags1", "CtxCallback",
    +        "CtxShadow", "CtxMaxConnectionTime", "CtxMaxDisconnectionTime",
    +        "CtxMaxIdleTime", "CtxKeyboardLayout", "CtxMinEncryptionLevel",
    +        "CtxWorkDirectory", "CtxNWLogonServer", "CtxWFHomeDir",
    +        "CtxWFHomeDirDrive", "CtxWFProfilePath", "CtxInitialProgram",
    +        "CtxCallbackNumber")

    +

    [line 79]

    +

    +

    Tags:

    +
    + + + + +
    access:  public
    +
    + +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    +

    + +
    + +

    Class Methods

    +
    + +
    + +

    method decode_munged [line 250]

    +
    +
    +
    + void decode_munged( + +$munge) +
    +

    + + Takes a base64-encoded MungedDial-String and returns an array of included parameters and values



    + + +

    Parameters:

    +
    + + + + + + +
      $munge  
    +

    +
    [ Top ]
    +
    +
    + +

    method encode_munged [line 176]

    +
    +
    +
    + void encode_munged( + +$params) +
    +

    + + Encode full MungedDial-String



    + + +

    Parameters:

    +
    + + + + + + +
      $params  
    +

    +
    [ Top ]
    +
    +
    + +

    method endian [line 121]

    +
    +
    +
    + void endian( + +$src) +
    +

    + + endian



    + + +

    Parameters:

    +
    + + + + + + +
      $src  
    +

    +
    [ Top ]
    +
    +
    + +

    method genTime [line 127]

    +
    +
    +
    + void genTime( + +$minutes) +
    +

    + + genTime



    + + +

    Parameters:

    +
    + + + + + + +
      $minutes  
    +

    +
    [ Top ]
    +
    +
    + +

    method getBrokenConn [line 383]

    +
    +
    +
    + void getBrokenConn( +) +
    +

    + + gets Broken-Connection value: disconnect/reset



    + + +
    [ Top ]
    +
    +
    + +

    method getConnectClientDrives [line 488]

    +
    +
    +
    + void getConnectClientDrives( +) +
    +

    + + gets connect-client-drive-at-logon value: enabled/disabled



    + + +
    [ Top ]
    +
    +
    + +

    method getConnectClientPrinters [line 514]

    +
    +
    +
    + void getConnectClientPrinters( +) +
    +

    + + gets connect-client-printers-at-logon value: enabled/disabled



    + + +
    [ Top ]
    +
    +
    + +

    method getCtxMaxConnectionTimeF [line 568]

    +
    +
    +
    + void getCtxMaxConnectionTimeF( +) +
    +

    + + SMARTY: gets the checkbox state of "Connection"



    + + +
    [ Top ]
    +
    +
    + +

    method getCtxMaxDisconnectionTimeF [line 589]

    +
    +
    +
    + void getCtxMaxDisconnectionTimeF( +) +
    +

    + + SMARTY: gets the checkbox state of "Disconnection"



    + + +
    [ Top ]
    +
    +
    + +

    method getCtxMaxIdleTimeF [line 610]

    +
    +
    +
    + void getCtxMaxIdleTimeF( +) +
    +

    + + SMARTY: gets the checkbox state of "Idle"



    + + +
    [ Top ]
    +
    +
    + +

    method getDefaultPrinter [line 541]

    +
    +
    +
    + void getDefaultPrinter( +) +
    +

    + + gets set-client-printer-to-default value: enabled/disabled



    + + +
    [ Top ]
    +
    +
    + +

    method getInheritMode [line 437]

    +
    +
    +
    + void getInheritMode( +) +
    +

    + + gets Inherit-config-from-client value: enabled/disabled



    + + +
    [ Top ]
    +
    +
    + +

    method getMunged [line 311]

    +
    +
    +
    + void getMunged( +) +
    +

    + + Returns ready-to-run mungedDialString to be filled into ldap



    + + +
    [ Top ]
    +
    +
    + +

    method getOnDemandFlags [line 325]

    +
    +
    +
    + void getOnDemandFlags( +) +
    +

    + + Returns array of flags, which can be set on-demand with activated java-script



    + + +
    [ Top ]
    +
    +
    + +

    method getReConn [line 410]

    +
    +
    +
    + void getReConn( +) +
    +

    + + gets Reconnection value: from any client/from previous client only



    + + +
    [ Top ]
    +
    +
    + +

    method getShadow [line 465]

    +
    +
    +
    + void getShadow( +) +
    +

    + + gets shadow value (enum): 0-4



    + + +
    [ Top ]
    +
    +
    + +

    method getTsLogin [line 355]

    +
    +
    +
    + void getTsLogin( +) +
    +

    + + Gets Terminal-Server-Login value: enabled/disabled



    + + +
    [ Top ]
    +
    +
    + +

    method hexstr [line 109]

    +
    +
    +
    + void hexstr( + +$hex) +
    +

    + + hexstr



    + + +

    Parameters:

    +
    + + + + + + +
      $hex  
    +

    +
    [ Top ]
    +
    +
    + +

    method is_samba_path [line 162]

    +
    +
    +
    + void is_samba_path( + +$path) +
    +

    + + Checks if this is a valid Samba path.



    + + +

    Parameters:

    +
    + + + + + + +
      $path  
    +

    +
    [ Top ]
    +
    +
    + +

    method load [line 305]

    +
    +
    +
    + void load( + +$mungedDial) +
    +

    + + function takes a base64-encoded sambaMungedDial



    + + +

    Parameters:

    +
    + + + + + + +
      $mungedDial  
    +

    +
    [ Top ]
    +
    +
    + +

    method munge [line 212]

    +
    +
    +
    + void munge( + +$paramName, +$paramValue, +$isString) +
    +

    + + Setup parameter given by paramName to MungedDial-Format



    + + +

    Parameters:

    +
    + + + + + + + + + + + + + + + + +
      $paramName  
      $paramValue  
      $isString  
    +

    +
    [ Top ]
    +
    +
    + +

    method readTime [line 135]

    +
    +
    +
    + void readTime( + +$time) +
    +

    + + readTime



    + + +

    Parameters:

    +
    + + + + + + +
      $time  
    +

    +
    [ Top ]
    +
    +
    + +

    method setBrokenConn [line 396]

    +
    +
    +
    + void setBrokenConn( + +$checked) +
    +

    + + sets Broken-Connection value: disconnect/reset



    + + +

    Parameters:

    +
    + + + + + + +
      $checked  
    +

    +
    [ Top ]
    +
    +
    + +

    method setConnectClientDrives [line 501]

    +
    +
    +
    + void setConnectClientDrives( + +$checked) +
    +

    + + sets connect-client-drive-at-logon value: enabled/disabled



    + + +

    Parameters:

    +
    + + + + + + +
      $checked  
    +

    +
    [ Top ]
    +
    +
    + +

    method setConnectClientPrinters [line 527]

    +
    +
    +
    + void setConnectClientPrinters( + +$checked) +
    +

    + + sets connect-client-printers-at-logon value: enabled/disabled



    + + +

    Parameters:

    +
    + + + + + + +
      $checked  
    +

    +
    [ Top ]
    +
    +
    + +

    method setCtxMaxConnectionTimeF [line 581]

    +
    +
    +
    + void setCtxMaxConnectionTimeF( + +$checked) +
    +

    + + SMARTY: sets the checkbox "Connection" to unchecked



    + + +

    Parameters:

    +
    + + + + + + +
      $checked  
    +

    +
    [ Top ]
    +
    +
    + +

    method setCtxMaxDisconnectionTimeF [line 602]

    +
    +
    +
    + void setCtxMaxDisconnectionTimeF( + +$checked) +
    +

    + + SMARTY: sets the checkbox "Disconnection" to unchecked



    + + +

    Parameters:

    +
    + + + + + + +
      $checked  
    +

    +
    [ Top ]
    +
    +
    + +

    method setCtxMaxIdleTimeF [line 623]

    +
    +
    +
    + void setCtxMaxIdleTimeF( + +$checked) +
    +

    + + SMARTY: sets the checkbox "Idle" to unchecked



    + + +

    Parameters:

    +
    + + + + + + +
      $checked  
    +

    +
    [ Top ]
    +
    +
    + +

    method setDefaultPrinter [line 554]

    +
    +
    +
    + void setDefaultPrinter( + +$checked) +
    +

    + + sets set-client-printer-to-default value: enabled/disabled



    + + +

    Parameters:

    +
    + + + + + + +
      $checked  
    +

    +
    [ Top ]
    +
    +
    + +

    method setInheritMode [line 449]

    +
    +
    +
    + void setInheritMode( + +$checked) +
    +

    + + sets Inherit-config-from-client value: enabled/disabled



    + + +

    Parameters:

    +
    + + + + + + +
      $checked  
    +

    +
    [ Top ]
    +
    +
    + +

    method setReConn [line 423]

    +
    +
    +
    + void setReConn( + +$checked) +
    +

    + + sets Reconnection value: from any client/from previous client only



    + + +

    Parameters:

    +
    + + + + + + +
      $checked  
    +

    +
    [ Top ]
    +
    +
    + +

    method setShadow [line 476]

    +
    +
    +
    + void setShadow( + +$checked, +$value) +
    +

    + + sets shadow value



    + + +

    Parameters:

    +
    + + + + + + + + + + + +
      $checked  
      $value  
    +

    +
    [ Top ]
    +
    +
    + +

    method setTsLogin [line 369]

    +
    +
    +
    + void setTsLogin( + +$checked) +
    +

    + + Sets Terminal-Server-Login value: enabled/disabled



    + + +

    Parameters:

    +
    + + + + + + +
      $checked  
    +

    +
    [ Top ]
    +
    +
    + +

    method strhex [line 97]

    +
    +
    +
    + void strhex( + +$string) +
    +

    + + strhex



    + + +

    Parameters:

    +
    + + + + + + +
      $string  
    +

    +
    [ Top ]
    +
    +
    + +

    method to8bit [line 147]

    +
    +
    +
    + void to8bit( + +$string) +
    +

    + + to8bit



    + + +

    Parameters:

    +
    + + + + + + +
      $string  
    +

    +
    [ Top ]
    +
    +

    + + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:05 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/sambaSamAccount.html b/lam-web/developers/phpdoc/modules/sambaSamAccount.html index c5e0f6ad..98d11db7 100644 --- a/lam-web/developers/phpdoc/modules/sambaSamAccount.html +++ b/lam-web/developers/phpdoc/modules/sambaSamAccount.html @@ -12,9 +12,11 @@
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/sambaSamAccount.inc

    - -
    @@ -135,17 +141,6 @@ Source Location: /lib/modules/sambaSamAccount.inc

    -

    Variables

    - -
    @@ -157,6 +152,7 @@ Source Location: /lib/modules/sambaSamAccount.inc

  • display_html_attributes
  • display_html_logonHours
  • display_html_sambaUserWorkstations
  • +
  • display_html_terminalServer
  • display_html_time
  • get_metaData
  • get_pdfEntries
  • @@ -165,11 +161,11 @@ Source Location: /lib/modules/sambaSamAccount.inc

  • load_attributes
  • load_Messages
  • load_profile
  • -
  • module_complete
  • module_ready
  • process_attributes
  • process_logonHours
  • process_sambaUserWorkstations
  • +
  • process_terminalServer
  • process_time
  • save_attributes
  • @@ -183,7 +179,6 @@ Source Location: /lib/modules/sambaSamAccount.inc

    -

    Inherited Variables

    @@ -191,50 +186,37 @@ Source Location: /lib/modules/sambaSamAccount.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -249,266 +231,282 @@ Source Location: /lib/modules/sambaSamAccount.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -523,107 +521,10 @@ Source Location: /lib/modules/sambaSamAccount.inc

    Class Details

    -[line 38]
    +[line 42]
    Manages the object class "sambaSamAccount" for users and hosts.



    [ Top ]

    -
    - -

    Class Variables

    -
    - -

    -

    $deactivated =

    -

    [line 48]

    - account deactivated?

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $hex2bitstring = array('0' => '0000', '1' => '0001', '2' => '0010', '3' => '0011', '4' => '0100',
    -      '5' => '0101', '6' => '0110', '7' => '0111', '8' => '1000', '9' => '1001', 'A' => '1010',
    -      'B' => '1011', 'C' => '1100', 'D' => '1101', 'E' => '1110', 'F' => '1111')

    -

    [line 52]

    - HEX to binary conversion table

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $noexpire =

    -

    [line 46]

    - password does not expire?

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $nopwd =

    -

    [line 44]

    - use no password?

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $rids =

    -

    [line 50]

    - array of well known rids

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    - -

    -

    $useunixpwd =

    -

    [line 42]

    - use Unix password as samba password?

    -
    -
    - - - - - -
    Type:  mixed
    -


    -
    [ Top ]

    -


    @@ -632,7 +533,7 @@ Manages the object class "sambaSamAccount" for users and hosts.
    <
    -

    constructor sambaSamAccount [line 62]

    +

    constructor sambaSamAccount [line 66]

    @@ -645,8 +546,6 @@ $scope) Creates a new sambaSamAccount object.



    - -

    Parameters:

    @@ -661,15 +560,16 @@ $scope)
    -

    method build_uploadAccounts [line 1392]

    +

    method build_uploadAccounts [line 1765]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -684,9 +584,7 @@ $ids, array


    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -704,6 +602,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -711,7 +614,7 @@ Overrides
    baseMo
    -

    method checkSelfServiceOptions [line 1726]

    +

    method checkSelfServiceOptions [line 2099]

    @@ -733,9 +636,7 @@ $attributes)

    - -Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP commands which should be executed.)

    - + Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP commands which should be executed.)

    Parameters:

    @@ -755,25 +656,32 @@ Overrides bas
    -

    method display_html_attributes [line 828]

    +

    method display_html_attributes [line 938]

    - void display_html_attributes( + array display_html_attributes( )

    -

    + Returns the HTML meta data for the main account page.



    +

    Tags:

    +
    + + + + +
    return:  HTML meta data
    +
    +

    - -
    [ Top ]

    -

    method display_html_logonHours [line 1042]

    +

    method display_html_logonHours [line 1212]

    @@ -794,31 +702,61 @@ Overrides bas

    - -

    -

    method display_html_sambaUserWorkstations [line 1008]

    +

    method display_html_sambaUserWorkstations [line 1178]

    - void display_html_sambaUserWorkstations( + array display_html_sambaUserWorkstations( )

    -

    + This function will create the HTML page to edit the allowed workstations.



    +

    Tags:

    +
    + + + + +
    return:  meta HTML code
    +
    +

    +
    [ Top ]
    +
    +
    + +

    method display_html_terminalServer [line 1325]

    +
    +
    +
    + array display_html_terminalServer( +) +
    +

    + + This function will create the HTML page to edit the terminal server options.



    +

    Tags:

    +
    + + + + +
    return:  meta HTML code
    +
    +

    - +
    [ Top ]

    -

    method display_html_time [line 1105]

    +

    method display_html_time [line 1275]

    @@ -839,13 +777,11 @@ Overrides bas

    - -

    -

    method get_metaData [line 113]

    +

    method get_metaData [line 117]

    @@ -865,14 +801,12 @@ Overrides bas

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 1373]

    +

    method get_pdfEntries [line 1663]

    @@ -893,13 +827,11 @@ Overrides baseModule::ge

    - -

    -

    method get_profileOptions [line 1156]

    +

    method get_profileOptions [line 1446]

    @@ -919,14 +851,12 @@ Overrides baseModule::ge

    - -Overrides
    baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

    - + Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

    [ Top ]

    -

    method init [line 462]

    +

    method init [line 511]

    @@ -938,9 +868,7 @@ $base) Initializes the module after it became part of an accountContainer



    - -Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

    - + Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

    Parameters:

    @@ -955,26 +883,40 @@ Overrides baseModule::init()
    -

    method load_attributes [line 503]

    +

    method load_attributes [line 552]

    void load_attributes( -mixed -$attr) + +$attr, array +$attributes)

    -

    - - -Overrides baseModule::load_attributes() (This function loads the LDAP attributes for this module.)

    + This function loads the LDAP attributes for this module.



    + Overrides baseModule::load_attributes() (This function loads the LDAP attributes for this module.)

    +

    Parameters:

    +
    + + + + + + + + + + + +
    array  $attributes  attribute list
      $attr  
    +

    [ Top ]

    -

    method load_Messages [line 74]

    +

    method load_Messages [line 78]

    @@ -985,14 +927,12 @@ Overrides baseModule: this functin fills the error message array with messages



    - -Overrides
    baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method load_profile [line 1281]

    +

    method load_profile [line 1571]

    @@ -1004,9 +944,7 @@ $profile) Loads the values of an account profile into internal variables.



    - -Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)

    - + Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)

    Parameters:

    @@ -1019,36 +957,9 @@ Overrides baseModule::lo
    -
    - -

    method module_complete [line 494]

    -
    -
    -
    - boolean module_complete( -) -
    -

    - - This functions is used to check if all settings for this module have been made.



    -

    Tags:

    -
    - - - - -
    return:  true, if settings are complete
    -
    -

    - - -Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

    - -
    [ Top ]
    -

    -

    method module_ready [line 482]

    +

    method module_ready [line 539]

    @@ -1068,14 +979,12 @@ Overrides baseModule:

    - -Overrides
    baseModule::module_ready() (This function is used to check if this module page can be displayed.)

    - + Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)

    [ Top ]

    -

    method process_attributes [line 551]

    +

    method process_attributes [line 619]

    @@ -1096,13 +1005,11 @@ Overrides baseModule::mo

    - -

    -

    method process_logonHours [line 762]

    +

    method process_logonHours [line 839]

    @@ -1123,13 +1030,11 @@ Overrides baseModule::mo

    - -

    -

    method process_sambaUserWorkstations [line 712]

    +

    method process_sambaUserWorkstations [line 789]

    @@ -1150,13 +1055,36 @@ Overrides baseModule::mo

    +
    + +
    + +

    method process_terminalServer [line 907]

    +
    +
    +
    + array process_terminalServer( +) +
    +

    + + Processes user input of the terminal server page.

    It checks if all input values are correct and updates the associated LDAP attributes.




    +

    Tags:

    +
    + + + + +
    return:  list of info/error messages
    +
    +

    - +
    [ Top ]

    -

    method process_time [line 788]

    +

    method process_time [line 865]

    diff --git a/lam-web/developers/phpdoc/modules/shadowAccount.html b/lam-web/developers/phpdoc/modules/shadowAccount.html index 1e7ec7d3..e4ec23ae 100644 --- a/lam-web/developers/phpdoc/modules/shadowAccount.html +++ b/lam-web/developers/phpdoc/modules/shadowAccount.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -1177,26 +1105,31 @@ Overrides baseModule::mo

    - -

    -

    method save_attributes [line 523]

    +

    method save_attributes [line 585]

    - void save_attributes( + array save_attributes( )

    -

    - - -Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    + 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.)

    [ Top ]

    @@ -1204,7 +1137,7 @@ Overrides baseModule:
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/modules/shadowAccount.inc

    -
    @@ -161,7 +167,6 @@ Source Location: /lib/modules/shadowAccount.inc

    -

    Inherited Variables

    @@ -169,50 +174,37 @@ Source Location: /lib/modules/shadowAccount.inc

    baseModule::$attributes - -
    -
    - -
    -
    - baseModule::$base - -
    +
    baseModule::$messages - -
    +
    baseModule::$meta - -
    +
    baseModule::$moduleSettings - -
    +
    baseModule::$orig - -
    +
    - baseModule::$scope - -
    + baseModule::$selfServiceSettings +
    @@ -227,266 +219,282 @@ Source Location: /lib/modules/shadowAccount.inc

    baseModule::baseModule() -
    Creates a new base module class
    baseModule::build_uploadAccounts() -
    In this function the LDAP account is built up.
    baseModule::can_manage() -
    Returns true if this module fits for the current scope.
    baseModule::checkSelfServiceOptions() -
    Checks if all input values are correct and returns the LDAP commands which should be executed. +
    +
    + baseModule::checkSelfServiceSettings() +
    +
    + Checks if the self service settings are valid.
    baseModule::check_configOptions() -
    Checks input values of module settings.
    baseModule::check_profileOptions() -
    Checks input values of account profiles.
    baseModule::delete_attributes() -
    Dummy function for modules which use no special options on account deletion.
    baseModule::display_html_delete() -
    Dummy function for modules which do not print extra HTML code on account deletion.
    baseModule::doUploadPostActions() -
    This function executes one post upload action. +
    +
    + baseModule::getAccountContainer() +
    +
    + Returns the accountContainer object. +
    +
    + baseModule::getAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module.
    baseModule::getButtonStatus() -
    Controls if the module button the account page is visible and activated.
    baseModule::getLDAPAliases() -
    Returns a list of aliases for LDAP attributes.
    baseModule::getManagedAttributes() -
    Returns a list of LDAP attributes which are managed by this module.
    baseModule::getManagedObjectClasses() -
    Returns a list of managed object classes for this module. +
    +
    + baseModule::getOriginalAttributes() +
    +
    + Returns the LDAP attributes which are managed in this module (with unchanged values).
    baseModule::getRequiredExtensions() -
    Returns a list of required PHP extensions.
    baseModule::getSelfServiceFields() -
    Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
    baseModule::getSelfServiceOptions() -
    Returns the meta HTML code for each input field.
    baseModule::getSelfServiceSearchAttributes() -
    Returns a list of possible search attributes for the self service. +
    +
    + baseModule::getSelfServiceSettings() +
    +
    + Returns a list of self service configuration settings.
    baseModule::get_alias() -
    Returns an alias name for the module.
    baseModule::get_configOptions() -
    Returns a list of elements for the configuration.
    baseModule::get_dependencies() -
    This function returns a list with all depending and conflicting modules.
    baseModule::get_help() -
    This function return the help entry array for a specific help id. Normally this->meta can be used.
    baseModule::get_ldap_filter() -
    returns an LDAP filter for the account lists
    baseModule::get_metaData() -
    Dummy function, meta data is provided by sub classes.
    baseModule::get_pdfFields() -
    Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
    baseModule::get_pdf_entries() -
    Returns a hastable with all entries that may be printed out in the PDF. The
    baseModule::get_profileOptions() -
    Returns a list of elements for the account profiles.
    baseModule::get_RDNAttributes() -
    Returns a list of possible LDAP attributes which can be used to form the RDN.
    baseModule::get_scope() -
    Returns the account type of this module (user, group, host)
    baseModule::get_uploadColumns() -
    Returns an array containing all input columns for the file upload.
    baseModule::get_uploadPreDepends() -
    Returns a list of module names which must be processed in building the account befor this module.
    baseModule::init() -
    Initializes the module after it became part of an accountContainer
    baseModule::is_base_module() -
    Returns true if this module is enough to provide a sensible account.
    baseModule::load_attributes() -
    This function loads the LDAP attributes for this module.
    baseModule::load_Messages() -
    This function fills the $messages variable with output messages from this module.
    baseModule::load_profile() -
    Loads the values of an account profile into internal variables.
    baseModule::module_complete() -
    This functions is used to check if all settings for this module have been made.
    baseModule::module_ready() -
    This function is used to check if this module page can be displayed. +
    +
    + baseModule::postDeleteActions() +
    +
    + Allows the module to run commands after the LDAP entry is deleted. +
    +
    + baseModule::postModifyActions() +
    +
    + Allows the module to run commands after the LDAP entry is changed or created. +
    +
    + baseModule::preDeleteActions() +
    +
    + Allows the module to run commands before the LDAP entry is deleted. +
    +
    + baseModule::preModifyActions() +
    +
    + Allows the module to run commands before the LDAP entry is changed or created.
    baseModule::save_attributes() -
    Returns a list of modifications which have to be made to the LDAP account. @@ -501,7 +509,7 @@ Source Location: /lib/modules/shadowAccount.inc

    Class Details

    -[line 38]
    +[line 39]
    Manages the object class "shadowAccount" for users.



    [ Top ]

    @@ -513,15 +521,16 @@ Manages the object class "shadowAccount" for users.

    <
    -

    method build_uploadAccounts [line 374]

    +

    method build_uploadAccounts [line 375]

    array build_uploadAccounts( array $rawAccounts, array -$ids, array -&$partialAccounts) +$ids, +&$partialAccounts, array +$partialAccounts)

    @@ -536,9 +545,7 @@ $ids, array


    - -Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    - + Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

    Parameters:

    @@ -556,6 +563,11 @@ Overrides baseMo + + + + +
    array   $ids   list of IDs for column position (e.g. "posixAccount_uid" => 5)
      &$partialAccounts  

    @@ -563,7 +575,7 @@ Overrides
    baseMo
    -

    method display_html_attributes [line 258]

    +

    method display_html_attributes [line 259]

    @@ -584,13 +596,11 @@ Overrides baseMo

    - -

    -

    method display_html_expire [line 324]

    +

    method display_html_expire [line 325]

    @@ -611,13 +621,11 @@ Overrides baseMo

    - -

    -

    method get_metaData [line 63]

    +

    method get_metaData [line 64]

    @@ -637,14 +645,12 @@ Overrides baseMo

    - -Overrides
    baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    - + Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

    [ Top ]

    -

    method get_pdfEntries [line 359]

    +

    method get_pdfEntries [line 360]

    @@ -665,13 +671,11 @@ Overrides baseModule::ge

    - -

    -

    method load_Messages [line 43]

    +

    method load_Messages [line 44]

    @@ -682,14 +686,12 @@ Overrides baseModule::ge This function builds up the message array.



    - -Overrides
    baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    - + Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

    [ Top ]

    -

    method load_profile [line 454]

    +

    method load_profile [line 455]

    @@ -24,8 +26,8 @@
    @@ -701,9 +703,7 @@ $profile) Loads the values of an account profile into internal variables.



    - -Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)

    - + Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)

    Parameters:

    @@ -718,7 +718,7 @@ Overrides baseModule::lo
    -

    method process_attributes [line 238]

    +

    method process_attributes [line 239]

    diff --git a/lam-web/developers/phpdoc/selfService/_lib---selfService.inc.html b/lam-web/developers/phpdoc/selfService/_lib---selfService.inc.html new file mode 100644 index 00000000..225fbad3 --- /dev/null +++ b/lam-web/developers/phpdoc/selfService/_lib---selfService.inc.html @@ -0,0 +1,450 @@ + + +Docs for page selfService.inc + + + + +
    diff --git a/lam-web/developers/phpdoc/ric_README.html b/lam-web/developers/phpdoc/ric_README.html index a8538cc6..49634fc9 100644 --- a/lam-web/developers/phpdoc/ric_README.html +++ b/lam-web/developers/phpdoc/ric_README.html @@ -12,9 +12,8 @@ @@ -24,8 +23,8 @@
    @@ -739,13 +739,11 @@ Overrides baseModule::lo

    - -

    -

    method process_expire [line 305]

    +

    method process_expire [line 306]

    @@ -24,8 +23,8 @@
    diff --git a/lam-web/developers/phpdoc/profiles/_lib---profiles.inc.html b/lam-web/developers/phpdoc/profiles/_lib---profiles.inc.html new file mode 100644 index 00000000..efd29432 --- /dev/null +++ b/lam-web/developers/phpdoc/profiles/_lib---profiles.inc.html @@ -0,0 +1,245 @@ + + +Docs for page profiles.inc + + + + +
    @@ -766,13 +764,11 @@ Overrides baseModule::lo

    - -

    -

    method save_attributes [line 220]

    +

    method save_attributes [line 221]

    diff --git a/lam-web/developers/phpdoc/modules/smbHash.html b/lam-web/developers/phpdoc/modules/smbHash.html index 2dd41d54..2f670767 100644 --- a/lam-web/developers/phpdoc/modules/smbHash.html +++ b/lam-web/developers/phpdoc/modules/smbHash.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -792,9 +788,7 @@ Overrides baseModule::lo

    - -Overrides
    baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    - + Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

    [ Top ]

    @@ -802,7 +796,7 @@ Overrides baseModule:
    - [ class tree: modules ] + + + [ class tree: modules ] [ index: modules ] - [ all elements ] + [ all elements ]
    @@ -117,7 +124,6 @@ Source Location: /lib/createntlm.inc

    -
    @@ -175,7 +181,6 @@ Source Location: /lib/createntlm.inc

    -

    @@ -376,8 +381,6 @@ $forw)

    - -

    Parameters:

    @@ -402,32 +405,40 @@ $forw)
    -

    method E_P16 [line 290]

    +

    method E_P16 [line 310]

    - void E_P16( -mixed + unknown E_P16( +unknown_type $in)

    -

    + E_P16



    - - +

    Parameters:

    +
    + + + + + + +
    unknown_type  $in  
    +

    [ Top ]

    -

    method lmhash [line 314]

    +

    method lmhash [line 334]

    string lmhash( [string -$password = ""]) +$password = ""])

    @@ -443,8 +454,6 @@ $password = ""])

    - -

    Parameters:

    @@ -473,8 +482,6 @@ $data)

    - -

    Parameters:

    @@ -508,8 +515,6 @@ $in2)

    - -

    Parameters:

    @@ -529,13 +534,13 @@ $in2)
    -

    method nthash [line 331]

    +

    method nthash [line 351]

    string nthash( [string -$password = ""]) +$password = ""])

    @@ -551,8 +556,6 @@ $password = ""])

    - -

    Parameters:

    @@ -574,7 +577,7 @@ $password = ""])array permute( array $in, array -$p, mixed +$p, $n)

    @@ -582,8 +585,6 @@ $n)

    - -

    Parameters:

    @@ -596,6 +597,11 @@ $n) + + + + +
    array   $p   p permutation
      $n  

    @@ -603,53 +609,88 @@ $n)
    -

    method smb_hash [line 270]

    +

    method smb_hash [line 284]

    - void smb_hash( -mixed -$in, mixed -$key, mixed + unknown smb_hash( +unknown_type +$in, unknown_type +$key, unknown_type $forw)

    -

    + smb_hash



    - - +

    Parameters:

    +
    + + + + + + + + + + + + + + + + +
    unknown_type  $in  
    unknown_type  $key  
    unknown_type  $forw  
    +

    [ Top ]

    -

    method str_to_key [line 255]

    +

    method str_to_key [line 261]

    - void str_to_key( -mixed + string str_to_key( +string $str)

    -

    + str_to_key



    +

    Tags:

    +
    + + + + +
    return:  key
    +
    +

    - - +

    Parameters:

    +
    + + + + + + +
    string  $str  
    +

    [ Top ]

    -

    method unsigned_shift_r [line 340]

    +

    method unsigned_shift_r [line 360]

    void unsigned_shift_r( -mixed -$a, mixed + +$a, $b)

    @@ -657,8 +698,21 @@ $b) Unsigned shift operation for 32bit values.

    PHP 4 only supports signed shifts by default.




    - - +

    Parameters:

    +
    + + + + + + + + + + + +
      $a  
      $b  
    +

    [ Top ]

    @@ -668,7 +722,7 @@ $b)
    void x( -mixed + $i)

    @@ -676,8 +730,16 @@ $i) Fixes too large numbers



    - - +

    Parameters:

    +
    + + + + + + +
      $i  
    +

    [ Top ]

    @@ -685,7 +747,7 @@ $i)

    - Documentation generated on Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:43 +0100 by phpDocumentor 1.4.0
    + + + + + + + + +
    profiles
    + + + [ class tree: profiles ] + [ index: profiles ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: profiles.inc

    +Source Location: /lib/profiles.inc

    + +
    +
    + + +

    Page Details:

    +This file provides functions to load and save account profiles.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    +
    + +

    delAccountProfile [line 147]

    +
    +
    +
    + boolean delAccountProfile( +string $file, string $scope) +
    +

    + + Deletes an account profile



    +

    Tags:

    +
    + + + + +
    return:  true if profile was deleted
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    string  $file  name of profile (Without .<scope> extension)
    string  $scope  account type
    +
    [ Top ]


    +
    +
    + +

    getAccountProfiles [line 38]

    +
    +
    +
    + array getAccountProfiles( +string $scope) +
    +

    + + Returns an array of string with all available profiles for the given account type



    +

    Tags:

    +
    + + + + +
    return:  profile names
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $scope  account type
    +
    [ Top ]


    +
    +
    + +

    loadAccountProfile [line 66]

    +
    +
    +
    + array loadAccountProfile( +string $profile, string $scope) +
    +

    + + Loads an profile of the given account type



    +

    Tags:

    +
    + + + + +
    return:  hash array (attribute => value)
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    string  $profile  name of the profile (without .<scope> extension)
    string  $scope  account type
    +
    [ Top ]


    +
    +
    + +

    saveAccountProfile [line 110]

    +
    +
    +
    + boolean saveAccountProfile( +array $attributes, string $profile, string $scope) +
    +

    + + Saves an hash array (attribute => value) to an account profile

    file is created, if needed




    +

    Tags:

    +
    + + + + +
    return:  true, if saving succeeded
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    string  $profile  name of the account profile (without .<scope> extension)
    array  $attributes  hash array (attribute => value)
    string  $scope  account type
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:02 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/profiles/_templates---profedit---profiledelete.php.html b/lam-web/developers/phpdoc/profiles/_templates---profedit---profiledelete.php.html new file mode 100644 index 00000000..3e6a5250 --- /dev/null +++ b/lam-web/developers/phpdoc/profiles/_templates---profedit---profiledelete.php.html @@ -0,0 +1,104 @@ + + +Docs for page profiledelete.php + + + + + + + + + + + + + +
    profiles
    + + + [ class tree: profiles ] + [ index: profiles ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: profiledelete.php

    +Source Location: /templates/profedit/profiledelete.php

    + +
    +
    + + +

    Page Details:

    +Manages deletion of profiles.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../../lib/security.inc") [line 32]
    +security functions

    include_once("../../lib/profiles.inc") [line 34]
    +helper functions for profiles

    include_once("../../lib/ldap.inc") [line 36]
    +access to LDAP server

    include_once("../../lib/config.inc") [line 38]
    +access to configuration options

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:01 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/profiles/_templates---profedit---profilemain.php.html b/lam-web/developers/phpdoc/profiles/_templates---profedit---profilemain.php.html new file mode 100644 index 00000000..f25ca2d3 --- /dev/null +++ b/lam-web/developers/phpdoc/profiles/_templates---profedit---profilemain.php.html @@ -0,0 +1,104 @@ + + +Docs for page profilemain.php + + + + + + + + + + + + + +
    profiles
    + + + [ class tree: profiles ] + [ index: profiles ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: profilemain.php

    +Source Location: /templates/profedit/profilemain.php

    + +
    +
    + + +

    Page Details:

    +This is the main window of the profile editor.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../../lib/security.inc") [line 32]
    +security functions

    include_once("../../lib/profiles.inc") [line 34]
    +helper functions for profiles

    include_once("../../lib/ldap.inc") [line 36]
    +access to LDAP server

    include_once("../../lib/config.inc") [line 38]
    +access to configuration options

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:01 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/profiles/_templates---profedit---profilepage.php.html b/lam-web/developers/phpdoc/profiles/_templates---profedit---profilepage.php.html new file mode 100644 index 00000000..4584386a --- /dev/null +++ b/lam-web/developers/phpdoc/profiles/_templates---profedit---profilepage.php.html @@ -0,0 +1,106 @@ + + +Docs for page profilepage.php + + + + + + + + + + + + + +
    profiles
    + + + [ class tree: profiles ] + [ index: profiles ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: profilepage.php

    +Source Location: /templates/profedit/profilepage.php

    + +
    +
    + + +

    Page Details:

    +Manages creating/changing of profiles.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../../lib/profiles.inc") [line 34]
    +helper functions for profiles

    include_once("../../lib/security.inc") [line 32]
    +security functions

    include_once("../../lib/ldap.inc") [line 36]
    +access to LDAP server

    include_once("../../lib/config.inc") [line 38]
    +access to configuration options

    include_once("../../lib/status.inc") [line 42]
    +Used to display status messages

    include_once("../../lib/modules.inc") [line 40]
    +access to account modules

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:02 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/ric_INSTALL.html b/lam-web/developers/phpdoc/ric_INSTALL.html index 05fd9815..9d18cefa 100644 --- a/lam-web/developers/phpdoc/ric_INSTALL.html +++ b/lam-web/developers/phpdoc/ric_INSTALL.html @@ -12,9 +12,8 @@
    - [ class tree: default ] - [ index: default ] - [ all elements ] + + [ all elements ]
    - [ class tree: default ] - [ index: default ] - [ all elements ] + + [ all elements ]
    + + + + + + + + +
    selfService
    + + + [ class tree: selfService ] + [ index: selfService ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: selfService.inc

    +Source Location: /lib/selfService.inc

    + +
    +
    + +
    +

    Classes:

    +
    selfServiceProfile
    +
    Includes all settings of a self service profile.
    +


    + +

    Page Details:

    +Interface between modules and self service pages.

    This file also includes the self service profile class and helper functions.




    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("modules.inc") [line 34]
    +modules

    include_once("types.inc") [line 36]
    +account types

    +

    +

    +
    +
    + +

    checkSelfServiceOptions [line 116]

    +
    +
    +
    + array checkSelfServiceOptions( +string $scope, string $fields, array $attributes) +
    +

    + + Checks if all input values are correct and returns the LDAP commands which should be executed.



    +

    Tags:

    +
    + + + + +
    return:  messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    string  $scope  account type
    string  $fields  input fields (array(<moduleName> => array(<field1>, <field2>, ...)))
    array  $attributes  LDAP attributes
    +
    [ Top ]


    +
    +
    + +

    checkSelfServiceSettings [line 238]

    +
    +
    +
    + array checkSelfServiceSettings( +string $scope, array $options) +
    +

    + + Checks if the self service settings are valid



    +

    Tags:

    +
    + + + + +
    return:  list of error messages
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    string  $scope  account type
    array  $options  hash array containing all options (name => array(...))
    +
    [ Top ]


    +
    +
    + +

    getSelfServiceFieldSettings [line 75]

    +
    +
    +
    + array getSelfServiceFieldSettings( +string $scope) +
    +

    + + Returns the field settings for the self service.



    +

    Tags:

    +
    + + + + +
    return:  settings
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $scope  account type
    +
    [ Top ]


    +
    +
    + +

    getSelfServiceOptions [line 95]

    +
    +
    +
    + array getSelfServiceOptions( +string $scope, array $fields, array $attributes) +
    +

    + + Returns meta HTML code for each self service field.



    +

    Tags:

    +
    + + + + +
    return:  meta HTML code (array(<moduleName> => array(<field1> => array(<meta HTML>))))
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    string  $scope  account type
    array  $fields  input fields (array(<moduleName> => array(<field1>, <field2>, ...)))
    array  $attributes  LDAP attributes (attribute names in lower case)
    +
    [ Top ]


    +
    +
    + +

    getSelfServiceProfiles [line 137]

    +
    +
    +
    + array getSelfServiceProfiles( +) +
    +

    + + Returns a list of all available self service profiles (without .conf)



    +

    Tags:

    +
    + + + + +
    return:  profile names (array(<account type> => array(<profile1>, <profile2>, ...)))
    +
    +

    + +
    [ Top ]


    +
    +
    + +

    getSelfServiceSearchAttributes [line 55]

    +
    +
    +
    + array getSelfServiceSearchAttributes( +string $scope) +
    +

    + + Returns a list of possible search attributes for the self service.



    +

    Tags:

    +
    + + + + +
    return:  attributes
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $scope  account type
    +
    [ Top ]


    +
    +
    + +

    getSelfServiceSettings [line 221]

    +
    +
    +
    + array getSelfServiceSettings( +string $scope) +
    +

    + + Returns a hash array (module name => elements) of all module options for the configuration page.



    +

    Tags:

    +
    + + + + +
    return:  configuration options
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $scope  account type
    +
    [ Top ]


    +
    +
    + +

    isLAMProVersion [line 43]

    +
    +
    +
    + boolean isLAMProVersion( +) +
    +

    + + Returns if this is a LAM Pro installation.



    +

    Tags:

    +
    + + + + +
    return:  LAM Pro installation
    +
    +

    + +
    [ Top ]


    +
    +
    + +

    loadSelfServiceProfile [line 161]

    +
    +
    +
    + selfServiceProfile loadSelfServiceProfile( +string $name, string $scope) +
    +

    + + Loads all settings of a self service profile.



    +

    Tags:

    +
    + + + + +
    return:  true if file was readable
    +
    +

    + +

    Parameters

    + + + + + + + + + + + +
    string  $name  profile name
    string  $scope  account type
    +
    [ Top ]


    +
    +
    + +

    saveSelfServiceProfile [line 194]

    +
    +
    +
    + boolean saveSelfServiceProfile( +string $name, string $scope, selfServiceProfile $profile) +
    +

    + + Saves a self service profile.

    File is created, if needed




    +

    Tags:

    +
    + + + + +
    return:  true, if saving succeeded
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    string  $name  name of the account profile
    string  $scope  account type
    selfServiceProfile  $profile  self service profile
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:09 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/selfService/selfServiceProfile.html b/lam-web/developers/phpdoc/selfService/selfServiceProfile.html new file mode 100644 index 00000000..b4a65b78 --- /dev/null +++ b/lam-web/developers/phpdoc/selfService/selfServiceProfile.html @@ -0,0 +1,407 @@ + + +Docs For Class selfServiceProfile + + + + + + + + + + + + + +
    selfService
    + + + [ class tree: selfService ] + [ index: selfService ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Class: selfServiceProfile

    +Source Location: /lib/selfService.inc

    + + + + + + + + + + +
    + +

    Class Overview

    +

    +
    Includes all settings of a self service profile.


    + + + + + + + +
    +

    Variables

    + +
    +

    Methods

    + +
    +
    + + + + + + + + +
    +
    + + +

    Class Details

    +
    +[line 255]
    +Includes all settings of a self service profile.



    +
    [ Top ]

    + +
    + +

    Class Variables

    +
    + +

    +

    $inputFields =

    +

    [line 285]

    + input fields

    Format: array(<module> => array(array('name' => <group name>, 'fields' => array(<field1>, <field2>))))




    +

    Tags:

    +
    + + + + +
    access:  public
    +
    + +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    + +

    +

    $LDAPPassword =

    +

    [line 267]

    + LDAP password



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    + +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    + +

    +

    $LDAPSuffix =

    +

    [line 261]

    + LDAP suffix



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    + +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    + +

    +

    $LDAPUser =

    +

    [line 264]

    + LDAP user DN



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    + +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    + +

    +

    $loginAttributeText =

    +

    [line 276]

    + describing text for search attribute



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    + +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    + +

    +

    $loginCaption =

    +

    [line 273]

    + describing text for user login



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    + +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    + +

    +

    $mainPageText =

    +

    [line 279]

    + describing text for self service main page



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    + +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    + +

    +

    $moduleSettings =

    +

    [line 288]

    + configuration settings of modules



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    + +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    + +

    +

    $searchAttribute =

    +

    [line 270]

    + LDAP search attribute



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    + +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    + +

    +

    $serverURL =

    +

    [line 258]

    + server address



    +

    Tags:

    +
    + + + + +
    access:  public
    +
    + +
    +
    + + + + + +
    Type:  mixed
    +


    +
    [ Top ]

    +

    + +
    + +

    Class Methods

    +
    + +
    + +

    constructor selfServiceProfile [line 295]

    +
    +
    +
    + selfServiceProfile selfServiceProfile( +) +
    +

    + + Constructor



    + + +
    [ Top ]
    +
    +

    + + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:10 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tests/_tests---conf-main-test.php.html b/lam-web/developers/phpdoc/tests/_tests---conf-main-test.php.html new file mode 100644 index 00000000..e3d35c01 --- /dev/null +++ b/lam-web/developers/phpdoc/tests/_tests---conf-main-test.php.html @@ -0,0 +1,99 @@ + + +Docs for page conf-main-test.php + + + + + + + + + + + + + +
    tests
    + + + [ class tree: tests ] + [ index: tests ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: conf-main-test.php

    +Source Location: /tests/conf-main-test.php

    + +
    +
    + + +

    Page Details:

    +This test reads all preferences from config.cfg. Then it writes new values and verifies if they were written. At last the old values are restored.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include("../lib/config.inc") [line 33]
    +configuration interface

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:41 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/tests/_tests---conf-test.php.html b/lam-web/developers/phpdoc/tests/_tests---conf-test.php.html new file mode 100644 index 00000000..7a3e1db5 --- /dev/null +++ b/lam-web/developers/phpdoc/tests/_tests---conf-test.php.html @@ -0,0 +1,99 @@ + + +Docs for page conf-test.php + + + + + + + + + + + + + +
    tests
    + + + [ class tree: tests ] + [ index: tests ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: conf-test.php

    +Source Location: /tests/conf-test.php

    + +
    +
    + + +

    Page Details:

    +This test reads all preferences from lam.conf. Then it writes new values and verifies if they were written. At last the old values are restored.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include("../lib/config.inc") [line 33]
    +access to configuration functions

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:41 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/tests/_tests---status-test.php.html b/lam-web/developers/phpdoc/tests/_tests---status-test.php.html new file mode 100644 index 00000000..38143f5d --- /dev/null +++ b/lam-web/developers/phpdoc/tests/_tests---status-test.php.html @@ -0,0 +1,99 @@ + + +Docs for page status-test.php + + + + + + + + + + + + + +
    tests
    + + + [ class tree: tests ] + [ index: tests ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: status-test.php

    +Source Location: /tests/status-test.php

    + +
    +
    + + +

    Page Details:

    +LDAP Account Manager status messages.



    +

    Tags:

    +
    + + + + +
    author:  Michael Duergner
    +
    +

    +

    Includes:

    +
    +include_once("../lib/status.inc") [line 32]
    +message displaying

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:11 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/tools/LdapExportInfo.html b/lam-web/developers/phpdoc/tools/LdapExportInfo.html index e2f101c0..ff53c915 100644 --- a/lam-web/developers/phpdoc/tools/LdapExportInfo.html +++ b/lam-web/developers/phpdoc/tools/LdapExportInfo.html @@ -12,9 +12,11 @@
    - [ class tree: tools ] + + + [ class tree: tools ] [ index: tools ] - [ all elements ] + [ all elements ]
    diff --git a/lam-web/developers/phpdoc/tools/MyCustomExporter.html b/lam-web/developers/phpdoc/tools/MyCustomExporter.html index 1824960f..f66907f6 100644 --- a/lam-web/developers/phpdoc/tools/MyCustomExporter.html +++ b/lam-web/developers/phpdoc/tools/MyCustomExporter.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -85,7 +89,6 @@ Source Location: /lib/export.inc

    -
    @@ -128,7 +131,6 @@ Source Location: /lib/export.inc

    -

    @@ -212,8 +214,6 @@ $scope = NULL]) Create a new LdapExportInfo object



    - -

    Parameters:

    @@ -241,7 +241,7 @@ $scope = NULL])

    - Documentation generated on Wed, 15 Nov 2006 18:00:43 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:45 +0100 by phpDocumentor 1.4.0
    - [ class tree: tools ] + + + [ class tree: tools ] [ index: tools ] - [ all elements ] + [ all elements ]
    diff --git a/lam-web/developers/phpdoc/tools/PlaAbstractExporter.html b/lam-web/developers/phpdoc/tools/PlaAbstractExporter.html index dbafd080..a0ac7bb6 100644 --- a/lam-web/developers/phpdoc/tools/PlaAbstractExporter.html +++ b/lam-web/developers/phpdoc/tools/PlaAbstractExporter.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -85,7 +89,6 @@ Source Location: /lib/export.inc

    -
    @@ -123,7 +126,6 @@ Source Location: /lib/export.inc

    -

    Inherited Variables

    @@ -131,15 +133,13 @@ Source Location: /lib/export.inc

    PlaExporter::$br - -
    +
    PlaExporter::$exporter - -
    +
    @@ -154,63 +154,54 @@ Source Location: /lib/export.inc

    PlaExporter::PlaExporter() -
    Constructor
    PlaExporter::export() -
    Abstract method use to export data.
    PlaExporter::is_safe_ascii() -
    Helper method to check if the attribute value should be base 64 encoded.
    PlaExporter::pla_fetch_entry_array() -
    Return the entry as an array
    PlaExporter::pla_fetch_entry_object() -
    Return the entry as an Entry object
    PlaExporter::pla_get_ldap_info() -
    Return a PlaLdapInfo Object
    PlaExporter::pla_has_entry() -
    Return true if there is some more entries to be processed
    PlaExporter::pla_num_entries() -
    Return the number of entries
    PlaExporter::setOutputFormat() -
    Set the carriage return /linefeed for the export @@ -220,35 +211,30 @@ Source Location: /lib/export.inc

    PlaAbstractExporter::pla_fetch_entry_array() -
    Return the entry as an array
    PlaAbstractExporter::pla_fetch_entry_object() -
    Return the entry as an Entry object
    PlaAbstractExporter::pla_get_ldap_info() -
    Return a PlaLdapInfo Object
    PlaAbstractExporter::pla_has_entry() -
    Return true if there is some more entries to be processed
    PlaAbstractExporter::pla_num_entries() -
    Return the number of entries @@ -286,9 +272,7 @@ Source Location: /lib/export.inc

    When doing an exporter, the method export need to be overriden.

    A basic implementation is provided here. Customize to your need




    - -Overrides PlaExporter::export() (Abstract method use to export data.)

    - + Overrides PlaExporter::export() (Abstract method use to export data.)

    [ Top ]

    @@ -298,7 +282,7 @@ Overrides PlaExporter::export()
    void MyCutsomExporter( -mixed + $exporter)

    @@ -306,8 +290,16 @@ $exporter)

    - - +

    Parameters:

    +
    + + + + + + +
      $exporter  
    +


    @@ -315,7 +307,7 @@ $exporter)

    - Documentation generated on Wed, 15 Nov 2006 18:00:43 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:45 +0100 by phpDocumentor 1.4.0
    - [ class tree: tools ] + + + [ class tree: tools ] [ index: tools ] - [ all elements ] + [ all elements ]
    @@ -85,7 +89,6 @@ Source Location: /lib/export.inc

    - diff --git a/lam-web/developers/phpdoc/tools/PlaCSVExporter.html b/lam-web/developers/phpdoc/tools/PlaCSVExporter.html index ec85ac02..a5169048 100644 --- a/lam-web/developers/phpdoc/tools/PlaCSVExporter.html +++ b/lam-web/developers/phpdoc/tools/PlaCSVExporter.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -123,7 +126,6 @@ Source Location: /lib/export.inc

    -

    Child classes:

    @@ -199,8 +201,6 @@ This class represents the base class of all exporters

    It can be su

    - -
    [ Top ]

    @@ -236,8 +236,6 @@ This class represents the base class of all exporters

    It can be su

    - -
    [ Top ]

    @@ -273,8 +271,6 @@ This class represents the base class of all exporters

    It can be su

    - -
    [ Top ]

    @@ -310,8 +306,6 @@ This class represents the base class of all exporters

    It can be su

    - -
    [ Top ]

    @@ -347,8 +341,6 @@ This class represents the base class of all exporters

    It can be su

    - -
    [ Top ]

    @@ -356,7 +348,7 @@ This class represents the base class of all exporters

    It can be su


    - Documentation generated on Wed, 15 Nov 2006 18:00:43 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:46 +0100 by phpDocumentor 1.4.0
    - [ class tree: tools ] + + + [ class tree: tools ] [ index: tools ] - [ all elements ] + [ all elements ]
    diff --git a/lam-web/developers/phpdoc/tools/PlaDsmlExporter.html b/lam-web/developers/phpdoc/tools/PlaDsmlExporter.html index 67160139..a17c0032 100644 --- a/lam-web/developers/phpdoc/tools/PlaDsmlExporter.html +++ b/lam-web/developers/phpdoc/tools/PlaDsmlExporter.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -85,7 +89,6 @@ Source Location: /lib/export.inc

    -
    @@ -137,7 +140,6 @@ Source Location: /lib/export.inc

    -

    Inherited Variables

    @@ -145,15 +147,13 @@ Source Location: /lib/export.inc

    PlaExporter::$br - -
    +
    PlaExporter::$exporter - -
    +
    @@ -168,63 +168,54 @@ Source Location: /lib/export.inc

    PlaExporter::PlaExporter() -
    Constructor
    PlaExporter::export() -
    Abstract method use to export data.
    PlaExporter::is_safe_ascii() -
    Helper method to check if the attribute value should be base 64 encoded.
    PlaExporter::pla_fetch_entry_array() -
    Return the entry as an array
    PlaExporter::pla_fetch_entry_object() -
    Return the entry as an Entry object
    PlaExporter::pla_get_ldap_info() -
    Return a PlaLdapInfo Object
    PlaExporter::pla_has_entry() -
    Return true if there is some more entries to be processed
    PlaExporter::pla_num_entries() -
    Return the number of entries
    PlaExporter::setOutputFormat() -
    Set the carriage return /linefeed for the export @@ -234,35 +225,30 @@ Source Location: /lib/export.inc

    PlaAbstractExporter::pla_fetch_entry_array() -
    Return the entry as an array
    PlaAbstractExporter::pla_fetch_entry_object() -
    Return the entry as an Entry object
    PlaAbstractExporter::pla_get_ldap_info() -
    Return a PlaLdapInfo Object
    PlaAbstractExporter::pla_has_entry() -
    Return true if there is some more entries to be processed
    PlaAbstractExporter::pla_num_entries() -
    Return the number of entries @@ -368,7 +354,7 @@ Export to cvs format



    PlaCSVExporter PlaCSVExporter( -mixed + $exporter)

    @@ -376,8 +362,16 @@ $exporter)

    - - +

    Parameters:

    +
    + + + + + + +
      $exporter  
    +

    [ Top ]

    @@ -393,9 +387,7 @@ $exporter)

    - -Overrides PlaExporter::export() (Abstract method use to export data.)

    - + Overrides PlaExporter::export() (Abstract method use to export data.)

    [ Top ]

    @@ -405,7 +397,7 @@ Overrides PlaExporter::export()
    void LdapEscape( -mixed + $var)

    @@ -413,8 +405,16 @@ $var)

    - - +

    Parameters:

    +
    + + + + + + +
      $var  
    +


    @@ -422,7 +422,7 @@ $var)

    - Documentation generated on Wed, 15 Nov 2006 18:00:43 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:46 +0100 by phpDocumentor 1.4.0
    - [ class tree: tools ] + + + [ class tree: tools ] [ index: tools ] - [ all elements ] + [ all elements ]
    @@ -85,7 +89,6 @@ Source Location: /lib/export.inc

    - diff --git a/lam-web/developers/phpdoc/tools/PlaExporter.html b/lam-web/developers/phpdoc/tools/PlaExporter.html index 17b43b1d..6f35332c 100644 --- a/lam-web/developers/phpdoc/tools/PlaExporter.html +++ b/lam-web/developers/phpdoc/tools/PlaExporter.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -133,7 +136,6 @@ Source Location: /lib/export.inc

    -

    Inherited Variables

    @@ -141,15 +143,13 @@ Source Location: /lib/export.inc

    PlaExporter::$br - -
    +
    PlaExporter::$exporter - -
    +
    @@ -164,63 +164,54 @@ Source Location: /lib/export.inc

    PlaExporter::PlaExporter() -
    Constructor
    PlaExporter::export() -
    Abstract method use to export data.
    PlaExporter::is_safe_ascii() -
    Helper method to check if the attribute value should be base 64 encoded.
    PlaExporter::pla_fetch_entry_array() -
    Return the entry as an array
    PlaExporter::pla_fetch_entry_object() -
    Return the entry as an Entry object
    PlaExporter::pla_get_ldap_info() -
    Return a PlaLdapInfo Object
    PlaExporter::pla_has_entry() -
    Return true if there is some more entries to be processed
    PlaExporter::pla_num_entries() -
    Return the number of entries
    PlaExporter::setOutputFormat() -
    Set the carriage return /linefeed for the export @@ -230,35 +221,30 @@ Source Location: /lib/export.inc

    PlaAbstractExporter::pla_fetch_entry_array() -
    Return the entry as an array
    PlaAbstractExporter::pla_fetch_entry_object() -
    Return the entry as an Entry object
    PlaAbstractExporter::pla_get_ldap_info() -
    Return a PlaLdapInfo Object
    PlaAbstractExporter::pla_has_entry() -
    Return true if there is some more entries to be processed
    PlaAbstractExporter::pla_num_entries() -
    Return the number of entries @@ -342,8 +328,6 @@ $exporter) Create a PlaDsmlExporter object



    - -

    Parameters:

    @@ -369,9 +353,7 @@ $exporter) Export the entries to DSML



    - -Overrides PlaExporter::export() (Abstract method use to export data.)

    - + Overrides PlaExporter::export() (Abstract method use to export data.)

    [ Top ]

    @@ -379,7 +361,7 @@ Overrides PlaExporter::export()
    - [ class tree: tools ] + + + [ class tree: tools ] [ index: tools ] - [ all elements ] + [ all elements ]
    @@ -85,7 +89,6 @@ Source Location: /lib/export.inc

    - diff --git a/lam-web/developers/phpdoc/tools/PlaLdifExporter.html b/lam-web/developers/phpdoc/tools/PlaLdifExporter.html index e9557a5f..3d6ddd34 100644 --- a/lam-web/developers/phpdoc/tools/PlaLdifExporter.html +++ b/lam-web/developers/phpdoc/tools/PlaLdifExporter.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -133,7 +136,6 @@ Source Location: /lib/export.inc

    - diff --git a/lam-web/developers/phpdoc/tools/PlaLdapExporter.html b/lam-web/developers/phpdoc/tools/PlaLdapExporter.html index 9a9b349a..789fb507 100644 --- a/lam-web/developers/phpdoc/tools/PlaLdapExporter.html +++ b/lam-web/developers/phpdoc/tools/PlaLdapExporter.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@

    Child classes:

    @@ -169,35 +171,30 @@ Source Location: /lib/export.inc

    PlaAbstractExporter::pla_fetch_entry_array() -
    Return the entry as an array
    PlaAbstractExporter::pla_fetch_entry_object() -
    Return the entry as an Entry object
    PlaAbstractExporter::pla_get_ldap_info() -
    Return a PlaLdapInfo Object
    PlaAbstractExporter::pla_has_entry() -
    Return true if there is some more entries to be processed
    PlaAbstractExporter::pla_num_entries() -
    Return the number of entries @@ -272,8 +269,6 @@ $source) Constructor



    - -

    Parameters:

    @@ -322,8 +317,6 @@ $source)

    - -
    [ Top ]

    @@ -350,8 +343,6 @@ $str)

    - -

    Parameters:

    @@ -386,9 +377,7 @@ $str)

    - -Overrides PlaAbstractExporter::pla_fetch_entry_array() (Return the entry as an array)

    - + Overrides PlaAbstractExporter::pla_fetch_entry_array() (Return the entry as an array)

    [ Top ]

    @@ -413,9 +402,7 @@ Overrides PlaAbstractExporter::pla_fetch_entry_object() (Return the entry as an Entry object)

    - + Overrides PlaAbstractExporter::pla_fetch_entry_object() (Return the entry as an Entry object)

    [ Top ]

    @@ -440,9 +427,7 @@ Overrides PlaAbstractExporter::pla_get_ldap_info() (Return a PlaLdapInfo Object)

    - + Overrides PlaAbstractExporter::pla_get_ldap_info() (Return a PlaLdapInfo Object)

    [ Top ]

    @@ -467,9 +452,7 @@ Overrides Pl

    - -Overrides
    PlaAbstractExporter::pla_has_entry() (Return true if there is some more entries to be processed)

    - + Overrides PlaAbstractExporter::pla_has_entry() (Return true if there is some more entries to be processed)

    [ Top ]

    @@ -494,9 +477,7 @@ Overrides PlaAbs

    - -Overrides
    PlaAbstractExporter::pla_num_entries() (Return the number of entries)

    - + Overrides PlaAbstractExporter::pla_num_entries() (Return the number of entries)

    [ Top ]

    @@ -514,8 +495,6 @@ $br) Set the carriage return /linefeed for the export



    - -

    Parameters:

    @@ -533,7 +512,7 @@ $br)

    - Documentation generated on Wed, 15 Nov 2006 18:00:43 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:46 +0100 by phpDocumentor 1.4.0
    - [ class tree: tools ] + + + [ class tree: tools ] [ index: tools ] - [ all elements ] + [ all elements ]
    @@ -85,7 +89,6 @@ Source Location: /lib/export.inc

    -
    @@ -143,7 +146,6 @@ Source Location: /lib/export.inc

    -

    Inherited Methods

    @@ -151,35 +153,30 @@ Source Location: /lib/export.inc

    PlaAbstractExporter::pla_fetch_entry_array() -
    Return the entry as an array
    PlaAbstractExporter::pla_fetch_entry_object() -
    Return the entry as an Entry object
    PlaAbstractExporter::pla_get_ldap_info() -
    Return a PlaLdapInfo Object
    PlaAbstractExporter::pla_has_entry() -
    Return true if there is some more entries to be processed
    PlaAbstractExporter::pla_num_entries() -
    Return the number of entries @@ -363,7 +360,7 @@ Export data from a ldap server



    String $queryFilter, String $base_dn, String -$scope, mixed +$scope, $attributes)

    @@ -371,8 +368,6 @@ $attributes) Create a PlaLdapExporter object.



    - -

    Parameters:

    @@ -390,6 +385,11 @@ $attributes) + + + + +
    String   $scope   the scope for export
      $attributes  

    @@ -417,9 +417,7 @@ $attributes)

    - -Overrides PlaAbstractExporter::pla_fetch_entry_array() (Return the entry as an array)

    - + Overrides PlaAbstractExporter::pla_fetch_entry_array() (Return the entry as an array)

    [ Top ]

    @@ -444,9 +442,7 @@ Overrides PlaAbstractExporter::pla_fetch_entry_object() (Return the entry as an Entry object)

    - + Overrides PlaAbstractExporter::pla_fetch_entry_object() (Return the entry as an Entry object)

    [ Top ]

    @@ -471,9 +467,7 @@ Overrides PlaAbstractExporter::pla_get_ldap_info() (Return a PlaLdapInfo Object)

    - + Overrides PlaAbstractExporter::pla_get_ldap_info() (Return a PlaLdapInfo Object)

    [ Top ]

    @@ -498,9 +492,7 @@ Overrides Pl

    - -Overrides
    PlaAbstractExporter::pla_has_entry() (Return true if there is some more entries to be processed)

    - + Overrides PlaAbstractExporter::pla_has_entry() (Return true if there is some more entries to be processed)

    [ Top ]

    @@ -525,9 +517,7 @@ Overrides PlaAbs

    - -Overrides
    PlaAbstractExporter::pla_num_entries() (Return the number of entries)

    - + Overrides PlaAbstractExporter::pla_num_entries() (Return the number of entries)

    [ Top ]

    @@ -535,7 +525,7 @@ Overrides PlaA
    - [ class tree: tools ] + + + [ class tree: tools ] [ index: tools ] - [ all elements ] + [ all elements ]
    @@ -85,7 +89,6 @@ Source Location: /lib/export.inc

    - diff --git a/lam-web/developers/phpdoc/tools/PlaVcardExporter.html b/lam-web/developers/phpdoc/tools/PlaVcardExporter.html index 6166075d..9f19257e 100644 --- a/lam-web/developers/phpdoc/tools/PlaVcardExporter.html +++ b/lam-web/developers/phpdoc/tools/PlaVcardExporter.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@ @@ -24,8 +26,8 @@
    @@ -135,7 +138,6 @@ Source Location: /lib/export.inc

    -

    Inherited Variables

    @@ -143,15 +145,13 @@ Source Location: /lib/export.inc

    PlaExporter::$br - -
    +
    PlaExporter::$exporter - -
    +
    @@ -166,63 +166,54 @@ Source Location: /lib/export.inc

    PlaExporter::PlaExporter() -
    Constructor
    PlaExporter::export() -
    Abstract method use to export data.
    PlaExporter::is_safe_ascii() -
    Helper method to check if the attribute value should be base 64 encoded.
    PlaExporter::pla_fetch_entry_array() -
    Return the entry as an array
    PlaExporter::pla_fetch_entry_object() -
    Return the entry as an Entry object
    PlaExporter::pla_get_ldap_info() -
    Return a PlaLdapInfo Object
    PlaExporter::pla_has_entry() -
    Return true if there is some more entries to be processed
    PlaExporter::pla_num_entries() -
    Return the number of entries
    PlaExporter::setOutputFormat() -
    Set the carriage return /linefeed for the export @@ -232,35 +223,30 @@ Source Location: /lib/export.inc

    PlaAbstractExporter::pla_fetch_entry_array() -
    Return the entry as an array
    PlaAbstractExporter::pla_fetch_entry_object() -
    Return the entry as an Entry object
    PlaAbstractExporter::pla_get_ldap_info() -
    Return a PlaLdapInfo Object
    PlaAbstractExporter::pla_has_entry() -
    Return true if there is some more entries to be processed
    PlaAbstractExporter::pla_num_entries() -
    Return the number of entries @@ -344,8 +330,6 @@ $exporter) Create a PlaLdifExporter object



    - -

    Parameters:

    @@ -365,7 +349,7 @@ $exporter)
    void displayExportInfo( -mixed + $pla_ldap_info)

    @@ -373,8 +357,16 @@ $pla_ldap_info)

    - - +

    Parameters:

    +
    + + + + + + +
      $pla_ldap_info  
    +

    [ Top ]

    @@ -390,9 +382,7 @@ $pla_ldap_info) Export entries to ldif format



    - -Overrides PlaExporter::export() (Abstract method use to export data.)

    - + Overrides PlaExporter::export() (Abstract method use to export data.)

    [ Top ]

    @@ -410,8 +400,6 @@ $str) Helper method to wrap ldif lines



    - -

    Parameters:

    @@ -429,7 +417,7 @@ $str)

    - Documentation generated on Wed, 15 Nov 2006 18:00:44 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:47 +0100 by phpDocumentor 1.4.0
    - [ class tree: tools ] + + + [ class tree: tools ] [ index: tools ] - [ all elements ] + [ all elements ]
    diff --git a/lam-web/developers/phpdoc/tools/_lib---export.inc.html b/lam-web/developers/phpdoc/tools/_lib---export.inc.html new file mode 100644 index 00000000..9b2512af --- /dev/null +++ b/lam-web/developers/phpdoc/tools/_lib---export.inc.html @@ -0,0 +1,244 @@ + + +Docs for page export.inc + + + + +
    @@ -85,7 +89,6 @@ Source Location: /lib/export.inc

    -
    @@ -130,7 +133,6 @@ Source Location: /lib/export.inc

    -

    Inherited Variables

    @@ -138,15 +140,13 @@ Source Location: /lib/export.inc

    PlaExporter::$br - -
    +
    PlaExporter::$exporter - -
    +
    @@ -161,63 +161,54 @@ Source Location: /lib/export.inc

    PlaExporter::PlaExporter() -
    Constructor
    PlaExporter::export() -
    Abstract method use to export data.
    PlaExporter::is_safe_ascii() -
    Helper method to check if the attribute value should be base 64 encoded.
    PlaExporter::pla_fetch_entry_array() -
    Return the entry as an array
    PlaExporter::pla_fetch_entry_object() -
    Return the entry as an Entry object
    PlaExporter::pla_get_ldap_info() -
    Return a PlaLdapInfo Object
    PlaExporter::pla_has_entry() -
    Return true if there is some more entries to be processed
    PlaExporter::pla_num_entries() -
    Return the number of entries
    PlaExporter::setOutputFormat() -
    Set the carriage return /linefeed for the export @@ -227,35 +218,30 @@ Source Location: /lib/export.inc

    PlaAbstractExporter::pla_fetch_entry_array() -
    Return the entry as an array
    PlaAbstractExporter::pla_fetch_entry_object() -
    Return the entry as an Entry object
    PlaAbstractExporter::pla_get_ldap_info() -
    Return a PlaLdapInfo Object
    PlaAbstractExporter::pla_has_entry() -
    Return true if there is some more entries to be processed
    PlaAbstractExporter::pla_num_entries() -
    Return the number of entries @@ -339,7 +325,7 @@ Source Location: /lib/export.inc

    PlaVcardExporter PlaVcardExporter( -mixed + $exporter)

    @@ -347,8 +333,16 @@ $exporter)

    - - +

    Parameters:

    +
    + + + + + + +
      $exporter  
    +

    [ Top ]

    @@ -364,9 +358,7 @@ $exporter) When doing an exporter, the method export need to be overriden.

    A basic implementation is provided here. Customize to your need




    - -Overrides PlaExporter::export() (Abstract method use to export data.)

    - + Overrides PlaExporter::export() (Abstract method use to export data.)

    [ Top ]

    @@ -374,7 +366,7 @@ Overrides PlaExporter::export()
    + + + + + + + + +
    tools
    + + + [ class tree: tools ] + [ index: tools ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: export.inc

    +Source Location: /lib/export.inc

    + +
    +
    + +
    +

    Classes:

    +
    LdapExportInfo
    +
    This class encapsulate informations about the ldap server from which the export is done.
    +
    PlaAbstractExporter
    +
    This class represents the base class of all exporters
    +
    PlaExporter
    +
    PlaExporter acts a wrapper around another exporter.
    +
    PlaLdapExporter
    +
    Export data from a ldap server
    +
    PlaLdifExporter
    +
    Export entries to ldif format
    +
    PlaDsmlExporter
    +
    Export entries to DSML v.1
    +
    PlaVcardExporter
    +
    +
    PlaCSVExporter
    +
    Export to cvs format
    +
    MyCustomExporter
    +
    +


    + +

    Page Details:

    +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.



    +

    Tags:

    +
    + + + + +
    return:  The user agent string as reported by the browser.
    +
    +

    + +
    [ Top ]


    +
    +
    + +

    is_browser_os_mac [line 947]

    +
    +
    +
    + boolean is_browser_os_mac( +) +
    +

    + + Determines whether the browser's operating system is Macintosh.



    +

    Tags:

    +
    + + + + +
    return:  True if the brower's OS is mac, false otherwise.
    +
    +

    + +
    [ Top ]


    +
    +
    + +

    is_browser_os_unix [line 859]

    +
    +
    +
    + boolean is_browser_os_unix( +) +
    +

    + + Determines whether the browser's operating system is UNIX (or something like UNIX).



    +

    Tags:

    +
    + + + + +
    return:  True if the brower's OS is UNIX, false otherwise.
    +
    +

    + +
    [ Top ]


    +
    +
    + +

    is_browser_os_windows [line 910]

    +
    +
    +
    + boolean is_browser_os_windows( +) +
    +

    + + Determines whether the browser's operating system is Windows.



    +

    Tags:

    +
    + + + + +
    return:  True if the brower's OS is Windows, false otherwise.
    +
    +

    + +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:45 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/tools/_templates---massBuildAccounts.php.html b/lam-web/developers/phpdoc/tools/_templates---massBuildAccounts.php.html new file mode 100644 index 00000000..7e3b17d1 --- /dev/null +++ b/lam-web/developers/phpdoc/tools/_templates---massBuildAccounts.php.html @@ -0,0 +1,127 @@ + + +Docs for page massBuildAccounts.php + + + + + + + + + + + + + +
    tools
    + + + [ class tree: tools ] + [ index: tools ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: massBuildAccounts.php

    +Source Location: /templates/massBuildAccounts.php

    + +
    +
    + + +

    Page Details:

    +Creates the accounts by parsing the uploaded file.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../lib/security.inc") [line 32]
    +security functions

    include_once('../lib/config.inc') [line 34]
    +access to configuration

    include_once('../lib/status.inc') [line 36]
    +status messages

    include_once('../lib/modules.inc') [line 38]
    +account modules

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:57 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/tools/_templates---massDoUpload.php.html b/lam-web/developers/phpdoc/tools/_templates---massDoUpload.php.html new file mode 100644 index 00000000..f3dd1061 --- /dev/null +++ b/lam-web/developers/phpdoc/tools/_templates---massDoUpload.php.html @@ -0,0 +1,129 @@ + + +Docs for page massDoUpload.php + + + + + + + + + + + + + +
    tools
    + + + [ class tree: tools ] + [ index: tools ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: massDoUpload.php

    +Source Location: /templates/massDoUpload.php

    + +
    +
    + + +

    Page Details:

    +Creates LDAP accounts for file upload.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../lib/config.inc') [line 34]
    +access to configuration

    include_once("../lib/security.inc") [line 32]
    +security functions

    include_once('../lib/ldap.inc') [line 36]
    +LDAP handle

    include_once('../lib/status.inc') [line 38]
    +status messages

    include_once('../lib/cache.inc') [line 42]
    +LAM cache

    include_once('../lib/modules.inc') [line 40]
    +account modules

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:57 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/tools/_templates---masscreate.php.html b/lam-web/developers/phpdoc/tools/_templates---masscreate.php.html new file mode 100644 index 00000000..7dd1dcb8 --- /dev/null +++ b/lam-web/developers/phpdoc/tools/_templates---masscreate.php.html @@ -0,0 +1,183 @@ + + +Docs for page masscreate.php + + + + + + + + + + + + + +
    tools
    + + + [ class tree: tools ] + [ index: tools ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: masscreate.php

    +Source Location: /templates/masscreate.php

    + +
    +
    + + +

    Page Details:

    +Start page of file upload



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once('../lib/config.inc') [line 34]
    +access to configuration

    include_once('../lib/status.inc') [line 36]
    +status messages

    include_once("../lib/security.inc") [line 32]
    +security functions

    include_once('../lib/modules.inc') [line 38]
    +account modules

    +

    +

    +
    +
    + +

    showColumnData [line 288]

    +
    +
    +
    + void showColumnData( +string $module, array $data, string $scope) +
    +

    + + Prints the properties of one input field.



    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    string  $module  account module name
    array  $data  field data from modules
    string  $scope  account type
    +
    [ Top ]


    +
    +
    + +

    showMainPage [line 120]

    +
    +
    +
    + void showMainPage( +string $scope) +
    +

    + + Displays the acount type specific main page of the upload.



    + +

    Parameters

    + + + + + + +
    string  $scope  account type
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:57 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/tools/_templates---ou_edit.php.html b/lam-web/developers/phpdoc/tools/_templates---ou_edit.php.html new file mode 100644 index 00000000..95e92bc9 --- /dev/null +++ b/lam-web/developers/phpdoc/tools/_templates---ou_edit.php.html @@ -0,0 +1,142 @@ + + +Docs for page ou_edit.php + + + + + + + + + + + + + +
    tools
    + + + [ class tree: tools ] + [ index: tools ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: ou_edit.php

    +Source Location: /templates/ou_edit.php

    + +
    +
    + + +

    Page Details:

    +This is an editor for organizational units.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../lib/security.inc") [line 32]
    +security functions

    include_once("../lib/config.inc") [line 34]
    +access to configuration data

    include_once("../lib/ldap.inc") [line 36]
    +access LDAP server

    include_once("../lib/status.inc") [line 38]
    +used to print status messages

    +

    +

    +
    +
    + +

    display_main [line 141]

    +
    +
    +
    + void display_main( +) +
    +

    + +

    + +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:59 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/tools/_templates---schema---schema.php.html b/lam-web/developers/phpdoc/tools/_templates---schema---schema.php.html new file mode 100644 index 00000000..a2390cc4 --- /dev/null +++ b/lam-web/developers/phpdoc/tools/_templates---schema---schema.php.html @@ -0,0 +1,130 @@ + + +Docs for page schema.php + + + + + + + + + + + + + +
    tools
    + + + [ class tree: tools ] + [ index: tools ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: schema.php

    +Source Location: /templates/schema/schema.php

    + +
    +
    + + +

    Page Details:

    +Displays the LDAP schema of the server



    +

    Tags:

    +
    + + + + + + + +
    author:  David Smith
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../../lib/security.inc") [line 35]
    +security functions

    include_once("../../lib/ldap.inc") [line 37]
    +access to LDAP server

    include_once("../../lib/config.inc") [line 39]
    +access to configuration options

    require_once("../../lib/schema.inc") [line 41]
    +schema functions

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:09 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/tools/_templates---tests---index.php.html b/lam-web/developers/phpdoc/tools/_templates---tests---index.php.html new file mode 100644 index 00000000..a6d65b47 --- /dev/null +++ b/lam-web/developers/phpdoc/tools/_templates---tests---index.php.html @@ -0,0 +1,125 @@ + + +Docs for page index.php + + + + + + + + + + + + + +
    tools
    + + + [ class tree: tools ] + [ index: tools ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: index.php

    +Source Location: /templates/tests/index.php

    + +
    +
    + + +

    Page Details:

    +Provides a list of LAM tests.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../../lib/security.inc") [line 32]
    +security functions

    include_once("../../lib/config.inc") [line 34]
    +access to configuration options

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:51 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/tools/_templates---tests---lamdaemonTest.php.html b/lam-web/developers/phpdoc/tools/_templates---tests---lamdaemonTest.php.html new file mode 100644 index 00000000..0db95faf --- /dev/null +++ b/lam-web/developers/phpdoc/tools/_templates---tests---lamdaemonTest.php.html @@ -0,0 +1,175 @@ + + +Docs for page lamdaemonTest.php + + + + + + + + + + + + + +
    tools
    + + + [ class tree: tools ] + [ index: tools ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: lamdaemonTest.php

    +Source Location: /templates/tests/lamdaemonTest.php

    + +
    +
    + + +

    Page Details:

    +Tests the lamdaemon script.



    +

    Tags:

    +
    + + + + + + + +
    author:  Roland Gruber
    author:  Thomas Manninger
    +
    +

    +

    Includes:

    +
    +include_once("../../lib/config.inc") [line 35]
    +access to configuration options

    include_once("../../lib/security.inc") [line 33]
    +security functions

    +

    +

    +
    +
    + +

    lamTestLamdaemon [line 63]

    +
    +
    +
    + boolean lamTestLamdaemon( +string $command, boolean $stopTest, connection $handle, string $testText) +
    +

    + + Runs a test case of lamdaemon.



    +

    Tags:

    +
    + + + + +
    return:  true, if errors occured
    +
    +

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + +
    string  $command  test command
    boolean  $stopTest  specifies if test should be run
    connection  $handle  SSH connection
    string  $testText  describing text
    +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:54 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/tools/_templates---tools.php.html b/lam-web/developers/phpdoc/tools/_templates---tools.php.html new file mode 100644 index 00000000..a551708d --- /dev/null +++ b/lam-web/developers/phpdoc/tools/_templates---tools.php.html @@ -0,0 +1,125 @@ + + +Docs for page tools.php + + + + + + + + + + + + + +
    tools
    + + + [ class tree: tools ] + [ index: tools ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: tools.php

    +Source Location: /templates/tools.php

    + +
    +
    + + +

    Page Details:

    +Provides a list of tools like file upload or profile editor.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("../lib/security.inc") [line 32]
    +security functions

    include_once("../lib/config.inc") [line 34]
    +access to configuration options

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:12 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/types/_lib---baseType.inc.html b/lam-web/developers/phpdoc/types/_lib---baseType.inc.html new file mode 100644 index 00000000..059a9891 --- /dev/null +++ b/lam-web/developers/phpdoc/types/_lib---baseType.inc.html @@ -0,0 +1,118 @@ + + +Docs for page baseType.inc + + + + + + + + + + + + + +
    types
    + + + [ class tree: types ] + [ index: types ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: baseType.inc

    +Source Location: /lib/baseType.inc

    + +
    +
    + +
    +

    Classes:

    +
    baseType
    +
    This is the parent class of all account types.
    +


    + +

    Page Details:

    +This is the parent class of all account types.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:40 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/types/_lib---types---group.inc.html b/lam-web/developers/phpdoc/types/_lib---types---group.inc.html new file mode 100644 index 00000000..ac2949e7 --- /dev/null +++ b/lam-web/developers/phpdoc/types/_lib---types---group.inc.html @@ -0,0 +1,123 @@ + + +Docs for page group.inc + + + + + + + + + + + + + +
    types
    + + + [ class tree: types ] + [ index: types ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: group.inc

    +Source Location: /lib/types/group.inc

    + +
    +
    + +
    +

    Classes:

    +
    group
    +
    The account type for group accounts (e.g. Unix and Samba).
    +
    lamGroupList
    +
    Generates the list view.
    +


    + +

    Page Details:

    +The account type for group accounts (e.g. Unix and Samba).



    +

    Tags:

    +
    + + + + + + + +
    author:  Roland Gruber
    author:  Ludek Finstrle
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:48 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/types/_lib---types---host.inc.html b/lam-web/developers/phpdoc/types/_lib---types---host.inc.html new file mode 100644 index 00000000..4c2c42b2 --- /dev/null +++ b/lam-web/developers/phpdoc/types/_lib---types---host.inc.html @@ -0,0 +1,120 @@ + + +Docs for page host.inc + + + + + + + + + + + + + +
    types
    + + + [ class tree: types ] + [ index: types ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: host.inc

    +Source Location: /lib/types/host.inc

    + +
    +
    + +
    +

    Classes:

    +
    host
    +
    The account type for host accounts (e.g. Samba).
    +
    lamHostList
    +
    Generates the list view.
    +


    + +

    Page Details:

    +The account type for host accounts (e.g. Samba).



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:49 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/types/_lib---types---mailAlias.inc.html b/lam-web/developers/phpdoc/types/_lib---types---mailAlias.inc.html new file mode 100644 index 00000000..7fc0c932 --- /dev/null +++ b/lam-web/developers/phpdoc/types/_lib---types---mailAlias.inc.html @@ -0,0 +1,120 @@ + + +Docs for page mailAlias.inc + + + + + + + + + + + + + +
    types
    + + + [ class tree: types ] + [ index: types ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: mailAlias.inc

    +Source Location: /lib/types/mailAlias.inc

    + +
    +
    + +
    +

    Classes:

    +
    mailAlias
    +
    The account type for mail aliases.
    +
    lamMailAliasList
    +
    Generates the list view.
    +


    + +

    Page Details:

    +The account type for mail aliases.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:10:56 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/types/_lib---types---smbDomain.inc.html b/lam-web/developers/phpdoc/types/_lib---types---smbDomain.inc.html new file mode 100644 index 00000000..890f24ca --- /dev/null +++ b/lam-web/developers/phpdoc/types/_lib---types---smbDomain.inc.html @@ -0,0 +1,120 @@ + + +Docs for page smbDomain.inc + + + + + + + + + + + + + +
    types
    + + + [ class tree: types ] + [ index: types ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: smbDomain.inc

    +Source Location: /lib/types/smbDomain.inc

    + +
    +
    + +
    +

    Classes:

    +
    smbDomain
    +
    The account type for Samba domains.
    +
    lamSmbDomainList
    +
    Generates the list view.
    +


    + +

    Page Details:

    +The account type for Samba domains.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:11 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/types/_lib---types---user.inc.html b/lam-web/developers/phpdoc/types/_lib---types---user.inc.html new file mode 100644 index 00000000..a4220669 --- /dev/null +++ b/lam-web/developers/phpdoc/types/_lib---types---user.inc.html @@ -0,0 +1,120 @@ + + +Docs for page user.inc + + + + + + + + + + + + + +
    types
    + + + [ class tree: types ] + [ index: types ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: user.inc

    +Source Location: /lib/types/user.inc

    + +
    +
    + +
    +

    Classes:

    +
    user
    +
    The account type for user accounts (e.g. Unix, Samba and Kolab).
    +
    lamUserList
    +
    Generates the list view.
    +


    + +

    Page Details:

    +The account type for user accounts (e.g. Unix, Samba and Kolab).



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    +

    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:15 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/types/_lib---types.inc.html b/lam-web/developers/phpdoc/types/_lib---types.inc.html new file mode 100644 index 00000000..918cafbc --- /dev/null +++ b/lam-web/developers/phpdoc/types/_lib---types.inc.html @@ -0,0 +1,303 @@ + + +Docs for page types.inc + + + + + + + + + + + + + +
    types
    + + + [ class tree: types ] + [ index: types ] + [ all elements ] +
    + + + + + + +
    +
    + +

    Procedural File: types.inc

    +Source Location: /lib/types.inc

    + +
    +
    + + +

    Page Details:

    +This file is the interface to the different account types.



    +

    Tags:

    +
    + + + + +
    author:  Roland Gruber
    +
    +

    +

    Includes:

    +
    +include_once("baseType.inc") [line 32]
    +parent class of account types

    include_once("lists.inc") [line 34]
    +parent class of list views

    include_once($typesINC_dirname.'/'.$entry) [line 45]
    +This includes all type definitions.

    +

    +

    +
    +
    + +

    getDefaultListAttributes [line 107]

    +
    +
    +
    + string getDefaultListAttributes( +string $type) +
    +

    + + Returns the default attribute list for an account type.

    It is used as default value for the configuration editor.




    +

    Tags:

    +
    + + + + +
    return:  attribute list
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $type  account type
    +
    [ Top ]


    +
    +
    + +

    getListAttributeDescriptions [line 119]

    +
    +
    +
    + array getListAttributeDescriptions( +string $type) +
    +

    + + Returns a list of attributes which have a translated description.

    This is used for the head row in the list view.




    +

    Tags:

    +
    + + + + +
    return:  list of descriptions
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $type  account type
    +
    [ Top ]


    +
    +
    + +

    getListClassName [line 95]

    +
    +
    +
    + string getListClassName( +string $type) +
    +

    + + Returns the class name for the list object.



    +

    Tags:

    +
    + + + + +
    return:  class name
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $type  account type
    +
    [ Top ]


    +
    +
    + +

    getTypeAlias [line 73]

    +
    +
    +
    + string getTypeAlias( +string $type) +
    +

    + + Returns the alias name of an account type.



    +

    Tags:

    +
    + + + + +
    return:  type alias
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $type  type name
    +
    [ Top ]


    +
    +
    + +

    getTypeDescription [line 84]

    +
    +
    +
    + string getTypeDescription( +string $type) +
    +

    + + Returns the description of an account type.



    +

    Tags:

    +
    + + + + +
    return:  type description
    +
    +

    + +

    Parameters

    + + + + + + +
    string  $type  type name
    +
    [ Top ]


    +
    +
    + +

    getTypes [line 54]

    +
    +
    +
    + array getTypes( +) +
    +

    + + Returns a list of available account types.



    +

    Tags:

    +
    + + + + +
    return:  list of types
    +
    +

    + +
    [ Top ]


    +
    + +
    +
    + Documentation generated on Sun, 04 Nov 2007 12:11:15 +0100 by phpDocumentor 1.4.0 +
    +
    +
    + + + diff --git a/lam-web/developers/phpdoc/types/baseType.html b/lam-web/developers/phpdoc/types/baseType.html index 9c30def5..9aacedce 100644 --- a/lam-web/developers/phpdoc/types/baseType.html +++ b/lam-web/developers/phpdoc/types/baseType.html @@ -12,9 +12,11 @@
    - [ class tree: types ] + + + [ class tree: types ] [ index: types ] - [ all elements ] + [ all elements ]
    @@ -78,7 +82,6 @@ Source Location: /lib/baseType.inc

    - diff --git a/lam-web/developers/phpdoc/types/group.html b/lam-web/developers/phpdoc/types/group.html index 5d391e9e..1b66fefa 100644 --- a/lam-web/developers/phpdoc/types/group.html +++ b/lam-web/developers/phpdoc/types/group.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -113,25 +116,24 @@ Source Location: /lib/baseType.inc

    -

    Child classes:

    -
    mailAlias
    -
    The account type for mail aliases.
    +
    group
    +
    The account type for group accounts (e.g. Unix and Samba).
    host
    The account type for host accounts (e.g. Samba).
    -
    smbDomain
    -
    The account type for Samba domains.
    +
    mailAlias
    +
    The account type for mail aliases.
    -
    group
    -
    The account type for group accounts (e.g. Unix and Samba).
    +
    smbDomain
    +
    The account type for Samba domains.
    user
    @@ -183,7 +185,7 @@ This is the parent class of all account types.



    Overridden in child classes as:

    -
    mailAlias::getAlias()
    +
    group::getAlias()
    Returns the alias name of this account type.
    @@ -191,11 +193,11 @@ This is the parent class of all account types.



    Returns the alias name of this account type.
    -
    smbDomain::getAlias()
    +
    mailAlias::getAlias()
    Returns the alias name of this account type.
    -
    group::getAlias()
    +
    smbDomain::getAlias()
    Returns the alias name of this account type.
    @@ -204,8 +206,6 @@ This is the parent class of all account types.



    - -
    [ Top ]

    @@ -232,7 +232,7 @@ This is the parent class of all account types.



    Overridden in child classes as:

    -
    mailAlias::getDefaultListAttributes()
    +
    group::getDefaultListAttributes()
    Returns the default attribute list for this account type.
    @@ -240,11 +240,11 @@ This is the parent class of all account types.



    Returns the default attribute list for this account type.
    -
    smbDomain::getDefaultListAttributes()
    +
    mailAlias::getDefaultListAttributes()
    Returns the default attribute list for this account type.
    -
    group::getDefaultListAttributes()
    +
    smbDomain::getDefaultListAttributes()
    Returns the default attribute list for this account type.
    @@ -253,8 +253,6 @@ This is the parent class of all account types.



    - -
    [ Top ]

    @@ -281,7 +279,7 @@ This is the parent class of all account types.



    Overridden in child classes as:

    -
    mailAlias::getDescription()
    +
    group::getDescription()
    Returns the description of this account type.
    @@ -289,11 +287,11 @@ This is the parent class of all account types.



    Returns the description of this account type.
    -
    smbDomain::getDescription()
    +
    mailAlias::getDescription()
    Returns the description of this account type.
    -
    group::getDescription()
    +
    smbDomain::getDescription()
    Returns the description of this account type.
    @@ -302,8 +300,6 @@ This is the parent class of all account types.



    - -
    [ Top ]

    @@ -330,7 +326,7 @@ This is the parent class of all account types.



    Overridden in child classes as:

    -
    mailAlias::getListAttributeDescriptions()
    +
    group::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
    @@ -338,11 +334,11 @@ This is the parent class of all account types.



    Returns a list of attributes which have a translated description.
    -
    smbDomain::getListAttributeDescriptions()
    +
    mailAlias::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
    -
    group::getListAttributeDescriptions()
    +
    smbDomain::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
    @@ -351,8 +347,6 @@ This is the parent class of all account types.



    - -
    [ Top ]

    @@ -379,7 +373,7 @@ This is the parent class of all account types.



    Overridden in child classes as:

    -
    mailAlias::getListClassName()
    +
    group::getListClassName()
    Returns the class name for the list object.
    @@ -387,11 +381,11 @@ This is the parent class of all account types.



    Returns the class name for the list object.
    -
    smbDomain::getListClassName()
    +
    mailAlias::getListClassName()
    Returns the class name for the list object.
    -
    group::getListClassName()
    +
    smbDomain::getListClassName()
    Returns the class name for the list object.
    @@ -400,8 +394,6 @@ This is the parent class of all account types.



    - -
    [ Top ]

    @@ -409,7 +401,7 @@ This is the parent class of all account types.




    - Documentation generated on Wed, 15 Nov 2006 18:00:38 +0100 by phpDocumentor 1.2.3 + Documentation generated on Sun, 04 Nov 2007 12:10:40 +0100 by phpDocumentor 1.4.0
    - [ class tree: types ] + + + [ class tree: types ] [ index: types ] - [ all elements ] + [ all elements ]
    @@ -78,7 +82,6 @@ Source Location: /lib/types/group.inc

    -
    @@ -118,7 +121,6 @@ Source Location: /lib/types/group.inc

    -

    Inherited Methods

    @@ -126,35 +128,30 @@ Source Location: /lib/types/group.inc

    baseType::getAlias() -
    Returns the alias name of this account type.
    baseType::getDefaultListAttributes() -
    Returns the default attribute list for this account type.
    baseType::getDescription() -
    Returns the description of this account type.
    baseType::getListAttributeDescriptions() -
    Returns a list of attributes which have a translated description.
    baseType::getListClassName() -
    Returns the class name for the list object. @@ -169,7 +166,7 @@ Source Location: /lib/types/group.inc

    Class Details

    -[line 36]
    +[line 37]
    The account type for group accounts (e.g. Unix and Samba).



    [ Top ]

    @@ -181,7 +178,7 @@ The account type for group accounts (e.g. Unix and Samba).


    -

    method getAlias [line 43]

    +

    method getAlias [line 44]

    @@ -201,14 +198,12 @@ The account type for group accounts (e.g. Unix and Samba).




    - -Overrides baseType::getAlias() (Returns the alias name of this account type.)

    - + Overrides baseType::getAlias() (Returns the alias name of this account type.)

    [ Top ]

    -

    method getDefaultListAttributes [line 70]

    +

    method getDefaultListAttributes [line 71]

    @@ -228,14 +223,12 @@ Overrides baseType::getAlias()

    - -Overrides
    baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

    - + Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

    [ Top ]

    -

    method getDescription [line 52]

    +

    method getDescription [line 53]

    @@ -255,14 +248,12 @@ Overrides baseTy

    - -Overrides
    baseType::getDescription() (Returns the description of this account type.)

    - + Overrides baseType::getDescription() (Returns the description of this account type.)

    [ Top ]

    -

    method getListAttributeDescriptions [line 80]

    +

    method getListAttributeDescriptions [line 81]

    @@ -282,14 +273,12 @@ Overrides baseType::getDes

    - -Overrides
    baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

    - + Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

    [ Top ]

    -

    method getListClassName [line 61]

    +

    method getListClassName [line 62]

    diff --git a/lam-web/developers/phpdoc/types/host.html b/lam-web/developers/phpdoc/types/host.html index 5731baa0..e6802ccb 100644 --- a/lam-web/developers/phpdoc/types/host.html +++ b/lam-web/developers/phpdoc/types/host.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -309,9 +298,7 @@ Overrides ba

    - -Overrides
    baseType::getListClassName() (Returns the class name for the list object.)

    - + Overrides baseType::getListClassName() (Returns the class name for the list object.)

    [ Top ]

    @@ -319,7 +306,7 @@ Overrides baseType::getL
    - [ class tree: types ] + + + [ class tree: types ] [ index: types ] - [ all elements ] + [ all elements ]
    diff --git a/lam-web/developers/phpdoc/types/mailAlias.html b/lam-web/developers/phpdoc/types/mailAlias.html index f9793493..63147889 100644 --- a/lam-web/developers/phpdoc/types/mailAlias.html +++ b/lam-web/developers/phpdoc/types/mailAlias.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -78,7 +82,6 @@ Source Location: /lib/types/host.inc

    -
    @@ -118,7 +121,6 @@ Source Location: /lib/types/host.inc

    -

    Inherited Methods

    @@ -126,35 +128,30 @@ Source Location: /lib/types/host.inc

    baseType::getAlias() -
    Returns the alias name of this account type.
    baseType::getDefaultListAttributes() -
    Returns the default attribute list for this account type.
    baseType::getDescription() -
    Returns the description of this account type.
    baseType::getListAttributeDescriptions() -
    Returns a list of attributes which have a translated description.
    baseType::getListClassName() -
    Returns the class name for the list object. @@ -201,9 +198,7 @@ The account type for host accounts (e.g. Samba).





    - -Overrides baseType::getAlias() (Returns the alias name of this account type.)

    - + Overrides baseType::getAlias() (Returns the alias name of this account type.)

    [ Top ]

    @@ -228,9 +223,7 @@ Overrides baseType::getAlias()

    - -Overrides
    baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

    - + Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

    [ Top ]

    @@ -255,9 +248,7 @@ Overrides baseTy

    - -Overrides
    baseType::getDescription() (Returns the description of this account type.)

    - + Overrides baseType::getDescription() (Returns the description of this account type.)

    [ Top ]

    @@ -282,9 +273,7 @@ Overrides baseType::getDes

    - -Overrides
    baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

    - + Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

    [ Top ]

    @@ -309,9 +298,7 @@ Overrides ba

    - -Overrides
    baseType::getListClassName() (Returns the class name for the list object.)

    - + Overrides baseType::getListClassName() (Returns the class name for the list object.)

    [ Top ]

    @@ -319,7 +306,7 @@ Overrides baseType::getL
    - [ class tree: types ] + + + [ class tree: types ] [ index: types ] - [ all elements ] + [ all elements ]
    diff --git a/lam-web/developers/phpdoc/types/smbDomain.html b/lam-web/developers/phpdoc/types/smbDomain.html index 73c4c1c6..fcd63141 100644 --- a/lam-web/developers/phpdoc/types/smbDomain.html +++ b/lam-web/developers/phpdoc/types/smbDomain.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -78,7 +82,6 @@ Source Location: /lib/types/mailAlias.inc

    -
    @@ -118,7 +121,6 @@ Source Location: /lib/types/mailAlias.inc

    -

    Inherited Methods

    @@ -126,35 +128,30 @@ Source Location: /lib/types/mailAlias.inc

    baseType::getAlias() -
    Returns the alias name of this account type.
    baseType::getDefaultListAttributes() -
    Returns the default attribute list for this account type.
    baseType::getDescription() -
    Returns the description of this account type.
    baseType::getListAttributeDescriptions() -
    Returns a list of attributes which have a translated description.
    baseType::getListClassName() -
    Returns the class name for the list object. @@ -201,9 +198,7 @@ The account type for mail aliases.





    - -Overrides baseType::getAlias() (Returns the alias name of this account type.)

    - + Overrides baseType::getAlias() (Returns the alias name of this account type.)

    [ Top ]

    @@ -228,9 +223,7 @@ Overrides baseType::getAlias()

    - -Overrides
    baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

    - + Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

    [ Top ]

    @@ -255,9 +248,7 @@ Overrides baseTy

    - -Overrides
    baseType::getDescription() (Returns the description of this account type.)

    - + Overrides baseType::getDescription() (Returns the description of this account type.)

    [ Top ]

    @@ -282,9 +273,7 @@ Overrides baseType::getDes

    - -Overrides
    baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

    - + Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

    [ Top ]

    @@ -309,9 +298,7 @@ Overrides ba

    - -Overrides
    baseType::getListClassName() (Returns the class name for the list object.)

    - + Overrides baseType::getListClassName() (Returns the class name for the list object.)

    [ Top ]

    @@ -319,7 +306,7 @@ Overrides baseType::getL
    - [ class tree: types ] + + + [ class tree: types ] [ index: types ] - [ all elements ] + [ all elements ]
    diff --git a/lam-web/developers/phpdoc/types/user.html b/lam-web/developers/phpdoc/types/user.html index 3a946d1d..2d4f1929 100644 --- a/lam-web/developers/phpdoc/types/user.html +++ b/lam-web/developers/phpdoc/types/user.html @@ -12,9 +12,11 @@ @@ -24,8 +26,8 @@
    @@ -78,7 +82,6 @@ Source Location: /lib/types/smbDomain.inc

    -
    @@ -118,7 +121,6 @@ Source Location: /lib/types/smbDomain.inc

    -

    Inherited Methods

    @@ -126,35 +128,30 @@ Source Location: /lib/types/smbDomain.inc

    baseType::getAlias() -
    Returns the alias name of this account type.
    baseType::getDefaultListAttributes() -
    Returns the default attribute list for this account type.
    baseType::getDescription() -
    Returns the description of this account type.
    baseType::getListAttributeDescriptions() -
    Returns a list of attributes which have a translated description.
    baseType::getListClassName() -
    Returns the class name for the list object. @@ -201,9 +198,7 @@ The account type for Samba domains.





    - -Overrides baseType::getAlias() (Returns the alias name of this account type.)

    - + Overrides baseType::getAlias() (Returns the alias name of this account type.)

    [ Top ]

    @@ -228,9 +223,7 @@ Overrides baseType::getAlias()

    - -Overrides
    baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

    - + Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

    [ Top ]

    @@ -255,9 +248,7 @@ Overrides baseTy

    - -Overrides
    baseType::getDescription() (Returns the description of this account type.)

    - + Overrides baseType::getDescription() (Returns the description of this account type.)

    [ Top ]

    @@ -282,9 +273,7 @@ Overrides baseType::getDes

    - -Overrides
    baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

    - + Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

    [ Top ]

    @@ -309,9 +298,7 @@ Overrides ba

    - -Overrides
    baseType::getListClassName() (Returns the class name for the list object.)

    - + Overrides baseType::getListClassName() (Returns the class name for the list object.)

    [ Top ]

    @@ -319,7 +306,7 @@ Overrides baseType::getL
    - [ class tree: types ] + + + [ class tree: types ] [ index: types ] - [ all elements ] + [ all elements ]
    @@ -78,7 +82,6 @@ Source Location: /lib/types/user.inc

    -
    @@ -118,7 +121,6 @@ Source Location: /lib/types/user.inc

    -

    Inherited Methods

    @@ -126,35 +128,30 @@ Source Location: /lib/types/user.inc

    baseType::getAlias() -
    Returns the alias name of this account type.
    baseType::getDefaultListAttributes() -
    Returns the default attribute list for this account type.
    baseType::getDescription() -
    Returns the description of this account type.
    baseType::getListAttributeDescriptions() -
    Returns a list of attributes which have a translated description.
    baseType::getListClassName() -
    Returns the class name for the list object. @@ -201,9 +198,7 @@ The account type for user accounts (e.g. Unix, Samba and Kolab).



    - -Overrides baseType::getAlias() (Returns the alias name of this account type.)

    - + Overrides baseType::getAlias() (Returns the alias name of this account type.)

    [ Top ]

    @@ -228,9 +223,7 @@ Overrides baseType::getAlias()

    - -Overrides
    baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

    - + Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

    [ Top ]

    @@ -255,9 +248,7 @@ Overrides baseTy

    - -Overrides
    baseType::getDescription() (Returns the description of this account type.)

    - + Overrides baseType::getDescription() (Returns the description of this account type.)

    [ Top ]

    @@ -282,9 +273,7 @@ Overrides baseType::getDes

    - -Overrides
    baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

    - + Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

    [ Top ]

    @@ -309,9 +298,7 @@ Overrides ba

    - -Overrides
    baseType::getListClassName() (Returns the class name for the list object.)

    - + Overrides baseType::getListClassName() (Returns the class name for the list object.)

    [ Top ]

    @@ -319,7 +306,7 @@ Overrides baseType::getL