From 9fa23b48e91854b2d5c401c9457f5ac8f5b50327 Mon Sep 17 00:00:00 2001 From: Roland Gruber Date: Thu, 7 Feb 2008 19:17:08 +0000 Subject: [PATCH] *** empty log message *** --- lam-web/developers/docs.htm | 2 +- .../phpdoc/Help/_help---help.inc.html | 93 - .../phpdoc/Help/_help_help_inc.html | 90 - .../phpdoc/Help/_templates---help.php.html | 159 - .../phpdoc/Help/_templates_help_php.html | 159 - lam-web/developers/phpdoc/LDAP/Ldap.html | 535 --- .../phpdoc/LDAP/_lib---ldap.inc.html | 138 - .../developers/phpdoc/LDAP/_lib_ldap_inc.html | 135 - lam-web/developers/phpdoc/PDF/FPDF.html | 3230 ----------------- lam-web/developers/phpdoc/PDF/UFPDF.html | 1647 --------- .../phpdoc/PDF/_lib---font---vera.php.html | 123 - .../phpdoc/PDF/_lib---font---verab.php.html | 123 - .../phpdoc/PDF/_lib---font---verabi.php.html | 123 - .../phpdoc/PDF/_lib---font---verai.php.html | 123 - .../phpdoc/PDF/_lib---fpdf.php.html | 141 - .../phpdoc/PDF/_lib---lamPDF.inc.html | 128 - .../developers/phpdoc/PDF/_lib---pdf.inc.html | 317 -- .../phpdoc/PDF/_lib---pdfstruct.inc.html | 295 -- .../phpdoc/PDF/_lib---ufpdf.php.html | 148 - .../phpdoc/PDF/_lib---xml_parser.inc.html | 128 - .../phpdoc/PDF/_lib_font_vera_php.html | 117 - .../phpdoc/PDF/_lib_font_verab_php.html | 117 - .../phpdoc/PDF/_lib_font_verabi_php.html | 117 - .../phpdoc/PDF/_lib_font_verai_php.html | 117 - .../developers/phpdoc/PDF/_lib_fpdf_php.html | 136 - .../developers/phpdoc/PDF/_lib_pdf_inc.html | 319 -- .../phpdoc/PDF/_lib_pdfstruct_inc.html | 294 -- .../developers/phpdoc/PDF/_lib_ufpdf_php.html | 143 - .../phpdoc/PDF/_lib_xml_parser_inc.html | 122 - .../_templates---pdfedit---pdfdelete.php.html | 128 - .../_templates---pdfedit---pdfmain.php.html | 131 - .../_templates---pdfedit---pdfpage.php.html | 135 - .../PDF/_templates_pdfedit_pdfdelete_php.html | 122 - .../PDF/_templates_pdfedit_pdfmain_php.html | 125 - .../PDF/_templates_pdfedit_pdfpage_php.html | 129 - lam-web/developers/phpdoc/PDF/lamPDF.html | 1220 ------- lam-web/developers/phpdoc/PDF/xmlParser.html | 215 -- .../developers/phpdoc/classtrees_Help.html | 62 - .../developers/phpdoc/classtrees_LDAP.html | 67 - lam-web/developers/phpdoc/classtrees_PDF.html | 76 - .../phpdoc/classtrees_configuration.html | 72 - lam-web/developers/phpdoc/classtrees_lib.html | 79 - .../developers/phpdoc/classtrees_lists.html | 81 - .../developers/phpdoc/classtrees_main.html | 62 - .../developers/phpdoc/classtrees_modules.html | 91 - .../phpdoc/classtrees_profiles.html | 62 - .../phpdoc/classtrees_selfService.html | 67 - .../developers/phpdoc/classtrees_tests.html | 62 - .../developers/phpdoc/classtrees_tools.html | 81 - .../developers/phpdoc/classtrees_types.html | 69 - .../phpdoc/configuration/LAMCfgMain.html | 402 -- .../phpdoc/configuration/LAMConfig.html | 1442 -------- .../configuration/_lib---config.inc.html | 257 -- .../phpdoc/configuration/_lib_config_inc.html | 212 -- .../_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 - .../_templates_config_conflogin_php.html | 114 - .../_templates_config_confmain_php.html | 132 - .../_templates_config_confmodules_php.html | 153 - .../_templates_config_conftypes_php.html | 115 - .../_templates_config_index_php.html | 113 - .../_templates_config_mainlogin_php.html | 114 - .../_templates_config_mainmanage_php.html | 115 - .../_templates_config_profmanage_php.html | 114 - lam-web/developers/phpdoc/elementindex.html | 2677 -------------- .../developers/phpdoc/elementindex_Help.html | 111 - .../developers/phpdoc/elementindex_LDAP.html | 183 - .../developers/phpdoc/elementindex_PDF.html | 703 ---- .../phpdoc/elementindex_configuration.html | 316 -- .../developers/phpdoc/elementindex_lib.html | 561 --- .../developers/phpdoc/elementindex_lists.html | 625 ---- .../developers/phpdoc/elementindex_main.html | 145 - .../phpdoc/elementindex_modules.html | 1156 ------ .../phpdoc/elementindex_profiles.html | 139 - .../phpdoc/elementindex_selfService.html | 224 -- .../developers/phpdoc/elementindex_tests.html | 100 - .../developers/phpdoc/elementindex_tools.html | 452 --- .../developers/phpdoc/elementindex_types.html | 255 -- lam-web/developers/phpdoc/errors.html | 175 - lam-web/developers/phpdoc/index.html | 65 - lam-web/developers/phpdoc/li_Help.html | 76 - lam-web/developers/phpdoc/li_LDAP.html | 79 - lam-web/developers/phpdoc/li_PDF.html | 106 - .../developers/phpdoc/li_configuration.html | 96 - lam-web/developers/phpdoc/li_lib.html | 94 - lam-web/developers/phpdoc/li_lists.html | 154 - lam-web/developers/phpdoc/li_main.html | 84 - lam-web/developers/phpdoc/li_modules.html | 144 - lam-web/developers/phpdoc/li_profiles.html | 80 - lam-web/developers/phpdoc/li_selfService.html | 89 - lam-web/developers/phpdoc/li_tests.html | 78 - lam-web/developers/phpdoc/li_tools.html | 106 - lam-web/developers/phpdoc/li_types.html | 96 - .../developers/phpdoc/lib/AttributeType.html | 1199 ------ .../developers/phpdoc/lib/MatchingRule.html | 473 --- .../phpdoc/lib/MatchingRuleUse.html | 350 -- .../developers/phpdoc/lib/ObjectClass.html | 770 ---- .../phpdoc/lib/ObjectClassAttribute.html | 255 -- lam-web/developers/phpdoc/lib/SchemaItem.html | 358 -- lam-web/developers/phpdoc/lib/Syntax.html | 256 -- .../phpdoc/lib/_lib---account.inc.html | 588 --- .../phpdoc/lib/_lib---cache.inc.html | 123 - .../phpdoc/lib/_lib---schema.inc.html | 595 --- .../phpdoc/lib/_lib---security.inc.html | 237 -- .../phpdoc/lib/_lib---status.inc.html | 149 - .../phpdoc/lib/_lib_account_inc.html | 623 ---- .../developers/phpdoc/lib/_lib_cache_inc.html | 116 - .../phpdoc/lib/_lib_schema_inc.html | 505 --- .../phpdoc/lib/_lib_security_inc.html | 189 - .../phpdoc/lib/_lib_status_inc.html | 146 - lam-web/developers/phpdoc/lib/cache.html | 459 --- .../phpdoc/lists/_lib---lists.inc.html | 190 - .../phpdoc/lists/_lib_lists_inc.html | 170 - ...emplates---lists---changePassword.php.html | 307 -- .../_templates---lists---deletelink.php.html | 177 - .../lists/_templates---lists---list.php.html | 177 - .../_templates---lists---userlink.php.html | 209 -- .../lists/_templates_lists_list_php.html | 165 - .../lists/_templates_lists_userlink_php.html | 198 - .../phpdoc/lists/lamBooleanListOption.html | 397 -- .../developers/phpdoc/lists/lamGroupList.html | 661 ---- .../developers/phpdoc/lists/lamHostList.html | 491 --- lam-web/developers/phpdoc/lists/lamList.html | 1377 ------- .../phpdoc/lists/lamListOption.html | 463 --- .../developers/phpdoc/lists/lamListTool.html | 357 -- .../phpdoc/lists/lamMailAliasList.html | 491 --- .../phpdoc/lists/lamSelectListOption.html | 411 --- .../phpdoc/lists/lamSmbDomainList.html | 491 --- .../developers/phpdoc/lists/lamUserList.html | 729 ---- .../phpdoc/lists/tree/_lib---tree.inc.html | 1200 ------ .../phpdoc/lists/tree/_lib_tree_inc.html | 1022 ------ .../_templates---tree---add_attr.php.html | 206 -- ..._templates---tree---add_attr_form.php.html | 205 -- .../_templates---tree---add_oclass.php.html | 182 - ...emplates---tree---add_oclass_form.php.html | 182 - .../_templates---tree---add_value.php.html | 182 - ...templates---tree---add_value_form.php.html | 182 - .../_templates---tree---collapse.php.html | 181 - .../tree/_templates---tree---create.php.html | 183 - .../_templates---tree---create_form.php.html | 183 - ...plates---tree---creation_template.php.html | 184 - .../tree/_templates---tree---delete.php.html | 182 - .../_templates---tree---delete_attr.php.html | 182 - .../_templates---tree---delete_form.php.html | 182 - ...tes---tree---download_binary_attr.php.html | 182 - .../tree/_templates---tree---edit.php.html | 183 - .../tree/_templates---tree---expand.php.html | 181 - .../tree/_templates---tree---export.php.html | 183 - .../_templates---tree---export_form.php.html | 206 -- .../tree/_templates---tree---rdelete.php.html | 205 -- .../tree/_templates---tree---refresh.php.html | 181 - ...e---templates---creation---custom.php.html | 253 -- ...ates---creation---new_ou_template.php.html | 174 - ...es---tree---templates---templates.inc.html | 174 - .../tree/_templates---tree---tree.php.html | 242 -- .../_templates---tree---tree_view.php.html | 178 - .../tree/_templates---tree---update.php.html | 182 - ...templates---tree---update_confirm.php.html | 182 - .../_templates_tree_add_attr_form_php.html | 186 - .../tree/_templates_tree_add_attr_php.html | 187 - .../_templates_tree_add_oclass_form_php.html | 170 - .../tree/_templates_tree_add_oclass_php.html | 170 - .../_templates_tree_add_value_form_php.html | 170 - .../tree/_templates_tree_add_value_php.html | 170 - .../tree/_templates_tree_collapse_php.html | 169 - .../tree/_templates_tree_create_form_php.html | 171 - .../tree/_templates_tree_create_php.html | 171 - ..._templates_tree_creation_template_php.html | 172 - .../tree/_templates_tree_delete_attr_php.html | 170 - .../tree/_templates_tree_delete_form_php.html | 170 - .../tree/_templates_tree_delete_php.html | 170 - ...mplates_tree_download_binary_attr_php.html | 170 - .../lists/tree/_templates_tree_edit_php.html | 171 - .../tree/_templates_tree_expand_php.html | 169 - .../tree/_templates_tree_export_form_php.html | 195 - .../tree/_templates_tree_export_php.html | 171 - .../tree/_templates_tree_rdelete_php.html | 186 - .../tree/_templates_tree_refresh_php.html | 169 - ...es_tree_templates_creation_custom_php.html | 210 -- ...emplates_creation_new_ou_template_php.html | 162 - ...emplates_tree_templates_templates_inc.html | 162 - .../lists/tree/_templates_tree_tree_php.html | 201 - .../tree/_templates_tree_tree_view_php.html | 166 - .../_templates_tree_update_confirm_php.html | 170 - .../tree/_templates_tree_update_php.html | 170 - .../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 - .../phpdoc/main/_templates_delete_php.html | 174 - .../phpdoc/main/_templates_initsuff_php.html | 105 - .../phpdoc/main/_templates_login_php.html | 131 - .../phpdoc/main/_templates_logout_php.html | 104 - .../main/_templates_main_header_php.html | 104 - .../phpdoc/main/_templates_main_php.html | 102 - .../developers/phpdoc/media/background.png | Bin 237 -> 0 bytes lam-web/developers/phpdoc/media/empty.png | Bin 205 -> 0 bytes lam-web/developers/phpdoc/media/style.css | 195 - .../phpdoc/modules/_lib---baseModule.inc.html | 166 - .../phpdoc/modules/_lib---createntlm.inc.html | 166 - .../phpdoc/modules/_lib---lamdaemon.inc.html | 241 -- .../modules/_lib---modules---account.inc.html | 172 - .../_lib---modules---groupOfNames.inc.html | 166 - ...ib---modules---groupOfUniqueNames.inc.html | 170 - .../_lib---modules---ieee802device.inc.html | 166 - ...-modules---inetLocalMailRecipient.inc.html | 166 - .../_lib---modules---inetOrgPerson.inc.html | 172 - .../_lib---modules---kolabUser.inc.html | 166 - .../_lib---modules---ldapPublicKey.inc.html | 169 - .../_lib---modules---nisMailAlias.inc.html | 166 - .../_lib---modules---posixAccount.inc.html | 175 - .../_lib---modules---posixGroup.inc.html | 172 - .../modules/_lib---modules---quota.inc.html | 172 - .../_lib---modules---sambaAccount.inc.html | 172 - .../_lib---modules---sambaDomain.inc.html | 166 - ...lib---modules---sambaGroupMapping.inc.html | 172 - ...sambaSamAccount---sambaMungedDial.inc.html | 192 - .../_lib---modules---sambaSamAccount.inc.html | 176 - .../_lib---modules---shadowAccount.inc.html | 172 - .../phpdoc/modules/_lib---modules.inc.html | 887 ----- .../phpdoc/modules/_lib_baseModule_inc.html | 153 - .../phpdoc/modules/_lib_createntlm_inc.html | 153 - .../phpdoc/modules/_lib_lamdaemon_inc.html | 217 -- .../modules/_lib_modules_account_inc.html | 159 - .../_lib_modules_ieee802device_inc.html | 153 - .../phpdoc/modules/_lib_modules_inc.html | 878 ----- ...ib_modules_inetLocalMailRecipient_inc.html | 153 - .../_lib_modules_inetOrgPerson_inc.html | 159 - .../modules/_lib_modules_kolabUser_inc.html | 153 - .../_lib_modules_ldapPublicKey_inc.html | 156 - .../_lib_modules_nisMailAlias_inc.html | 153 - .../_lib_modules_posixAccount_inc.html | 159 - .../modules/_lib_modules_posixGroup_inc.html | 159 - .../modules/_lib_modules_quota_inc.html | 159 - .../_lib_modules_sambaAccount_inc.html | 159 - .../modules/_lib_modules_sambaDomain_inc.html | 153 - .../_lib_modules_sambaGroupMapping_inc.html | 159 - .../_lib_modules_sambaSamAccount_inc.html | 159 - .../_lib_modules_shadowAccount_inc.html | 159 - .../_templates---account---edit.php.html | 170 - .../modules/_templates_account_edit_php.html | 157 - .../developers/phpdoc/modules/account.html | 797 ---- .../phpdoc/modules/accountContainer.html | 767 ---- .../developers/phpdoc/modules/baseModule.html | 2426 ------------- .../phpdoc/modules/groupOfNames.html | 897 ----- .../phpdoc/modules/groupOfUniqueNames.html | 708 ---- .../phpdoc/modules/ieee802Device.html | 719 ---- .../modules/inetLocalMailRecipient.html | 719 ---- .../phpdoc/modules/inetOrgPerson.html | 969 ----- .../developers/phpdoc/modules/kolabUser.html | 833 ----- .../phpdoc/modules/ldapPublicKey.html | 693 ---- .../phpdoc/modules/nisMailAlias.html | 771 ---- .../phpdoc/modules/posixAccount.html | 1396 ------- .../developers/phpdoc/modules/posixGroup.html | 1047 ------ lam-web/developers/phpdoc/modules/quota.html | 976 ----- .../phpdoc/modules/samba3domain.html | 369 -- .../phpdoc/modules/sambaAccount.html | 976 ----- .../phpdoc/modules/sambaDomain.html | 719 ---- .../phpdoc/modules/sambaGroupMapping.html | 881 ----- .../phpdoc/modules/sambaMungedDial.html | 1144 ------ .../phpdoc/modules/sambaSamAccount.html | 1166 ------ .../phpdoc/modules/shadowAccount.html | 825 ----- .../developers/phpdoc/modules/smbHash.html | 764 ---- .../phpdoc/profiles/_lib---profiles.inc.html | 245 -- .../phpdoc/profiles/_lib_profiles_inc.html | 246 -- ...plates---profedit---profiledelete.php.html | 104 - ...emplates---profedit---profilemain.php.html | 104 - ...emplates---profedit---profilepage.php.html | 106 - ..._templates_profedit_profiledelete_php.html | 101 - .../_templates_profedit_profilemain_php.html | 101 - .../_templates_profedit_profilepage_php.html | 103 - lam-web/developers/phpdoc/ric_INSTALL.html | 124 - lam-web/developers/phpdoc/ric_README.html | 142 - .../selfService/_lib---selfService.inc.html | 460 --- ...plates---selfService---adminLogin.php.html | 112 - ...mplates---selfService---adminMain.php.html | 111 - ...plates---selfService---profManage.php.html | 111 - ...---selfService---selfServiceLogin.php.html | 111 - ...s---selfService---selfServiceMain.php.html | 111 - .../selfService/selfServiceProfile.html | 417 --- .../tests/_tests---conf-main-test.php.html | 99 - .../phpdoc/tests/_tests---conf-test.php.html | 99 - .../tests/_tests---status-test.php.html | 99 - .../tests/_tests_conf-main-test_php.html | 96 - .../phpdoc/tests/_tests_conf-test_php.html | 96 - .../phpdoc/tests/_tests_status-test_php.html | 96 - lam-web/developers/phpdoc/tools/LAMTool.html | 294 -- .../phpdoc/tools/LdapExportInfo.html | 255 -- .../phpdoc/tools/MyCustomExporter.html | 321 -- .../phpdoc/tools/PlaAbstractExporter.html | 362 -- .../phpdoc/tools/PlaCSVExporter.html | 436 --- .../phpdoc/tools/PlaDsmlExporter.html | 375 -- .../developers/phpdoc/tools/PlaExporter.html | 526 --- .../phpdoc/tools/PlaLdapExporter.html | 539 --- .../phpdoc/tools/PlaLdifExporter.html | 431 --- .../phpdoc/tools/PlaVcardExporter.html | 380 -- .../phpdoc/tools/_lib---export.inc.html | 247 -- .../phpdoc/tools/_lib_export_inc.html | 244 -- .../_templates---massBuildAccounts.php.html | 130 - .../tools/_templates---massDoUpload.php.html | 132 - .../tools/_templates---masscreate.php.html | 186 - .../tools/_templates---ou_edit.php.html | 145 - .../_templates---schema---schema.php.html | 133 - .../tools/_templates---tests---index.php.html | 128 - ...templates---tests---lamdaemonTest.php.html | 178 - .../_templates---tests---schemaTest.php.html | 199 - .../phpdoc/tools/_templates---tools.php.html | 133 - .../_templates_massBuildAccounts_php.html | 123 - .../tools/_templates_massDoUpload_php.html | 125 - .../tools/_templates_masscreate_php.html | 181 - .../phpdoc/tools/_templates_ou_edit_php.html | 139 - .../tools/_templates_schema_schema_php.html | 126 - .../tools/_templates_tests_index_php.html | 121 - .../_templates_tests_lamdaemonTest_php.html | 169 - .../phpdoc/tools/_templates_tools_php.html | 121 - .../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 | 304 -- .../phpdoc/types/_lib_baseType_inc.html | 114 - .../phpdoc/types/_lib_types_group_inc.html | 116 - .../phpdoc/types/_lib_types_host_inc.html | 116 - .../phpdoc/types/_lib_types_inc.html | 305 -- .../types/_lib_types_mailAlias_inc.html | 116 - .../types/_lib_types_smbDomain_inc.html | 116 - .../phpdoc/types/_lib_types_user_inc.html | 116 - lam-web/developers/phpdoc/types/baseType.html | 412 --- lam-web/developers/phpdoc/types/group.html | 317 -- lam-web/developers/phpdoc/types/host.html | 317 -- .../developers/phpdoc/types/mailAlias.html | 317 -- .../developers/phpdoc/types/smbDomain.html | 317 -- lam-web/developers/phpdoc/types/user.html | 317 -- 343 files changed, 1 insertion(+), 97954 deletions(-) delete mode 100644 lam-web/developers/phpdoc/Help/_help---help.inc.html delete mode 100644 lam-web/developers/phpdoc/Help/_help_help_inc.html delete mode 100644 lam-web/developers/phpdoc/Help/_templates---help.php.html delete mode 100644 lam-web/developers/phpdoc/Help/_templates_help_php.html delete mode 100644 lam-web/developers/phpdoc/LDAP/Ldap.html delete mode 100644 lam-web/developers/phpdoc/LDAP/_lib---ldap.inc.html delete mode 100644 lam-web/developers/phpdoc/LDAP/_lib_ldap_inc.html delete mode 100644 lam-web/developers/phpdoc/PDF/FPDF.html delete mode 100644 lam-web/developers/phpdoc/PDF/UFPDF.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib---font---vera.php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib---font---verab.php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib---font---verabi.php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib---font---verai.php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib---fpdf.php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib---lamPDF.inc.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib---pdf.inc.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib---pdfstruct.inc.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib---ufpdf.php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib---xml_parser.inc.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib_font_vera_php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib_font_verab_php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib_font_verabi_php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib_font_verai_php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib_fpdf_php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib_pdf_inc.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib_pdfstruct_inc.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib_ufpdf_php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_lib_xml_parser_inc.html delete mode 100644 lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfdelete.php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfmain.php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfpage.php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfdelete_php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfmain_php.html delete mode 100644 lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfpage_php.html delete mode 100644 lam-web/developers/phpdoc/PDF/lamPDF.html delete mode 100644 lam-web/developers/phpdoc/PDF/xmlParser.html delete mode 100644 lam-web/developers/phpdoc/classtrees_Help.html delete mode 100644 lam-web/developers/phpdoc/classtrees_LDAP.html delete mode 100644 lam-web/developers/phpdoc/classtrees_PDF.html delete mode 100644 lam-web/developers/phpdoc/classtrees_configuration.html delete mode 100644 lam-web/developers/phpdoc/classtrees_lib.html delete mode 100644 lam-web/developers/phpdoc/classtrees_lists.html delete mode 100644 lam-web/developers/phpdoc/classtrees_main.html delete mode 100644 lam-web/developers/phpdoc/classtrees_modules.html delete mode 100644 lam-web/developers/phpdoc/classtrees_profiles.html delete mode 100644 lam-web/developers/phpdoc/classtrees_selfService.html delete mode 100644 lam-web/developers/phpdoc/classtrees_tests.html delete mode 100644 lam-web/developers/phpdoc/classtrees_tools.html delete mode 100644 lam-web/developers/phpdoc/classtrees_types.html delete mode 100644 lam-web/developers/phpdoc/configuration/LAMCfgMain.html delete mode 100644 lam-web/developers/phpdoc/configuration/LAMConfig.html delete mode 100644 lam-web/developers/phpdoc/configuration/_lib---config.inc.html delete mode 100644 lam-web/developers/phpdoc/configuration/_lib_config_inc.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---conflogin.php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---confmain.php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---confmodules.php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---conftypes.php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---index.php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---mainlogin.php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---mainmanage.php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates---config---profmanage.php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates_config_conflogin_php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates_config_confmain_php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates_config_confmodules_php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates_config_conftypes_php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates_config_index_php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates_config_mainlogin_php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates_config_mainmanage_php.html delete mode 100644 lam-web/developers/phpdoc/configuration/_templates_config_profmanage_php.html delete mode 100644 lam-web/developers/phpdoc/elementindex.html delete mode 100644 lam-web/developers/phpdoc/elementindex_Help.html delete mode 100644 lam-web/developers/phpdoc/elementindex_LDAP.html delete mode 100644 lam-web/developers/phpdoc/elementindex_PDF.html delete mode 100644 lam-web/developers/phpdoc/elementindex_configuration.html delete mode 100644 lam-web/developers/phpdoc/elementindex_lib.html delete mode 100644 lam-web/developers/phpdoc/elementindex_lists.html delete mode 100644 lam-web/developers/phpdoc/elementindex_main.html delete mode 100644 lam-web/developers/phpdoc/elementindex_modules.html delete mode 100644 lam-web/developers/phpdoc/elementindex_profiles.html delete mode 100644 lam-web/developers/phpdoc/elementindex_selfService.html delete mode 100644 lam-web/developers/phpdoc/elementindex_tests.html delete mode 100644 lam-web/developers/phpdoc/elementindex_tools.html delete mode 100644 lam-web/developers/phpdoc/elementindex_types.html delete mode 100644 lam-web/developers/phpdoc/errors.html delete mode 100644 lam-web/developers/phpdoc/index.html delete mode 100644 lam-web/developers/phpdoc/li_Help.html delete mode 100644 lam-web/developers/phpdoc/li_LDAP.html delete mode 100644 lam-web/developers/phpdoc/li_PDF.html delete mode 100644 lam-web/developers/phpdoc/li_configuration.html delete mode 100644 lam-web/developers/phpdoc/li_lib.html delete mode 100644 lam-web/developers/phpdoc/li_lists.html delete mode 100644 lam-web/developers/phpdoc/li_main.html delete mode 100644 lam-web/developers/phpdoc/li_modules.html delete mode 100644 lam-web/developers/phpdoc/li_profiles.html delete mode 100644 lam-web/developers/phpdoc/li_selfService.html delete mode 100644 lam-web/developers/phpdoc/li_tests.html delete mode 100644 lam-web/developers/phpdoc/li_tools.html delete mode 100644 lam-web/developers/phpdoc/li_types.html delete mode 100644 lam-web/developers/phpdoc/lib/AttributeType.html delete mode 100644 lam-web/developers/phpdoc/lib/MatchingRule.html delete mode 100644 lam-web/developers/phpdoc/lib/MatchingRuleUse.html delete mode 100644 lam-web/developers/phpdoc/lib/ObjectClass.html delete mode 100644 lam-web/developers/phpdoc/lib/ObjectClassAttribute.html delete mode 100644 lam-web/developers/phpdoc/lib/SchemaItem.html delete mode 100644 lam-web/developers/phpdoc/lib/Syntax.html delete mode 100644 lam-web/developers/phpdoc/lib/_lib---account.inc.html delete mode 100644 lam-web/developers/phpdoc/lib/_lib---cache.inc.html delete mode 100644 lam-web/developers/phpdoc/lib/_lib---schema.inc.html delete mode 100644 lam-web/developers/phpdoc/lib/_lib---security.inc.html delete mode 100644 lam-web/developers/phpdoc/lib/_lib---status.inc.html delete mode 100644 lam-web/developers/phpdoc/lib/_lib_account_inc.html delete mode 100644 lam-web/developers/phpdoc/lib/_lib_cache_inc.html delete mode 100644 lam-web/developers/phpdoc/lib/_lib_schema_inc.html delete mode 100644 lam-web/developers/phpdoc/lib/_lib_security_inc.html delete mode 100644 lam-web/developers/phpdoc/lib/_lib_status_inc.html delete mode 100644 lam-web/developers/phpdoc/lib/cache.html delete mode 100644 lam-web/developers/phpdoc/lists/_lib---lists.inc.html delete mode 100644 lam-web/developers/phpdoc/lists/_lib_lists_inc.html delete mode 100644 lam-web/developers/phpdoc/lists/_templates---lists---changePassword.php.html delete mode 100644 lam-web/developers/phpdoc/lists/_templates---lists---deletelink.php.html delete mode 100644 lam-web/developers/phpdoc/lists/_templates---lists---list.php.html delete mode 100644 lam-web/developers/phpdoc/lists/_templates---lists---userlink.php.html delete mode 100644 lam-web/developers/phpdoc/lists/_templates_lists_list_php.html delete mode 100644 lam-web/developers/phpdoc/lists/_templates_lists_userlink_php.html delete mode 100644 lam-web/developers/phpdoc/lists/lamBooleanListOption.html delete mode 100644 lam-web/developers/phpdoc/lists/lamGroupList.html delete mode 100644 lam-web/developers/phpdoc/lists/lamHostList.html delete mode 100644 lam-web/developers/phpdoc/lists/lamList.html delete mode 100644 lam-web/developers/phpdoc/lists/lamListOption.html delete mode 100644 lam-web/developers/phpdoc/lists/lamListTool.html delete mode 100644 lam-web/developers/phpdoc/lists/lamMailAliasList.html delete mode 100644 lam-web/developers/phpdoc/lists/lamSelectListOption.html delete mode 100644 lam-web/developers/phpdoc/lists/lamSmbDomainList.html delete mode 100644 lam-web/developers/phpdoc/lists/lamUserList.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_lib---tree.inc.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_lib_tree_inc.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---add_attr.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---add_attr_form.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---add_oclass.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---add_oclass_form.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---add_value.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---add_value_form.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---collapse.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---create.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---create_form.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---creation_template.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---delete.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---delete_attr.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---delete_form.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---download_binary_attr.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---edit.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---expand.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---export.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---export_form.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---rdelete.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---refresh.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---creation---custom.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---creation---new_ou_template.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---templates.inc.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---tree.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---tree_view.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---update.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates---tree---update_confirm.php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_add_attr_form_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_add_attr_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_add_oclass_form_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_add_oclass_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_add_value_form_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_add_value_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_collapse_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_create_form_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_create_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_creation_template_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_attr_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_form_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_download_binary_attr_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_edit_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_expand_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_export_form_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_export_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_rdelete_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_refresh_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_creation_custom_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_creation_new_ou_template_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_templates_inc.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_tree_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_tree_view_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_update_confirm_php.html delete mode 100644 lam-web/developers/phpdoc/lists/tree/_templates_tree_update_php.html delete mode 100644 lam-web/developers/phpdoc/main/_templates---delete.php.html delete mode 100644 lam-web/developers/phpdoc/main/_templates---initsuff.php.html delete mode 100644 lam-web/developers/phpdoc/main/_templates---login.php.html delete mode 100644 lam-web/developers/phpdoc/main/_templates---logout.php.html delete mode 100644 lam-web/developers/phpdoc/main/_templates---main.php.html delete mode 100644 lam-web/developers/phpdoc/main/_templates---main_header.php.html delete mode 100644 lam-web/developers/phpdoc/main/_templates_delete_php.html delete mode 100644 lam-web/developers/phpdoc/main/_templates_initsuff_php.html delete mode 100644 lam-web/developers/phpdoc/main/_templates_login_php.html delete mode 100644 lam-web/developers/phpdoc/main/_templates_logout_php.html delete mode 100644 lam-web/developers/phpdoc/main/_templates_main_header_php.html delete mode 100644 lam-web/developers/phpdoc/main/_templates_main_php.html delete mode 100644 lam-web/developers/phpdoc/media/background.png delete mode 100644 lam-web/developers/phpdoc/media/empty.png delete mode 100644 lam-web/developers/phpdoc/media/style.css delete mode 100644 lam-web/developers/phpdoc/modules/_lib---baseModule.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---createntlm.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---lamdaemon.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---account.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---groupOfNames.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---groupOfUniqueNames.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---ieee802device.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---inetLocalMailRecipient.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---inetOrgPerson.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---kolabUser.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---ldapPublicKey.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---nisMailAlias.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---posixAccount.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---posixGroup.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---quota.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---sambaAccount.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---sambaDomain.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---sambaGroupMapping.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---sambaSamAccount.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules---shadowAccount.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib---modules.inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_baseModule_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_createntlm_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_lamdaemon_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_account_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_ieee802device_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_inetLocalMailRecipient_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_inetOrgPerson_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_kolabUser_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_ldapPublicKey_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_nisMailAlias_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_posixAccount_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_posixGroup_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_quota_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_sambaAccount_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_sambaDomain_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_sambaGroupMapping_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_sambaSamAccount_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_lib_modules_shadowAccount_inc.html delete mode 100644 lam-web/developers/phpdoc/modules/_templates---account---edit.php.html delete mode 100644 lam-web/developers/phpdoc/modules/_templates_account_edit_php.html delete mode 100644 lam-web/developers/phpdoc/modules/account.html delete mode 100644 lam-web/developers/phpdoc/modules/accountContainer.html delete mode 100644 lam-web/developers/phpdoc/modules/baseModule.html delete mode 100644 lam-web/developers/phpdoc/modules/groupOfNames.html delete mode 100644 lam-web/developers/phpdoc/modules/groupOfUniqueNames.html delete mode 100644 lam-web/developers/phpdoc/modules/ieee802Device.html delete mode 100644 lam-web/developers/phpdoc/modules/inetLocalMailRecipient.html delete mode 100644 lam-web/developers/phpdoc/modules/inetOrgPerson.html delete mode 100644 lam-web/developers/phpdoc/modules/kolabUser.html delete mode 100644 lam-web/developers/phpdoc/modules/ldapPublicKey.html delete mode 100644 lam-web/developers/phpdoc/modules/nisMailAlias.html delete mode 100644 lam-web/developers/phpdoc/modules/posixAccount.html delete mode 100644 lam-web/developers/phpdoc/modules/posixGroup.html delete mode 100644 lam-web/developers/phpdoc/modules/quota.html delete mode 100644 lam-web/developers/phpdoc/modules/samba3domain.html delete mode 100644 lam-web/developers/phpdoc/modules/sambaAccount.html delete mode 100644 lam-web/developers/phpdoc/modules/sambaDomain.html delete mode 100644 lam-web/developers/phpdoc/modules/sambaGroupMapping.html delete mode 100644 lam-web/developers/phpdoc/modules/sambaMungedDial.html delete mode 100644 lam-web/developers/phpdoc/modules/sambaSamAccount.html delete mode 100644 lam-web/developers/phpdoc/modules/shadowAccount.html delete mode 100644 lam-web/developers/phpdoc/modules/smbHash.html delete mode 100644 lam-web/developers/phpdoc/profiles/_lib---profiles.inc.html delete mode 100644 lam-web/developers/phpdoc/profiles/_lib_profiles_inc.html delete mode 100644 lam-web/developers/phpdoc/profiles/_templates---profedit---profiledelete.php.html delete mode 100644 lam-web/developers/phpdoc/profiles/_templates---profedit---profilemain.php.html delete mode 100644 lam-web/developers/phpdoc/profiles/_templates---profedit---profilepage.php.html delete mode 100644 lam-web/developers/phpdoc/profiles/_templates_profedit_profiledelete_php.html delete mode 100644 lam-web/developers/phpdoc/profiles/_templates_profedit_profilemain_php.html delete mode 100644 lam-web/developers/phpdoc/profiles/_templates_profedit_profilepage_php.html delete mode 100644 lam-web/developers/phpdoc/ric_INSTALL.html delete mode 100644 lam-web/developers/phpdoc/ric_README.html delete mode 100644 lam-web/developers/phpdoc/selfService/_lib---selfService.inc.html delete mode 100644 lam-web/developers/phpdoc/selfService/_templates---selfService---adminLogin.php.html delete mode 100644 lam-web/developers/phpdoc/selfService/_templates---selfService---adminMain.php.html delete mode 100644 lam-web/developers/phpdoc/selfService/_templates---selfService---profManage.php.html delete mode 100644 lam-web/developers/phpdoc/selfService/_templates---selfService---selfServiceLogin.php.html delete mode 100644 lam-web/developers/phpdoc/selfService/_templates---selfService---selfServiceMain.php.html delete mode 100644 lam-web/developers/phpdoc/selfService/selfServiceProfile.html delete mode 100644 lam-web/developers/phpdoc/tests/_tests---conf-main-test.php.html delete mode 100644 lam-web/developers/phpdoc/tests/_tests---conf-test.php.html delete mode 100644 lam-web/developers/phpdoc/tests/_tests---status-test.php.html delete mode 100644 lam-web/developers/phpdoc/tests/_tests_conf-main-test_php.html delete mode 100644 lam-web/developers/phpdoc/tests/_tests_conf-test_php.html delete mode 100644 lam-web/developers/phpdoc/tests/_tests_status-test_php.html delete mode 100644 lam-web/developers/phpdoc/tools/LAMTool.html delete mode 100644 lam-web/developers/phpdoc/tools/LdapExportInfo.html delete mode 100644 lam-web/developers/phpdoc/tools/MyCustomExporter.html delete mode 100644 lam-web/developers/phpdoc/tools/PlaAbstractExporter.html delete mode 100644 lam-web/developers/phpdoc/tools/PlaCSVExporter.html delete mode 100644 lam-web/developers/phpdoc/tools/PlaDsmlExporter.html delete mode 100644 lam-web/developers/phpdoc/tools/PlaExporter.html delete mode 100644 lam-web/developers/phpdoc/tools/PlaLdapExporter.html delete mode 100644 lam-web/developers/phpdoc/tools/PlaLdifExporter.html delete mode 100644 lam-web/developers/phpdoc/tools/PlaVcardExporter.html delete mode 100644 lam-web/developers/phpdoc/tools/_lib---export.inc.html delete mode 100644 lam-web/developers/phpdoc/tools/_lib_export_inc.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates---massBuildAccounts.php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates---massDoUpload.php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates---masscreate.php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates---ou_edit.php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates---schema---schema.php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates---tests---index.php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates---tests---lamdaemonTest.php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates---tests---schemaTest.php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates---tools.php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates_massBuildAccounts_php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates_massDoUpload_php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates_masscreate_php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates_ou_edit_php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates_schema_schema_php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates_tests_index_php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates_tests_lamdaemonTest_php.html delete mode 100644 lam-web/developers/phpdoc/tools/_templates_tools_php.html delete mode 100644 lam-web/developers/phpdoc/types/_lib---baseType.inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib---types---group.inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib---types---host.inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib---types---mailAlias.inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib---types---smbDomain.inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib---types---user.inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib---types.inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib_baseType_inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib_types_group_inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib_types_host_inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib_types_inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib_types_mailAlias_inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib_types_smbDomain_inc.html delete mode 100644 lam-web/developers/phpdoc/types/_lib_types_user_inc.html delete mode 100644 lam-web/developers/phpdoc/types/baseType.html delete mode 100644 lam-web/developers/phpdoc/types/group.html delete mode 100644 lam-web/developers/phpdoc/types/host.html delete mode 100644 lam-web/developers/phpdoc/types/mailAlias.html delete mode 100644 lam-web/developers/phpdoc/types/smbDomain.html delete mode 100644 lam-web/developers/phpdoc/types/user.html diff --git a/lam-web/developers/docs.htm b/lam-web/developers/docs.htm index a8c380e4..e9374ec1 100644 --- a/lam-web/developers/docs.htm +++ b/lam-web/developers/docs.htm @@ -213,7 +213,7 @@ SourceForge

These pages describe the architecture of LAM and how the different parts work together.


-

Specification for account modules

+

Module interface

The interface definition of the account modules.


diff --git a/lam-web/developers/phpdoc/Help/_help---help.inc.html b/lam-web/developers/phpdoc/Help/_help---help.inc.html deleted file mode 100644 index e2d1bc77..00000000 --- a/lam-web/developers/phpdoc/Help/_help---help.inc.html +++ /dev/null @@ -1,93 +0,0 @@ - - -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, 06 Jan 2008 18:59:06 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/Help/_help_help_inc.html b/lam-web/developers/phpdoc/Help/_help_help_inc.html deleted file mode 100644 index 4ecd5016..00000000 --- a/lam-web/developers/phpdoc/Help/_help_help_inc.html +++ /dev/null @@ -1,90 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:46 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/Help/_templates---help.php.html b/lam-web/developers/phpdoc/Help/_templates---help.php.html deleted file mode 100644 index 4feab88e..00000000 --- a/lam-web/developers/phpdoc/Help/_templates---help.php.html +++ /dev/null @@ -1,159 +0,0 @@ - - -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, 06 Jan 2008 18:59:06 +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 deleted file mode 100644 index 67bfe8d3..00000000 --- a/lam-web/developers/phpdoc/Help/_templates_help_php.html +++ /dev/null @@ -1,159 +0,0 @@ - - -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 131]
-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 Wed, 15 Nov 2006 18:00:46 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/LDAP/Ldap.html b/lam-web/developers/phpdoc/LDAP/Ldap.html deleted file mode 100644 index c066daca..00000000 --- a/lam-web/developers/phpdoc/LDAP/Ldap.html +++ /dev/null @@ -1,535 +0,0 @@ - - -Docs For Class Ldap - - - - - - - - - - - - - -
LDAP
- - - [ class tree: LDAP ] - [ index: LDAP ] - [ all elements ] -
- - - - - - -
-
- -

Class: Ldap

-Source Location: /lib/ldap.inc

- - - - - - - - - -
- -

Class Overview

-

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


- - - - - - - -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 52]
-Ldap manages connection to LDAP and includes several helper functions.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 73]

-
-
-
- Ldap __construct( -object -$config) -
-

- -

- - -

Parameters:

-
- - - - - - -
object  $config  an object of class Config
-

-
[ Top ]
-
-
- -

method close [line 125]

-
-
-
- void close( -) -
-

- - Closes connection to server



- - -
[ Top ]
-
-
- -

method cmp_array [line 314]

-
-
-
- integer cmp_array( -string -$a, string -$b) -
-

- - Helper function to sort the unit DNs



-

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 ]
-
-
- -

method connect [line 89]

-
-
-
- mixed connect( -string -$user, string -$passwd) -
-

- - Connects to the server using the given username and password



-

Tags:

-
- - - - -
return:  if connect succeeds the server handle is returned, else false
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
string  $user  user name
string  $passwd  password
-

-
[ Top ]
-
-
- -

method decrypt [line 252]

-
-
-
- string decrypt( -object -$data) -
-

- - Decrypts a string



-

Tags:

-
- - - - -
return:  decrypted string
-
-

- - -

Parameters:

-
- - - - - - -
object  $data  string to decrypt
-

-
[ Top ]
-
-
- -

method decrypt_login [line 291]

-
-
-
- array decrypt_login( -) -
-

- - Decrypts username and password



-

Tags:

-
- - - - -
return:  array(user name, password)
-
-

- - -
[ Top ]
-
-
- -

method destroy [line 300]

-
-
-
- void destroy( -) -
-

- - Closes connection to LDAP server and deletes encrypted username/password



- - -
[ Top ]
-
-
- -

method encrypt [line 226]

-
-
-
- object encrypted encrypt( -string -$data) -
-

- - Encrypts a string



-

Tags:

-
- - - - -
return:  string
-
-

- - -

Parameters:

-
- - - - - - -
string  $data  string to encrypt
-

-
[ Top ]
-
-
- -

method encrypt_login [line 280]

-
-
-
- void encrypt_login( -string -$username, string -$password) -
-

- - Encrypts username and password



- - -

Parameters:

-
- - - - - - - - - - - -
string  $username  LDAP user name
string  $password  LDAP password
-

-
[ Top ]
-
-
- -

method new_rand [line 212]

-
-
-
- int new_rand( -) -
-

- - Calculates a new value for rand



-

Tags:

-
- - - - -
return:  New random value
-
-

- - -
[ Top ]
-
-
- -

method search_units [line 135]

-
-
-
- array search_units( -string -$suffix) -
-

- - Returns an array with all organizational units under the given suffix



-

Tags:

-
- - - - -
return:  DNs of organizational units
-
-

- - -

Parameters:

-
- - - - - - -
string  $suffix  search suffix
-

-
[ Top ]
-
-
- -

method server [line 166]

-
-
-
- object connection server( -) -
-

- - Returns the LDAP connection handle



-

Tags:

-
- - - - -
return:  handle
-
-

- - -
[ Top ]
-
-
- -

method __sleep [line 176]

-
-
-
- void __sleep( -) -
-

- - Closes connection to LDAP server before serialization



- - -
[ Top ]
-
-
- -

method __wakeup [line 183]

-
-
-
- void __wakeup( -) -
-

- - Reconnects to LDAP server when deserialized



- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:12 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/LDAP/_lib---ldap.inc.html b/lam-web/developers/phpdoc/LDAP/_lib---ldap.inc.html deleted file mode 100644 index 4cc27fdd..00000000 --- a/lam-web/developers/phpdoc/LDAP/_lib---ldap.inc.html +++ /dev/null @@ -1,138 +0,0 @@ - - -Docs for page ldap.inc - - - - - - - - - - - - - -
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, 06 Jan 2008 18:59:12 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/LDAP/_lib_ldap_inc.html b/lam-web/developers/phpdoc/LDAP/_lib_ldap_inc.html deleted file mode 100644 index 16d72406..00000000 --- a/lam-web/developers/phpdoc/LDAP/_lib_ldap_inc.html +++ /dev/null @@ -1,135 +0,0 @@ - - -Docs for page ldap.inc - - - - - - - - - - - - - -
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 Wed, 15 Nov 2006 18:00:50 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/FPDF.html b/lam-web/developers/phpdoc/PDF/FPDF.html deleted file mode 100644 index 475fca6b..00000000 --- a/lam-web/developers/phpdoc/PDF/FPDF.html +++ /dev/null @@ -1,3230 +0,0 @@ - - -Docs For Class FPDF - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Class: FPDF

-Source Location: /lib/fpdf.php

- - - - - - - - - - -
- -

Class Overview

-

-
Main FPDF class for creating PDF documents


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

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

Class Details

-
-[line 28]
-Main FPDF class for creating PDF documents



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$AliasNbPages =

-

[line 82]

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


-
[ Top ]

- -

-

$author =

-

[line 79]

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


-
[ Top ]

- -

-

$AutoPageBreak =

-

[line 72]

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


-
[ Top ]

- -

-

$bMargin =

-

[line 49]

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


-
[ Top ]

- -

-

$buffer =

-

[line 34]

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


-
[ Top ]

- -

-

$cMargin =

-

[line 50]

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


-
[ Top ]

- -

-

$ColorFlag =

-

[line 70]

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


-
[ Top ]

- -

-

$compress =

-

[line 37]

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


-
[ Top ]

- -

-

$CoreFonts =

-

[line 54]

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


-
[ Top ]

- -

-

$creator =

-

[line 81]

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


-
[ Top ]

- -

-

$CurOrientation =

-

[line 39]

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


-
[ Top ]

- -

-

$CurrentFont =

-

[line 64]

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


-
[ Top ]

- -

-

$DefOrientation =

-

[line 38]

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


-
[ Top ]

- -

-

$diffs =

-

[line 57]

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


-
[ Top ]

- -

-

$DrawColor =

-

[line 67]

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


-
[ Top ]

- -

-

$fh =

-

[line 43]

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


-
[ Top ]

- -

-

$fhPt =

-

[line 42]

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


-
[ Top ]

- -

-

$FillColor =

-

[line 68]

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


-
[ Top ]

- -

-

$FontFamily =

-

[line 61]

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


-
[ Top ]

- -

-

$FontFiles =

-

[line 56]

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


-
[ Top ]

- -

-

$fonts =

-

[line 55]

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


-
[ Top ]

- -

-

$FontSize =

-

[line 66]

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


-
[ Top ]

- -

-

$FontSizePt =

-

[line 65]

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


-
[ Top ]

- -

-

$FontStyle =

-

[line 62]

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


-
[ Top ]

- -

-

$fw =

-

[line 43]

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


-
[ Top ]

- -

-

$fwPt =

-

[line 42]

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


-
[ Top ]

- -

-

$h =

-

[line 45]

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


-
[ Top ]

- -

-

$hPt =

-

[line 44]

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


-
[ Top ]

- -

-

$images =

-

[line 58]

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


-
[ Top ]

- -

-

$InFooter =

-

[line 74]

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


-
[ Top ]

- -

-

$k =

-

[line 41]

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


-
[ Top ]

- -

-

$keywords =

-

[line 80]

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


-
[ Top ]

- -

-

$lasth =

-

[line 52]

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


-
[ Top ]

- -

-

$LayoutMode =

-

[line 76]

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


-
[ Top ]

- -

-

$LineWidth =

-

[line 53]

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


-
[ Top ]

- -

-

$links =

-

[line 60]

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


-
[ Top ]

- -

-

$lMargin =

-

[line 46]

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


-
[ Top ]

- -

-

$n =

-

[line 32]

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


-
[ Top ]

- -

-

$offsets =

-

[line 33]

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


-
[ Top ]

- -

-

$OrientationChanges =

-

[line 40]

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


-
[ Top ]

- -

-

$page =

-

[line 31]

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


-
[ Top ]

- -

-

$PageBreakTrigger =

-

[line 73]

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


-
[ Top ]

- -

-

$PageLinks =

-

[line 59]

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


-
[ Top ]

- -

-

$pages =

-

[line 35]

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


-
[ Top ]

- -

-

$PDFVersion =

-

[line 83]

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


-
[ Top ]

- -

-

$rMargin =

-

[line 48]

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


-
[ Top ]

- -

-

$state =

-

[line 36]

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


-
[ Top ]

- -

-

$subject =

-

[line 78]

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


-
[ Top ]

- -

-

$TextColor =

-

[line 69]

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


-
[ Top ]

- -

-

$title =

-

[line 77]

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


-
[ Top ]

- -

-

$tMargin =

-

[line 47]

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


-
[ Top ]

- -

-

$underline =

-

[line 63]

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


-
[ Top ]

- -

-

$w =

-

[line 45]

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


-
[ Top ]

- -

-

$wPt =

-

[line 44]

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


-
[ Top ]

- -

-

$ws =

-

[line 71]

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


-
[ Top ]

- -

-

$x =

-

[line 51]

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


-
[ Top ]

- -

-

$y =

-

[line 51]

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


-
[ Top ]

- -

-

$ZoomMode =

-

[line 75]

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor FPDF [line 90]

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

- - *****************************************************************************

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




- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $orientation  
  $unit  
  $format  
-

-
[ Top ]
-
-
- -

method AcceptPageBreak [line 628]

-
-
-
- void AcceptPageBreak( -) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::AcceptPageBreak()
-
-
-

- -
[ Top ]
-
-
- -

method AddFont [line 474]

-
-
-
- void AddFont( - -$family, [ -$style = ''], [ -$file = '']) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::AddFont()
-
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $family  
  $style  
  $file  
-

-
[ Top ]
-
-
- -

method AddLink [line 593]

-
-
-
- void AddLink( -) -
-

- -

- - -
[ Top ]
-
-
- -

method AddPage [line 320]

-
-
-
- void AddPage( -[ -$orientation = '']) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $orientation  
-

-
[ Top ]
-
-
- -

method AliasNbPages [line 285]

-
-
-
- void AliasNbPages( -[ -$alias = '{nb}']) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::AliasNbPages()
-
-
-

- -

Parameters:

-
- - - - - - -
  $alias  
-

-
[ Top ]
-
-
- -

method Cell [line 634]

-
-
-
- void Cell( - -$w, [ -$h = 0], [ -$txt = ''], [ -$border = 0], [ -$ln = 0], [ -$align = ''], [ -$fill = 0], [ -$link = '']) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::Cell()
-
-
-

- -

Parameters:

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

-
[ Top ]
-
-
- -

method Close [line 303]

-
-
-
- void Close( -) -
-

- -

- - -
[ Top ]
-
-
- -

method Error [line 291]

-
-
-
- void Error( - -$msg) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $msg  
-

-
[ Top ]
-
-
- -

method Footer [line 392]

-
-
-
- void Footer( -) -
-

- -

- - -
[ Top ]
-
-
- -

method GetStringWidth [line 436]

-
-
-
- void GetStringWidth( - -$s) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::GetStringWidth()
-
-
-

- -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method GetX [line 967]

-
-
-
- void GetX( -) -
-

- -

- - -
[ Top ]
-
-
- -

method GetY [line 982]

-
-
-
- void GetY( -) -
-

- -

- - -
[ Top ]
-
-
- -

method Header [line 387]

-
-
-
- void Header( -) -
-

- -

- - -
[ Top ]
-
-
- -

method Image [line 907]

-
-
-
- void Image( - -$file, -$x, -$y, [ -$w = 0], [ -$h = 0], [ -$type = ''], [ -$link = '']) -
-

- -

- - -

Parameters:

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

-
[ Top ]
-
-
- -

method Line [line 456]

-
-
-
- void Line( - -$x1, -$y1, -$x2, -$y2) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
  $x1  
  $y1  
  $x2  
  $y2  
-

-
[ Top ]
-
-
- -

method Link [line 611]

-
-
-
- void Link( - -$x, -$y, -$w, -$h, -$link) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
  $x  
  $y  
  $w  
  $h  
  $link  
-

-
[ Top ]
-
-
- -

method Ln [line 957]

-
-
-
- void Ln( -[ -$h = '']) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $h  
-

-
[ Top ]
-
-
- -

method MultiCell [line 713]

-
-
-
- void MultiCell( - -$w, -$h, -$txt, [ -$border = 0], [ -$align = 'J'], [ -$fill = 0]) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::MultiCell()
-
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  $w  
  $h  
  $txt  
  $border  
  $align  
  $fill  
-

-
[ Top ]
-
-
- -

method Open [line 297]

-
-
-
- void Open( -) -
-

- -

- - -
[ Top ]
-
-
- -

method Output [line 1005]

-
-
-
- void Output( -[ -$name = ''], [ -$dest = '']) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
  $name  
  $dest  
-

-
[ Top ]
-
-
- -

method PageNo [line 397]

-
-
-
- void PageNo( -) -
-

- -

- - -
[ Top ]
-
-
- -

method Rect [line 462]

-
-
-
- void Rect( - -$x, -$y, -$w, -$h, [ -$style = '']) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
  $x  
  $y  
  $w  
  $h  
  $style  
-

-
[ Top ]
-
-
- -

method SetAuthor [line 267]

-
-
-
- void SetAuthor( - -$author) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $author  
-

-
[ Top ]
-
-
- -

method SetAutoPageBreak [line 225]

-
-
-
- void SetAutoPageBreak( - -$auto, [ -$margin = 0]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
  $auto  
  $margin  
-

-
[ Top ]
-
-
- -

method SetCompression [line 246]

-
-
-
- void SetCompression( - -$compress) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $compress  
-

-
[ Top ]
-
-
- -

method SetCreator [line 279]

-
-
-
- void SetCreator( - -$creator) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $creator  
-

-
[ Top ]
-
-
- -

method SetDisplayMode [line 233]

-
-
-
- void SetDisplayMode( - -$zoom, [ -$layout = 'continuous']) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
  $zoom  
  $layout  
-

-
[ Top ]
-
-
- -

method SetDrawColor [line 403]

-
-
-
- void SetDrawColor( - -$r, [ -$g = -1], [ -$b = -1]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $r  
  $g  
  $b  
-

-
[ Top ]
-
-
- -

method SetFillColor [line 414]

-
-
-
- void SetFillColor( - -$r, [ -$g = -1], [ -$b = -1]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $r  
  $g  
  $b  
-

-
[ Top ]
-
-
- -

method SetFont [line 522]

-
-
-
- void SetFont( - -$family, [ -$style = ''], [ -$size = 0]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $family  
  $style  
  $size  
-

-
[ Top ]
-
-
- -

method SetFontSize [line 582]

-
-
-
- void SetFontSize( - -$size) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $size  
-

-
[ Top ]
-
-
- -

method SetKeywords [line 273]

-
-
-
- void SetKeywords( - -$keywords) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $keywords  
-

-
[ Top ]
-
-
- -

method SetLeftMargin [line 205]

-
-
-
- void SetLeftMargin( - -$margin) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $margin  
-

-
[ Top ]
-
-
- -

method SetLineWidth [line 448]

-
-
-
- void SetLineWidth( - -$width) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $width  
-

-
[ Top ]
-
-
- -

method SetLink [line 601]

-
-
-
- void SetLink( - -$link, [ -$y = 0], [ -$page = -1]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $link  
  $y  
  $page  
-

-
[ Top ]
-
-
- -

method SetMargins [line 195]

-
-
-
- void SetMargins( - -$left, -$top, [ -$right = -1]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $left  
  $top  
  $right  
-

-
[ Top ]
-
-
- -

method SetRightMargin [line 219]

-
-
-
- void SetRightMargin( - -$margin) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $margin  
-

-
[ Top ]
-
-
- -

method SetSubject [line 261]

-
-
-
- void SetSubject( - -$subject) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $subject  
-

-
[ Top ]
-
-
- -

method SetTextColor [line 426]

-
-
-
- void SetTextColor( - -$r, [ -$g = -1], [ -$b = -1]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $r  
  $g  
  $b  
-

-
[ Top ]
-
-
- -

method SetTitle [line 255]

-
-
-
- void SetTitle( - -$title) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $title  
-

-
[ Top ]
-
-
- -

method SetTopMargin [line 213]

-
-
-
- void SetTopMargin( - -$margin) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $margin  
-

-
[ Top ]
-
-
- -

method SetX [line 973]

-
-
-
- void SetX( - -$x) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $x  
-

-
[ Top ]
-
-
- -

method SetXY [line 998]

-
-
-
- void SetXY( - -$x, -$y) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
  $x  
  $y  
-

-
[ Top ]
-
-
- -

method SetY [line 988]

-
-
-
- void SetY( - -$y) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $y  
-

-
[ Top ]
-
-
- -

method Text [line 617]

-
-
-
- void Text( - -$x, -$y, -$txt) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::Text()
-
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $x  
  $y  
  $txt  
-

-
[ Top ]
-
-
- -

method Write [line 826]

-
-
-
- void Write( - -$h, -$txt, [ -$link = '']) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::Write()
-
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $h  
  $txt  
  $link  
-

-
[ Top ]
-
-
- -

method _beginpage [line 1445]

-
-
-
- void _beginpage( - -$orientation) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $orientation  
-

-
[ Top ]
-
-
- -

method _dochecks [line 1078]

-
-
-
- void _dochecks( -) -
-

- - *****************************************************************************

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




- - -
[ Top ]
-
-
- -

method _dounderline [line 1498]

-
-
-
- void _dounderline( - -$x, -$y, -$txt) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::_dounderline()
-
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $x  
  $y  
  $txt  
-

-
[ Top ]
-
-
- -

method _enddoc [line 1410]

-
-
-
- void _enddoc( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _endpage [line 1484]

-
-
-
- void _endpage( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _escape [line 1627]

-
-
-
- void _escape( - -$s) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method _freadint [line 1614]

-
-
-
- void _freadint( - -$f) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $f  
-

-
[ Top ]
-
-
- -

method _getfontpath [line 1088]

-
-
-
- void _getfontpath( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _newobj [line 1490]

-
-
-
- void _newobj( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _out [line 1640]

-
-
-
- void _out( - -$s) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method _parsejpg [line 1507]

-
-
-
- void _parsejpg( - -$file) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $file  
-

-
[ Top ]
-
-
- -

method _parsepng [line 1531]

-
-
-
- void _parsepng( - -$file) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $file  
-

-
[ Top ]
-
-
- -

method _putcatalog [line 1378]

-
-
-
- void _putcatalog( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putfonts [line 1166]

-
-
-
- void _putfonts( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putheader [line 1398]

-
-
-
- void _putheader( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putimages [line 1283]

-
-
-
- void _putimages( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putinfo [line 1362]

-
-
-
- void _putinfo( -) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::_putinfo()
-
-
-

- -
[ Top ]
-
-
- -

method _putpages [line 1095]

-
-
-
- void _putpages( -) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::_putpages()
-
-
-

- -
[ Top ]
-
-
- -

method _putresourcedict [line 1337]

-
-
-
- void _putresourcedict( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putresources [line 1349]

-
-
-
- void _putresources( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putstream [line 1633]

-
-
-
- void _putstream( - -$s) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method _puttrailer [line 1403]

-
-
-
- void _puttrailer( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putxobjectdict [line 1331]

-
-
-
- void _putxobjectdict( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _textstring [line 1621]

-
-
-
- void _textstring( - -$s) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::_textstring()
-
-
-

- -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/UFPDF.html b/lam-web/developers/phpdoc/PDF/UFPDF.html deleted file mode 100644 index ed4cbc31..00000000 --- a/lam-web/developers/phpdoc/PDF/UFPDF.html +++ /dev/null @@ -1,1647 +0,0 @@ - - -Docs For Class UFPDF - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Class: UFPDF

-Source Location: /lib/ufpdf.php

- - - - - - - - - -
- -

Class Overview

-
FPDF
-   |
-   --UFPDF

-
Main UFPDF class for creating Unicode PDF documents


-

Author(s):

-
    -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - - -
-

Child classes:

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

Inherited Variables

-
-

Class: FPDF

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

Inherited Methods

-
-

Class: FPDF

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

Class Details

-
-[line 37]
-Main UFPDF class for creating Unicode PDF documents



-

Tags:

-
- - - - -
see:  FPDF::FPDF()
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor UFPDF [line 45]

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

- - *****************************************************************************

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




- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $orientation  
  $unit  
  $format  
-

-
[ Top ]
-
-
- -

method AcceptPageBreak [line 113]

-
-
-
- void AcceptPageBreak( -) -
-

- -

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

-
[ Top ]
-
-
- -

method AddFont [line 73]

-
-
-
- void AddFont( - -$family, [ -$style = ''], [ -$file = '']) -
-

- -

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

-

Parameters:

-
- - - - - - - - - - - - - - - - -
  $family  
  $style  
  $file  
-

-
[ Top ]
-
-
- -

method AliasNbPages [line 407]

-
-
-
- void AliasNbPages( -[ -$alias = '{nb}']) -
-

- -

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

-

Parameters:

-
- - - - - - -
  $alias  
-

-
[ Top ]
-
-
- -

method Cell [line 119]

-
-
-
- void Cell( - -$w, [ -$h = 0], [ -$txt = ''], [ -$border = 0], [ -$ln = 0], [ -$align = 'J'], [ -$fill = 0], [ -$link = '']) -
-

- -

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

-

Parameters:

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

-
[ Top ]
-
-
- -

method code2utf [line 697]

-
-
-
- void code2utf( - -$num) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $num  
-

-
[ Top ]
-
-
- -

method GetStringWidth [line 50]

-
-
-
- void GetStringWidth( - -$s) -
-

- -

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

-

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method MultiCell [line 199]

-
-
-
- void MultiCell( - -$w, -$h, -$txt, [ -$border = 0], [ -$align = 'J'], [ -$fill = 0]) -
-

- -

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

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  $w  
  $h  
  $txt  
  $border  
  $align  
  $fill  
-

-
[ Top ]
-
-
- -

method strlen [line 705]

-
-
-
- void strlen( - -$s) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method Text [line 102]

-
-
-
- void Text( - -$x, -$y, -$txt) -
-

- -

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

-

Parameters:

-
- - - - - - - - - - - - - - - - -
  $x  
  $y  
  $txt  
-

-
[ Top ]
-
-
- -

method utf8_substr [line 709]

-
-
-
- void utf8_substr( - -$str, -$start) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
  $str  
  $start  
-

-
[ Top ]
-
-
- -

method utf8_to_codepoints [line 726]

-
-
-
- void utf8_to_codepoints( - -$txt) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $txt  
-

-
[ Top ]
-
-
- -

method utf8_to_utf16be [line 597]

-
-
-
- void utf8_to_utf16be( - -&$txt, [ -$bom = true]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
  &$txt  
  $bom  
-

-
[ Top ]
-
-
- -

method Write [line 324]

-
-
-
- void Write( - -$h, -$txt, [ -$link = '']) -
-

- -

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

-

Parameters:

-
- - - - - - - - - - - - - - - - -
  $h  
  $txt  
  $link  
-

-
[ Top ]
-
-
- -

method _dounderline [line 481]

-
-
-
- void _dounderline( - -$x, -$y, -$width, -$txt) -
-

- -

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

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
  $x  
  $y  
  $width  
  $txt  
-

-
[ Top ]
-
-
- -

method _escapetext [line 498]

-
-
-
- void _escapetext( - -$s) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method _putinfo [line 506]

-
-
-
- void _putinfo( -) -
-

- -

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

-
[ Top ]
-
-
- -

method _putpages [line 522]

-
-
-
- void _putpages( -) -
-

- -

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

-
[ Top ]
-
-
- -

method _puttruetypeunicode [line 419]

-
-
-
- void _puttruetypeunicode( - -$font) -
-

- - *****************************************************************************

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




- - -

Parameters:

-
- - - - - - -
  $font  
-

-
[ Top ]
-
-
- -

method _textstring [line 490]

-
-
-
- void _textstring( - -$s) -
-

- -

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

-

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:35 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/_lib---font---vera.php.html b/lam-web/developers/phpdoc/PDF/_lib---font---vera.php.html deleted file mode 100644 index 0650842a..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib---font---vera.php.html +++ /dev/null @@ -1,123 +0,0 @@ - - -Docs for page vera.php - - - - - - - - - - - - - -
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, 06 Jan 2008 18:59:36 +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 deleted file mode 100644 index fd99dd2e..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib---font---verab.php.html +++ /dev/null @@ -1,123 +0,0 @@ - - -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, 06 Jan 2008 18:59:36 +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 deleted file mode 100644 index dc77579b..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib---font---verabi.php.html +++ /dev/null @@ -1,123 +0,0 @@ - - -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, 06 Jan 2008 18:59:36 +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 deleted file mode 100644 index ce65e308..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib---font---verai.php.html +++ /dev/null @@ -1,123 +0,0 @@ - - -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, 06 Jan 2008 18:59:36 +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 deleted file mode 100644 index cf9425fe..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib---fpdf.php.html +++ /dev/null @@ -1,141 +0,0 @@ - - -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, 06 Jan 2008 18:59:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/PDF/_lib---lamPDF.inc.html b/lam-web/developers/phpdoc/PDF/_lib---lamPDF.inc.html deleted file mode 100644 index 63bfcd9e..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib---lamPDF.inc.html +++ /dev/null @@ -1,128 +0,0 @@ - - -Docs for page lamPDF.inc - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: lamPDF.inc

-Source Location: /lib/lamPDF.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
-
-

-

-

-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:12 +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 deleted file mode 100644 index 59f51c3d..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib---pdf.inc.html +++ /dev/null @@ -1,317 +0,0 @@ - - -Docs for page pdf.inc - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: pdf.inc

-Source Location: /lib/pdf.inc

- -
-
- - -

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('pdfstruct.inc') [line 39]
-access to PDF configuration files

include_once('xml_parser.inc') [line 36]
-XML functions

-

-

-
- -

LAMPDF_LINEWIDTH [line 33]

-
-
-
- LAMPDF_LINEWIDTH = 190 -
-
- - PDF line width


-
-
[ Top ]


-
-
- -

createModulePDF [line 56]

-
-
-
- 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 170]

-
-
-
- string getSectionHeadline( -string $line) -
-

- - Creates a section headline.



-

Tags:

-
- - - - -
return:  XML code for headline
-
-

- -

Parameters

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


-
-
- -

processAttributes [line 298]

-
-
-
- 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 265]

-
-
-
- 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 189]

-
-
-
- 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, 06 Jan 2008 18:59:18 +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 deleted file mode 100644 index b5427724..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib---pdfstruct.inc.html +++ /dev/null @@ -1,295 +0,0 @@ - - -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, 06 Jan 2008 18:59:18 +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 deleted file mode 100644 index 433e8917..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib---ufpdf.php.html +++ /dev/null @@ -1,148 +0,0 @@ - - -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, 06 Jan 2008 18:59:35 +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 deleted file mode 100644 index eadd29ea..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib---xml_parser.inc.html +++ /dev/null @@ -1,128 +0,0 @@ - - -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, 06 Jan 2008 18:59:36 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/PDF/_lib_font_vera_php.html b/lam-web/developers/phpdoc/PDF/_lib_font_vera_php.html deleted file mode 100644 index e68399a9..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib_font_vera_php.html +++ /dev/null @@ -1,117 +0,0 @@ - - -Docs for page vera.php - - - - - - - - - - - - - -
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 Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/_lib_font_verab_php.html b/lam-web/developers/phpdoc/PDF/_lib_font_verab_php.html deleted file mode 100644 index 410e09db..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib_font_verab_php.html +++ /dev/null @@ -1,117 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/_lib_font_verabi_php.html b/lam-web/developers/phpdoc/PDF/_lib_font_verabi_php.html deleted file mode 100644 index 6ffc32cc..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib_font_verabi_php.html +++ /dev/null @@ -1,117 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/_lib_font_verai_php.html b/lam-web/developers/phpdoc/PDF/_lib_font_verai_php.html deleted file mode 100644 index f6f2a763..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib_font_verai_php.html +++ /dev/null @@ -1,117 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/_lib_fpdf_php.html b/lam-web/developers/phpdoc/PDF/_lib_fpdf_php.html deleted file mode 100644 index f86f65ed..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib_fpdf_php.html +++ /dev/null @@ -1,136 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:45 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/_lib_pdf_inc.html b/lam-web/developers/phpdoc/PDF/_lib_pdf_inc.html deleted file mode 100644 index eb8030aa..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib_pdf_inc.html +++ /dev/null @@ -1,319 +0,0 @@ - - -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 197]

-
-
-
- string getSectionHeadline( -string $line) -
-

- - Creates a section headline.



-

Tags:

-
- - - - -
return:  XML code for headline
-
-

- - -

Parameters

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


-
-
- -

processAttributes [line 325]

-
-
-
- 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 292]

-
-
-
- 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 216]

-
-
-
- array processLine( -string $line, [boolean $first_td = true], mixed $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
-
[ Top ]


-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:55 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/_lib_pdfstruct_inc.html b/lam-web/developers/phpdoc/PDF/_lib_pdfstruct_inc.html deleted file mode 100644 index 9f276388..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib_pdfstruct_inc.html +++ /dev/null @@ -1,294 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:56 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/_lib_ufpdf_php.html b/lam-web/developers/phpdoc/PDF/_lib_ufpdf_php.html deleted file mode 100644 index de5bd745..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib_ufpdf_php.html +++ /dev/null @@ -1,143 +0,0 @@ - - -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:  Andrea Rossato
author:  Steven Wittens
-
-

-

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 Wed, 15 Nov 2006 18:01:12 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/_lib_xml_parser_inc.html b/lam-web/developers/phpdoc/PDF/_lib_xml_parser_inc.html deleted file mode 100644 index 7d048c5c..00000000 --- a/lam-web/developers/phpdoc/PDF/_lib_xml_parser_inc.html +++ /dev/null @@ -1,122 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfdelete.php.html b/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfdelete.php.html deleted file mode 100644 index 5146a5c1..00000000 --- a/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfdelete.php.html +++ /dev/null @@ -1,128 +0,0 @@ - - -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 Duergner
-
-

-

Includes:

-
-include_once("../../lib/security.inc") [line 33]
-security functions

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

-

-

-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:18 +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 deleted file mode 100644 index 708ef392..00000000 --- a/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfmain.php.html +++ /dev/null @@ -1,131 +0,0 @@ - - -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, 06 Jan 2008 18:59:18 +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 deleted file mode 100644 index e90e862f..00000000 --- a/lam-web/developers/phpdoc/PDF/_templates---pdfedit---pdfpage.php.html +++ /dev/null @@ -1,135 +0,0 @@ - - -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 38]
-access to PDF configuration files

include_once("../../lib/security.inc") [line 36]
-security functions

include_once('../../lib/ldap.inc') [line 40]
-LDAP object

include_once('../../lib/config.inc') [line 42]
-LAM configuration

include_once('../../lib/xml_parser.inc') [line 46]
-XML functions

include_once('../../lib/modules.inc') [line 44]
-module functions

-

-

-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:18 +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 deleted file mode 100644 index d8865100..00000000 --- a/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfdelete_php.html +++ /dev/null @@ -1,122 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:56 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfmain_php.html b/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfmain_php.html deleted file mode 100644 index 8635aed8..00000000 --- a/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfmain_php.html +++ /dev/null @@ -1,125 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:56 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfpage_php.html b/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfpage_php.html deleted file mode 100644 index 8e50ed0a..00000000 --- a/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfpage_php.html +++ /dev/null @@ -1,129 +0,0 @@ - - -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:  Roland Gruber
author:  Michael Dürgner
-
-

-

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 Wed, 15 Nov 2006 18:00:56 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/lamPDF.html b/lam-web/developers/phpdoc/PDF/lamPDF.html deleted file mode 100644 index 48a13bfb..00000000 --- a/lam-web/developers/phpdoc/PDF/lamPDF.html +++ /dev/null @@ -1,1220 +0,0 @@ - - -Docs For Class lamPDF - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamPDF

-Source Location: /lib/lamPDF.inc

- - - - - - - - - - -
- -

Class Overview

-
FPDF
-   |
-   --UFPDF
-      |
-      --lamPDF

-
Creates a LAM information page in PDF format.


-

Author(s):

-
    -
  • Michael Duergner
  • -
- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: FPDF

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

Inherited Methods

-
-

Class: UFPDF

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

Class: FPDF

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

Class Details

-
-[line 38]
-Creates a LAM information page in PDF format.



-

Tags:

-
- - - - -
author:  Michael Duergner
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

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

-

[line 54]

- list of supported fonts

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


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


-
[ Top ]

- -

-

$fontName =

-

[line 48]

- current active font name

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


-
[ Top ]

- -

-

$page_definitions =

-

[line 43]

- format settings for page layout

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor __construct [line 64]

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

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
string  $account_type  
array  $page_definitions  
  $fontName  
-

-
[ Top ]
-
-
- -

method footer [line 120]

-
-
-
- void footer( -) -
-

- -

- - -
[ Top ]
-
-
- -

method header [line 88]

-
-
-
- void header( -) -
-

- -

- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:12 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/PDF/xmlParser.html b/lam-web/developers/phpdoc/PDF/xmlParser.html deleted file mode 100644 index e96c551b..00000000 --- a/lam-web/developers/phpdoc/PDF/xmlParser.html +++ /dev/null @@ -1,215 +0,0 @@ - - -Docs For Class xmlParser - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Class: xmlParser

-Source Location: /lib/xml_parser.inc

- - - - - - - - - -
- -

Class Overview

-

-


-

Author(s):

-
    -
  • Michael Duergner
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 36]
-

-

Tags:

-
- - - - -
author:  Michael Duergner
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 46]

-
-
-
- xmlParser __construct( -) -
-

- - Constructor



- - -
[ Top ]
-
-
- -

method parse [line 60]

-
-
-
- array parse( -string -$filename) -
-

- -

- - -

Parameters:

-
- - - - - - -
string  $filename  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:36 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_Help.html b/lam-web/developers/phpdoc/classtrees_Help.html deleted file mode 100644 index 18cc1475..00000000 --- a/lam-web/developers/phpdoc/classtrees_Help.html +++ /dev/null @@ -1,62 +0,0 @@ - - -Class Trees for Package Help - - - - - - - - - - - - - -
Help
- - - [ class tree: Help ] - [ index: Help ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package Help

-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_LDAP.html b/lam-web/developers/phpdoc/classtrees_LDAP.html deleted file mode 100644 index 199ecc6c..00000000 --- a/lam-web/developers/phpdoc/classtrees_LDAP.html +++ /dev/null @@ -1,67 +0,0 @@ - - -Class Trees for Package LDAP - - - - - - - - - - - - - -
LDAP
- - - [ class tree: LDAP ] - [ index: LDAP ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package LDAP

-
-
Root class Ldap

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_PDF.html b/lam-web/developers/phpdoc/classtrees_PDF.html deleted file mode 100644 index e90824fb..00000000 --- a/lam-web/developers/phpdoc/classtrees_PDF.html +++ /dev/null @@ -1,76 +0,0 @@ - - -Class Trees for Package PDF - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package PDF

-
-
Root class FPDF

- - -
-
Root class xmlParser

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_configuration.html b/lam-web/developers/phpdoc/classtrees_configuration.html deleted file mode 100644 index b691b865..00000000 --- a/lam-web/developers/phpdoc/classtrees_configuration.html +++ /dev/null @@ -1,72 +0,0 @@ - - -Class Trees for Package configuration - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package configuration

-
-
Root class LAMCfgMain

- - -
-
Root class LAMConfig

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_lib.html b/lam-web/developers/phpdoc/classtrees_lib.html deleted file mode 100644 index 3cae65c9..00000000 --- a/lam-web/developers/phpdoc/classtrees_lib.html +++ /dev/null @@ -1,79 +0,0 @@ - - -Class Trees for Package lib - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package lib

-
-
Root class cache

- - -
-
Root class ObjectClassAttribute

- - -
-
Root class SchemaItem

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_lists.html b/lam-web/developers/phpdoc/classtrees_lists.html deleted file mode 100644 index e3b8e8e5..00000000 --- a/lam-web/developers/phpdoc/classtrees_lists.html +++ /dev/null @@ -1,81 +0,0 @@ - - -Class Trees for Package lists - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package lists

-
-
Root class lamList

- - -
-
Root class lamListOption

- - -
-
Root class lamListTool

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_main.html b/lam-web/developers/phpdoc/classtrees_main.html deleted file mode 100644 index 212623ad..00000000 --- a/lam-web/developers/phpdoc/classtrees_main.html +++ /dev/null @@ -1,62 +0,0 @@ - - -Class Trees for Package main - - - - - - - - - - - - - -
main
- - - [ class tree: main ] - [ index: main ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package main

-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_modules.html b/lam-web/developers/phpdoc/classtrees_modules.html deleted file mode 100644 index 0de61b09..00000000 --- a/lam-web/developers/phpdoc/classtrees_modules.html +++ /dev/null @@ -1,91 +0,0 @@ - - -Class Trees for Package modules - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package modules

-
-
Root class accountContainer

- - -
-
Root class baseModule

- - -
-
Root class samba3domain

- - -
-
Root class sambaMungedDial

- - -
-
Root class smbHash

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_profiles.html b/lam-web/developers/phpdoc/classtrees_profiles.html deleted file mode 100644 index 7b86546b..00000000 --- a/lam-web/developers/phpdoc/classtrees_profiles.html +++ /dev/null @@ -1,62 +0,0 @@ - - -Class Trees for Package profiles - - - - - - - - - - - - - -
profiles
- - - [ class tree: profiles ] - [ index: profiles ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package profiles

-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_selfService.html b/lam-web/developers/phpdoc/classtrees_selfService.html deleted file mode 100644 index 63c4726e..00000000 --- a/lam-web/developers/phpdoc/classtrees_selfService.html +++ /dev/null @@ -1,67 +0,0 @@ - - -Class Trees for Package selfService - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package selfService

-
-
Root class selfServiceProfile

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_tests.html b/lam-web/developers/phpdoc/classtrees_tests.html deleted file mode 100644 index 06a7c0bb..00000000 --- a/lam-web/developers/phpdoc/classtrees_tests.html +++ /dev/null @@ -1,62 +0,0 @@ - - -Class Trees for Package tests - - - - - - - - - - - - - -
tests
- - - [ class tree: tests ] - [ index: tests ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package tests

-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_tools.html b/lam-web/developers/phpdoc/classtrees_tools.html deleted file mode 100644 index d77e1689..00000000 --- a/lam-web/developers/phpdoc/classtrees_tools.html +++ /dev/null @@ -1,81 +0,0 @@ - - -Class Trees for Package tools - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package tools

-
-
Root class LAMTool

- - -
-
Root class LdapExportInfo

- - -
-
Root class PlaAbstractExporter

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/classtrees_types.html b/lam-web/developers/phpdoc/classtrees_types.html deleted file mode 100644 index 5137075f..00000000 --- a/lam-web/developers/phpdoc/classtrees_types.html +++ /dev/null @@ -1,69 +0,0 @@ - - -Class Trees for Package types - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package types

-
-
Root class baseType

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/configuration/LAMCfgMain.html b/lam-web/developers/phpdoc/configuration/LAMCfgMain.html deleted file mode 100644 index 9f64ac6d..00000000 --- a/lam-web/developers/phpdoc/configuration/LAMCfgMain.html +++ /dev/null @@ -1,402 +0,0 @@ - - -Docs For Class LAMCfgMain - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Class: LAMCfgMain

-Source Location: /lib/config.inc

- - - - - - - - - - -
- -

Class Overview

-

-
This class manages config.cfg.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 882]
-This class manages config.cfg.



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$allowedHosts =

-

[line 900]

- list of hosts which may access LAM



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$default =

-

[line 885]

- Default profile



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$logDestination =

-

[line 897]

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



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$logLevel =

-

[line 894]

- log level



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$sessionTimeout =

-

[line 891]

- Time of inactivity before session times out (minutes)



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor __construct [line 909]

-
-
-
- LAMCfgMain __construct( -) -
-

- - Loads preferences from config file



- - -
[ Top ]
-
-
- -

method checkPassword [line 1014]

-
-
-
- boolean checkPassword( -String -$password) -
-

- - Checks if the given password matches.



-

Tags:

-
- - - - - - - -
return:  true, if password matches
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
String  $password  password
-

-
[ Top ]
-
-
- -

method save [line 950]

-
-
-
- void save( -) -
-

- - Saves preferences to config file config.cfg



-

Tags:

-
- - - - -
access:  public
-
-

- - -
[ Top ]
-
-
- -

method setPassword [line 1000]

-
-
-
- void setPassword( -String -$password) -
-

- - Sets a new config password.



-

Tags:

-
- - - - -
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
String  $password  new password
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:55 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/configuration/LAMConfig.html b/lam-web/developers/phpdoc/configuration/LAMConfig.html deleted file mode 100644 index 20d4f06c..00000000 --- a/lam-web/developers/phpdoc/configuration/LAMConfig.html +++ /dev/null @@ -1,1442 +0,0 @@ - - -Docs For Class LAMConfig - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Class: LAMConfig

-Source Location: /lib/config.inc

- - - - - - - - - - -
- -

Class Overview

-

-
This class manages .conf files.


- - - - - - - -
-

Constants

- -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

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



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 234]

-
-
-
- LAMConfig __construct( -[integer -$file = 0]) -
-

- - Loads preferences from config file



- - -

Parameters:

-
- - - - - - -
integer  $file  Index number in config file array
-

-
[ Top ]
-
-
- -

method check_Passwd [line 487]

-
-
-
- boolean check_Passwd( -String -$password) -
-

- - Checks if the given password matches.



-

Tags:

-
- - - - - - - -
return:  true, if matches
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
String  $password  
-

-
[ Top ]
-
-
- -

method getAccessLevel [line 861]

-
-
-
- int getAccessLevel( -) -
-

- - Returns the access level for this profile.



-

Tags:

-
- - - - - - - -
return:  level
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getName [line 403]

-
-
-
- String getName( -) -
-

- - Returns the name of the config file



-

Tags:

-
- - - - - - - -
return:  name
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_AccountModules [line 765]

-
-
-
- array get_AccountModules( -string -$scope) -
-

- - Returns an array of all selected account modules



-

Tags:

-
- - - - - - - -
return:  user modules
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $scope  account type
-

-
[ Top ]
-
-
- -

method get_ActiveTypes [line 821]

-
-
-
- array get_ActiveTypes( -) -
-

- - Returns a list of active account types.



-

Tags:

-
- - - - - - - -
return:  list of types
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_Admins [line 453]

-
-
-
- array get_Admins( -) -
-

- - Returns an array of string with all admin names



-

Tags:

-
- - - - - - - -
return:  the admin names
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_Adminstring [line 462]

-
-
-
- string get_Adminstring( -) -
-

- - Returns all admin users seperated by semicolons



-

Tags:

-
- - - - - - - -
return:  the admin string
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_cacheTimeout [line 731]

-
-
-
- integer get_cacheTimeout( -) -
-

- - Returns the LDAP cache timeout in minutes



-

Tags:

-
- - - - - - - -
return:  cache time
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_cacheTimeoutSec [line 741]

-
-
-
- integer get_cacheTimeoutSec( -) -
-

- - Returns the LDAP cache timeout in seconds



-

Tags:

-
- - - - - - - -
return:  cache time
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_defaultLanguage [line 600]

-
-
-
- string get_defaultLanguage( -) -
-

- - Returns the default language string



-

Tags:

-
- - - - - - - -
return:  default language
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_listAttributes [line 574]

-
-
-
- string get_listAttributes( -string -$scope) -
-

- - Returns the list of attributes to show in user list



-

Tags:

-
- - - - - - - -
return:  the attribute list
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $scope  account type
-

-
[ Top ]
-
-
- -

method get_moduleSettings [line 812]

-
-
-
- array get_moduleSettings( -) -
-

- - Returns a list of saved module settings



-

Tags:

-
- - - - - - - -
return:  list of settings: array(name => value)
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_scriptPath [line 621]

-
-
-
- string get_scriptPath( -) -
-

- - Returns the path to the external script



-

Tags:

-
- - - - - - - -
return:  script path
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_scriptRights [line 704]

-
-
-
- string get_scriptRights( -) -
-

- - Returns the chmod value for new home directories.



-

Tags:

-
- - - - - - - -
return:  rights
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_scriptServers [line 643]

-
-
-
- string get_scriptServers( -) -
-

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



-

Tags:

-
- - - - - - - -
return:  script servers
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_ServerURL [line 432]

-
-
-
- string get_ServerURL( -) -
-

- - Returns the server address as string



-

Tags:

-
- - - - - - - -
return:  server address
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_Suffix [line 538]

-
-
-
- string get_Suffix( -string -$scope) -
-

- - Returns the LDAP suffix for the given account type



-

Tags:

-
- - - - - - - -
return:  the LDAP suffix
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $scope  account type
-

-
[ Top ]
-
-
- -

method get_typeSettings [line 852]

-
-
-
- array get_typeSettings( -) -
-

- - Returns a list of saved type settings



-

Tags:

-
- - - - - - - -
return:  list of settings: array(name => value)
access:  public
-
-

- - -
[ Top ]
-
-
- -

method isWritable [line 412]

-
-
-
- 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 307]

-
-
-
- void save( -) -
-

- - Saves preferences to config file



-

Tags:

-
- - - - -
access:  public
-
-

- - -
[ Top ]
-
-
- -

method setAccessLevel [line 870]

-
-
-
- void setAccessLevel( -int -$level) -
-

- - Sets the access level for this profile.



-

Tags:

-
- - - - -
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
int  $level  level
-

-
[ Top ]
-
-
- -

method set_AccountModules [line 781]

-
-
-
- boolean set_AccountModules( -array -$modules, string -$scope) -
-

- - Sets the selected account modules



-

Tags:

-
- - - - - - - -
return:  true if $modules has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
array  $modules  array with module names (not aliases!)
string  $scope  account type
-

-
[ Top ]
-
-
- -

method set_ActiveTypes [line 831]

-
-
-
- void set_ActiveTypes( -array -$types) -
-

- - Sets the list of active types.



-

Tags:

-
- - - - -
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
array  $types  list of types
-

-
[ Top ]
-
-
- -

method set_Adminstring [line 472]

-
-
-
- boolean set_Adminstring( -string -$value) -
-

- - Sets the admin string



-

Tags:

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

- - -

Parameters:

-
- - - - - - -
string  $value  new admin string that contains all admin users seperated by semicolons
-

-
[ Top ]
-
-
- -

method set_cacheTimeout [line 751]

-
-
-
- boolean set_cacheTimeout( -integer -$value) -
-

- - Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)



-

Tags:

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

- - -

Parameters:

-
- - - - - - -
integer  $value  new cache timeout
-

-
[ Top ]
-
-
- -

method set_defaultLanguage [line 610]

-
-
-
- boolean set_defaultLanguage( -string -$value) -
-

- - Sets the default language string



-

Tags:

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

- - -

Parameters:

-
- - - - - - -
string  $value  new default language
-

-
[ Top ]
-
-
- -

method set_listAttributes [line 585]

-
-
-
- boolean set_listAttributes( -string -$value, string -$scope) -
-

- - Sets the list of attributes to show in user list



-

Tags:

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

- - -

Parameters:

-
- - - - - - - - - - - -
string  $value  new attribute string
string  $scope  account type
-

-
[ Top ]
-
-
- -

method set_moduleSettings [line 801]

-
-
-
- boolean set_moduleSettings( -array -$settings) -
-

- - Sets the settings for the account modules.



-

Tags:

-
- - - - - - - -
return:  true if $settings has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
array  $settings  list of module setting array(name => value)
-

-
[ Top ]
-
-
- -

method set_Passwd [line 507]

-
-
-
- boolean set_Passwd( -string -$value) -
-

- - Sets the preferences wizard password



-

Tags:

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

- - -

Parameters:

-
- - - - - - -
string  $value  new password
-

-
[ Top ]
-
-
- -

method set_scriptPath [line 631]

-
-
-
- boolean set_scriptPath( -string -$value) -
-

- - Sets the path to the external script



-

Tags:

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

- - -

Parameters:

-
- - - - - - -
string  $value  new script path
-

-
[ Top ]
-
-
- -

method set_scriptRights [line 715]

-
-
-
- boolean set_scriptRights( -string -$chmod) -
-

- - Sets the rights for the home directory.



-

Tags:

-
- - - - - - - -
return:  true if values has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $chmod  the rights
-

-
[ Top ]
-
-
- -

method set_scriptServers [line 653]

-
-
-
- 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 servers
-

-
[ Top ]
-
-
- -

method set_ServerURL [line 442]

-
-
-
- boolean set_ServerURL( -string -$value) -
-

- - Sets the server address



-

Tags:

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

- - -

Parameters:

-
- - - - - - -
string  $value  new server address
-

-
[ Top ]
-
-
- -

method set_Suffix [line 554]

-
-
-
- boolean set_Suffix( -string -$scope, string -$value) -
-

- - Sets the LDAP suffix where accounts are saved



-

Tags:

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

- - -

Parameters:

-
- - - - - - - - - - - -
string  $scope  account type
string  $value  new LDAP suffix
-

-
[ Top ]
-
-
- -

method set_typeSettings [line 841]

-
-
-
- boolean set_typeSettings( -array -$settings) -
-

- - Sets the settings for the account types.



-

Tags:

-
- - - - - - - -
return:  true if $settings has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
array  $settings  list of type setting array(name => value)
-

-
[ Top ]
-
-

- -
- -

Class Constants

-
- -

-

ACCESS_ALL =  100

-

[line 166]

- -
-
[ Top ]

- -

-

ACCESS_PASSWORD_CHANGE =  20

-

[line 167]

- -
-
[ Top ]

- -

-

ACCESS_READ_ONLY =  0

-

[line 168]

- -
-
[ Top ]

-

- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:56 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/configuration/_lib---config.inc.html b/lam-web/developers/phpdoc/configuration/_lib---config.inc.html deleted file mode 100644 index a3a96da2..00000000 --- a/lam-web/developers/phpdoc/configuration/_lib---config.inc.html +++ /dev/null @@ -1,257 +0,0 @@ - - -Docs for page config.inc - - - - - - - - - - - - - -
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, 06 Jan 2008 18:58:55 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/configuration/_lib_config_inc.html b/lam-web/developers/phpdoc/configuration/_lib_config_inc.html deleted file mode 100644 index cbb56287..00000000 --- a/lam-web/developers/phpdoc/configuration/_lib_config_inc.html +++ /dev/null @@ -1,212 +0,0 @@ - - -Docs for page config.inc - - - - - - - - - - - - - -
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
-
-

-

Includes:

-
-include_once("modules.inc") [line 35]
-Used to get module information.

include_once("status.inc") [line 33]
-Used to print messages.

include_once("types.inc") [line 37]
-Used to get type information.

-

-

-
-
- -

getConfigProfiles [line 61]

-
-
-
- array getConfigProfiles( -) -
-

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



-

Tags:

-
- - - - -
return:  profile names
-
-

- - -
[ Top ]


-
-
- -

LAMVersion [line 85]

-
-
-
- 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 103]

-
-
-
- void metaRefresh( -string $page) -
-

- - Prints a meta refresh page



- - -

Parameters

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


-
-
- -

setlanguage [line 42]

-
-
-
- void setlanguage( -) -
-

- - Sets language settings for automatic translation



- - -
[ Top ]


-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:39 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/configuration/_templates---config---conflogin.php.html b/lam-web/developers/phpdoc/configuration/_templates---config---conflogin.php.html deleted file mode 100644 index b8293aec..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates---config---conflogin.php.html +++ /dev/null @@ -1,118 +0,0 @@ - - -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, 06 Jan 2008 18:58:57 +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 deleted file mode 100644 index b278677a..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates---config---confmain.php.html +++ /dev/null @@ -1,138 +0,0 @@ - - -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 72]
-go back to login if password is invalid

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

-

-

-
-
- -

saveSettings [line 481]

-
-
-
- void saveSettings( -) -
-

- - Saves the entered settings.



- -
[ Top ]


-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:57 +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 deleted file mode 100644 index 4ff6a749..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates---config---confmodules.php.html +++ /dev/null @@ -1,156 +0,0 @@ - - -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 139]

-
-
-
- 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, 06 Jan 2008 18:58:57 +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 deleted file mode 100644 index 5ea61701..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates---config---conftypes.php.html +++ /dev/null @@ -1,119 +0,0 @@ - - -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, 06 Jan 2008 18:58:57 +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 deleted file mode 100644 index 8fbbfaa2..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates---config---index.php.html +++ /dev/null @@ -1,117 +0,0 @@ - - -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, 06 Jan 2008 18:59:08 +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 deleted file mode 100644 index 8eb3ea9e..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates---config---mainlogin.php.html +++ /dev/null @@ -1,118 +0,0 @@ - - -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, 06 Jan 2008 18:59:16 +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 deleted file mode 100644 index eaa66055..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates---config---mainmanage.php.html +++ /dev/null @@ -1,119 +0,0 @@ - - -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, 06 Jan 2008 18:59:16 +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 deleted file mode 100644 index 568fbd94..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates---config---profmanage.php.html +++ /dev/null @@ -1,118 +0,0 @@ - - -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, 06 Jan 2008 18:59:22 +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 deleted file mode 100644 index a15221bf..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates_config_conflogin_php.html +++ /dev/null @@ -1,114 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:40 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_confmain_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_confmain_php.html deleted file mode 100644 index 7fc87772..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates_config_confmain_php.html +++ /dev/null @@ -1,132 +0,0 @@ - - -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
-
-

-

Includes:

-
-include_once("../../lib/config.inc") [line 34]
-Access to config functions

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

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

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

-

-

-
-
- -

saveSettings [line 411]

-
-
-
- void saveSettings( -) -
-

- - Saves the entered settings.



- - -
[ Top ]


-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:40 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_confmodules_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_confmodules_php.html deleted file mode 100644 index 8b301121..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates_config_confmodules_php.html +++ /dev/null @@ -1,153 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:40 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_conftypes_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_conftypes_php.html deleted file mode 100644 index 086d9e71..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates_config_conftypes_php.html +++ /dev/null @@ -1,115 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:40 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_index_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_index_php.html deleted file mode 100644 index aaf69ee5..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates_config_index_php.html +++ /dev/null @@ -1,113 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:47 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_mainlogin_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_mainlogin_php.html deleted file mode 100644 index 82824553..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates_config_mainlogin_php.html +++ /dev/null @@ -1,114 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_mainmanage_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_mainmanage_php.html deleted file mode 100644 index 35fd990d..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates_config_mainmanage_php.html +++ /dev/null @@ -1,115 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_profmanage_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_profmanage_php.html deleted file mode 100644 index 34215a20..00000000 --- a/lam-web/developers/phpdoc/configuration/_templates_config_profmanage_php.html +++ /dev/null @@ -1,114 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:00 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex.html b/lam-web/developers/phpdoc/elementindex.html deleted file mode 100644 index a2636fc2..00000000 --- a/lam-web/developers/phpdoc/elementindex.html +++ /dev/null @@ -1,2677 +0,0 @@ - - -Element Index - - - - - - - - - - - - - -
- - [ all elements ] -
- - - - - - -
-
- - -

Index of all elements

- [ a ] - [ b ] - [ c ] - [ d ] - [ e ] - [ f ] - [ g ] - [ h ] - [ i ] - [ k ] - [ l ] - [ m ] - [ n ] - [ o ] - [ p ] - [ q ] - [ r ] - [ s ] - [ t ] - [ u ] - [ v ] - [ w ] - [ x ] - [ y ] - [ z ] - [ _ ] - -
- -
-

a

-
-
$aliases
-
in file schema.inc, variable AttributeType::$aliases
    An array of alias attribute names, strings
-
$AliasNbPages
-
in file fpdf.php, variable FPDF::$AliasNbPages
-
$allowedHosts
-
in file config.inc, variable LAMCfgMain::$allowedHosts
    list of hosts which may access LAM
-
$attrArray
-
in file lists.inc, variable lamList::$attrArray
    list of LDAP 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 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
-
$ATTR_MEMBER_NAME
-
in file groupOfNames.inc, variable groupOfNames::$ATTR_MEMBER_NAME
    name of member attribute
-
$ATTR_MEMBER_NAME
-
in file groupOfUniqueNames.inc, variable groupOfUniqueNames::$ATTR_MEMBER_NAME
    name of member attribute
-
$author
-
in file fpdf.php, variable FPDF::$author
-
$autoAddObjectClasses
-
in file baseModule.inc, variable baseModule::$autoAddObjectClasses
    if true, managed object classes are added when an account is created or loaded (default: true)
-
$AutoPageBreak
-
in file fpdf.php, variable FPDF::$AutoPageBreak
-
AcceptPageBreak
-
in file fpdf.php, method FPDF::AcceptPageBreak()
-
AcceptPageBreak
-
in file ufpdf.php, method UFPDF::AcceptPageBreak()
-
ACCESS_ALL
-
in file config.inc, class constant LAMConfig::ACCESS_ALL
-
ACCESS_PASSWORD_CHANGE
-
in file config.inc, class constant LAMConfig::ACCESS_PASSWORD_CHANGE
-
ACCESS_READ_ONLY
-
in file config.inc, class constant LAMConfig::ACCESS_READ_ONLY
-
account
-
in file account.inc, class account
    Manages the object class "account" for users and hosts.
-
accountContainer
-
in file modules.inc, class accountContainer
    This class includes all modules and attributes of an account.
-
addAlias
-
in file schema.inc, method AttributeType::addAlias()
    Adds an attribute name to the alias array.
-
addChildObjectClass
-
in file schema.inc, method ObjectClass::addChildObjectClass()
    Adds an objectClass to the list of objectClasses that inherit from this objectClass.
-
AddFont
-
in file fpdf.php, method FPDF::AddFont()
-
AddFont
-
in file ufpdf.php, method UFPDF::AddFont()
-
AddLink
-
in file fpdf.php, method FPDF::AddLink()
-
addMayAttrs
-
in file schema.inc, method ObjectClass::addMayAttrs()
    Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.
-
addMustAttrs
-
in file schema.inc, method ObjectClass::addMustAttrs()
    Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.
-
AddPage
-
in file fpdf.php, method FPDF::AddPage()
-
addRequiredByObjectClass
-
in file schema.inc, method AttributeType::addRequiredByObjectClass()
    Adds an objectClass name to this attribute's list of "required by" objectClasses, that is the list of objectClasses which must have this attribute.
-
addUsedByAttr
-
in file schema.inc, method MatchingRule::addUsedByAttr()
    Adds an attribute name to the list of attributes who use this MatchingRule
-
addUsedInObjectClass
-
in file schema.inc, method AttributeType::addUsedInObjectClass()
    Adds an objectClass name to this attribute's list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
-
add_aliases_to_attrs
-
in file schema.inc, function add_aliases_to_attrs()
    For each attribute that has multiple names, this function adds unique entries to the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.
-
add_cache
-
in file cache.inc, method cache::add_cache()
    This function adds attributes to the cache.
-
add_sup_to_attrs
-
in file schema.inc, function add_sup_to_attrs()
    Adds inherited values to each attributeType specified by the SUP directive.
-
AliasNbPages
-
in file fpdf.php, method FPDF::AliasNbPages()
-
AliasNbPages
-
in file ufpdf.php, method UFPDF::AliasNbPages()
-
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.
-
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
-
account.inc
-
procedural page account.inc
-
adminLogin.php
-
procedural page adminLogin.php
-
adminMain.php
-
procedural page adminMain.php
-
add_attr.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_oclass_form.php
-
procedural page add_oclass_form.php
-
add_value.php
-
procedural page add_value.php
-
add_value_form.php
-
procedural page add_value_form.php
-
-
- top
-
- -
-

b

-
-
$base_dn
-
in file export.inc, variable LdapExportInfo::$base_dn
-
$bMargin
-
in file fpdf.php, variable FPDF::$bMargin
-
$br
-
in file export.inc, variable PlaExporter::$br
-
$buffer
-
in file fpdf.php, variable FPDF::$buffer
-
baseModule
-
in file baseModule.inc, class baseModule
    Parent class of all account modules.
-
baseType
-
in file baseType.inc, class baseType
    This is the parent class of all account types.
-
buildUploadAccounts
-
in file modules.inc, function buildUploadAccounts()
    This function builds the LDAP accounts for the file upload.
-
build_initial_tree_icons
-
in file tree.inc, function build_initial_tree_icons()
    Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned
-
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 nisMailAlias.inc, method nisMailAlias::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 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 sambaGroupMapping.inc, method sambaGroupMapping::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 groupOfNames.inc, method groupOfNames::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file baseModule.inc, method baseModule::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file ldapPublicKey.inc, method ldapPublicKey::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.
-
build_uploadAccounts
-
in file kolabUser.inc, method kolabUser::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file account.inc, method account::build_uploadAccounts()
    In this function the LDAP account is built up.
-
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
-
baseType.inc
-
procedural page baseType.inc
-
-
- top
-
- -
-

c

-
-
$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)
-
$cMargin
-
in file fpdf.php, variable FPDF::$cMargin
-
$ColorFlag
-
in file fpdf.php, variable FPDF::$ColorFlag
-
$compress
-
in file fpdf.php, variable FPDF::$compress
-
$CoreFonts
-
in file fpdf.php, variable FPDF::$CoreFonts
-
$counter
-
in file export.inc, variable PlaLdifExporter::$counter
-
$counter
-
in file export.inc, variable PlaDsmlExporter::$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
-
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
-
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()
-
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.
-
checkConfigOptions
-
in file modules.inc, function checkConfigOptions()
    Checks if the configuration options are valid
-
checkIfPasswordChangeIsAllowed
-
in file security.inc, function checkIfPasswordChangeIsAllowed()
    Checks if passwords may be changed.
-
checkIfWriteAccessIsAllowed
-
in file security.inc, function checkIfWriteAccessIsAllowed()
    Checks if write access to LDAP is allowed.
-
checkPassword
-
in file config.inc, method LAMCfgMain::checkPassword()
    Checks if the given password matches.
-
checkProfileOptions
-
in file modules.inc, function checkProfileOptions()
    Checks if the profile options are valid
-
checkSchemaForModule
-
in file schemaTest.php, function checkSchemaForModule()
    Checks if the object classes and attributes for this module are available.
-
checkSelfServiceOptions
-
in file 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.
-
checkSelfServiceOptions
-
in file selfService.inc, function checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceOptions
-
in file posixAccount.inc, method posixAccount::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceOptions
-
in file inetOrgPerson.inc, method inetOrgPerson::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceSettings
-
in file baseModule.inc, method baseModule::checkSelfServiceSettings()
    Checks if the self service settings are valid.
-
checkSelfServiceSettings
-
in file selfService.inc, function 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
-
check_module_depends
-
in file modules.inc, function check_module_depends()
    Checks if there are missing dependencies between modules.
-
check_Passwd
-
in file config.inc, method LAMConfig::check_Passwd()
    Checks if the given password matches.
-
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.
-
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
-
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.
-
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.
-
cache.inc
-
procedural page cache.inc
-
config.inc
-
procedural page config.inc
-
createntlm.inc
-
procedural page createntlm.inc
-
conflogin.php
-
procedural page conflogin.php
-
confmain.php
-
procedural page confmain.php
-
confmodules.php
-
procedural page confmodules.php
-
conftypes.php
-
procedural page conftypes.php
-
changePassword.php
-
procedural page changePassword.php
-
collapse.php
-
procedural page collapse.php
-
create.php
-
procedural page create.php
-
create_form.php
-
procedural page create_form.php
-
creation_template.php
-
procedural page creation_template.php
-
custom.php
-
procedural page custom.php
-
conf-main-test.php
-
procedural page conf-main-test.php
-
conf-test.php
-
procedural page conf-test.php
-
-
- top
-
- -
-

d

-
-
$default
-
in file config.inc, variable LAMCfgMain::$default
    Default profile
-
$DefOrientation
-
in file fpdf.php, variable FPDF::$DefOrientation
-
$deliveryAddress
-
in file export.inc, variable PlaVcardExporter::$deliveryAddress
-
$descArray
-
in file lists.inc, variable lamList::$descArray
    list of attribute descriptions
-
$description
-
in file tools.php, variable LAMTool::$description
    description text
-
$description
-
in file schema.inc, variable SchemaItem::$description
    The description of this schema item.
-
$diffs
-
in file fpdf.php, variable FPDF::$diffs
-
$dn
-
in file modules.inc, variable accountContainer::$dn
    DN suffix of the account
-
$dn
-
in file account.inc, variable samba3domain::$dn
    DN
-
$dn_orig
-
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
-
deleteDN
-
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.
-
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 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.
-
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.
-
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 sambaAccount.inc, method sambaAccount::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 nisMailAlias.inc, method nisMailAlias::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()
    Returns the HTML meta data for the main account page.
-
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 quota.inc, method quota::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()
    Returns the HTML meta data for the main account page.
-
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 ieee802device.inc, method ieee802Device::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 groupOfNames.inc, method groupOfNames::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()
    Returns the HTML meta data for the main account page.
-
display_html_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 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()
    Returns the HTML meta data for the main account page.
-
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
-
in file kolabUser.inc, method kolabUser::display_html_deleteUser()
    This function will create the meta HTML code to show a page to delete accounts.
-
display_html_expire
-
in file shadowAccount.inc, method shadowAccount::display_html_expire()
    This function will create the meta HTML code to show a page with the expiration date.
-
display_html_group
-
in file posixAccount.inc, method posixAccount::display_html_group()
    Displays the group selection.
-
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_members
-
in file groupOfNames.inc, method groupOfNames::display_html_members()
    This function will create the meta HTML code to show a page to change the member attribute.
-
display_html_owner
-
in file groupOfNames.inc, method groupOfNames::display_html_owner()
    This function will create the meta HTML code to show a page to change the owner attribute.
-
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 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()
    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()
    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.
-
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.
-
doHash
-
in file createntlm.inc, method smbHash::doHash()
-
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.
-
doUploadPostActions
-
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.
-
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.
-
draw_jpeg_photos
-
in file tree.inc, function draw_jpeg_photos()
    Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to specify how the images are to be displayed.
-
draw_server_tree
-
in file tree.inc, function draw_server_tree()
    Prints the HTML of the tree view.
-
draw_tree_html
-
in file tree.php, function draw_tree_html()
    Recursively descend on the given dn and draw the tree in html
-
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
-
delete_form.php
-
procedural page delete_form.php
-
download_binary_attr.php
-
procedural page download_binary_attr.php
-
-
- top
-
- -
-

e

-
-
$entries
-
in file lists.inc, variable lamList::$entries
    LDAP entries
-
$entry_array
-
in file export.inc, variable PlaLdapExporter::$entry_array
-
$entry_id
-
in file export.inc, variable PlaLdapExporter::$entry_id
-
$equality
-
in file schema.inc, variable AttributeType::$equality
    The equality rule used
-
$escapeCode
-
in file export.inc, variable PlaCSVExporter::$escapeCode
-
$exporter
-
in file export.inc, variable PlaExporter::$exporter
-
echoHTMLFoot
-
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.
-
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 PlaCSVExporter::export()
-
export
-
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 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()
    E_P16
-
export.inc
-
procedural page export.inc
-
edit.php
-
procedural page edit.php
-
edit.php
-
procedural page edit.php
-
expand.php
-
procedural page expand.php
-
export.php
-
procedural page export.php
-
export_form.php
-
procedural page export_form.php
-
-
- top
-
- -
-

f

-
-
$fh
-
in file fpdf.php, variable FPDF::$fh
-
$fhPt
-
in file fpdf.php, variable FPDF::$fhPt
-
$FillColor
-
in file fpdf.php, variable FPDF::$FillColor
-
$filterText
-
in file lists.inc, variable lamList::$filterText
    filter string to include in URL
-
$FontFamily
-
in file fpdf.php, variable FPDF::$FontFamily
-
$FontFiles
-
in file fpdf.php, variable FPDF::$FontFiles
-
$fontList
-
in file lamPDF.inc, variable lamPDF::$fontList
    list of supported fonts
-
$fontName
-
in file lamPDF.inc, variable lamPDF::$fontName
    current active font name
-
$fonts
-
in file fpdf.php, variable FPDF::$fonts
-
$FontSize
-
in file fpdf.php, variable FPDF::$FontSize
-
$FontSizePt
-
in file fpdf.php, variable FPDF::$FontSizePt
-
$FontStyle
-
in file fpdf.php, variable FPDF::$FontStyle
-
$fw
-
in file fpdf.php, variable FPDF::$fw
-
$fwPt
-
in file fpdf.php, variable FPDF::$fwPt
-
fillFromPostData
-
in file lists.inc, method lamSelectListOption::fillFromPostData()
    Fills the config option from POST data.
-
fillFromPostData
-
in file lists.inc, method lamListOption::fillFromPostData()
    Fills the config option from POST data.
-
fillFromPostData
-
in file lists.inc, method lamBooleanListOption::fillFromPostData()
    Fills the config option from POST data.
-
findgroups
-
in file cache.inc, method cache::findgroups()
    This function returns an array with all group names which were found in the LDAP directory.
-
fixLDAPAttributes
-
in file modules.inc, method accountContainer::fixLDAPAttributes()
    Fixes spelling errors in the attribute names.
-
Footer
-
in file fpdf.php, method FPDF::Footer()
-
footer
-
in file lamPDF.inc, method lamPDF::footer()
-
FPDF
-
in file fpdf.php, class FPDF
    Main FPDF class for creating PDF documents
-
FPDF
-
in file fpdf.php, method FPDF::FPDF()
    *****************************************************************************
-
FPDF_VERSION
-
in file fpdf.php, constant FPDF_VERSION
    *****************************************************************************
-
fpdf.php
-
procedural page fpdf.php
-
-
- top
-
- -
-

g

-
-
generatePassword
-
in file changePassword.php, function generatePassword()
    Sets a generated password and displays it or sends it via mail.
-
generateRandomPassword
-
in file account.inc, function generateRandomPassword()
    Generates a random password with 12 digits.
-
genTime
-
in file sambaMungedDial.inc, method sambaMungedDial::genTime()
    genTime
-
getAccessLevel
-
in file config.inc, method LAMConfig::getAccessLevel()
    Returns the access level for this profile.
-
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
-
getAdditionalTools
-
in file user.inc, method lamUserList::getAdditionalTools()
    Returns a list of lamListTool objects to display next to the edit/delete buttons.
-
getAdditionalTools
-
in file lists.inc, method lamList::getAdditionalTools()
    Returns a list of lamListTool objects to display next to the edit/delete buttons.
-
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.
-
getAlias
-
in file baseType.inc, method baseType::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 mailAlias.inc, method mailAlias::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.
-
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.
-
getAvailableModules
-
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.
-
getBrokenConn
-
in file sambaMungedDial.inc, method sambaMungedDial::getBrokenConn()
    gets Broken-Connection value: disconnect/reset
-
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 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 nisMailAlias.inc, method nisMailAlias::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.
-
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.
-
getConfigProfiles
-
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.
-
getDefaultListAttributes
-
in file types.inc, function getDefaultListAttributes()
    Returns the default attribute list for an 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.
-
getDefaultListAttributes
-
in file baseType.inc, method baseType::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 mailAlias.inc, method mailAlias::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDefaultListAttributes
-
in file host.inc, method host::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 schema.inc, method SchemaItem::getDescription()
-
getDescription
-
in file mailAlias.inc, method mailAlias::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.
-
getDescription
-
in file baseType.inc, method baseType::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 smbDomain.inc, method smbDomain::getDescription()
    Returns the description of this account type.
-
getEquality
-
in file schema.inc, method AttributeType::getEquality()
    Gets this attribute's equality string
-
getgid
-
in file cache.inc, method cache::getgid()
    This function will return the GID number to an existing group name (using the cache).
-
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.
-
getIcon
-
in file baseModule.inc, method baseModule::getIcon()
    Returns the path to the module icon.
-
getID
-
in file lists.inc, method lamListOption::getID()
    Returns the option ID.
-
getImage
-
in file lists.inc, method lamListTool::getImage()
    Returns the name of the tool image.
-
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 AttributeType::getIsObsolete()
    Gets whether this attribute has been flagged as obsolete by the LDAP server
-
getIsObsolete
-
in file schema.inc, method MatchingRule::getIsObsolete()
    Gets whether this MatchingRule is flagged as obsolete by the LDAP server.
-
getIsSingleValue
-
in file schema.inc, method AttributeType::getIsSingleValue()
    Gets whether this attribute is single-valued. If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.
-
getLDAPAliases
-
in file baseModule.inc, method baseModule::getLDAPAliases()
    Returns a list of aliases for LDAP attributes.
-
getLinkTarget
-
in file lists.inc, method lamListTool::getLinkTarget()
    Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.
-
getListAttributeDescriptions
-
in file group.inc, method group::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 mailAlias.inc, method mailAlias::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 user.inc, method user::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.
-
getListClassName
-
in file user.inc, method user::getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file mailAlias.inc, method mailAlias::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 host.inc, method host::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.
-
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.
-
getManagedAttributes
-
in file baseModule.inc, method baseModule::getManagedAttributes()
    Returns a list of LDAP attributes which are managed by this module.
-
getManagedObjectClasses
-
in file baseModule.inc, method baseModule::getManagedObjectClasses()
    Returns a list of managed object classes for this module.
-
getMaxLength
-
in file schema.inc, method AttributeType::getMaxLength()
    Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.
-
getMayAttrNames
-
in file schema.inc, method ObjectClass::getMayAttrNames()
    Gets an array of attribute names (strings) that entries of this ObjectClass must define.
-
getMayAttrs
-
in file schema.inc, method ObjectClass::getMayAttrs()
    Gets an array of AttributeType objects that entries of this ObjectClass may define.
-
getMetaHTML
-
in file lists.inc, method lamListOption::getMetaHTML()
    Returns the meta HTML data to display this option.
-
getMetaHTML
-
in file lists.inc, method lamBooleanListOption::getMetaHTML()
    Returns the meta HTML data to display this option.
-
getMetaHTML
-
in file lists.inc, method lamSelectListOption::getMetaHTML()
    Returns the meta HTML data to display this option.
-
getModuleAlias
-
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
-
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
-
in file schema.inc, method ObjectClass::getMustAttrs()
    Gets an array of AttributeType objects that entries of this ObjectClass must define.
-
getName
-
in file schema.inc, method MatchingRuleUse::getName()
    Gets this MatchingRuleUse's name
-
getName
-
in file lists.inc, method lamListTool::getName()
    Returns the tool name.
-
getName
-
in file schema.inc, method AttributeType::getName()
    Gets this attribute's name
-
getName
-
in file schema.inc, method MatchingRule::getName()
    Gets this MatchingRule's name.
-
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 config.inc, method LAMConfig::getName()
    Returns the name of the config file
-
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.
-
getProfileOptions
-
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.
-
getReConn
-
in file sambaMungedDial.inc, method sambaMungedDial::getReConn()
    gets Reconnection value: from any client/from previous client only
-
getRecursiveAttributesFromObjectClass
-
in file schemaTest.php, function getRecursiveAttributesFromObjectClass()
    Returns the names of all attributes which are managed by the given object class and its parents.
-
getRequiredByObjectClasses
-
in file schema.inc, method AttributeType::getRequiredByObjectClasses()
    Gets the list of "required by" objectClasses, that is the list of objectClasses which provide must have attribute.
-
getRequiredExtensions
-
in file modules.inc, function getRequiredExtensions()
    Returns true if the module is a base module
-
getRequiredExtensions
-
in file baseModule.inc, method baseModule::getRequiredExtensions()
    Returns a list of required PHP extensions.
-
getSectionHeadline
-
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 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 posixAccount.inc, method posixAccount::getSelfServiceOptions()
    Returns the meta HTML code for each input field.
-
getSelfServiceOptions
-
in file selfService.inc, function getSelfServiceOptions()
    Returns meta HTML code for each self service field.
-
getSelfServiceProfiles
-
in file selfService.inc, function getSelfServiceProfiles()
    Returns a list of all available self service profiles (without .conf)
-
getSelfServiceSearchAttributes
-
in file selfService.inc, function getSelfServiceSearchAttributes()
    Returns a list of possible search attributes for the self service.
-
getSelfServiceSearchAttributes
-
in file baseModule.inc, method baseModule::getSelfServiceSearchAttributes()
    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.
-
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
-
getshells
-
in file account.inc, function getshells()
    Returns a list of shells listed in config/shells.
-
getSource
-
in file schema.inc, method ObjectClassAttribute::getSource()
    Gets the name of the ObjectClass which originally specified this attribute.
-
GetStringWidth
-
in file fpdf.php, method FPDF::GetStringWidth()
-
GetStringWidth
-
in file ufpdf.php, method UFPDF::GetStringWidth()
-
getSubstr
-
in file schema.inc, method AttributeType::getSubstr()
    Gets this attribute's substring matching specification
-
getSupAttribute
-
in file schema.inc, method AttributeType::getSupAttribute()
    Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.
-
getSupClasses
-
in file schema.inc, method ObjectClass::getSupClasses()
    Gets the objectClass names from which this objectClass inherits.
-
getSyntaxOID
-
in file schema.inc, method AttributeType::getSyntaxOID()
    Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.
-
getSyntaxString
-
in file schema.inc, method AttributeType::getSyntaxString()
    Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").
-
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.
-
getTypeDescription
-
in file types.inc, function getTypeDescription()
    Returns the description of an account type.
-
getTypes
-
in file types.inc, function getTypes()
    Returns a list of available account types.
-
getUploadColumns
-
in file modules.inc, function getUploadColumns()
    Returns an array containing all input columns for the file upload.
-
getUsage
-
in file schema.inc, method AttributeType::getUsage()
    Gets this attribute's usage string as defined by the LDAP server
-
getUsedByAttrs
-
in file schema.inc, method MatchingRuleUse::getUsedByAttrs()
    Gets an array of attribute names (strings) which use this MatchingRuleUse object.
-
getUsedByAttrs
-
in file schema.inc, method MatchingRule::getUsedByAttrs()
    Gets an array of attribute names (strings) which use this MatchingRule
-
getUsedInObjectClasses
-
in file schema.inc, method AttributeType::getUsedInObjectClasses()
    Gets the list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
-
getValue
-
in file lists.inc, method lamListOption::getValue()
    Returns the option value. The value must not contain "=" and ";".
-
GetX
-
in file fpdf.php, method FPDF::GetX()
-
GetY
-
in file fpdf.php, method FPDF::GetY()
-
get_AccountModules
-
in file config.inc, method LAMConfig::get_AccountModules()
    Returns an array of all selected account modules
-
get_ActiveTypes
-
in file config.inc, method LAMConfig::get_ActiveTypes()
    Returns a list of active account types.
-
get_Admins
-
in file config.inc, method LAMConfig::get_Admins()
    Returns an array of string with all admin names
-
get_Adminstring
-
in file config.inc, method LAMConfig::get_Adminstring()
    Returns all admin users seperated by semicolons
-
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.
-
get_binary_attr_select_html
-
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
-
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 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.
-
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:
-
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()
-
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
-
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
-
get_ldap_filter
-
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.
-
get_listAttributes
-
in file config.inc, method LAMConfig::get_listAttributes()
    Returns the list of attributes to show in user list
-
get_metaData
-
in file posixGroup.inc, method posixGroup::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 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 baseModule.inc, method baseModule::get_metaData()
    Dummy function, meta data is provided by sub classes.
-
get_metaData
-
in file quota.inc, method quota::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
-
get_metaData
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::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 groupOfUniqueNames.inc, method groupOfUniqueNames::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 sambaAccount.inc, method sambaAccount::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 nisMailAlias.inc, method nisMailAlias::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file groupOfNames.inc, method groupOfNames::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_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:
-
get_object_attrs
-
in file tree.inc, function get_object_attrs()
    Gets the attributes/values of an entry. Returns an associative array whose
-
get_pdfEntries
-
in file shadowAccount.inc, method shadowAccount::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 nisMailAlias.inc, method nisMailAlias::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 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 account.inc, method account::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 groupOfNames.inc, method groupOfNames::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 inetLocalMailRecipient.inc, method inetLocalMailRecipient::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 sambaAccount.inc, method sambaAccount::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 sambaDomain.inc, method sambaDomain::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_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 posixAccount.inc, method posixAccount::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_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 baseModule.inc, method baseModule::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.
-
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.
-
get_schema_attributes
-
in file schema.inc, function get_schema_attributes()
    Gets an associative array of AttributeType objects for the specified server. Each array entry's key is the name of the attributeType in lower-case and the value is an AttributeType object.
-
get_schema_matching_rules
-
in file schema.inc, function get_schema_matching_rules()
    Returns an array of MatchingRule objects for the specified server.
-
get_schema_objectclass
-
in file schema.inc, function get_schema_objectclass()
    Gets a single ObjectClass object specified by name.
-
get_schema_objectclasses
-
in file schema.inc, function get_schema_objectclasses()
    Gets an associative array of ObjectClass objects for the specified server. Each array entry's key is the name of the objectClass in lower-case and the value is an ObjectClass object.
-
get_schema_syntaxes
-
in file schema.inc, function get_schema_syntaxes()
    Returns an array of Syntax objects that this LDAP server uses mapped to their descriptions. The key of each entry is the OID of the Syntax.
-
get_scope
-
in file baseModule.inc, method baseModule::get_scope()
    Returns the account type of this module (user, group, host)
-
get_scriptPath
-
in file config.inc, method LAMConfig::get_scriptPath()
    Returns the path to 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
-
in file config.inc, method LAMConfig::get_Suffix()
    Returns the LDAP suffix for the given account type
-
get_type
-
in file modules.inc, method accountContainer::get_type()
    Returns the accout type of this object (e.g. user, group, host).
-
get_typeSettings
-
in file config.inc, method LAMConfig::get_typeSettings()
    Returns a list of saved type settings
-
get_uploadColumns
-
in file quota.inc, method quota::get_uploadColumns()
    Returns an array containing all input columns for the file upload.
-
get_uploadColumns
-
in file baseModule.inc, method baseModule::get_uploadColumns()
    Returns an array containing all input columns for the file upload.
-
get_uploadPreDepends
-
in file baseModule.inc, method baseModule::get_uploadPreDepends()
    Returns a list of module names which must be processed in building the account befor this module.
-
get_user_agent_string
-
in file export.inc, function get_user_agent_string()
    Gets the USER_AGENT string from the $_SERVER array, all in lower case in an E_NOTICE safe manner.
-
group
-
in file group.inc, class group
    The account type for group accounts (e.g. Unix and Samba).
-
groupOfNames
-
in file groupOfNames.inc, class groupOfNames
    Manages group members for the object class groupOfNames.
-
groupOfUniqueNames
-
in file groupOfUniqueNames.inc, class groupOfUniqueNames
    Manages group members for the object class groupOfUniqueNames.
-
groupRefreshPrimary
-
in file group.inc, method lamGroupList::groupRefreshPrimary()
    Refreshes the primary group members list.
-
groupOfNames.inc
-
procedural page groupOfNames.inc
-
groupOfUniqueNames.inc
-
procedural page groupOfUniqueNames.inc
-
group.inc
-
procedural page group.inc
-
-
- top
-
- -
-

h

-
-
$h
-
in file fpdf.php, variable FPDF::$h
-
$hasNext
-
in file export.inc, variable PlaLdapExporter::$hasNext
-
$hPt
-
in file fpdf.php, variable FPDF::$hPt
-
header
-
in file lamPDF.inc, method lamPDF::header()
-
Header
-
in file fpdf.php, method FPDF::Header()
-
help.inc
-
procedural page help.inc
-
hex2bin
-
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
-
help.php
-
procedural page help.php
-
-
- top
-
- -
-

i

-
-
$images
-
in file fpdf.php, variable FPDF::$images
-
$indent_step
-
in file export.inc, variable PlaDsmlExporter::$indent_step
-
$InFooter
-
in file fpdf.php, variable FPDF::$InFooter
-
$inputFields
-
in file selfService.inc, variable selfServiceProfile::$inputFields
    input fields
-
$isNewAccount
-
in file modules.inc, variable accountContainer::$isNewAccount
    True if this is a newly created account
-
$is_collective
-
in file schema.inc, variable AttributeType::$is_collective
    boolean: is collective?
-
$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 ObjectClass::$is_obsolete
    boolean value indicating whether this objectClass is obsolete
-
$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 AttributeType::$is_obsolete
    string: the description
-
$is_single_value
-
in file schema.inc, variable AttributeType::$is_single_value
    boolean: is single valued only?
-
ieee802Device
-
in file ieee802device.inc, class ieee802Device
    Provides MAC addresses for hosts.
-
Image
-
in file fpdf.php, method FPDF::Image()
-
inetLocalMailRecipient
-
in file inetLocalMailRecipient.inc, class inetLocalMailRecipient
    Provides mail routing for users.
-
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 sambaGroupMapping.inc, method sambaGroupMapping::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
-
init
-
in file posixGroup.inc, method posixGroup::init()
    This functin will be called when the module will be loaded *
-
init
-
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
-
initialize_session_tree
-
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 MatchingRuleUse::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 MatchingRule::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 SchemaItem::initVars()
    Initialize class members to default values.
-
initVars
-
in file schema.inc, method Syntax::initVars()
    Initializes 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_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.
-
isSelected
-
in file lists.inc, method lamBooleanListOption::isSelected()
    Returns if this option is selected.
-
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.
-
is_attr_boolean
-
in file tree.inc, function is_attr_boolean()
    Given an attribute name and server ID number, this function returns whether the attrbiute contains boolean data. This is useful for developers who wish to display the contents of a boolean attribute with a drop-down.
-
is_base_module
-
in file 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()
-
is_browser_os_mac
-
in file export.inc, function is_browser_os_mac()
    Determines whether the browser's operating system is Macintosh.
-
is_browser_os_unix
-
in file export.inc, function is_browser_os_unix()
    Determines whether the browser's operating system is UNIX (or something like UNIX).
-
is_browser_os_windows
-
in file export.inc, function is_browser_os_windows()
    Determines whether the browser's operating system is Windows.
-
is_dn_attr
-
in file tree.inc, function is_dn_attr()
    Returns true if the attribute specified is required to take as input a DN.
-
is_jpeg_photo
-
in file tree.inc, function is_jpeg_photo()
    Used to determine if the specified attribute is indeed a jpegPhoto. If the specified attribute is one that houses jpeg data, true is returned. Otherwise this function returns false.
-
is_mail_string
-
in file tree.inc, function is_mail_string()
    Get whether a string looks like an email address (user@example.com).
-
is_multi_line_attr
-
in file tree.inc, function is_multi_line_attr()
    Determines if an attribute's value can contain multiple lines. Attributes that fall in this multi-line category may be configured in config.php. Hence, this function accesses the global variable $multi_line_attributes;
-
is_safe_ascii
-
in file export.inc, method PlaExporter::is_safe_ascii()
    Helper method to check if the attribute value should be base 64 encoded.
-
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/)
-
ieee802device.inc
-
procedural page ieee802device.inc
-
inetLocalMailRecipient.inc
-
procedural page inetLocalMailRecipient.inc
-
inetOrgPerson.inc
-
procedural page inetOrgPerson.inc
-
index.php
-
procedural page index.php
-
initsuff.php
-
procedural page initsuff.php
-
index.php
-
procedural page index.php
-
-
- top
-
- -
-

k

-
-
$k
-
in file fpdf.php, variable FPDF::$k
-
$keywords
-
in file fpdf.php, variable FPDF::$keywords
-
kolabUser
-
in file kolabUser.inc, class kolabUser
    Manages Kolab user accounts.
-
kolabUser.inc
-
procedural page kolabUser.inc
-
-
- top
-
- -
-

l

-
-
$labels
-
in file lists.inc, variable lamList::$labels
    list of account specific labels
-
$lasth
-
in file fpdf.php, variable FPDF::$lasth
-
$LayoutMode
-
in file fpdf.php, variable FPDF::$LayoutMode
-
$LDAPPassword
-
in file selfService.inc, variable selfServiceProfile::$LDAPPassword
    LDAP password
-
$LDAPSuffix
-
in file selfService.inc, variable selfServiceProfile::$LDAPSuffix
    LDAP suffix
-
$LDAPUser
-
in file selfService.inc, variable selfServiceProfile::$LDAPUser
    LDAP user DN
-
$ldap_info
-
in file export.inc, variable PlaLdapExporter::$ldap_info
-
$LineWidth
-
in file fpdf.php, variable FPDF::$LineWidth
-
$link
-
in file tools.php, variable LAMTool::$link
    link to tool page (relative to templates/)
-
$links
-
in file fpdf.php, variable FPDF::$links
-
$lMargin
-
in file fpdf.php, variable FPDF::$lMargin
-
$logDestination
-
in file config.inc, variable LAMCfgMain::$logDestination
    log destination ("SYSLOG":syslog, "/...":file, "NONE":none)
-
$loginAttributeText
-
in file selfService.inc, variable selfServiceProfile::$loginAttributeText
    describing text for search attribute
-
$loginCaption
-
in file selfService.inc, variable selfServiceProfile::$loginCaption
    describing text for user login
-
$logLevel
-
in file config.inc, variable LAMCfgMain::$logLevel
    log level
-
lamBooleanListOption
-
in file lists.inc, class lamBooleanListOption
    Boolean option for list configuration.
-
LAMCfgMain
-
in file config.inc, class LAMCfgMain
    This class manages config.cfg.
-
LAMConfig
-
in file config.inc, class LAMConfig
    This class manages .conf files.
-
lamdaemon
-
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, class lamGroupList
    Generates the list view.
-
lamHostList
-
in file host.inc, class lamHostList
    Generates the list view.
-
lamList
-
in file lists.inc, class lamList
    Generates the list view.
-
lamListOption
-
in file lists.inc, class lamListOption
    Represents a list configuration option.
-
lamListTool
-
in file lists.inc, class lamListTool
    Represents a tool which can be included in the account lists.
-
lamMailAliasList
-
in file mailAlias.inc, class lamMailAliasList
    Generates the list view.
-
lamPDF
-
in file lamPDF.inc, class lamPDF
    Creates a LAM information page in PDF format.
-
LAMPDF_LINEWIDTH
-
in file pdf.inc, constant LAMPDF_LINEWIDTH
    PDF line width
-
lamSelectListOption
-
in file lists.inc, class lamSelectListOption
    Boolean option for list configuration.
-
lamSmbDomainList
-
in file smbDomain.inc, class lamSmbDomainList
    Generates the list view.
-
lamTestLamdaemon
-
in file lamdaemonTest.php, function lamTestLamdaemon()
    Runs a test case of lamdaemon.
-
LAMTool
-
in file tools.php, class LAMTool
    Represents a tool.
-
lamUserList
-
in file user.inc, class lamUserList
    Generates the list view.
-
LAMVersion
-
in file config.inc, function LAMVersion()
    Returns the version number of this LAM installation.
-
Ldap
-
in file ldap.inc, class Ldap
    Ldap manages connection to LDAP and includes several helper functions.
-
LdapEscape
-
in file export.inc, method PlaCSVExporter::LdapEscape()
-
LdapExportInfo
-
in file export.inc, class LdapExportInfo
    This class encapsulate informations about the ldap server from which the export is done.
-
LdapExportInfo
-
in file export.inc, method LdapExportInfo::LdapExportInfo()
    Create a new LdapExportInfo object
-
ldapPublicKey
-
in file ldapPublicKey.inc, class ldapPublicKey
    Manages SSH public keys.
-
lamdaemon.inc
-
procedural page lamdaemon.inc
-
lamPDF.inc
-
procedural page lamPDF.inc
-
ldap.inc
-
procedural page ldap.inc
-
lists.inc
-
procedural page lists.inc
-
ldapPublicKey.inc
-
procedural page ldapPublicKey.inc
-
Line
-
in file fpdf.php, method FPDF::Line()
-
Link
-
in file fpdf.php, method FPDF::Link()
-
listBuildFilter
-
in file lists.inc, method lamList::listBuildFilter()
    Builds the regular expressions from the filter values.
-
listConfigurationChanged
-
in file user.inc, method lamUserList::listConfigurationChanged()
    Called when the configuration options changed.
-
listConfigurationChanged
-
in file group.inc, method lamGroupList::listConfigurationChanged()
    Called when the configuration options changed.
-
listConfigurationChanged
-
in file lists.inc, method lamList::listConfigurationChanged()
    Called when the configuration options changed.
-
listDrawNavigationBar
-
in file lists.inc, method lamList::listDrawNavigationBar()
    Draws a navigation bar to switch between pages
-
listFilterAccounts
-
in file lists.inc, method lamList::listFilterAccounts()
    Removes all entries which do not fit to the filter.
-
listGetAllConfigOptions
-
in file group.inc, method lamGroupList::listGetAllConfigOptions()
    Returns a list of possible configuration options.
-
listGetAllConfigOptions
-
in file lists.inc, method lamList::listGetAllConfigOptions()
    Returns a list of possible configuration options.
-
listGetAllConfigOptions
-
in file user.inc, method lamUserList::listGetAllConfigOptions()
    Returns a list of possible configuration options.
-
listGetConfigOptionByID
-
in file lists.inc, method lamList::listGetConfigOptionByID()
    Returns the configuration option with the given ID.
-
listGetParams
-
in file lists.inc, method lamList::listGetParams()
    Sets some internal parameters.
-
listGetParams
-
in file user.inc, method lamUserList::listGetParams()
    Sets some internal parameters.
-
listGetParams
-
in file group.inc, method lamGroupList::listGetParams()
    Sets some internal parameters.
-
listPrintButtons
-
in file lists.inc, method lamList::listPrintButtons()
    Prints the create and delete buttons.
-
listPrintConfigurationPage
-
in file lists.inc, method lamList::listPrintConfigurationPage()
    Prints the list configuration page.
-
listPrintFooter
-
in file lists.inc, method lamList::listPrintFooter()
    Prints the HTML footer.
-
listPrintHeader
-
in file lists.inc, method lamList::listPrintHeader()
    Prints the HTML header.
-
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 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.
-
listPrintTableHeader
-
in file lists.inc, method lamList::listPrintTableHeader()
    Prints the attribute and filter row at the account table head
-
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
-
in file lists.inc, method lamList::listSort()
    Sorts an account list by a given attribute
-
LIST_SIZE_OPTION_NAME
-
in file lists.inc, class constant lamList::LIST_SIZE_OPTION_NAME
    ID for list size config option
-
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.
-
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
-
loadPDFStructureDefinitions
-
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.
-
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()
    This function loads the LDAP attributes for this module.
-
load_attributes
-
in file sambaAccount.inc, method sambaAccount::load_attributes()
    This function loads the LDAP attributes for this module.
-
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_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 shadowAccount.inc, method shadowAccount::load_Messages()
    This function builds up the message array.
-
load_Messages
-
in file groupOfNames.inc, method groupOfNames::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 quota.inc, method quota::load_Messages()
    this functin 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 ieee802device.inc, method ieee802Device::load_Messages()
    This function fills the error message array with messages
-
load_Messages
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::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 account.inc, method account::load_Messages()
    This function fills 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 posixGroup.inc, method posixGroup::load_Messages()
    This function fills the $messages variable with output messages from this module.
-
load_Messages
-
in file posixAccount.inc, method posixAccount::load_Messages()
    This function 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 sambaAccount.inc, method sambaAccount::load_Messages()
    this functin fills the error message array with messages
-
load_profile
-
in file shadowAccount.inc, method shadowAccount::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file sambaSamAccount.inc, method sambaSamAccount::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 quota.inc, method quota::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file posixAccount.inc, method posixAccount::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file sambaGroupMapping.inc, method sambaGroupMapping::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file baseModule.inc, method baseModule::load_profile()
    Loads the values of an account profile into internal variables.
-
logNewMessage
-
in file security.inc, function logNewMessage()
    Puts a new message in the log file.
-
logoffAndBackToLoginPage
-
in file security.inc, function logoffAndBackToLoginPage()
    Logs off the user and displays the login page.
-
lshift
-
in file createntlm.inc, method smbHash::lshift()
-
list.php
-
procedural page list.php
-
login.php
-
procedural page login.php
-
logout.php
-
procedural page logout.php
-
lamdaemonTest.php
-
procedural page lamdaemonTest.php
-
-
- top
-
- -
-

m

-
-
$mainPageText
-
in file selfService.inc, variable selfServiceProfile::$mainPageText
    describing text for self service main page
-
$maxPageEntries
-
in file lists.inc, variable lamList::$maxPageEntries
    maximum count of entries per page
-
$MAX_LDIF_LINE_LENGTH
-
in file export.inc, variable PlaLdifExporter::$MAX_LDIF_LINE_LENGTH
-
$max_length
-
in file schema.inc, variable AttributeType::$max_length
    The max number of characters this attribute can be
-
$may_attrs
-
in file schema.inc, variable ObjectClass::$may_attrs
    arrays of attribute names that this objectClass allows, but does not require
-
$messages
-
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
-
$moduleSettings
-
in file baseModule.inc, variable baseModule::$moduleSettings
    configuration settings of all modules
-
$moduleSettings
-
in file selfService.inc, variable selfServiceProfile::$moduleSettings
    configuration settings of 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
-
mailAlias.inc
-
procedural page mailAlias.inc
-
mailAlias
-
in file mailAlias.inc, class mailAlias
    The account type for mail aliases.
-
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, class MatchingRuleUse
    Represents an LDAP schema matchingRuleUse entry
-
MatchingRuleUse
-
in file schema.inc, method MatchingRuleUse::MatchingRuleUse()
-
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 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 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_complete
-
in file groupOfNames.inc, method groupOfNames::module_complete()
    This functions is used to check if all settings for this module have been made.
-
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 account.inc, method account::module_complete()
    This functions returns true if all needed settings are done.
-
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()
    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 baseModule.inc, method baseModule::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
-
in file export.inc, class MyCustomExporter
-
MyCutsomExporter
-
in file export.inc, method MyCustomExporter::MyCutsomExporter()
-
mainlogin.php
-
procedural page mainlogin.php
-
mainmanage.php
-
procedural page mainmanage.php
-
main.php
-
procedural page main.php
-
main_header.php
-
procedural page main_header.php
-
massBuildAccounts.php
-
procedural page massBuildAccounts.php
-
masscreate.php
-
procedural page masscreate.php
-
massDoUpload.php
-
procedural page massDoUpload.php
-
-
- top
-
- -
-

n

-
-
$n
-
in file fpdf.php, variable FPDF::$n
-
$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 schema.inc, variable MatchingRule::$name
    This rule's name
-
$name
-
in file schema.inc, variable AttributeType::$name
    The name of this attributeType
-
$name
-
in file schema.inc, variable ObjectClassAttribute::$name
    This Attribute's name
-
$name
-
in file tools.php, variable LAMTool::$name
    name of the tool
-
$name
-
in file account.inc, variable samba3domain::$name
    Domain name
-
$nextGroupRID
-
in file account.inc, variable samba3domain::$nextGroupRID
    Next group RID
-
$nextRID
-
in file account.inc, variable samba3domain::$nextRID
    Next RID
-
$nextUserRID
-
in file account.inc, variable samba3domain::$nextUserRID
    Next user RID
-
$num_entries
-
in file export.inc, variable PlaLdapExporter::$num_entries
-
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
-
in file ldap.inc, method Ldap::new_rand()
    Calculates a new value for rand
-
nisMailAlias
-
in file nisMailAlias.inc, class nisMailAlias
    Provides NIS mail alias management.
-
not_an_attr
-
in file add_attr_form.php, function not_an_attr()
    Given an attribute $x, this returns true if it is NOT already specified in the current entry, returns false otherwise.
-
nthash
-
in file createntlm.inc, method smbHash::nthash()
    Calculates the NT hash of a given password.
-
ntPassword
-
in file account.inc, function ntPassword()
    Generates the NT hash of a password.
-
new_ou_template.php
-
procedural page new_ou_template.php
-
-
- top
-
- -
-

o

-
-
$OBJECT_CLASS_NAME
-
in file groupOfNames.inc, variable groupOfNames::$OBJECT_CLASS_NAME
    name of managed object class
-
$OBJECT_CLASS_NAME
-
in file groupOfUniqueNames.inc, variable groupOfUniqueNames::$OBJECT_CLASS_NAME
    name of managed object class
-
$offsets
-
in file fpdf.php, variable FPDF::$offsets
-
$oid
-
in file schema.inc, variable SchemaItem::$oid
    The OID of this schema item.
-
$ordering
-
in file schema.inc, variable AttributeType::$ordering
    The ordering of the attributeType
-
$OrientationChanges
-
in file fpdf.php, variable FPDF::$OrientationChanges
-
$orig
-
in file baseModule.inc, variable baseModule::$orig
    contains all ldap attributes which are loaded from ldap
-
ObjectClass
-
in file schema.inc, method ObjectClass::ObjectClass()
    Creates a new ObjectClass object given a raw LDAP objectClass string.
-
ObjectClass
-
in file schema.inc, class ObjectClass
    Represents an LDAP objectClass
-
ObjectClassAttribute
-
in file schema.inc, method ObjectClassAttribute::ObjectClassAttribute()
    Creates a new ObjectClassAttribute with specified name and source objectClass.
-
ObjectClassAttribute
-
in file schema.inc, class ObjectClassAttribute
    A simple class for representing AttributeTypes used only by the ObjectClass class.
-
Open
-
in file fpdf.php, method FPDF::Open()
-
Output
-
in file fpdf.php, method FPDF::Output()
-
ou_edit.php
-
procedural page ou_edit.php
-
-
- top
-
- -
-

p

-
-
$page
-
in file lists.inc, variable lamList::$page
    current page number
-
$page
-
in file fpdf.php, variable FPDF::$page
-
$PageBreakTrigger
-
in file fpdf.php, variable FPDF::$PageBreakTrigger
-
$PageLinks
-
in file fpdf.php, variable FPDF::$PageLinks
-
$pages
-
in file fpdf.php, variable FPDF::$pages
-
$page_definitions
-
in file lamPDF.inc, variable lamPDF::$page_definitions
    format settings for page layout
-
$PDFVersion
-
in file fpdf.php, variable FPDF::$PDFVersion
-
$perm1
-
in file createntlm.inc, variable smbHash::$perm1
-
$perm2
-
in file createntlm.inc, variable smbHash::$perm2
-
$perm3
-
in file createntlm.inc, variable smbHash::$perm3
-
$perm4
-
in file createntlm.inc, variable smbHash::$perm4
-
$perm5
-
in file createntlm.inc, variable smbHash::$perm5
-
$perm6
-
in file createntlm.inc, variable smbHash::$perm6
-
$possibleSuffixes
-
in file lists.inc, variable lamList::$possibleSuffixes
    list of possible LDAP suffixes(organizational units)
-
posixAccount.inc
-
procedural page posixAccount.inc
-
posixGroup.inc
-
procedural page posixGroup.inc
-
pdf.inc
-
procedural page pdf.inc
-
pdfstruct.inc
-
procedural page pdfstruct.inc
-
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.
-
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()
-
PlaDsmlExporter
-
in file export.inc, method PlaDsmlExporter::PlaDsmlExporter()
    Create a PlaDsmlExporter object
-
PlaDsmlExporter
-
in file export.inc, class PlaDsmlExporter
    Export entries to DSML v.1
-
PlaExporter
-
in file export.inc, class PlaExporter
    PlaExporter acts a wrapper around another exporter.
-
PlaExporter
-
in file export.inc, method PlaExporter::PlaExporter()
    Constructor
-
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
-
in file export.inc, method PlaLdifExporter::PlaLdifExporter()
    Create a PlaLdifExporter object
-
PlaVcardExporter
-
in file export.inc, method PlaVcardExporter::PlaVcardExporter()
-
PlaVcardExporter
-
in file export.inc, class 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.
-
pla_explode_dn
-
in file tree.inc, function pla_explode_dn()
    Explode a DN into an array of its RDN parts. This function is UTF-8 safe and replaces the buggy PHP ldap_explode_dn() which does not properly handle UTF-8 DNs and also causes segmentation faults with some inputs.
-
pla_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 PlaLdapExporter::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 PlaAbstractExporter::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 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 PlaLdapExporter::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_has_entry
-
in file export.inc, method PlaAbstractExporter::pla_has_entry()
    Return true if there is some more entries to be processed
-
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_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.
-
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 PlaAbstractExporter::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_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
-
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 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.
-
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.
-
pretty_print_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.
-
processFormatTags
-
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 sambaGroupMapping.inc, method sambaGroupMapping::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 sambaDomain.inc, method sambaDomain::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 sambaSamAccount.inc, method sambaSamAccount::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 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 ldapPublicKey.inc, method ldapPublicKey::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 kolabUser.inc, method kolabUser::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 inetLocalMailRecipient.inc, method inetLocalMailRecipient::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file groupOfNames.inc, method groupOfNames::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 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
-
in file shadowAccount.inc, method shadowAccount::process_expire()
    Processes user input of the expiration page.
-
process_group
-
in file posixAccount.inc, method posixAccount::process_group()
    Processes user input of the group selection page.
-
process_logonHours
-
in file sambaSamAccount.inc, method sambaSamAccount::process_logonHours()
    Processes user input of the logon hours page.
-
process_members
-
in file groupOfNames.inc, method groupOfNames::process_members()
    Processes user input of the members page.
-
process_owner
-
in file groupOfNames.inc, method groupOfNames::process_owner()
    Processes user input of the owner page.
-
process_password
-
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 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
-
in file posixGroup.inc, method posixGroup::process_user()
    Processes user input of the user selection page.
-
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
-
pwd_enable
-
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
-
pwd_is_enabled
-
in file account.inc, function pwd_is_enabled()
    Checks if a password hash is enabled/disabled
-
profmanage.php
-
procedural page profmanage.php
-
pdfdelete.php
-
procedural page pdfdelete.php
-
pdfmain.php
-
procedural page pdfmain.php
-
pdfpage.php
-
procedural page pdfpage.php
-
profiledelete.php
-
procedural page profiledelete.php
-
profilemain.php
-
procedural page profilemain.php
-
profilepage.php
-
procedural page profilepage.php
-
profManage.php
-
procedural page profManage.php
-
-
- top
-
- -
-

q

-
-
$qualifier
-
in file export.inc, variable PlaCSVExporter::$qualifier
-
$queryFilter
-
in file export.inc, variable PlaLdapExporter::$queryFilter
-
$query_filter
-
in file export.inc, variable LdapExportInfo::$query_filter
-
quota.inc
-
procedural page quota.inc
-
quota
-
in file quota.inc, class quota
    Manages quotas for users and groups.
-
-
- top
-
- -
-

r

-
-
$rdn
-
in file modules.inc, variable accountContainer::$rdn
    RDN attribute of this account
-
$refresh
-
in file lists.inc, variable lamList::$refresh
    refresh page switch
-
$required_by_object_classes
-
in file schema.inc, variable AttributeType::$required_by_object_classes
    A list of object class names that require this attribute type.
-
$requiresPasswordChanges
-
in file tools.php, variable LAMTool::$requiresPasswordChanges
    tool requires password change rights
-
$requiresWriteAccess
-
in file tools.php, variable LAMTool::$requiresWriteAccess
    tool requires write access to LDAP
-
$results
-
in file export.inc, variable PlaLdapExporter::$results
-
$RIDbase
-
in file account.inc, variable samba3domain::$RIDbase
    RID base to calculate RIDs, default 1000
-
$rMargin
-
in file fpdf.php, variable FPDF::$rMargin
-
readTime
-
in file sambaMungedDial.inc, method sambaMungedDial::readTime()
    readTime
-
readUser
-
in file changePassword.php, function readUser()
    Returns the LDAP attributes of the given DN.
-
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.
-
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.
-
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
-
replaceSpecialChars
-
in file quota.inc, method quota::replaceSpecialChars()
    Replaces special characters in HTML name values.
-
rdelete.php
-
procedural page rdelete.php
-
refresh.php
-
procedural page refresh.php
-
-
- top
-
- -
-

s

-
-
$sbox
-
in file createntlm.inc, variable smbHash::$sbox
-
$sc
-
in file createntlm.inc, variable smbHash::$sc
-
$scope
-
in file export.inc, variable LdapExportInfo::$scope
-
$scope
-
in file export.inc, variable PlaLdapExporter::$scope
-
$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.
-
$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)
-
$SID
-
in file account.inc, variable samba3domain::$SID
    Domain SID
-
$sortColumn
-
in file lists.inc, variable lamList::$sortColumn
    sort column name
-
$sortDirection
-
in file lists.inc, variable lamList::$sortDirection
    sort direction: 1 for ascending, -1 for descending
-
$source
-
in file schema.inc, variable ObjectClassAttribute::$source
    This Attribute's root
-
$state
-
in file fpdf.php, variable FPDF::$state
-
$subject
-
in file fpdf.php, variable FPDF::$subject
-
$sub_str
-
in file schema.inc, variable AttributeType::$sub_str
    Boolean: supports substring matching?
-
$suffix
-
in file lists.inc, variable lamList::$suffix
    LDAP suffix
-
$sup_attribute
-
in file schema.inc, variable AttributeType::$sup_attribute
    The attribute from which this attribute inherits (if any)
-
$sup_classes
-
in file schema.inc, variable ObjectClass::$sup_classes
    array of objectClass names from which this objectClass inherits
-
$syntax
-
in file schema.inc, variable AttributeType::$syntax
    The full syntax string, ie 1.2.3.4{16}
-
$syntax
-
in file schema.inc, variable MatchingRule::$syntax
    This rule's syntax OID
-
sambaAccount.inc
-
procedural page sambaAccount.inc
-
sambaDomain.inc
-
procedural page sambaDomain.inc
-
sambaGroupMapping.inc
-
procedural page sambaGroupMapping.inc
-
sambaMungedDial.inc
-
procedural page sambaMungedDial.inc
-
sambaSamAccount.inc
-
procedural page sambaSamAccount.inc
-
shadowAccount.inc
-
procedural page shadowAccount.inc
-
schema.inc
-
procedural page schema.inc
-
security.inc
-
procedural page security.inc
-
selfService.inc
-
procedural page selfService.inc
-
status.inc
-
procedural page status.inc
-
smbDomain.inc
-
procedural page smbDomain.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.
-
sambaDomain
-
in file sambaDomain.inc, class sambaDomain
    Manages Samba 3 domain entries.
-
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.
-
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
-
savePDFStructureDefinitions
-
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.
-
saveSettings
-
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 kolabUser.inc, method kolabUser::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 shadowAccount.inc, method shadowAccount::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()
    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 sambaSamAccount.inc, method sambaSamAccount::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 sambaGroupMapping.inc, method sambaGroupMapping::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 nisMailAlias.inc, method nisMailAlias::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.
-
SCHEMA_SESSION_CACHE_ENABLED
-
in file schema.inc, constant SCHEMA_SESSION_CACHE_ENABLED
    To enable/disable session-based schema caching (1: enabled, 0: disabled).
-
search_domains
-
in file account.inc, function search_domains()
    Returns an array with all Samba 3 domain entries under the given suffix
-
search_units
-
in file ldap.inc, method Ldap::search_units()
    Returns an array with all organizational units under the given suffix
-
search_username
-
in file userlink.php, function search_username()
    Searches LDAP for a specific user name (uid attribute) and returns its DN entry
-
selfServiceProfile
-
in file selfService.inc, class selfServiceProfile
    Includes all settings of a self service profile.
-
server
-
in file ldap.inc, method Ldap::server()
    Returns the LDAP connection handle
-
setAccessLevel
-
in file config.inc, method LAMConfig::setAccessLevel()
    Sets the access level for this profile.
-
setAliases
-
in file schema.inc, method AttributeType::setAliases()
    Sets this attribute's list of aliases.
-
SetAuthor
-
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
-
in file fpdf.php, method FPDF::SetDisplayMode()
-
SetDrawColor
-
in file fpdf.php, method FPDF::SetDrawColor()
-
SetFillColor
-
in file fpdf.php, method FPDF::SetFillColor()
-
SetFont
-
in file fpdf.php, method FPDF::SetFont()
-
SetFontSize
-
in file fpdf.php, method FPDF::SetFontSize()
-
setHelpID
-
in file lists.inc, method lamSelectListOption::setHelpID()
    Sets the help ID.
-
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
-
SetLeftMargin
-
in file fpdf.php, method FPDF::SetLeftMargin()
-
SetLineWidth
-
in file fpdf.php, method FPDF::SetLineWidth()
-
SetLink
-
in file fpdf.php, method FPDF::SetLink()
-
SetMargins
-
in file fpdf.php, method FPDF::SetMargins()
-
setName
-
in file schema.inc, method AttributeType::setName()
    Sets this attriute's name.
-
setOID
-
in file schema.inc, method SchemaItem::setOID()
-
setOutputFormat
-
in file export.inc, method PlaExporter::setOutputFormat()
    Set the carriage return /linefeed for the export
-
setPassword
-
in file changePassword.php, function setPassword()
    Sets the password to LDAP.
-
setPassword
-
in file config.inc, method LAMCfgMain::setPassword()
    Sets a new config password.
-
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
-
setSpecifiedPassword
-
in file changePassword.php, function setSpecifiedPassword()
    Sets the new password.
-
SetSubject
-
in file fpdf.php, method FPDF::SetSubject()
-
setSupAttribute
-
in file schema.inc, method AttributeType::setSupAttribute()
    Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).
-
SetTextColor
-
in file fpdf.php, method FPDF::SetTextColor()
-
SetTitle
-
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
-
in file schema.inc, method MatchingRule::setUsedByAttrs()
    Sets the list of used_by_attrs to the array specified by $attrs;
-
setValue
-
in file lists.inc, method lamListOption::setValue()
    Sets the config option value. The value must not contain "=" and ";".
-
SetX
-
in file fpdf.php, method FPDF::SetX()
-
SetXY
-
in file fpdf.php, method FPDF::SetXY()
-
SetY
-
in file fpdf.php, method FPDF::SetY()
-
set_AccountModules
-
in file config.inc, method LAMConfig::set_AccountModules()
    Sets the selected account modules
-
set_ActiveTypes
-
in file config.inc, method LAMConfig::set_ActiveTypes()
    Sets the list of active types.
-
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.
-
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
-
in file config.inc, method LAMConfig::set_defaultLanguage()
    Sets the default language string
-
set_listAttributes
-
in file config.inc, method LAMConfig::set_listAttributes()
    Sets the list of attributes to show in user list
-
set_moduleSettings
-
in file config.inc, method LAMConfig::set_moduleSettings()
    Sets the settings for the account modules.
-
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.
-
set_scriptPath
-
in file config.inc, method LAMConfig::set_scriptPath()
    Sets the path to 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
-
in file config.inc, method LAMConfig::set_Suffix()
    Sets the LDAP suffix where accounts are saved
-
set_typeSettings
-
in file config.inc, method LAMConfig::set_typeSettings()
    Sets the settings for the account types.
-
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.
-
showMainPage
-
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.
-
smbHash
-
in file createntlm.inc, class smbHash
    Calculates NT and LM hashes.
-
smb_hash
-
in file createntlm.inc, method smbHash::smb_hash()
    smb_hash
-
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.
-
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.
-
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()
    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
-
schemaTest.php
-
procedural page schemaTest.php
-
status-test.php
-
procedural page status-test.php
-
-
- top
-
- -
-

t

-
-
$TextColor
-
in file fpdf.php, variable FPDF::$TextColor
-
$title
-
in file fpdf.php, variable FPDF::$title
-
$tMargin
-
in file fpdf.php, variable FPDF::$tMargin
-
$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 schema.inc, variable ObjectClass::$type
    one of STRUCTURAL, ABSTRACT, or AUXILIARY
-
tree.inc
-
procedural page tree.inc
-
types.inc
-
procedural page types.inc
-
tools.php
-
procedural page tools.php
-
templates.inc
-
procedural page templates.inc
-
tree.php
-
procedural page tree.php
-
tree_view.php
-
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
-
TRANS_PRIMARY_OPTION_NAME
-
in file user.inc, class constant lamUserList::TRANS_PRIMARY_OPTION_NAME
    ID for config option
-
TRANS_PRIMARY_OPTION_NAME
-
in file group.inc, class constant lamGroupList::TRANS_PRIMARY_OPTION_NAME
    ID for config option
-
-
- top
-
- -
-

u

-
-
$underline
-
in file fpdf.php, variable FPDF::$underline
-
$usage
-
in file schema.inc, variable AttributeType::$usage
    The usage string set by the LDAP schema
-
$used_by_attrs
-
in file schema.inc, variable MatchingRuleUse::$used_by_attrs
    An array of attributeType names who make use of the mathingRule
-
$used_by_attrs
-
in file schema.inc, variable MatchingRule::$used_by_attrs
    An array of attribute names who use this MatchingRule
-
$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)
-
user.inc
-
procedural page user.inc
-
ufpdf.php
-
procedural page ufpdf.php
-
userlink.php
-
procedural page userlink.php
-
update.php
-
procedural page update.php
-
update_confirm.php
-
procedural page update_confirm.php
-
UFPDF
-
in file ufpdf.php, class UFPDF
    Main UFPDF class for creating Unicode PDF documents
-
UFPDF
-
in file ufpdf.php, method UFPDF::UFPDF()
    *****************************************************************************
-
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.
-
user
-
in file user.inc, class user
    The account type for user accounts (e.g. Unix, Samba and Kolab).
-
utf8_substr
-
in file ufpdf.php, method UFPDF::utf8_substr()
-
utf8_to_codepoints
-
in file ufpdf.php, method UFPDF::utf8_to_codepoints()
-
utf8_to_utf16be
-
in file ufpdf.php, method UFPDF::utf8_to_utf16be()
-
-
- top
-
- -
-

v

-
-
$vcardMapping
-
in file export.inc, variable PlaVcardExporter::$vcardMapping
-
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
-
- -
-

w

-
-
$w
-
in file fpdf.php, variable FPDF::$w
-
$wPt
-
in file fpdf.php, variable FPDF::$wPt
-
$ws
-
in file fpdf.php, variable FPDF::$ws
-
Write
-
in file ufpdf.php, method UFPDF::Write()
-
Write
-
in file fpdf.php, method FPDF::Write()
-
-
- top
-
- -
-

x

-
-
$x
-
in file fpdf.php, variable FPDF::$x
-
xml_parser.inc
-
procedural page xml_parser.inc
-
x
-
in file createntlm.inc, method smbHash::x()
    Fixes too large numbers
-
xmlParser
-
in file xml_parser.inc, class xmlParser
-
-
- top
-
- -
-

y

-
-
$y
-
in file fpdf.php, variable FPDF::$y
-
-
- top
-
- -
-

z

-
-
$ZoomMode
-
in file fpdf.php, variable FPDF::$ZoomMode
-
-
- top
-
- -
-

_

-
-
_beginpage
-
in file fpdf.php, method FPDF::_beginpage()
-
_dochecks
-
in file fpdf.php, method FPDF::_dochecks()
    *****************************************************************************
-
_dounderline
-
in file ufpdf.php, method UFPDF::_dounderline()
-
_dounderline
-
in file fpdf.php, method FPDF::_dounderline()
-
_enddoc
-
in file fpdf.php, method FPDF::_enddoc()
-
_endpage
-
in file fpdf.php, method FPDF::_endpage()
-
_escape
-
in file fpdf.php, method FPDF::_escape()
-
_escapetext
-
in file ufpdf.php, method UFPDF::_escapetext()
-
_freadint
-
in file fpdf.php, method FPDF::_freadint()
-
_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".
-
_get_schema_dn
-
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
-
in file fpdf.php, method FPDF::_out()
-
_parsejpg
-
in file fpdf.php, method FPDF::_parsejpg()
-
_parsepng
-
in file fpdf.php, method FPDF::_parsepng()
-
_putcatalog
-
in file fpdf.php, method FPDF::_putcatalog()
-
_putfonts
-
in file fpdf.php, method FPDF::_putfonts()
-
_putheader
-
in file fpdf.php, method FPDF::_putheader()
-
_putimages
-
in file fpdf.php, method FPDF::_putimages()
-
_putinfo
-
in file fpdf.php, method FPDF::_putinfo()
-
_putinfo
-
in file ufpdf.php, method UFPDF::_putinfo()
-
_putpages
-
in file fpdf.php, method FPDF::_putpages()
-
_putpages
-
in file ufpdf.php, method UFPDF::_putpages()
-
_putresourcedict
-
in file fpdf.php, method FPDF::_putresourcedict()
-
_putresources
-
in file fpdf.php, method FPDF::_putresources()
-
_putstream
-
in file fpdf.php, method FPDF::_putstream()
-
_puttrailer
-
in file fpdf.php, method FPDF::_puttrailer()
-
_puttruetypeunicode
-
in file ufpdf.php, method UFPDF::_puttruetypeunicode()
    *****************************************************************************
-
_putxobjectdict
-
in file fpdf.php, method FPDF::_putxobjectdict()
-
_textstring
-
in file ufpdf.php, method UFPDF::_textstring()
-
_textstring
-
in file fpdf.php, method FPDF::_textstring()
-
__construct
-
in file sambaGroupMapping.inc, method sambaGroupMapping::__construct()
    Creates a new module for Samba 3 groups.
-
__construct
-
in file sambaAccount.inc, method sambaAccount::__construct()
    Creates a new sambaAccount object.
-
__construct
-
in file modules.inc, method accountContainer::__construct()
    Constructor
-
__construct
-
in file sambaSamAccount.inc, method sambaSamAccount::__construct()
    Creates a new sambaSamAccount object.
-
__construct
-
in file xml_parser.inc, method xmlParser::__construct()
    Constructor
-
__construct
-
in file smbDomain.inc, method lamSmbDomainList::__construct()
    Constructor
-
__construct
-
in file selfService.inc, method selfServiceProfile::__construct()
    Constructor
-
__construct
-
in file user.inc, method lamUserList::__construct()
    Constructor
-
__construct
-
in file mailAlias.inc, method lamMailAliasList::__construct()
    Constructor
-
__construct
-
in file group.inc, method lamGroupList::__construct()
    Constructor
-
__construct
-
in file host.inc, method lamHostList::__construct()
    Constructor
-
__construct
-
in file kolabUser.inc, method kolabUser::__construct()
    Creates a new kolabUser object.
-
__construct
-
in file lamPDF.inc, method lamPDF::__construct()
-
__construct
-
in file baseModule.inc, method baseModule::__construct()
    Creates a new base module class
-
__construct
-
in file config.inc, method LAMConfig::__construct()
    Loads preferences from config file
-
__construct
-
in file cache.inc, method cache::__construct()
    Constructor.
-
__construct
-
in file config.inc, method LAMCfgMain::__construct()
    Loads preferences from config file
-
__construct
-
in file lists.inc, method lamSelectListOption::__construct()
    Creates a new selection list option.
-
__construct
-
in file ldap.inc, method Ldap::__construct()
-
__construct
-
in file lists.inc, method lamListTool::__construct()
    Constructor
-
__construct
-
in file lists.inc, method lamList::__construct()
    Constructor
-
__construct
-
in file lists.inc, method lamListOption::__construct()
    Creates a new config option.
-
__construct
-
in file lists.inc, method lamBooleanListOption::__construct()
    Creates a new boolean option.
-
__sleep
-
in file cache.inc, method cache::__sleep()
    Encrypts LDAP cache before saving to session file.
-
__sleep
-
in file modules.inc, method accountContainer::__sleep()
    Encrypts sensitive data before storing in session.
-
__sleep
-
in file ldap.inc, method Ldap::__sleep()
    Closes connection to LDAP server before serialization
-
__wakeup
-
in file ldap.inc, method Ldap::__wakeup()
    Reconnects to LDAP server when deserialized
-
__wakeup
-
in file cache.inc, method cache::__wakeup()
    Decrypts LDAP cache after loading from session file.
-
__wakeup
-
in file modules.inc, method accountContainer::__wakeup()
    Decrypts sensitive data after accountContainer was loaded from session.
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_Help.html b/lam-web/developers/phpdoc/elementindex_Help.html deleted file mode 100644 index 55409030..00000000 --- a/lam-web/developers/phpdoc/elementindex_Help.html +++ /dev/null @@ -1,111 +0,0 @@ - - -Package Help Element Index - - - - - - - - - - - - - -
Help
- - - [ class tree: Help ] - [ index: Help ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package Help

- [ d ] - [ e ] - [ h ] - -
- -
-

d

-
-
displayHelp
-
in file help.php, function displayHelp()
    Print help site for a specific help number.
-
-
- top
-
- -
-

e

-
-
echoHTMLFoot
-
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.
-
-
- top
-
- -
-

h

-
-
help.inc
-
procedural page help.inc
-
help.php
-
procedural page help.php
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_LDAP.html b/lam-web/developers/phpdoc/elementindex_LDAP.html deleted file mode 100644 index da36bd58..00000000 --- a/lam-web/developers/phpdoc/elementindex_LDAP.html +++ /dev/null @@ -1,183 +0,0 @@ - - -Package LDAP Element Index - - - - - - - - - - - - - -
LDAP
- - - [ class tree: LDAP ] - [ index: LDAP ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package LDAP

- [ c ] - [ d ] - [ e ] - [ h ] - [ l ] - [ n ] - [ s ] - [ _ ] - -
- -
-

_

-
-
__construct
-
in file ldap.inc, method Ldap::__construct()
-
__sleep
-
in file ldap.inc, method Ldap::__sleep()
    Closes connection to LDAP server before serialization
-
__wakeup
-
in file ldap.inc, method Ldap::__wakeup()
    Reconnects to LDAP server when deserialized
-
-
- top
-
- -
-

c

-
-
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
-
connect
-
in file ldap.inc, method Ldap::connect()
    Connects to the server using the given username and password
-
-
- top
-
- -
-

d

-
-
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
-
destroy
-
in file ldap.inc, method Ldap::destroy()
    Closes connection to LDAP server and deletes encrypted username/password
-
-
- top
-
- -
-

e

-
-
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
-
-
- top
-
- -
-

h

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

l

-
-
Ldap
-
in file ldap.inc, class Ldap
    Ldap manages connection to LDAP and includes several helper functions.
-
ldap.inc
-
procedural page ldap.inc
-
-
- top
-
- -
-

n

-
-
new_rand
-
in file ldap.inc, method Ldap::new_rand()
    Calculates a new value for rand
-
-
- top
-
- -
-

s

-
-
search_units
-
in file ldap.inc, method Ldap::search_units()
    Returns an array with all organizational units under the given suffix
-
server
-
in file ldap.inc, method Ldap::server()
    Returns the LDAP connection handle
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_PDF.html b/lam-web/developers/phpdoc/elementindex_PDF.html deleted file mode 100644 index f0af82f3..00000000 --- a/lam-web/developers/phpdoc/elementindex_PDF.html +++ /dev/null @@ -1,703 +0,0 @@ - - -Package PDF Element Index - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package PDF

- [ a ] - [ b ] - [ c ] - [ d ] - [ e ] - [ f ] - [ g ] - [ h ] - [ i ] - [ k ] - [ l ] - [ m ] - [ n ] - [ o ] - [ p ] - [ r ] - [ s ] - [ t ] - [ u ] - [ v ] - [ w ] - [ x ] - [ y ] - [ z ] - [ _ ] - -
- -
-

_

-
-
_beginpage
-
in file fpdf.php, method FPDF::_beginpage()
-
_dochecks
-
in file fpdf.php, method FPDF::_dochecks()
    *****************************************************************************
-
_dounderline
-
in file fpdf.php, method FPDF::_dounderline()
-
_dounderline
-
in file ufpdf.php, method UFPDF::_dounderline()
-
_enddoc
-
in file fpdf.php, method FPDF::_enddoc()
-
_endpage
-
in file fpdf.php, method FPDF::_endpage()
-
_escape
-
in file fpdf.php, method FPDF::_escape()
-
_escapetext
-
in file ufpdf.php, method UFPDF::_escapetext()
-
_freadint
-
in file fpdf.php, method FPDF::_freadint()
-
_getfontpath
-
in file fpdf.php, method FPDF::_getfontpath()
-
_newobj
-
in file fpdf.php, method FPDF::_newobj()
-
_out
-
in file fpdf.php, method FPDF::_out()
-
_parsejpg
-
in file fpdf.php, method FPDF::_parsejpg()
-
_parsepng
-
in file fpdf.php, method FPDF::_parsepng()
-
_putcatalog
-
in file fpdf.php, method FPDF::_putcatalog()
-
_putfonts
-
in file fpdf.php, method FPDF::_putfonts()
-
_putheader
-
in file fpdf.php, method FPDF::_putheader()
-
_putimages
-
in file fpdf.php, method FPDF::_putimages()
-
_putinfo
-
in file fpdf.php, method FPDF::_putinfo()
-
_putinfo
-
in file ufpdf.php, method UFPDF::_putinfo()
-
_putpages
-
in file ufpdf.php, method UFPDF::_putpages()
-
_putpages
-
in file fpdf.php, method FPDF::_putpages()
-
_putresourcedict
-
in file fpdf.php, method FPDF::_putresourcedict()
-
_putresources
-
in file fpdf.php, method FPDF::_putresources()
-
_putstream
-
in file fpdf.php, method FPDF::_putstream()
-
_puttrailer
-
in file fpdf.php, method FPDF::_puttrailer()
-
_puttruetypeunicode
-
in file ufpdf.php, method UFPDF::_puttruetypeunicode()
    *****************************************************************************
-
_putxobjectdict
-
in file fpdf.php, method FPDF::_putxobjectdict()
-
_textstring
-
in file ufpdf.php, method UFPDF::_textstring()
-
_textstring
-
in file fpdf.php, method FPDF::_textstring()
-
__construct
-
in file xml_parser.inc, method xmlParser::__construct()
    Constructor
-
__construct
-
in file lamPDF.inc, method lamPDF::__construct()
-
-
- top
-
- -
-

a

-
-
$AliasNbPages
-
in file fpdf.php, variable FPDF::$AliasNbPages
-
$author
-
in file fpdf.php, variable FPDF::$author
-
$AutoPageBreak
-
in file fpdf.php, variable FPDF::$AutoPageBreak
-
AcceptPageBreak
-
in file fpdf.php, method FPDF::AcceptPageBreak()
-
AcceptPageBreak
-
in file ufpdf.php, method UFPDF::AcceptPageBreak()
-
AddFont
-
in file ufpdf.php, method UFPDF::AddFont()
-
AddFont
-
in file fpdf.php, method FPDF::AddFont()
-
AddLink
-
in file fpdf.php, method FPDF::AddLink()
-
AddPage
-
in file fpdf.php, method FPDF::AddPage()
-
AliasNbPages
-
in file ufpdf.php, method UFPDF::AliasNbPages()
-
AliasNbPages
-
in file fpdf.php, method FPDF::AliasNbPages()
-
-
- top
-
- -
-

b

-
-
$bMargin
-
in file fpdf.php, variable FPDF::$bMargin
-
$buffer
-
in file fpdf.php, variable FPDF::$buffer
-
-
- top
-
- -
-

c

-
-
$cMargin
-
in file fpdf.php, variable FPDF::$cMargin
-
$ColorFlag
-
in file fpdf.php, variable FPDF::$ColorFlag
-
$compress
-
in file fpdf.php, variable FPDF::$compress
-
$CoreFonts
-
in file fpdf.php, variable FPDF::$CoreFonts
-
$creator
-
in file fpdf.php, variable FPDF::$creator
-
$CurOrientation
-
in file fpdf.php, variable FPDF::$CurOrientation
-
$CurrentFont
-
in file fpdf.php, variable FPDF::$CurrentFont
-
Cell
-
in file fpdf.php, method FPDF::Cell()
-
Cell
-
in file ufpdf.php, method UFPDF::Cell()
-
Close
-
in file fpdf.php, method FPDF::Close()
-
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.
-
-
- top
-
- -
-

d

-
-
$DefOrientation
-
in file fpdf.php, variable FPDF::$DefOrientation
-
$diffs
-
in file fpdf.php, variable FPDF::$diffs
-
$DrawColor
-
in file fpdf.php, variable FPDF::$DrawColor
-
deletePDFStructureDefinition
-
in file pdfstruct.inc, function deletePDFStructureDefinition()
    Deletes XML file with PDF structure definitions.
-
-
- top
-
- -
-

e

-
-
Error
-
in file fpdf.php, method FPDF::Error()
-
-
- top
-
- -
-

f

-
-
$fh
-
in file fpdf.php, variable FPDF::$fh
-
$fhPt
-
in file fpdf.php, variable FPDF::$fhPt
-
$FillColor
-
in file fpdf.php, variable FPDF::$FillColor
-
$FontFamily
-
in file fpdf.php, variable FPDF::$FontFamily
-
$FontFiles
-
in file fpdf.php, variable FPDF::$FontFiles
-
$fontList
-
in file lamPDF.inc, variable lamPDF::$fontList
    list of supported fonts
-
$fontName
-
in file lamPDF.inc, variable lamPDF::$fontName
    current active font name
-
$fonts
-
in file fpdf.php, variable FPDF::$fonts
-
$FontSize
-
in file fpdf.php, variable FPDF::$FontSize
-
$FontSizePt
-
in file fpdf.php, variable FPDF::$FontSizePt
-
$FontStyle
-
in file fpdf.php, variable FPDF::$FontStyle
-
$fw
-
in file fpdf.php, variable FPDF::$fw
-
$fwPt
-
in file fpdf.php, variable FPDF::$fwPt
-
footer
-
in file lamPDF.inc, method lamPDF::footer()
-
Footer
-
in file fpdf.php, method FPDF::Footer()
-
FPDF
-
in file fpdf.php, method FPDF::FPDF()
    *****************************************************************************
-
FPDF
-
in file fpdf.php, class FPDF
    Main FPDF class for creating PDF documents
-
FPDF_VERSION
-
in file fpdf.php, constant FPDF_VERSION
    *****************************************************************************
-
fpdf.php
-
procedural page fpdf.php
-
-
- top
-
- -
-

g

-
-
getAvailableLogos
-
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.
-
getSectionHeadline
-
in file pdf.inc, function getSectionHeadline()
    Creates a section headline.
-
GetStringWidth
-
in file ufpdf.php, method UFPDF::GetStringWidth()
-
GetStringWidth
-
in file fpdf.php, method FPDF::GetStringWidth()
-
GetX
-
in file fpdf.php, method FPDF::GetX()
-
GetY
-
in file fpdf.php, method FPDF::GetY()
-
-
- top
-
- -
-

h

-
-
$h
-
in file fpdf.php, variable FPDF::$h
-
$hPt
-
in file fpdf.php, variable FPDF::$hPt
-
header
-
in file lamPDF.inc, method lamPDF::header()
-
Header
-
in file fpdf.php, method FPDF::Header()
-
-
- top
-
- -
-

i

-
-
$images
-
in file fpdf.php, variable FPDF::$images
-
$InFooter
-
in file fpdf.php, variable FPDF::$InFooter
-
Image
-
in file fpdf.php, method FPDF::Image()
-
-
- top
-
- -
-

k

-
-
$k
-
in file fpdf.php, variable FPDF::$k
-
$keywords
-
in file fpdf.php, variable FPDF::$keywords
-
-
- top
-
- -
-

l

-
-
$lasth
-
in file fpdf.php, variable FPDF::$lasth
-
$LayoutMode
-
in file fpdf.php, variable FPDF::$LayoutMode
-
$LineWidth
-
in file fpdf.php, variable FPDF::$LineWidth
-
$links
-
in file fpdf.php, variable FPDF::$links
-
$lMargin
-
in file fpdf.php, variable FPDF::$lMargin
-
lamPDF
-
in file lamPDF.inc, class lamPDF
    Creates a LAM information page in PDF format.
-
LAMPDF_LINEWIDTH
-
in file pdf.inc, constant LAMPDF_LINEWIDTH
    PDF line width
-
lamPDF.inc
-
procedural page lamPDF.inc
-
Line
-
in file fpdf.php, method FPDF::Line()
-
Link
-
in file fpdf.php, method FPDF::Link()
-
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.
-
-
- top
-
- -
-

m

-
-
MultiCell
-
in file ufpdf.php, method UFPDF::MultiCell()
-
MultiCell
-
in file fpdf.php, method FPDF::MultiCell()
-
-
- top
-
- -
-

n

-
-
$n
-
in file fpdf.php, variable FPDF::$n
-
-
- top
-
- -
-

o

-
-
$offsets
-
in file fpdf.php, variable FPDF::$offsets
-
$OrientationChanges
-
in file fpdf.php, variable FPDF::$OrientationChanges
-
Open
-
in file fpdf.php, method FPDF::Open()
-
Output
-
in file fpdf.php, method FPDF::Output()
-
-
- top
-
- -
-

p

-
-
$page
-
in file fpdf.php, variable FPDF::$page
-
$PageBreakTrigger
-
in file fpdf.php, variable FPDF::$PageBreakTrigger
-
$PageLinks
-
in file fpdf.php, variable FPDF::$PageLinks
-
$pages
-
in file fpdf.php, variable FPDF::$pages
-
$page_definitions
-
in file lamPDF.inc, variable lamPDF::$page_definitions
    format settings for page layout
-
$PDFVersion
-
in file fpdf.php, variable FPDF::$PDFVersion
-
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.
-
processFormatTags
-
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.
-
pdfdelete.php
-
procedural page pdfdelete.php
-
pdfmain.php
-
procedural page pdfmain.php
-
pdfpage.php
-
procedural page pdfpage.php
-
-
- top
-
- -
-

r

-
-
$rMargin
-
in file fpdf.php, variable FPDF::$rMargin
-
Rect
-
in file fpdf.php, method FPDF::Rect()
-
-
- top
-
- -
-

s

-
-
$state
-
in file fpdf.php, variable FPDF::$state
-
$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
-
SetAuthor
-
in file fpdf.php, method FPDF::SetAuthor()
-
SetAutoPageBreak
-
in file fpdf.php, method FPDF::SetAutoPageBreak()
-
SetCompression
-
in file fpdf.php, method FPDF::SetCompression()
-
SetCreator
-
in file fpdf.php, method FPDF::SetCreator()
-
SetDisplayMode
-
in file fpdf.php, method FPDF::SetDisplayMode()
-
SetDrawColor
-
in file fpdf.php, method FPDF::SetDrawColor()
-
SetFillColor
-
in file fpdf.php, method FPDF::SetFillColor()
-
SetFont
-
in file fpdf.php, method FPDF::SetFont()
-
SetFontSize
-
in file fpdf.php, method FPDF::SetFontSize()
-
SetKeywords
-
in file fpdf.php, method FPDF::SetKeywords()
-
SetLeftMargin
-
in file fpdf.php, method FPDF::SetLeftMargin()
-
SetLineWidth
-
in file fpdf.php, method FPDF::SetLineWidth()
-
SetLink
-
in file fpdf.php, method FPDF::SetLink()
-
SetMargins
-
in file fpdf.php, method FPDF::SetMargins()
-
SetRightMargin
-
in file fpdf.php, method FPDF::SetRightMargin()
-
SetSubject
-
in file fpdf.php, method FPDF::SetSubject()
-
SetTextColor
-
in file fpdf.php, method FPDF::SetTextColor()
-
SetTitle
-
in file fpdf.php, method FPDF::SetTitle()
-
SetTopMargin
-
in file fpdf.php, method FPDF::SetTopMargin()
-
SetX
-
in file fpdf.php, method FPDF::SetX()
-
SetXY
-
in file fpdf.php, method FPDF::SetXY()
-
SetY
-
in file fpdf.php, method FPDF::SetY()
-
strlen
-
in file ufpdf.php, method UFPDF::strlen()
-
-
- top
-
- -
-

t

-
-
$TextColor
-
in file fpdf.php, variable FPDF::$TextColor
-
$title
-
in file fpdf.php, variable FPDF::$title
-
$tMargin
-
in file fpdf.php, variable FPDF::$tMargin
-
Text
-
in file ufpdf.php, method UFPDF::Text()
-
Text
-
in file fpdf.php, method FPDF::Text()
-
-
- top
-
- -
-

u

-
-
$underline
-
in file fpdf.php, variable FPDF::$underline
-
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
    *****************************************************************************
-
utf8_substr
-
in file ufpdf.php, method UFPDF::utf8_substr()
-
utf8_to_codepoints
-
in file ufpdf.php, method UFPDF::utf8_to_codepoints()
-
utf8_to_utf16be
-
in file ufpdf.php, method UFPDF::utf8_to_utf16be()
-
-
- top
-
- -
-

v

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

w

-
-
$w
-
in file fpdf.php, variable FPDF::$w
-
$wPt
-
in file fpdf.php, variable FPDF::$wPt
-
$ws
-
in file fpdf.php, variable FPDF::$ws
-
Write
-
in file ufpdf.php, method UFPDF::Write()
-
Write
-
in file fpdf.php, method FPDF::Write()
-
-
- top
-
- -
-

x

-
-
$x
-
in file fpdf.php, variable FPDF::$x
-
xml_parser.inc
-
procedural page xml_parser.inc
-
xmlParser
-
in file xml_parser.inc, class xmlParser
-
-
- top
-
- -
-

y

-
-
$y
-
in file fpdf.php, variable FPDF::$y
-
-
- top
-
- -
-

z

-
-
$ZoomMode
-
in file fpdf.php, variable FPDF::$ZoomMode
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_configuration.html b/lam-web/developers/phpdoc/elementindex_configuration.html deleted file mode 100644 index 6d1e9553..00000000 --- a/lam-web/developers/phpdoc/elementindex_configuration.html +++ /dev/null @@ -1,316 +0,0 @@ - - -Package configuration Element Index - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package configuration

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

_

-
-
__construct
-
in file config.inc, method LAMConfig::__construct()
    Loads preferences from config file
-
__construct
-
in file config.inc, method LAMCfgMain::__construct()
    Loads preferences from config file
-
-
- top
-
- -
-

a

-
-
$allowedHosts
-
in file config.inc, variable LAMCfgMain::$allowedHosts
    list of hosts which may access LAM
-
ACCESS_ALL
-
in file config.inc, class constant LAMConfig::ACCESS_ALL
-
ACCESS_PASSWORD_CHANGE
-
in file config.inc, class constant LAMConfig::ACCESS_PASSWORD_CHANGE
-
ACCESS_READ_ONLY
-
in file config.inc, class constant LAMConfig::ACCESS_READ_ONLY
-
-
- top
-
- -
-

c

-
-
checkChmod
-
in file config.inc, function checkChmod()
    Checks whether a specific flag in the rights string is set.
-
checkPassword
-
in file config.inc, method LAMCfgMain::checkPassword()
    Checks if the given password matches.
-
check_Passwd
-
in file config.inc, method LAMConfig::check_Passwd()
    Checks if the given password matches.
-
config_showAccountModules
-
in file confmodules.php, function config_showAccountModules()
    Displays the module selection boxes and checks if dependencies are fulfilled.
-
config.inc
-
procedural page config.inc
-
conflogin.php
-
procedural page conflogin.php
-
confmain.php
-
procedural page confmain.php
-
confmodules.php
-
procedural page confmodules.php
-
conftypes.php
-
procedural page conftypes.php
-
-
- top
-
- -
-

d

-
-
$default
-
in file config.inc, variable LAMCfgMain::$default
    Default profile
-
-
- top
-
- -
-

g

-
-
getAccessLevel
-
in file config.inc, method LAMConfig::getAccessLevel()
    Returns the access level for this profile.
-
getConfigProfiles
-
in file config.inc, function getConfigProfiles()
    Returns an array of string with all available configuration profiles (without .conf)
-
getName
-
in file config.inc, method LAMConfig::getName()
    Returns the name of the config file
-
get_AccountModules
-
in file config.inc, method LAMConfig::get_AccountModules()
    Returns an array of all selected account modules
-
get_ActiveTypes
-
in file config.inc, method LAMConfig::get_ActiveTypes()
    Returns a list of active account types.
-
get_Admins
-
in file config.inc, method LAMConfig::get_Admins()
    Returns an array of string with all admin names
-
get_Adminstring
-
in file config.inc, method LAMConfig::get_Adminstring()
    Returns all admin users seperated by semicolons
-
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_defaultLanguage
-
in file config.inc, method LAMConfig::get_defaultLanguage()
    Returns the default language string
-
get_listAttributes
-
in file config.inc, method LAMConfig::get_listAttributes()
    Returns the list of attributes to show in user list
-
get_moduleSettings
-
in file config.inc, method LAMConfig::get_moduleSettings()
    Returns a list of saved module settings
-
get_scriptPath
-
in file config.inc, method LAMConfig::get_scriptPath()
    Returns the path to 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
-
in file config.inc, method LAMConfig::get_Suffix()
    Returns the LDAP suffix for the given account type
-
get_typeSettings
-
in file config.inc, method LAMConfig::get_typeSettings()
    Returns a list of saved type settings
-
-
- top
-
- -
-

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
-
-
- top
-
- -
-

l

-
-
$logDestination
-
in file config.inc, variable LAMCfgMain::$logDestination
    log destination ("SYSLOG":syslog, "/...":file, "NONE":none)
-
$logLevel
-
in file config.inc, variable LAMCfgMain::$logLevel
    log level
-
LAMCfgMain
-
in file config.inc, class LAMCfgMain
    This class manages config.cfg.
-
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.
-
-
- top
-
- -
-

m

-
-
metaRefresh
-
in file config.inc, function metaRefresh()
    Prints a meta refresh page
-
mainlogin.php
-
procedural page mainlogin.php
-
mainmanage.php
-
procedural page mainmanage.php
-
-
- top
-
- -
-

p

-
-
profmanage.php
-
procedural page profmanage.php
-
-
- top
-
- -
-

s

-
-
$sessionTimeout
-
in file config.inc, variable LAMCfgMain::$sessionTimeout
    Time of inactivity before session times out (minutes)
-
save
-
in file config.inc, method LAMConfig::save()
    Saves preferences to config file
-
save
-
in file config.inc, method LAMCfgMain::save()
    Saves preferences to config file config.cfg
-
saveSettings
-
in file confmain.php, function saveSettings()
    Saves the entered settings.
-
setAccessLevel
-
in file config.inc, method LAMConfig::setAccessLevel()
    Sets the access level for this profile.
-
setlanguage
-
in file config.inc, function setlanguage()
    Sets language settings for automatic translation
-
setPassword
-
in file config.inc, method LAMCfgMain::setPassword()
    Sets a new config password.
-
set_AccountModules
-
in file config.inc, method LAMConfig::set_AccountModules()
    Sets the selected account modules
-
set_ActiveTypes
-
in file config.inc, method LAMConfig::set_ActiveTypes()
    Sets the list of active types.
-
set_Adminstring
-
in file config.inc, method LAMConfig::set_Adminstring()
    Sets the admin string
-
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
-
in file config.inc, method LAMConfig::set_defaultLanguage()
    Sets the default language string
-
set_listAttributes
-
in file config.inc, method LAMConfig::set_listAttributes()
    Sets the list of attributes to show in user list
-
set_moduleSettings
-
in file config.inc, method LAMConfig::set_moduleSettings()
    Sets the settings for the account modules.
-
set_Passwd
-
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_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
-
in file config.inc, method LAMConfig::set_Suffix()
    Sets the LDAP suffix where accounts are saved
-
set_typeSettings
-
in file config.inc, method LAMConfig::set_typeSettings()
    Sets the settings for the account types.
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_lib.html b/lam-web/developers/phpdoc/elementindex_lib.html deleted file mode 100644 index 1e23c350..00000000 --- a/lam-web/developers/phpdoc/elementindex_lib.html +++ /dev/null @@ -1,561 +0,0 @@ - - -Package lib Element Index - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package lib

- [ a ] - [ c ] - [ d ] - [ e ] - [ f ] - [ g ] - [ i ] - [ l ] - [ m ] - [ n ] - [ o ] - [ p ] - [ r ] - [ s ] - [ t ] - [ u ] - [ _ ] - -
- -
-

_

-
-
_get_raw_schema
-
in file schema.inc, function _get_raw_schema()
    Fetches the raw schema array for the subschemaSubentry of the server. Note, this function has grown many hairs to accomodate more LDAP servers. It is needfully complicated as it now supports many popular LDAP servers that don't necessarily expose their schema "the right way".
-
_get_schema_dn
-
in file schema.inc, function _get_schema_dn()
    Helper for _get_raw_schema() which fetches the DN of the schema object
-
__construct
-
in file cache.inc, method cache::__construct()
    Constructor.
-
__sleep
-
in file cache.inc, method cache::__sleep()
    Encrypts LDAP cache before saving to session file.
-
__wakeup
-
in file cache.inc, method cache::__wakeup()
    Decrypts LDAP cache after loading from session file.
-
-
- top
-
- -
-

a

-
-
$aliases
-
in file schema.inc, variable AttributeType::$aliases
    An array of alias attribute names, strings
-
addAlias
-
in file schema.inc, method AttributeType::addAlias()
    Adds an attribute name to the alias array.
-
addChildObjectClass
-
in file schema.inc, method ObjectClass::addChildObjectClass()
    Adds an objectClass to the list of objectClasses that inherit from this objectClass.
-
addMayAttrs
-
in file schema.inc, method ObjectClass::addMayAttrs()
    Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.
-
addMustAttrs
-
in file schema.inc, method ObjectClass::addMustAttrs()
    Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.
-
addRequiredByObjectClass
-
in file schema.inc, method AttributeType::addRequiredByObjectClass()
    Adds an objectClass name to this attribute's list of "required by" objectClasses, that is the list of objectClasses which must have this attribute.
-
addUsedByAttr
-
in file schema.inc, method MatchingRule::addUsedByAttr()
    Adds an attribute name to the list of attributes who use this MatchingRule
-
addUsedInObjectClass
-
in file schema.inc, method AttributeType::addUsedInObjectClass()
    Adds an objectClass name to this attribute's list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
-
add_aliases_to_attrs
-
in file schema.inc, function add_aliases_to_attrs()
    For each attribute that has multiple names, this function adds unique entries to the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.
-
add_cache
-
in file cache.inc, method cache::add_cache()
    This function adds attributes to the cache.
-
add_sup_to_attrs
-
in file schema.inc, function add_sup_to_attrs()
    Adds inherited values to each attributeType specified by the SUP directive.
-
array_delete
-
in file account.inc, function array_delete()
    This function will return all values from $array without values of $values.
-
AttributeType
-
in file schema.inc, method AttributeType::AttributeType()
    Creates a new AttributeType objcet from a raw LDAP AttributeType string.
-
AttributeType
-
in file schema.inc, class AttributeType
    Represents an LDAP AttributeType
-
account.inc
-
procedural page account.inc
-
-
- top
-
- -
-

c

-
-
$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.
-
cached_schema_available
-
in file schema.inc, function cached_schema_available()
    Returns true if the schema for $schema_type has been cached and
-
checkClientIP
-
in file security.inc, function checkClientIP()
    Checks if the client's IP address is on the list of allowed IPs.
-
checkIfPasswordChangeIsAllowed
-
in file security.inc, function checkIfPasswordChangeIsAllowed()
    Checks if passwords may be changed.
-
checkIfWriteAccessIsAllowed
-
in file security.inc, function checkIfWriteAccessIsAllowed()
    Checks if write access to LDAP is allowed.
-
cmp_domain
-
in file account.inc, function cmp_domain()
    Helper function to sort the domains
-
cache.inc
-
procedural page cache.inc
-
-
- top
-
- -
-

d

-
-
$description
-
in file schema.inc, variable SchemaItem::$description
    The description of this schema item.
-
-
- top
-
- -
-

e

-
-
$equality
-
in file schema.inc, variable AttributeType::$equality
    The equality rule used
-
-
- top
-
- -
-

f

-
-
findgroups
-
in file cache.inc, method cache::findgroups()
    This function returns an array with all group names which were found in the LDAP directory.
-
-
- top
-
- -
-

g

-
-
generateRandomPassword
-
in file account.inc, function generateRandomPassword()
    Generates a random password with 12 digits.
-
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.
-
getDescription
-
in file schema.inc, method SchemaItem::getDescription()
-
getEquality
-
in file schema.inc, method AttributeType::getEquality()
    Gets this attribute's equality string
-
getgid
-
in file cache.inc, method cache::getgid()
    This function will return the GID number to an existing group name (using the cache).
-
getgrnam
-
in file cache.inc, method cache::getgrnam()
    This function returns the group name to an existing gidNumber.
-
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 AttributeType::getIsObsolete()
    Gets whether this attribute has been flagged as obsolete by the LDAP server
-
getIsObsolete
-
in file schema.inc, method ObjectClass::getIsObsolete()
    Gets whether this objectClass is flagged as obsolete by the LDAP server.
-
getIsObsolete
-
in file schema.inc, method MatchingRule::getIsObsolete()
    Gets whether this MatchingRule is flagged as obsolete by the LDAP server.
-
getIsSingleValue
-
in file schema.inc, method AttributeType::getIsSingleValue()
    Gets whether this attribute is single-valued. If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.
-
getMaxLength
-
in file schema.inc, method AttributeType::getMaxLength()
    Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.
-
getMayAttrNames
-
in file schema.inc, method ObjectClass::getMayAttrNames()
    Gets an array of attribute names (strings) that entries of this ObjectClass must define.
-
getMayAttrs
-
in file schema.inc, method ObjectClass::getMayAttrs()
    Gets an array of AttributeType objects that entries of this ObjectClass may define.
-
getMustAttrNames
-
in file schema.inc, method ObjectClass::getMustAttrNames()
    Gets an array of attribute names (strings) that entries of this ObjectClass must define.
-
getMustAttrs
-
in file schema.inc, method ObjectClass::getMustAttrs()
    Gets an array of AttributeType objects that entries of this ObjectClass must define.
-
getName
-
in file schema.inc, method MatchingRule::getName()
    Gets this MatchingRule's name.
-
getName
-
in file schema.inc, method MatchingRuleUse::getName()
    Gets this MatchingRuleUse's name
-
getName
-
in file schema.inc, method AttributeType::getName()
    Gets this attribute's name
-
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
-
getOID
-
in file schema.inc, method SchemaItem::getOID()
-
getOrdering
-
in file schema.inc, method AttributeType::getOrdering()
    Gets this attribute's ordering specification.
-
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.
-
getSource
-
in file schema.inc, method ObjectClassAttribute::getSource()
    Gets the name of the ObjectClass which originally specified this attribute.
-
getSubstr
-
in file schema.inc, method AttributeType::getSubstr()
    Gets this attribute's substring matching specification
-
getSupAttribute
-
in file schema.inc, method AttributeType::getSupAttribute()
    Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.
-
getSupClasses
-
in file schema.inc, method ObjectClass::getSupClasses()
    Gets the objectClass names from which this objectClass inherits.
-
getSyntaxOID
-
in file schema.inc, method AttributeType::getSyntaxOID()
    Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.
-
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 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
-
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
-
getUsedInObjectClasses
-
in file schema.inc, method AttributeType::getUsedInObjectClasses()
    Gets the list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
-
get_cache
-
in file cache.inc, method cache::get_cache()
    Queries the cache for a list of LDAP entries and their attributes.
-
get_cached_schema
-
in file schema.inc, function get_cached_schema()
    Returns the cached array of schemaitem objects for the specified
-
get_preg
-
in file account.inc, function get_preg()
    Checks if a given value matches the selected regular expression.
-
get_schema_attribute
-
in file schema.inc, function get_schema_attribute()
    Gets a single AttributeType object specified by name.
-
get_schema_attributes
-
in file schema.inc, function get_schema_attributes()
    Gets an associative array of AttributeType objects for the specified server. Each array entry's key is the name of the attributeType in lower-case and the value is an AttributeType object.
-
get_schema_matching_rules
-
in file schema.inc, function get_schema_matching_rules()
    Returns an array of MatchingRule objects for the specified server.
-
get_schema_objectclass
-
in file schema.inc, function get_schema_objectclass()
    Gets a single ObjectClass object specified by name.
-
get_schema_objectclasses
-
in file schema.inc, function get_schema_objectclasses()
    Gets an associative array of ObjectClass objects for the specified server. Each array entry's key is the name of the objectClass in lower-case and the value is an ObjectClass object.
-
get_schema_syntaxes
-
in file schema.inc, function get_schema_syntaxes()
    Returns an array of Syntax objects that this LDAP server uses mapped to their descriptions. The key of each entry is the OID of the Syntax.
-
-
- top
-
- -
-

i

-
-
$is_collective
-
in file schema.inc, variable AttributeType::$is_collective
    boolean: is collective?
-
$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 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?
-
initVars
-
in file schema.inc, method ObjectClass::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 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 MatchingRule::initVars()
    Initialize the class' member variables
-
initVars
-
in file schema.inc, method MatchingRuleUse::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_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).
-
-
- top
-
- -
-

l

-
-
lmPassword
-
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.
-
logoffAndBackToLoginPage
-
in file security.inc, function logoffAndBackToLoginPage()
    Logs off the user and displays the login page.
-
-
- top
-
- -
-

m

-
-
$max_length
-
in file schema.inc, variable AttributeType::$max_length
    The max number of characters this attribute can be
-
$may_attrs
-
in file schema.inc, variable ObjectClass::$may_attrs
    arrays of attribute names that this objectClass allows, but does not require
-
$must_attrs
-
in file schema.inc, variable ObjectClass::$must_attrs
    arrays of attribute names that this objectClass requires
-
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
-
MatchingRuleUse
-
in file schema.inc, class MatchingRuleUse
    Represents an LDAP schema matchingRuleUse entry
-
MatchingRuleUse
-
in file schema.inc, method MatchingRuleUse::MatchingRuleUse()
-
-
- top
-
- -
-

n

-
-
$name
-
in file schema.inc, variable ObjectClass::$name
    This objectClass' name, ie "inetOrgPerson"
-
$name
-
in file schema.inc, variable ObjectClassAttribute::$name
    This Attribute's name
-
$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 AttributeType::$name
    The name of this attributeType
-
ntPassword
-
in file account.inc, function ntPassword()
    Generates the NT hash of a password.
-
-
- top
-
- -
-

o

-
-
$oid
-
in file schema.inc, variable SchemaItem::$oid
    The OID of this schema item.
-
$ordering
-
in file schema.inc, variable AttributeType::$ordering
    The ordering of the attributeType
-
ObjectClass
-
in file schema.inc, method ObjectClass::ObjectClass()
    Creates a new ObjectClass object given a raw LDAP objectClass string.
-
ObjectClass
-
in file schema.inc, class ObjectClass
    Represents an LDAP objectClass
-
ObjectClassAttribute
-
in file schema.inc, method ObjectClassAttribute::ObjectClassAttribute()
    Creates a new ObjectClassAttribute with specified name and source objectClass.
-
ObjectClassAttribute
-
in file schema.inc, class ObjectClassAttribute
    A simple class for representing AttributeTypes used only by the ObjectClass class.
-
-
- top
-
- -
-

p

-
-
pwd_disable
-
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
-
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
-
pwd_is_enabled
-
in file account.inc, function pwd_is_enabled()
    Checks if a password hash is enabled/disabled
-
-
- top
-
- -
-

r

-
-
$required_by_object_classes
-
in file schema.inc, variable AttributeType::$required_by_object_classes
    A list of object class names that require this attribute type.
-
refresh_cache
-
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.
-
-
- top
-
- -
-

s

-
-
$source
-
in file schema.inc, variable ObjectClassAttribute::$source
    This Attribute's root
-
$sub_str
-
in file schema.inc, variable AttributeType::$sub_str
    Boolean: supports substring matching?
-
$sup_attribute
-
in file schema.inc, variable AttributeType::$sup_attribute
    The attribute from which this attribute inherits (if any)
-
$sup_classes
-
in file schema.inc, variable ObjectClass::$sup_classes
    array of objectClass names from which this objectClass inherits
-
$syntax
-
in file schema.inc, variable MatchingRule::$syntax
    This rule's syntax OID
-
$syntax
-
in file schema.inc, variable AttributeType::$syntax
    The full syntax string, ie 1.2.3.4{16}
-
schema.inc
-
procedural page schema.inc
-
security.inc
-
procedural page security.inc
-
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).
-
search_domains
-
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
-
in file schema.inc, method SchemaItem::setDescription()
-
setIsSingleValue
-
in file schema.inc, method AttributeType::setIsSingleValue()
    Sets whether this attribute is single-valued.
-
setName
-
in file schema.inc, method AttributeType::setName()
    Sets this attriute's name.
-
setOID
-
in file schema.inc, method SchemaItem::setOID()
-
setSupAttribute
-
in file schema.inc, method AttributeType::setSupAttribute()
    Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).
-
setType
-
in file schema.inc, method AttributeType::setType()
    Sets this attribute's type.
-
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.
-
set_schema_cache_unavailable
-
in file schema.inc, function set_schema_cache_unavailable()
    Sets the schema entry for the server_id to be "unavailable" so that we realize that we tried to get the schema but could not, so quit trying next time to fetch it from the server.
-
smbflag
-
in file account.inc, function smbflag()
    Takes a list of Samba flags and creates the corresponding flag string.
-
startSecureSession
-
in file security.inc, function startSecureSession()
    Starts a session and checks the environment.
-
StatusMessage
-
in file status.inc, function StatusMessage()
    This function prints a short status message. It can be used to print INFO, WARN and ERROR messages at the moment.
-
Syntax
-
in file schema.inc, method Syntax::Syntax()
    Creates a new Syntax object from a raw LDAP syntax string.
-
Syntax
-
in file schema.inc, class Syntax
    Represents an LDAP Syntax
-
-
- top
-
- -
-

t

-
-
$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)
-
-
- top
-
- -
-

u

-
-
$usage
-
in file schema.inc, variable AttributeType::$usage
    The usage string set by the LDAP schema
-
$used_by_attrs
-
in file schema.inc, variable MatchingRule::$used_by_attrs
    An array of attribute names who use this MatchingRule
-
$used_by_attrs
-
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)
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_lists.html b/lam-web/developers/phpdoc/elementindex_lists.html deleted file mode 100644 index 9831d8c4..00000000 --- a/lam-web/developers/phpdoc/elementindex_lists.html +++ /dev/null @@ -1,625 +0,0 @@ - - -Package lists Element Index - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package lists

- [ a ] - [ b ] - [ c ] - [ d ] - [ e ] - [ f ] - [ g ] - [ i ] - [ l ] - [ m ] - [ n ] - [ p ] - [ r ] - [ s ] - [ t ] - [ u ] - [ _ ] - -
- -
-

_

-
-
__construct
-
in file lists.inc, method lamSelectListOption::__construct()
    Creates a new selection list option.
-
__construct
-
in file mailAlias.inc, method lamMailAliasList::__construct()
    Constructor
-
__construct
-
in file smbDomain.inc, method lamSmbDomainList::__construct()
    Constructor
-
__construct
-
in file user.inc, method lamUserList::__construct()
    Constructor
-
__construct
-
in file lists.inc, method lamListTool::__construct()
    Constructor
-
__construct
-
in file lists.inc, method lamListOption::__construct()
    Creates a new config option.
-
__construct
-
in file host.inc, method lamHostList::__construct()
    Constructor
-
__construct
-
in file lists.inc, method lamBooleanListOption::__construct()
    Creates a new boolean option.
-
__construct
-
in file lists.inc, method lamList::__construct()
    Constructor
-
__construct
-
in file group.inc, method lamGroupList::__construct()
    Constructor
-
-
- top
-
- -
-

a

-
-
$attrArray
-
in file lists.inc, variable lamList::$attrArray
    list of LDAP attributes
-
arrayLower
-
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
-
add_attr_form.php
-
procedural page add_attr_form.php
-
add_oclass.php
-
procedural page add_oclass.php
-
add_oclass_form.php
-
procedural page add_oclass_form.php
-
add_value.php
-
procedural page add_value.php
-
add_value_form.php
-
procedural page add_value_form.php
-
-
- top
-
- -
-

b

-
-
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
-
-
- top
-
- -
-

c

-
-
cmp_array
-
in file lists.inc, method lamList::cmp_array()
    Compare function used for usort-method
-
changePassword.php
-
procedural page changePassword.php
-
collapse.php
-
procedural page collapse.php
-
create.php
-
procedural page create.php
-
create_form.php
-
procedural page create_form.php
-
creation_template.php
-
procedural page creation_template.php
-
custom.php
-
procedural page custom.php
-
-
- top
-
- -
-

d

-
-
$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()
    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()
-
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.
-
draw_jpeg_photos
-
in file tree.inc, function draw_jpeg_photos()
    Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to specify how the images are to be displayed.
-
draw_server_tree
-
in file tree.inc, function draw_server_tree()
    Prints the HTML of the tree view.
-
draw_tree_html
-
in file tree.php, function draw_tree_html()
    Recursively descend on the given dn and draw the tree in html
-
delete.php
-
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
-
-
- top
-
- -
-

e

-
-
$entries
-
in file lists.inc, variable lamList::$entries
    LDAP entries
-
edit.php
-
procedural page edit.php
-
expand.php
-
procedural page expand.php
-
export.php
-
procedural page export.php
-
export_form.php
-
procedural page export_form.php
-
-
- top
-
- -
-

f

-
-
$filterText
-
in file lists.inc, variable lamList::$filterText
    filter string to include in URL
-
fillFromPostData
-
in file lists.inc, method lamSelectListOption::fillFromPostData()
    Fills the config option from POST data.
-
fillFromPostData
-
in file lists.inc, method lamListOption::fillFromPostData()
    Fills the config option from POST data.
-
fillFromPostData
-
in file lists.inc, method lamBooleanListOption::fillFromPostData()
    Fills the config option from POST data.
-
-
- top
-
- -
-

g

-
-
generatePassword
-
in file changePassword.php, function generatePassword()
    Sets a generated password and displays it or sends it via mail.
-
getAdditionalTools
-
in file lists.inc, method lamList::getAdditionalTools()
    Returns a list of lamListTool objects to display next to the edit/delete buttons.
-
getAdditionalTools
-
in file user.inc, method lamUserList::getAdditionalTools()
    Returns a list of lamListTool objects to display next to the edit/delete buttons.
-
getID
-
in file lists.inc, method lamListOption::getID()
    Returns the option ID.
-
getImage
-
in file lists.inc, method lamListTool::getImage()
    Returns the name of the tool image.
-
getLinkTarget
-
in file lists.inc, method lamListTool::getLinkTarget()
    Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.
-
getMetaHTML
-
in file lists.inc, method lamSelectListOption::getMetaHTML()
    Returns the meta HTML data to display this option.
-
getMetaHTML
-
in file lists.inc, method lamListOption::getMetaHTML()
    Returns the meta HTML data to display this option.
-
getMetaHTML
-
in file lists.inc, method lamBooleanListOption::getMetaHTML()
    Returns the meta HTML data to display this option.
-
getName
-
in file lists.inc, method lamListTool::getName()
    Returns the tool name.
-
getValue
-
in file lists.inc, method lamListOption::getValue()
    Returns the option value. The value must not contain "=" and ";".
-
groupRefreshPrimary
-
in file group.inc, method lamGroupList::groupRefreshPrimary()
    Refreshes the primary group members list.
-
get_attr_select_html
-
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.
-
get_container
-
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:
-
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
-
get_icon
-
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()
    Helper functoin for fetching the line end format.
-
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:
-
get_object_attrs
-
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()
    Given a DN string, this returns the 'RDN' portion of the string.
-
-
- top
-
- -
-

i

-
-
isSelected
-
in file lists.inc, method lamBooleanListOption::isSelected()
    Returns if this option is selected.
-
initialize_session_tree
-
in file tree.inc, function initialize_session_tree()
    Checks and fixes an initial session's tree cache if needed.
-
is_attr_binary
-
in file tree.inc, function is_attr_binary()
    Given an attribute name and server ID number, this function returns whether the attrbiute may contain binary data. This is useful for developers who wish to display the contents of an arbitrary attribute but don't want to dump binary data on the page.
-
is_attr_boolean
-
in file tree.inc, function is_attr_boolean()
    Given an attribute name and server ID number, this function returns whether the attrbiute contains boolean data. This is useful for developers who wish to display the contents of a boolean attribute with a drop-down.
-
is_binary_option_required
-
in file add_attr.php, function is_binary_option_required()
-
is_dn_attr
-
in file tree.inc, function is_dn_attr()
    Returns true if the attribute specified is required to take as input a DN.
-
is_jpeg_photo
-
in file tree.inc, function is_jpeg_photo()
    Used to determine if the specified attribute is indeed a jpegPhoto. If the specified attribute is one that houses jpeg data, true is returned. Otherwise this function returns false.
-
is_mail_string
-
in file tree.inc, function is_mail_string()
    Get whether a string looks like an email address (user@example.com).
-
is_multi_line_attr
-
in file tree.inc, function is_multi_line_attr()
    Determines if an attribute's value can contain multiple lines. Attributes that fall in this multi-line category may be configured in config.php. Hence, this function accesses the global variable $multi_line_attributes;
-
is_url_string
-
in file tree.inc, function is_url_string()
    Get whether a string looks like a web URL (http://www.example.com/)
-
-
- top
-
- -
-

l

-
-
$labels
-
in file lists.inc, variable lamList::$labels
    list of account specific labels
-
lamBooleanListOption
-
in file lists.inc, class lamBooleanListOption
    Boolean option for list configuration.
-
lamGroupList
-
in file group.inc, class lamGroupList
    Generates the list view.
-
lamHostList
-
in file host.inc, class lamHostList
    Generates the list view.
-
lamList
-
in file lists.inc, class lamList
    Generates the list view.
-
lamListOption
-
in file lists.inc, class lamListOption
    Represents a list configuration option.
-
lamListTool
-
in file lists.inc, class lamListTool
    Represents a tool which can be included in the account lists.
-
lamMailAliasList
-
in file mailAlias.inc, class lamMailAliasList
    Generates the list view.
-
lamSelectListOption
-
in file lists.inc, class lamSelectListOption
    Boolean option for list configuration.
-
lamSmbDomainList
-
in file smbDomain.inc, class lamSmbDomainList
    Generates the list view.
-
lamUserList
-
in file user.inc, class lamUserList
    Generates the list view.
-
lists.inc
-
procedural page lists.inc
-
listBuildFilter
-
in file lists.inc, method lamList::listBuildFilter()
    Builds the regular expressions from the filter values.
-
listConfigurationChanged
-
in file group.inc, method lamGroupList::listConfigurationChanged()
    Called when the configuration options changed.
-
listConfigurationChanged
-
in file lists.inc, method lamList::listConfigurationChanged()
    Called when the configuration options changed.
-
listConfigurationChanged
-
in file user.inc, method lamUserList::listConfigurationChanged()
    Called when the configuration options changed.
-
listDrawNavigationBar
-
in file lists.inc, method lamList::listDrawNavigationBar()
    Draws a navigation bar to switch between pages
-
listFilterAccounts
-
in file lists.inc, method lamList::listFilterAccounts()
    Removes all entries which do not fit to the filter.
-
listGetAllConfigOptions
-
in file lists.inc, method lamList::listGetAllConfigOptions()
    Returns a list of possible configuration options.
-
listGetAllConfigOptions
-
in file user.inc, method lamUserList::listGetAllConfigOptions()
    Returns a list of possible configuration options.
-
listGetAllConfigOptions
-
in file group.inc, method lamGroupList::listGetAllConfigOptions()
    Returns a list of possible configuration options.
-
listGetConfigOptionByID
-
in file lists.inc, method lamList::listGetConfigOptionByID()
    Returns the configuration option with the given ID.
-
listGetParams
-
in file group.inc, method lamGroupList::listGetParams()
    Sets some internal parameters.
-
listGetParams
-
in file lists.inc, method lamList::listGetParams()
    Sets some internal parameters.
-
listGetParams
-
in file user.inc, method lamUserList::listGetParams()
    Sets some internal parameters.
-
listPrintButtons
-
in file lists.inc, method lamList::listPrintButtons()
    Prints the create and delete buttons.
-
listPrintConfigurationPage
-
in file lists.inc, method lamList::listPrintConfigurationPage()
    Prints the list configuration page.
-
listPrintFooter
-
in file lists.inc, method lamList::listPrintFooter()
    Prints the HTML footer.
-
listPrintHeader
-
in file lists.inc, method lamList::listPrintHeader()
    Prints the HTML header.
-
listPrintTableBody
-
in file lists.inc, method lamList::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
-
listRefreshData
-
in file lists.inc, method lamList::listRefreshData()
    Rereads the entries from LDAP.
-
listRefreshData
-
in file user.inc, method lamUserList::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
-
in file lists.inc, method lamList::listSort()
    Sorts an account list by a given attribute
-
LIST_SIZE_OPTION_NAME
-
in file lists.inc, class constant lamList::LIST_SIZE_OPTION_NAME
    ID for list size config option
-
list.php
-
procedural page list.php
-
-
- top
-
- -
-

m

-
-
$maxPageEntries
-
in file lists.inc, variable lamList::$maxPageEntries
    maximum count of entries per page
-
-
- top
-
- -
-

n

-
-
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.
-
new_ou_template.php
-
procedural page new_ou_template.php
-
-
- top
-
- -
-

p

-
-
$page
-
in file lists.inc, variable lamList::$page
    current page number
-
$possibleSuffixes
-
in file lists.inc, variable lamList::$possibleSuffixes
    list of possible LDAP suffixes(organizational units)
-
pla_compare_dns
-
in file tree.inc, function pla_compare_dns()
    Compares 2 DNs. If they are equivelant, returns 0, otherwise, returns their sorting order (similar to strcmp()): Returns < 0 if dn1 is less than dn2.
-
pla_explode_dn
-
in file tree.inc, function pla_explode_dn()
    Explode a DN into an array of its RDN parts. This function is UTF-8 safe and replaces the buggy PHP ldap_explode_dn() which does not properly handle UTF-8 DNs and also causes segmentation faults with some inputs.
-
pla_ldap_search
-
in file tree.inc, function pla_ldap_search()
    A handy ldap searching function very similar to PHP's ldap_search() with the following exceptions: Callers may specify a search scope and the return value is an array containing the search results rather than an LDAP result resource.
-
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
-
pretty_print_dn
-
in file tree.inc, function pretty_print_dn()
    Returns an HTML-beautified version of a DN.
-
-
- top
-
- -
-

r

-
-
$refresh
-
in file lists.inc, variable lamList::$refresh
    refresh page switch
-
readUser
-
in file changePassword.php, function readUser()
    Returns the LDAP attributes of the given DN.
-
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()
    Prunes off anything after the ";" in an attr name. This is useful for attributes that may have ";binary" appended to their names. With real_attr_name(), you can more easily fetch these attributes' schema with their "real" attribute name.
-
remove_aliases
-
in file custom.php, function remove_aliases()
    Removes attributes from the array that are aliases for eachother
-
rdelete.php
-
procedural page rdelete.php
-
refresh.php
-
procedural page refresh.php
-
-
- top
-
- -
-

s

-
-
$sortColumn
-
in file lists.inc, variable lamList::$sortColumn
    sort column name
-
$sortDirection
-
in file lists.inc, variable lamList::$sortDirection
    sort direction: 1 for ascending, -1 for descending
-
$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
-
setHelpID
-
in file lists.inc, method lamSelectListOption::setHelpID()
    Sets the help ID.
-
setPassword
-
in file changePassword.php, function setPassword()
    Sets the password to LDAP.
-
setSpecifiedPassword
-
in file changePassword.php, function setSpecifiedPassword()
    Sets the new password.
-
setValue
-
in file lists.inc, method lamListOption::setValue()
    Sets the config option value. The value must not contain "=" and ";".
-
showPage
-
in file lists.inc, method lamList::showPage()
    Prints the HTML code to display the list view.
-
sortAttrs
-
in file tree.inc, function sortAttrs()
-
-
- top
-
- -
-

t

-
-
$type
-
in file lists.inc, variable lamList::$type
    Account type
-
TRANS_PRIMARY_OPTION_NAME
-
in file user.inc, class constant lamUserList::TRANS_PRIMARY_OPTION_NAME
    ID for config option
-
TRANS_PRIMARY_OPTION_NAME
-
in file group.inc, class constant lamGroupList::TRANS_PRIMARY_OPTION_NAME
    ID for config option
-
tree.inc
-
procedural page tree.inc
-
templates.inc
-
procedural page templates.inc
-
tree.php
-
procedural page tree.php
-
tree_view.php
-
procedural page tree_view.php
-
-
- top
-
- -
-

u

-
-
userlink.php
-
procedural page userlink.php
-
update.php
-
procedural page update.php
-
update_confirm.php
-
procedural page update_confirm.php
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_main.html b/lam-web/developers/phpdoc/elementindex_main.html deleted file mode 100644 index 7dfec7ff..00000000 --- a/lam-web/developers/phpdoc/elementindex_main.html +++ /dev/null @@ -1,145 +0,0 @@ - - -Package main Element Index - - - - - - - - - - - - - -
main
- - - [ class tree: main ] - [ index: main ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package main

- [ d ] - [ g ] - [ i ] - [ l ] - [ m ] - -
- -
-

d

-
-
deleteDN
-
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.
-
delete.php
-
procedural page delete.php
-
-
- top
-
- -
-

g

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

i

-
-
initsuff.php
-
procedural page initsuff.php
-
-
- top
-
- -
-

l

-
-
login.php
-
procedural page login.php
-
logout.php
-
procedural page logout.php
-
-
- top
-
- -
-

m

-
-
main.php
-
procedural page main.php
-
main_header.php
-
procedural page main_header.php
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_modules.html b/lam-web/developers/phpdoc/elementindex_modules.html deleted file mode 100644 index d50f63d0..00000000 --- a/lam-web/developers/phpdoc/elementindex_modules.html +++ /dev/null @@ -1,1156 +0,0 @@ - - -Package modules Element Index - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package modules

- [ a ] - [ b ] - [ c ] - [ d ] - [ e ] - [ f ] - [ g ] - [ h ] - [ i ] - [ k ] - [ l ] - [ m ] - [ n ] - [ o ] - [ p ] - [ q ] - [ r ] - [ s ] - [ t ] - [ u ] - [ x ] - [ _ ] - -
- -
-

_

-
-
__construct
-
in file sambaSamAccount.inc, method sambaSamAccount::__construct()
    Creates a new sambaSamAccount object.
-
__construct
-
in file sambaAccount.inc, method sambaAccount::__construct()
    Creates a new sambaAccount object.
-
__construct
-
in file baseModule.inc, method baseModule::__construct()
    Creates a new base module class
-
__construct
-
in file modules.inc, method accountContainer::__construct()
    Constructor
-
__construct
-
in file kolabUser.inc, method kolabUser::__construct()
    Creates a new kolabUser object.
-
__construct
-
in file sambaGroupMapping.inc, method sambaGroupMapping::__construct()
    Creates a new module for Samba 3 groups.
-
__sleep
-
in file modules.inc, method accountContainer::__sleep()
    Encrypts sensitive data before storing in session.
-
__wakeup
-
in file modules.inc, method accountContainer::__wakeup()
    Decrypts sensitive data after accountContainer was loaded from session.
-
-
- top
-
- -
-

a

-
-
$attributes
-
in file modules.inc, variable accountContainer::$attributes
    Array of all used attributes
-
$attributes
-
in file baseModule.inc, variable baseModule::$attributes
    contains all ldap attributes which should be written
-
$attributes_orig
-
in file modules.inc, variable accountContainer::$attributes_orig
    original LDAP attributes when account was loaded from LDAP
-
$ATTR_MEMBER_NAME
-
in file groupOfUniqueNames.inc, variable groupOfUniqueNames::$ATTR_MEMBER_NAME
    name of member attribute
-
$ATTR_MEMBER_NAME
-
in file groupOfNames.inc, variable groupOfNames::$ATTR_MEMBER_NAME
    name of member attribute
-
$autoAddObjectClasses
-
in file baseModule.inc, variable baseModule::$autoAddObjectClasses
    if true, managed object classes are added when an account is created or loaded (default: true)
-
account
-
in file account.inc, class account
    Manages the object class "account" for users and hosts.
-
accountContainer
-
in file modules.inc, class accountContainer
    This class includes all modules and attributes of an account.
-
account.inc
-
procedural page account.inc
-
-
- top
-
- -
-

b

-
-
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.
-
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 sambaAccount.inc, method sambaAccount::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 sambaGroupMapping.inc, method sambaGroupMapping::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 ldapPublicKey.inc, method ldapPublicKey::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file groupOfNames.inc, method groupOfNames::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file baseModule.inc, method baseModule::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.
-
build_uploadAccounts
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file kolabUser.inc, method kolabUser::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file inetOrgPerson.inc, method inetOrgPerson::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file account.inc, method account::build_uploadAccounts()
    In this function the LDAP account is built up.
-
baseModule.inc
-
procedural page baseModule.inc
-
-
- top
-
- -
-

c

-
-
$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
-
checkProfileOptions
-
in file modules.inc, function checkProfileOptions()
    Checks if the profile options are valid
-
checkSelfServiceOptions
-
in file inetOrgPerson.inc, method inetOrgPerson::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceOptions
-
in file posixAccount.inc, method posixAccount::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceOptions
-
in file sambaSamAccount.inc, method sambaSamAccount::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceOptions
-
in file baseModule.inc, method baseModule::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP 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
-
check_module_depends
-
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
-
-
- top
-
- -
-

d

-
-
$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 posixAccount.inc, method posixAccount::delete_attributes()
    Additional LDAP operations on delete.
-
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.
-
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()
    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 sambaDomain.inc, method sambaDomain::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 sambaSamAccount.inc, method sambaSamAccount::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()
    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_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()
    Returns the HTML meta data for the main account page.
-
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 groupOfNames.inc, method groupOfNames::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()
    Returns the HTML meta data for the main account page.
-
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 kolabUser.inc, method kolabUser::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()
    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()
    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
-
in file shadowAccount.inc, method shadowAccount::display_html_expire()
    This function will create the meta HTML code to show a page with the expiration date.
-
display_html_group
-
in file posixAccount.inc, method posixAccount::display_html_group()
    Displays the group selection.
-
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_members
-
in file groupOfNames.inc, method groupOfNames::display_html_members()
    This function will create the meta HTML code to show a page to change the member attribute.
-
display_html_owner
-
in file groupOfNames.inc, method groupOfNames::display_html_owner()
    This function will create the meta HTML code to show a page to change the owner attribute.
-
display_html_password
-
in file posixGroup.inc, method posixGroup::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_password
-
in file posixAccount.inc, method posixAccount::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()
    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()
    This function will create the HTML page to edit the allowed workstations.
-
doHash
-
in file createntlm.inc, method smbHash::doHash()
-
doUploadPostActions
-
in file posixAccount.inc, method posixAccount::doUploadPostActions()
    This function executes one post upload action.
-
doUploadPostActions
-
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.
-
-
- top
-
- -
-

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()
    E_P16
-
edit.php
-
procedural page edit.php
-
-
- top
-
- -
-

f

-
-
fixLDAPAttributes
-
in file modules.inc, method accountContainer::fixLDAPAttributes()
    Fixes spelling errors in the attribute names.
-
-
- top
-
- -
-

g

-
-
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
-
getAvailablePDFFields
-
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 nisMailAlias.inc, method nisMailAlias::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 baseModule.inc, method baseModule::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.
-
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.
-
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.
-
getIcon
-
in file baseModule.inc, method baseModule::getIcon()
    Returns the path to the module icon.
-
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
-
in file baseModule.inc, method baseModule::getManagedAttributes()
    Returns a list of LDAP attributes which are managed by this module.
-
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
-
getModulesDependencies
-
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.
-
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.
-
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 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.
-
get_alias
-
in file baseModule.inc, method baseModule::get_alias()
    Returns an alias name for the module.
-
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 baseModule.inc, method baseModule::get_ldap_filter()
    returns an LDAP filter for the account lists
-
get_ldap_filter
-
in file modules.inc, function get_ldap_filter()
    Returns the LDAP filter used by the account lists
-
get_metaData
-
in file shadowAccount.inc, method shadowAccount::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 quota.inc, method quota::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 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 baseModule.inc, method baseModule::get_metaData()
    Dummy function, meta data is provided by sub classes.
-
get_metaData
-
in file sambaDomain.inc, method sambaDomain::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file groupOfUniqueNames.inc, method groupOfUniqueNames::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 account.inc, method account::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file groupOfNames.inc, method groupOfNames::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 sambaSamAccount.inc, method sambaSamAccount::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 kolabUser.inc, method kolabUser::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 sambaGroupMapping.inc, method sambaGroupMapping::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 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.
-
get_pdfEntries
-
in file shadowAccount.inc, method shadowAccount::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 modules.inc, method accountContainer::get_pdfEntries()
    Returns a list of possible PDF entries for this account.
-
get_pdfEntries
-
in file ieee802device.inc, method ieee802Device::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 inetOrgPerson.inc, method inetOrgPerson::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 kolabUser.inc, method kolabUser::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file groupOfNames.inc, method groupOfNames::get_pdfEntries()
    Returns a list of PDF entries
-
get_pdfEntries
-
in file nisMailAlias.inc, method nisMailAlias::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_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 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.
-
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.
-
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
-
in file baseModule.inc, method baseModule::get_scope()
    Returns the account type of this module (user, group, host)
-
get_type
-
in file modules.inc, method accountContainer::get_type()
    Returns the accout type of this object (e.g. user, group, host).
-
get_uploadColumns
-
in file quota.inc, method quota::get_uploadColumns()
    Returns an array containing all input columns for the file upload.
-
get_uploadColumns
-
in file baseModule.inc, method baseModule::get_uploadColumns()
    Returns an array containing all input columns for the file upload.
-
get_uploadPreDepends
-
in file baseModule.inc, method baseModule::get_uploadPreDepends()
    Returns a list of module names which must be processed in building the account befor this module.
-
groupOfNames
-
in file groupOfNames.inc, class groupOfNames
    Manages group members for the object class groupOfNames.
-
groupOfUniqueNames
-
in file groupOfUniqueNames.inc, class groupOfUniqueNames
    Manages group members for the object class groupOfUniqueNames.
-
groupOfNames.inc
-
procedural page groupOfNames.inc
-
groupOfUniqueNames.inc
-
procedural page groupOfUniqueNames.inc
-
-
- top
-
- -
-

h

-
-
hexstr
-
in file sambaMungedDial.inc, method sambaMungedDial::hexstr()
    hexstr
-
-
- top
-
- -
-

i

-
-
$isNewAccount
-
in file modules.inc, variable accountContainer::$isNewAccount
    True if this is a newly created account
-
ieee802Device
-
in file ieee802device.inc, class ieee802Device
    Provides MAC addresses for hosts.
-
inetLocalMailRecipient
-
in file inetLocalMailRecipient.inc, class inetLocalMailRecipient
    Provides mail routing for users.
-
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 posixGroup.inc, method posixGroup::init()
    This functin will be called when the module will be loaded *
-
init
-
in file sambaGroupMapping.inc, method sambaGroupMapping::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 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 baseModule.inc, method baseModule::is_base_module()
    Returns true if this module is enough to provide a sensible account.
-
is_base_module
-
in file modules.inc, function is_base_module()
    Returns true if the module is a base module
-
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
-
inetLocalMailRecipient.inc
-
procedural page inetLocalMailRecipient.inc
-
inetOrgPerson.inc
-
procedural page inetOrgPerson.inc
-
-
- top
-
- -
-

k

-
-
kolabUser
-
in file kolabUser.inc, class kolabUser
    Manages Kolab user accounts.
-
kolabUser.inc
-
procedural page kolabUser.inc
-
-
- top
-
- -
-

l

-
-
lamdaemon
-
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.
-
ldapPublicKey
-
in file ldapPublicKey.inc, class ldapPublicKey
    Manages SSH public keys.
-
lamdaemon.inc
-
procedural page lamdaemon.inc
-
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 posixAccount.inc, method posixAccount::load_attributes()
    This function loads all needed LDAP attributes.
-
load_attributes
-
in file sambaAccount.inc, method sambaAccount::load_attributes()
    This function loads the LDAP attributes for this module.
-
load_attributes
-
in file baseModule.inc, method baseModule::load_attributes()
    This function loads the LDAP attributes for this module.
-
load_attributes
-
in file sambaSamAccount.inc, method sambaSamAccount::load_attributes()
    This function loads the LDAP attributes for this module.
-
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 shadowAccount.inc, method shadowAccount::load_Messages()
    This function builds up the message array.
-
load_Messages
-
in file sambaSamAccount.inc, method sambaSamAccount::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 sambaDomain.inc, method sambaDomain::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 ieee802device.inc, method ieee802Device::load_Messages()
    This function fills the error message array with messages
-
load_Messages
-
in file groupOfNames.inc, method groupOfNames::load_Messages()
    This function fills the $messages variable with output messages from this module.
-
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 inetOrgPerson.inc, method inetOrgPerson::load_Messages()
    This function fills the message array.
-
load_Messages
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::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 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_profile
-
in file sambaSamAccount.inc, method sambaSamAccount::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 baseModule.inc, method baseModule::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 sambaGroupMapping.inc, method sambaGroupMapping::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.
-
lshift
-
in file createntlm.inc, method smbHash::lshift()
-
-
- top
-
- -
-

m

-
-
$messages
-
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
-
$moduleSettings
-
in file baseModule.inc, variable baseModule::$moduleSettings
    configuration settings of all modules
-
modules.inc
-
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 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 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 groupOfNames.inc, method groupOfNames::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.
-
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 sambaAccount.inc, method sambaAccount::module_ready()
    This function is used to check if this module page can be displayed.
-
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 quota.inc, method quota::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.
-
munge
-
in file sambaMungedDial.inc, method sambaMungedDial::munge()
    Setup parameter given by paramName to MungedDial-Format
-
mxor
-
in file createntlm.inc, method smbHash::mxor()
-
-
- top
-
- -
-

n

-
-
$name
-
in file account.inc, variable samba3domain::$name
    Domain name
-
$nextGroupRID
-
in file account.inc, variable samba3domain::$nextGroupRID
    Next group RID
-
$nextRID
-
in file account.inc, variable samba3domain::$nextRID
    Next RID
-
$nextUserRID
-
in file account.inc, variable samba3domain::$nextUserRID
    Next user RID
-
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
-
in file nisMailAlias.inc, class nisMailAlias
    Provides NIS mail alias management.
-
nthash
-
in file createntlm.inc, method smbHash::nthash()
    Calculates the NT hash of a given password.
-
-
- top
-
- -
-

o

-
-
$OBJECT_CLASS_NAME
-
in file groupOfUniqueNames.inc, variable groupOfUniqueNames::$OBJECT_CLASS_NAME
    name of managed object class
-
$OBJECT_CLASS_NAME
-
in file groupOfNames.inc, variable groupOfNames::$OBJECT_CLASS_NAME
    name of managed object class
-
$orig
-
in file baseModule.inc, variable baseModule::$orig
    contains all ldap attributes which are loaded from ldap
-
-
- top
-
- -
-

p

-
-
$perm1
-
in file createntlm.inc, variable smbHash::$perm1
-
$perm2
-
in file createntlm.inc, variable smbHash::$perm2
-
$perm3
-
in file createntlm.inc, variable smbHash::$perm3
-
$perm4
-
in file createntlm.inc, variable smbHash::$perm4
-
$perm5
-
in file createntlm.inc, variable smbHash::$perm5
-
$perm6
-
in file createntlm.inc, variable smbHash::$perm6
-
posixAccount.inc
-
procedural page posixAccount.inc
-
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.
-
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 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 quota.inc, method quota::preDeleteActions()
    Allows the module to run commands before the LDAP entry is deleted.
-
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.
-
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 groupOfNames.inc, method groupOfNames::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 quota.inc, method quota::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 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 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 posixGroup.inc, method posixGroup::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 account.inc, method account::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 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.
-
process_attributes
-
in file nisMailAlias.inc, method nisMailAlias::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
-
in file shadowAccount.inc, method shadowAccount::process_expire()
    Processes user input of the expiration page.
-
process_group
-
in file posixAccount.inc, method posixAccount::process_group()
    Processes user input of the group selection page.
-
process_logonHours
-
in file sambaSamAccount.inc, method sambaSamAccount::process_logonHours()
    Processes user input of the logon hours page.
-
process_members
-
in file groupOfNames.inc, method groupOfNames::process_members()
    Processes user input of the members page.
-
process_owner
-
in file groupOfNames.inc, method groupOfNames::process_owner()
    Processes user input of the owner page.
-
process_password
-
in file posixGroup.inc, method posixGroup::process_password()
    Processes user input of the password page.
-
process_password
-
in file posixAccount.inc, method posixAccount::process_password()
    Processes user input of the password page.
-
process_password
-
in file inetOrgPerson.inc, method inetOrgPerson::process_password()
    Sets a new password.
-
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
-
in file posixGroup.inc, method posixGroup::process_user()
    Processes user input of the user selection page.
-
process_userWorkstations
-
in file sambaAccount.inc, method sambaAccount::process_userWorkstations()
    Processes user input of the workstation selection page.
-
-
- top
-
- -
-

q

-
-
quota.inc
-
procedural page quota.inc
-
quota
-
in file quota.inc, class quota
    Manages quotas for users and groups.
-
-
- top
-
- -
-

r

-
-
$rdn
-
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
-
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
-
- -
-

s

-
-
$sbox
-
in file createntlm.inc, variable smbHash::$sbox
-
$sc
-
in file createntlm.inc, variable smbHash::$sc
-
$selfServiceSettings
-
in file baseModule.inc, variable baseModule::$selfServiceSettings
    self service settings of all modules
-
$SID
-
in file account.inc, variable samba3domain::$SID
    Domain SID
-
sambaAccount.inc
-
procedural page sambaAccount.inc
-
sambaDomain.inc
-
procedural page sambaDomain.inc
-
sambaGroupMapping.inc
-
procedural page sambaGroupMapping.inc
-
sambaMungedDial.inc
-
procedural page sambaMungedDial.inc
-
sambaSamAccount.inc
-
procedural page sambaSamAccount.inc
-
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.
-
sambaDomain
-
in file sambaDomain.inc, class sambaDomain
    Manages Samba 3 domain entries.
-
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.
-
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 sambaGroupMapping.inc, method sambaGroupMapping::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()
    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 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()
    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.
-
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 nisMailAlias.inc, method nisMailAlias::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_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()
    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()
    str_to_key
-
-
- top
-
- -
-

t

-
-
to8bit
-
in file sambaMungedDial.inc, method sambaMungedDial::to8bit()
    to8bit
-
-
- top
-
- -
-

u

-
-
unsigned_shift_r
-
in file createntlm.inc, method smbHash::unsigned_shift_r()
    Unsigned shift operation for 32bit values.
-
-
- top
-
- -
-

x

-
-
x
-
in file createntlm.inc, method smbHash::x()
    Fixes too large numbers
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_profiles.html b/lam-web/developers/phpdoc/elementindex_profiles.html deleted file mode 100644 index 21c30c74..00000000 --- a/lam-web/developers/phpdoc/elementindex_profiles.html +++ /dev/null @@ -1,139 +0,0 @@ - - -Package profiles Element Index - - - - - - - - - - - - - -
profiles
- - - [ class tree: profiles ] - [ index: profiles ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package profiles

- [ d ] - [ g ] - [ l ] - [ p ] - [ s ] - -
- -
-

d

-
-
delAccountProfile
-
in file profiles.inc, function delAccountProfile()
    Deletes an account profile
-
-
- top
-
- -
-

g

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

l

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

p

-
-
profiles.inc
-
procedural page profiles.inc
-
profiledelete.php
-
procedural page profiledelete.php
-
profilemain.php
-
procedural page profilemain.php
-
profilepage.php
-
procedural page profilepage.php
-
-
- top
-
- -
-

s

-
-
saveAccountProfile
-
in file profiles.inc, function saveAccountProfile()
    Saves an hash array (attribute => value) to an account profile
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_selfService.html b/lam-web/developers/phpdoc/elementindex_selfService.html deleted file mode 100644 index 8009ba5c..00000000 --- a/lam-web/developers/phpdoc/elementindex_selfService.html +++ /dev/null @@ -1,224 +0,0 @@ - - -Package selfService Element Index - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package selfService

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

_

-
-
__construct
-
in file selfService.inc, method selfServiceProfile::__construct()
    Constructor
-
-
- top
-
- -
-

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.
-
checkSelfServiceSettings
-
in file selfService.inc, function checkSelfServiceSettings()
    Checks if the self service settings are valid
-
-
- top
-
- -
-

g

-
-
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.
-
getSelfServiceProfiles
-
in file selfService.inc, function getSelfServiceProfiles()
    Returns a list of all available self service profiles (without .conf)
-
getSelfServiceSearchAttributes
-
in file selfService.inc, function getSelfServiceSearchAttributes()
    Returns a list of possible search attributes for the self service.
-
getSelfServiceSettings
-
in file selfService.inc, function getSelfServiceSettings()
    Returns a hash array (module name => elements) of all module options for the configuration page.
-
-
- top
-
- -
-

i

-
-
$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.
-
-
- top
-
- -
-

l

-
-
$LDAPPassword
-
in file selfService.inc, variable selfServiceProfile::$LDAPPassword
    LDAP password
-
$LDAPSuffix
-
in file selfService.inc, variable selfServiceProfile::$LDAPSuffix
    LDAP suffix
-
$LDAPUser
-
in file selfService.inc, variable selfServiceProfile::$LDAPUser
    LDAP user DN
-
$loginAttributeText
-
in file selfService.inc, variable selfServiceProfile::$loginAttributeText
    describing text for search attribute
-
$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.
-
-
- top
-
- -
-

m

-
-
$mainPageText
-
in file selfService.inc, variable selfServiceProfile::$mainPageText
    describing text for self service main page
-
$moduleSettings
-
in file selfService.inc, variable selfServiceProfile::$moduleSettings
    configuration settings of modules
-
-
- top
-
- -
-

p

-
-
profManage.php
-
procedural page profManage.php
-
-
- top
-
- -
-

s

-
-
$searchAttribute
-
in file selfService.inc, variable selfServiceProfile::$searchAttribute
    LDAP search attribute
-
$serverURL
-
in file selfService.inc, variable selfServiceProfile::$serverURL
    server address
-
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.
-
selfServiceLogin.php
-
procedural page selfServiceLogin.php
-
selfServiceMain.php
-
procedural page selfServiceMain.php
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_tests.html b/lam-web/developers/phpdoc/elementindex_tests.html deleted file mode 100644 index d46827a8..00000000 --- a/lam-web/developers/phpdoc/elementindex_tests.html +++ /dev/null @@ -1,100 +0,0 @@ - - -Package tests Element Index - - - - - - - - - - - - - -
tests
- - - [ class tree: tests ] - [ index: tests ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package tests

- [ c ] - [ s ] - -
- -
-

c

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

s

-
-
status-test.php
-
procedural page status-test.php
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_tools.html b/lam-web/developers/phpdoc/elementindex_tools.html deleted file mode 100644 index c252dd53..00000000 --- a/lam-web/developers/phpdoc/elementindex_tools.html +++ /dev/null @@ -1,452 +0,0 @@ - - -Package tools Element Index - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package tools

- [ a ] - [ b ] - [ c ] - [ d ] - [ e ] - [ g ] - [ h ] - [ i ] - [ l ] - [ m ] - [ n ] - [ o ] - [ p ] - [ q ] - [ r ] - [ s ] - [ t ] - [ v ] - -
- -
-

a

-
-
$attributes
-
in file export.inc, variable PlaLdapExporter::$attributes
-
-
- top
-
- -
-

b

-
-
$base_dn
-
in file export.inc, variable LdapExportInfo::$base_dn
-
$br
-
in file export.inc, variable PlaExporter::$br
-
-
- top
-
- -
-

c

-
-
$counter
-
in file export.inc, variable PlaDsmlExporter::$counter
-
$counter
-
in file export.inc, variable PlaLdifExporter::$counter
-
checkSchemaForModule
-
in file schemaTest.php, function checkSchemaForModule()
    Checks if the object classes and attributes for this module are available.
-
-
- top
-
- -
-

d

-
-
$deliveryAddress
-
in file export.inc, variable PlaVcardExporter::$deliveryAddress
-
$description
-
in file tools.php, variable LAMTool::$description
    description text
-
displayExportInfo
-
in file export.inc, method PlaLdifExporter::displayExportInfo()
-
display_main
-
in file ou_edit.php, function display_main()
-
-
- top
-
- -
-

e

-
-
$entry_array
-
in file export.inc, variable PlaLdapExporter::$entry_array
-
$entry_id
-
in file export.inc, variable PlaLdapExporter::$entry_id
-
$escapeCode
-
in file export.inc, variable PlaCSVExporter::$escapeCode
-
$exporter
-
in file export.inc, variable PlaExporter::$exporter
-
export
-
in file export.inc, method PlaLdifExporter::export()
    Export entries to ldif format
-
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 MyCustomExporter::export()
    When doing an exporter, the method export need to be overriden.
-
export
-
in file export.inc, method PlaCSVExporter::export()
-
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.
-
export.inc
-
procedural page export.inc
-
-
- top
-
- -
-

g

-
-
getRecursiveAttributesFromObjectClass
-
in file schemaTest.php, function getRecursiveAttributesFromObjectClass()
    Returns the names of all attributes which are managed by the given object class and its parents.
-
get_user_agent_string
-
in file export.inc, function get_user_agent_string()
    Gets the USER_AGENT string from the $_SERVER array, all in lower case in an E_NOTICE safe manner.
-
-
- top
-
- -
-

h

-
-
$hasNext
-
in file export.inc, variable PlaLdapExporter::$hasNext
-
-
- top
-
- -
-

i

-
-
$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.
-
is_browser_os_unix
-
in file export.inc, function is_browser_os_unix()
    Determines whether the browser's operating system is UNIX (or something like UNIX).
-
is_browser_os_windows
-
in file export.inc, function is_browser_os_windows()
    Determines whether the browser's operating system is Windows.
-
is_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
-
-
- top
-
- -
-

l

-
-
$ldap_info
-
in file export.inc, variable PlaLdapExporter::$ldap_info
-
$link
-
in file tools.php, variable LAMTool::$link
    link to tool page (relative to templates/)
-
lamTestLamdaemon
-
in file lamdaemonTest.php, function lamTestLamdaemon()
    Runs a test case of lamdaemon.
-
LAMTool
-
in file tools.php, class LAMTool
    Represents a tool.
-
LdapEscape
-
in file export.inc, method PlaCSVExporter::LdapEscape()
-
LdapExportInfo
-
in file export.inc, class LdapExportInfo
    This class encapsulate informations about the ldap server from which the export is done.
-
LdapExportInfo
-
in file export.inc, method LdapExportInfo::LdapExportInfo()
    Create a new LdapExportInfo object
-
lamdaemonTest.php
-
procedural page lamdaemonTest.php
-
-
- top
-
- -
-

m

-
-
$MAX_LDIF_LINE_LENGTH
-
in file export.inc, variable PlaLdifExporter::$MAX_LDIF_LINE_LENGTH
-
$multivalue_separator
-
in file export.inc, variable PlaCSVExporter::$multivalue_separator
-
multi_lines_display
-
in file export.inc, method PlaLdifExporter::multi_lines_display()
    Helper method to wrap ldif lines
-
MyCustomExporter
-
in file export.inc, class MyCustomExporter
-
MyCutsomExporter
-
in file export.inc, method MyCustomExporter::MyCutsomExporter()
-
massBuildAccounts.php
-
procedural page massBuildAccounts.php
-
masscreate.php
-
procedural page masscreate.php
-
massDoUpload.php
-
procedural page massDoUpload.php
-
-
- top
-
- -
-

n

-
-
$name
-
in file tools.php, variable LAMTool::$name
    name of the tool
-
$num_entries
-
in file export.inc, variable PlaLdapExporter::$num_entries
-
-
- top
-
- -
-

o

-
-
ou_edit.php
-
procedural page ou_edit.php
-
-
- top
-
- -
-

p

-
-
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()
-
PlaDsmlExporter
-
in file export.inc, method PlaDsmlExporter::PlaDsmlExporter()
    Create a PlaDsmlExporter object
-
PlaDsmlExporter
-
in file export.inc, class PlaDsmlExporter
    Export entries to DSML v.1
-
PlaExporter
-
in file export.inc, method PlaExporter::PlaExporter()
    Constructor
-
PlaExporter
-
in file export.inc, class PlaExporter
    PlaExporter acts a wrapper around another exporter.
-
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
-
in file export.inc, method PlaLdifExporter::PlaLdifExporter()
    Create a PlaLdifExporter object
-
PlaVcardExporter
-
in file export.inc, class PlaVcardExporter
-
PlaVcardExporter
-
in file export.inc, method PlaVcardExporter::PlaVcardExporter()
-
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_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 PlaLdapExporter::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_has_entry
-
in file export.inc, method PlaAbstractExporter::pla_has_entry()
    Return true if there is some more entries to be processed
-
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_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
-
-
- top
-
- -
-

q

-
-
$qualifier
-
in file export.inc, variable PlaCSVExporter::$qualifier
-
$queryFilter
-
in file export.inc, variable PlaLdapExporter::$queryFilter
-
$query_filter
-
in file export.inc, variable LdapExportInfo::$query_filter
-
-
- top
-
- -
-

r

-
-
$requiresPasswordChanges
-
in file tools.php, variable LAMTool::$requiresPasswordChanges
    tool requires password change rights
-
$requiresWriteAccess
-
in file tools.php, variable LAMTool::$requiresWriteAccess
    tool requires write access to LDAP
-
$results
-
in file export.inc, variable PlaLdapExporter::$results
-
-
- top
-
- -
-

s

-
-
$scope
-
in file export.inc, variable LdapExportInfo::$scope
-
$scope
-
in file export.inc, variable PlaLdapExporter::$scope
-
$separator
-
in file export.inc, variable PlaCSVExporter::$separator
    When doing an exporter, the method export need to be overriden.
-
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.
-
showMainPage
-
in file masscreate.php, function showMainPage()
    Displays the acount type specific main page of the upload.
-
schema.php
-
procedural page schema.php
-
schemaTest.php
-
procedural page schemaTest.php
-
-
- top
-
- -
-

t

-
-
tools.php
-
procedural page tools.php
-
-
- top
-
- -
-

v

-
-
$vcardMapping
-
in file export.inc, variable PlaVcardExporter::$vcardMapping
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/elementindex_types.html b/lam-web/developers/phpdoc/elementindex_types.html deleted file mode 100644 index 6e1f2760..00000000 --- a/lam-web/developers/phpdoc/elementindex_types.html +++ /dev/null @@ -1,255 +0,0 @@ - - -Package types Element Index - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package types

- [ b ] - [ g ] - [ h ] - [ m ] - [ s ] - [ t ] - [ u ] - -
- -
-

b

-
-
baseType
-
in file baseType.inc, class baseType
    This is the parent class of all account types.
-
baseType.inc
-
procedural page baseType.inc
-
-
- top
-
- -
-

g

-
-
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 host.inc, method host::getAlias()
    Returns the alias name of this account type.
-
getAlias
-
in file mailAlias.inc, method mailAlias::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 user.inc, method user::getAlias()
    Returns the alias name of this 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 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.
-
getDefaultListAttributes
-
in file mailAlias.inc, method mailAlias::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 baseType.inc, method baseType::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDescription
-
in file mailAlias.inc, method mailAlias::getDescription()
    Returns the description of this account type.
-
getDescription
-
in file baseType.inc, method baseType::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 smbDomain.inc, method smbDomain::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 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.
-
getListAttributeDescriptions
-
in file group.inc, method group::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 smbDomain.inc, method smbDomain::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 mailAlias.inc, method mailAlias::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
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.
-
getListClassName
-
in file user.inc, method user::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.
-
getListClassName
-
in file smbDomain.inc, method smbDomain::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 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.
-
getTypeDescription
-
in file types.inc, function getTypeDescription()
    Returns the description of an account type.
-
getTypes
-
in file types.inc, function getTypes()
    Returns a list of available account types.
-
group
-
in file group.inc, class group
    The account type for group accounts (e.g. Unix and Samba).
-
group.inc
-
procedural page group.inc
-
-
- top
-
- -
-

h

-
-
host
-
in file host.inc, class host
    The account type for host accounts (e.g. Samba).
-
host.inc
-
procedural page host.inc
-
-
- top
-
- -
-

m

-
-
mailAlias.inc
-
procedural page mailAlias.inc
-
mailAlias
-
in file mailAlias.inc, class mailAlias
    The account type for mail aliases.
-
-
- top
-
- -
-

s

-
-
smbDomain.inc
-
procedural page smbDomain.inc
-
smbDomain
-
in file smbDomain.inc, class smbDomain
    The account type for Samba domains.
-
-
- top
-
- -
-

t

-
-
types.inc
-
procedural page types.inc
-
-
- top
-
- -
-

u

-
-
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).
-
-
- top
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/errors.html b/lam-web/developers/phpdoc/errors.html deleted file mode 100644 index beac62c0..00000000 --- a/lam-web/developers/phpdoc/errors.html +++ /dev/null @@ -1,175 +0,0 @@ - - -phpDocumentor Parser Errors and Warnings - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -Post-parsing
-fpdf.php
-schema.inc
-ufpdf.php
- -

export.inc

-

Warnings:


-Warning on line 445 - Method "displayExportInfo" has no method-level DocBlock.
-Warning on line 590 - Method "PlaVcardExporter" has no method-level DocBlock.
-Warning on line 687 - Method "PlaCSVExporter" has no method-level DocBlock.
-Warning on line 775 - Method "export" has no method-level DocBlock.
-Warning on line 781 - Method "LdapEscape" has no method-level DocBlock.
-Warning on line 795 - Method "MyCutsomExporter" has no method-level DocBlock.
- -

fpdf.php

-

Warnings:


-Warning on line 202 - Method "SetMargins" has no method-level DocBlock.
-Warning on line 210 - Method "SetLeftMargin" has no method-level DocBlock.
-Warning on line 216 - Method "SetTopMargin" has no method-level DocBlock.
-Warning on line 222 - Method "SetRightMargin" has no method-level DocBlock.
-Warning on line 230 - Method "SetAutoPageBreak" has no method-level DocBlock.
-Warning on line 243 - Method "SetDisplayMode" has no method-level DocBlock.
-Warning on line 252 - Method "SetCompression" has no method-level DocBlock.
-Warning on line 258 - Method "SetTitle" has no method-level DocBlock.
-Warning on line 264 - Method "SetSubject" has no method-level DocBlock.
-Warning on line 270 - Method "SetAuthor" has no method-level DocBlock.
-Warning on line 276 - Method "SetKeywords" has no method-level DocBlock.
-Warning on line 282 - Method "SetCreator" has no method-level DocBlock.
-Warning on line 288 - Method "AliasNbPages" has no method-level DocBlock.
-Warning on line 294 - Method "Error" has no method-level DocBlock.
-Warning on line 300 - Method "Open" has no method-level DocBlock.
-Warning on line 317 - Method "Close" has no method-level DocBlock.
-Warning on line 384 - Method "AddPage" has no method-level DocBlock.
-Warning on line 389 - Method "Header" has no method-level DocBlock.
-Warning on line 394 - Method "Footer" has no method-level DocBlock.
-Warning on line 400 - Method "PageNo" has no method-level DocBlock.
-Warning on line 411 - Method "SetDrawColor" has no method-level DocBlock.
-Warning on line 423 - Method "SetFillColor" has no method-level DocBlock.
-Warning on line 433 - Method "SetTextColor" has no method-level DocBlock.
-Warning on line 445 - Method "GetStringWidth" has no method-level DocBlock.
-Warning on line 453 - Method "SetLineWidth" has no method-level DocBlock.
-Warning on line 459 - Method "Line" has no method-level DocBlock.
-Warning on line 471 - Method "Rect" has no method-level DocBlock.
-Warning on line 519 - Method "AddFont" has no method-level DocBlock.
-Warning on line 579 - Method "SetFont" has no method-level DocBlock.
-Warning on line 590 - Method "SetFontSize" has no method-level DocBlock.
-Warning on line 598 - Method "AddLink" has no method-level DocBlock.
-Warning on line 608 - Method "SetLink" has no method-level DocBlock.
-Warning on line 614 - Method "Link" has no method-level DocBlock.
-Warning on line 625 - Method "Text" has no method-level DocBlock.
-Warning on line 631 - Method "AcceptPageBreak" has no method-level DocBlock.
-Warning on line 710 - Method "Cell" has no method-level DocBlock.
-Warning on line 823 - Method "MultiCell" has no method-level DocBlock.
-Warning on line 904 - Method "Write" has no method-level DocBlock.
-Warning on line 954 - Method "Image" has no method-level DocBlock.
-Warning on line 964 - Method "Ln" has no method-level DocBlock.
-Warning on line 970 - Method "GetX" has no method-level DocBlock.
-Warning on line 979 - Method "SetX" has no method-level DocBlock.
-Warning on line 985 - Method "GetY" has no method-level DocBlock.
-Warning on line 995 - Method "SetY" has no method-level DocBlock.
-Warning on line 1002 - Method "SetXY" has no method-level DocBlock.
-Warning on line 1070 - Method "Output" has no method-level DocBlock.
-Warning on line 1092 - Method "_getfontpath" has no method-level DocBlock.
-Warning on line 1163 - Method "_putpages" has no method-level DocBlock.
-Warning on line 1280 - Method "_putfonts" has no method-level DocBlock.
-Warning on line 1328 - Method "_putimages" has no method-level DocBlock.
-Warning on line 1334 - Method "_putxobjectdict" has no method-level DocBlock.
-Warning on line 1346 - Method "_putresourcedict" has no method-level DocBlock.
-Warning on line 1359 - Method "_putresources" has no method-level DocBlock.
-Warning on line 1375 - Method "_putinfo" has no method-level DocBlock.
-Warning on line 1395 - Method "_putcatalog" has no method-level DocBlock.
-Warning on line 1400 - Method "_putheader" has no method-level DocBlock.
-Warning on line 1407 - Method "_puttrailer" has no method-level DocBlock.
-Warning on line 1442 - Method "_enddoc" has no method-level DocBlock.
-Warning on line 1481 - Method "_beginpage" has no method-level DocBlock.
-Warning on line 1487 - Method "_endpage" has no method-level DocBlock.
-Warning on line 1495 - Method "_newobj" has no method-level DocBlock.
-Warning on line 1504 - Method "_dounderline" has no method-level DocBlock.
-Warning on line 1528 - Method "_parsejpg" has no method-level DocBlock.
-Warning on line 1611 - Method "_parsepng" has no method-level DocBlock.
-Warning on line 1618 - Method "_freadint" has no method-level DocBlock.
-Warning on line 1624 - Method "_textstring" has no method-level DocBlock.
-Warning on line 1630 - Method "_escape" has no method-level DocBlock.
-Warning on line 1637 - Method "_putstream" has no method-level DocBlock.
-Warning on line 1646 - Method "_out" has no method-level DocBlock.
- -

schema.inc

-

Warnings:


-Warning on line 67 - Method "setOID" has no method-level DocBlock.
-Warning on line 72 - Method "setDescription" has no method-level DocBlock.
-Warning on line 77 - Method "getOID" has no method-level DocBlock.
-Warning on line 82 - Method "getDescription" has no method-level DocBlock.
-Warning on line 1232 - Method "MatchingRuleUse" has no method-level DocBlock.
- -

ufpdf.php

-

Warnings:


-Warning on line 70 - Method "GetStringWidth" has no method-level DocBlock.
-Warning on line 99 - Method "AddFont" has no method-level DocBlock.
-Warning on line 110 - Method "Text" has no method-level DocBlock.
-Warning on line 116 - Method "AcceptPageBreak" has no method-level DocBlock.
-Warning on line 196 - Method "Cell" has no method-level DocBlock.
-Warning on line 321 - Method "MultiCell" has no method-level DocBlock.
-Warning on line 404 - Method "Write" has no method-level DocBlock.
-Warning on line 410 - Method "AliasNbPages" has no method-level DocBlock.
-Warning on line 487 - Method "_dounderline" has no method-level DocBlock.
-Warning on line 495 - Method "_textstring" has no method-level DocBlock.
-Warning on line 503 - Method "_escapetext" has no method-level DocBlock.
-Warning on line 519 - Method "_putinfo" has no method-level DocBlock.
-Warning on line 592 - Method "_putpages" has no method-level DocBlock.
-Warning on line 694 - Method "utf8_to_utf16be" has no method-level DocBlock.
-Warning on line 702 - Method "code2utf" has no method-level DocBlock.
-Warning on line 706 - Method "strlen" has no method-level DocBlock.
-Warning on line 721 - Method "utf8_substr" has no method-level DocBlock.
-Warning on line 813 - Method "utf8_to_codepoints" has no method-level DocBlock.
-
-
- Documentation generated on Sun, 06 Jan 2008 18:59:37 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/index.html b/lam-web/developers/phpdoc/index.html deleted file mode 100644 index 03b85a46..00000000 --- a/lam-web/developers/phpdoc/index.html +++ /dev/null @@ -1,65 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
default
- - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to default!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_Help.html b/lam-web/developers/phpdoc/li_Help.html deleted file mode 100644 index 708a4305..00000000 --- a/lam-web/developers/phpdoc/li_Help.html +++ /dev/null @@ -1,76 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
Help
- - - [ class tree: Help ] - [ index: Help ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to Help!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_LDAP.html b/lam-web/developers/phpdoc/li_LDAP.html deleted file mode 100644 index 12637b2e..00000000 --- a/lam-web/developers/phpdoc/li_LDAP.html +++ /dev/null @@ -1,79 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
LDAP
- - - [ class tree: LDAP ] - [ index: LDAP ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to LDAP!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_PDF.html b/lam-web/developers/phpdoc/li_PDF.html deleted file mode 100644 index 12ee7200..00000000 --- a/lam-web/developers/phpdoc/li_PDF.html +++ /dev/null @@ -1,106 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to PDF!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_configuration.html b/lam-web/developers/phpdoc/li_configuration.html deleted file mode 100644 index 9f77941b..00000000 --- a/lam-web/developers/phpdoc/li_configuration.html +++ /dev/null @@ -1,96 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to configuration!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_lib.html b/lam-web/developers/phpdoc/li_lib.html deleted file mode 100644 index 919396cf..00000000 --- a/lam-web/developers/phpdoc/li_lib.html +++ /dev/null @@ -1,94 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to lib!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_lists.html b/lam-web/developers/phpdoc/li_lists.html deleted file mode 100644 index 39de8928..00000000 --- a/lam-web/developers/phpdoc/li_lists.html +++ /dev/null @@ -1,154 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to lists!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_main.html b/lam-web/developers/phpdoc/li_main.html deleted file mode 100644 index 43dfcd84..00000000 --- a/lam-web/developers/phpdoc/li_main.html +++ /dev/null @@ -1,84 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
main
- - - [ class tree: main ] - [ index: main ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to main!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_modules.html b/lam-web/developers/phpdoc/li_modules.html deleted file mode 100644 index b4ba1f82..00000000 --- a/lam-web/developers/phpdoc/li_modules.html +++ /dev/null @@ -1,144 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to modules!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_profiles.html b/lam-web/developers/phpdoc/li_profiles.html deleted file mode 100644 index cc3c94e2..00000000 --- a/lam-web/developers/phpdoc/li_profiles.html +++ /dev/null @@ -1,80 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
profiles
- - - [ class tree: profiles ] - [ index: profiles ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to profiles!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_selfService.html b/lam-web/developers/phpdoc/li_selfService.html deleted file mode 100644 index 069dde9e..00000000 --- a/lam-web/developers/phpdoc/li_selfService.html +++ /dev/null @@ -1,89 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to selfService!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_tests.html b/lam-web/developers/phpdoc/li_tests.html deleted file mode 100644 index 22fe25e2..00000000 --- a/lam-web/developers/phpdoc/li_tests.html +++ /dev/null @@ -1,78 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
tests
- - - [ class tree: tests ] - [ index: tests ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to tests!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_tools.html b/lam-web/developers/phpdoc/li_tools.html deleted file mode 100644 index 8591d805..00000000 --- a/lam-web/developers/phpdoc/li_tools.html +++ /dev/null @@ -1,106 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to tools!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/li_types.html b/lam-web/developers/phpdoc/li_types.html deleted file mode 100644 index a2b06709..00000000 --- a/lam-web/developers/phpdoc/li_types.html +++ /dev/null @@ -1,96 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to types!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/AttributeType.html b/lam-web/developers/phpdoc/lib/AttributeType.html deleted file mode 100644 index 83720ac5..00000000 --- a/lam-web/developers/phpdoc/lib/AttributeType.html +++ /dev/null @@ -1,1199 +0,0 @@ - - -Docs For Class AttributeType - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: AttributeType

-Source Location: /lib/schema.inc

- - - - - - - - - - -
- -

Class Overview

-
SchemaItem
-   |
-   --AttributeType

-
Represents an LDAP AttributeType


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: SchemaItem

-
-
- SchemaItem::$description -
-
- -
-
- SchemaItem::$oid -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: SchemaItem

-
-
- SchemaItem::SchemaItem() -
-
- Default constructor. -
-
- SchemaItem::getDescription() -
-
- -
-
- SchemaItem::getOID() -
-
- -
-
- SchemaItem::initVars() -
-
- Initialize class members to default values. -
-
- SchemaItem::setDescription() -
-
- -
-
- SchemaItem::setOID() -
-
- -
-
-
-
-
- - -

Class Details

-
-[line 514]
-Represents an LDAP AttributeType



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$aliases =

-

[line 539]

- An array of alias attribute names, strings

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


-
[ Top ]

- -

-

$equality =

-

[line 523]

- The equality rule used

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


-
[ Top ]

- -

-

$is_collective =

-

[line 533]

- boolean: is collective?

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


-
[ Top ]

- -

-

$is_no_user_modification =

-

[line 535]

- boolean: can use modify?

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


-
[ Top ]

- -

-

$is_obsolete =

-

[line 519]

- string: the description

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


-
[ Top ]

- -

-

$is_single_value =

-

[line 531]

- boolean: is single valued only?

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


-
[ Top ]

- -

-

$max_length =

-

[line 541]

- The max number of characters this attribute can be

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


-
[ Top ]

- -

-

$name =

-

[line 517]

- The name of this attributeType

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


-
[ Top ]

- -

-

$ordering =

-

[line 525]

- The ordering of the attributeType

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


-
[ Top ]

- -

-

$required_by_object_classes = array()

-

[line 547]

- A list of object class names that require this attribute type.

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


-
[ Top ]

- -

-

$sub_str =

-

[line 527]

- Boolean: supports substring matching?

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


-
[ Top ]

- -

-

$sup_attribute =

-

[line 521]

- The attribute from which this attribute inherits (if any)

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


-
[ Top ]

- -

-

$syntax =

-

[line 529]

- The full syntax string, ie 1.2.3.4{16}

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


-
[ Top ]

- -

-

$type =

-

[line 543]

- A string description of the syntax type (taken from the LDAPSyntaxes)

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


-
[ Top ]

- -

-

$usage =

-

[line 537]

- The usage string set by the LDAP schema

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


-
[ Top ]

- -

-

$used_in_object_classes =

-

[line 545]

- An array of objectClasses which use this attributeType (must be set by caller)

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor AttributeType [line 579]

-
-
-
- AttributeType AttributeType( - -$raw_ldap_attr_string) -
-

- - Creates a new AttributeType objcet from a raw LDAP AttributeType string.



- - -

Parameters:

-
- - - - - - -
  $raw_ldap_attr_string  
-

-
[ Top ]
-
-
- -

method addAlias [line 878]

-
-
-
- void addAlias( -string -$new_alias_name) -
-

- - Adds an attribute name to the alias array.



- - -

Parameters:

-
- - - - - - -
string  $new_alias_name  The name of a new attribute to add to this attribute's list of aliases.
-

-
[ Top ]
-
-
- -

method addRequiredByObjectClass [line 948]

-
-
-
- void addRequiredByObjectClass( -string -$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:

-
- - - - - - -
string  $object_class_name  The name of the objectClass to add.
-

-
[ Top ]
-
-
- -

method addUsedInObjectClass [line 924]

-
-
-
- void addUsedInObjectClass( -string -$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:

-
- - - - - - -
string  $object_class_name  The name of the objectClass to add.
-

-
[ Top ]
-
-
- -

method getAliases [line 761]

-
-
-
- array getAliases( -) -
-

- - Gets the names of attributes that are an alias for this attribute (if any).



-

Tags:

-
- - - - -
return:  An array of names of attributes which alias this attribute or an empty array if no attribute aliases this object.
-
-

- - -
[ Top ]
-
-
- -

method getEquality [line 733]

-
-
-
- string getEquality( -) -
-

- - Gets this attribute's equality string



- - -
[ Top ]
-
-
- -

method getIsCollective [line 833]

-
-
-
- bool getIsCollective( -) -
-

- - Gets whether this attribute is collective.



-

Tags:

-
- - - - -
return:  Returns true if this attribute is collective and false otherwise.
-
-

- - -
[ Top ]
-
-
- -

method getIsNoUserModification [line 842]

-
-
-
- bool getIsNoUserModification( -) -
-

- - Gets whether this attribute is not modifiable by users.



-

Tags:

-
- - - - -
return:  Returns true if this attribute is not modifiable by users.
-
-

- - -
[ Top ]
-
-
- -

method getIsObsolete [line 705]

-
-
-
- bool getIsObsolete( -) -
-

- - Gets whether this attribute has been flagged as obsolete by the LDAP server



- - -
[ Top ]
-
-
- -

method getIsSingleValue [line 815]

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



-

Tags:

-
- - - - -
return:  Returns true if this attribute is single-valued or false otherwise.
-
-

- - -
[ Top ]
-
-
- -

method getMaxLength [line 805]

-
-
-
- int getMaxLength( -) -
-

- - Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.



-

Tags:

-
- - - - -
return:  The maximum length (in characters) of this attribute or null if no maximum is specified.
-
-

- - -
[ Top ]
-
-
- -

method getName [line 696]

-
-
-
- string getName( -) -
-

- - Gets this attribute's name



- - -
[ Top ]
-
-
- -

method getOrdering [line 742]

-
-
-
- string getOrdering( -) -
-

- - Gets this attribute's ordering specification.



- - -
[ Top ]
-
-
- -

method getRequiredByObjectClasses [line 962]

-
-
-
- array getRequiredByObjectClasses( -) -
-

- - Gets the list of "required by" objectClasses, that is the list of objectClasses which provide must have attribute.



-

Tags:

-
- - - - -
return:  An array of names of objectclasses (strings) which provide this attribute
-
-

- - -
[ Top ]
-
-
- -

method getSubstr [line 751]

-
-
-
- string getSubstr( -) -
-

- - Gets this attribute's substring matching specification



- - -
[ Top ]
-
-
- -

method getSupAttribute [line 724]

-
-
-
- string getSupAttribute( -) -
-

- - Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.



- - -
[ Top ]
-
-
- -

method getSyntaxOID [line 796]

-
-
-
- string getSyntaxOID( -) -
-

- - Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.

Ie, if the syntax string is "1.2.3.4{16}", this function only retruns "1.2.3.4".




-

Tags:

-
- - - - -
return:  The syntax OID string.
-
-

- - -
[ Top ]
-
-
- -

method getSyntaxString [line 784]

-
-
-
- string getSyntaxString( -) -
-

- - Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").



-

Tags:

-
- - - - -
return:  The raw syntax string
-
-

- - -
[ Top ]
-
-
- -

method getType [line 851]

-
-
-
- string getType( -) -
-

- - Gets this attribute's type



-

Tags:

-
- - - - -
return:  The attribute's type.
-
-

- - -
[ Top ]
-
-
- -

method getUsage [line 714]

-
-
-
- string getUsage( -) -
-

- - Gets this attribute's usage string as defined by the LDAP server



- - -
[ Top ]
-
-
- -

method getUsedInObjectClasses [line 938]

-
-
-
- array getUsedInObjectClasses( -) -
-

- - Gets the list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.



-

Tags:

-
- - - - -
return:  An array of names of objectclasses (strings) which provide this attribute
-
-

- - -
[ Top ]
-
-
- -

method initVars [line 552]

-
-
-
- void initVars( -) -
-

- - Initialize the class' member variables



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

-
[ Top ]
-
-
- -

method isAliasFor [line 771]

-
-
-
- bool isAliasFor( -string -$attr_name) -
-

- - Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).



-

Tags:

-
- - - - -
return:  True if the specified attribute is an alias for this one, or false otherwise.
-
-

- - -

Parameters:

-
- - - - - - -
string  $attr_name  The name of the attribute to check.
-

-
[ Top ]
-
-
- -

method removeAlias [line 862]

-
-
-
- bool removeAlias( -string -$remove_alias_name) -
-

- - Removes an attribute name from this attribute's alias array.



-

Tags:

-
- - - - -
return:  true on success or false on failure (ie, if the specified attribute name is not found in this attribute's list of aliases)
-
-

- - -

Parameters:

-
- - - - - - -
string  $remove_alias_name  The name of the attribute to remove.
-

-
[ Top ]
-
-
- -

method setAliases [line 905]

-
-
-
- void setAliases( -array -$new_aliases) -
-

- - Sets this attribute's list of aliases.



- - -

Parameters:

-
- - - - - - -
array  $new_aliases  The array of alias names (strings)
-

-
[ Top ]
-
-
- -

method setIsSingleValue [line 824]

-
-
-
- void setIsSingleValue( -bool -$is_single_value) -
-

- - Sets whether this attribute is single-valued.



- - -

Parameters:

-
- - - - - - -
bool  $is_single_value  
-

-
[ Top ]
-
-
- -

method setName [line 887]

-
-
-
- void setName( -string -$new_name) -
-

- - Sets this attriute's name.



- - -

Parameters:

-
- - - - - - -
string  $new_name  The new name to give this attribute.
-

-
[ Top ]
-
-
- -

method setSupAttribute [line 896]

-
-
-
- void setSupAttribute( -string -$new_sup_attr) -
-

- - Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).



- - -

Parameters:

-
- - - - - - -
string  $new_sup_attr  The name of the new parent (SUP) attribute
-

-
[ Top ]
-
-
- -

method setType [line 914]

-
-
-
- void setType( -string -$new_type) -
-

- - Sets this attribute's type.



- - -

Parameters:

-
- - - - - - -
string  $new_type  The new type.
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:27 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/MatchingRule.html b/lam-web/developers/phpdoc/lib/MatchingRule.html deleted file mode 100644 index d422e44d..00000000 --- a/lam-web/developers/phpdoc/lib/MatchingRule.html +++ /dev/null @@ -1,473 +0,0 @@ - - -Docs For Class MatchingRule - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: MatchingRule

-Source Location: /lib/schema.inc

- - - - - - - - - - -
- -

Class Overview

-
SchemaItem
-   |
-   --MatchingRule

-
Represents an LDAP MatchingRule


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: SchemaItem

-
-
- SchemaItem::$description -
-
- -
-
- SchemaItem::$oid -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: SchemaItem

-
-
- SchemaItem::SchemaItem() -
-
- Default constructor. -
-
- SchemaItem::getDescription() -
-
- -
-
- SchemaItem::getOID() -
-
- -
-
- SchemaItem::initVars() -
-
- Initialize class members to default values. -
-
- SchemaItem::setDescription() -
-
- -
-
- SchemaItem::setOID() -
-
- -
-
-
-
-
- - -

Class Details

-
-[line 1019]
-Represents an LDAP MatchingRule



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$is_obsolete =

-

[line 1026]

- Boolean value indicating whether this MatchingRule is obsolete

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


-
[ Top ]

- -

-

$name =

-

[line 1022]

- This rule's name

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


-
[ Top ]

- -

-

$syntax =

-

[line 1024]

- This rule's syntax OID

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


-
[ Top ]

- -

-

$used_by_attrs =

-

[line 1028]

- An array of attribute names who use this MatchingRule

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor MatchingRule [line 1045]

-
-
-
- MatchingRule MatchingRule( - -$raw_ldap_matching_rule_string) -
-

- - Creates a new MatchingRule object from a raw LDAP MatchingRule string.



- - -

Parameters:

-
- - - - - - -
  $raw_ldap_matching_rule_string  
-

-
[ Top ]
-
-
- -

method addUsedByAttr [line 1115]

-
-
-
- true addUsedByAttr( - -$new_attr_name) -
-

- - Adds an attribute name to the list of attributes who use this MatchingRule



-

Tags:

-
- - - - -
return:  if the attribute was added and false otherwise (already in the list)
-
-

- - -

Parameters:

-
- - - - - - -
  $new_attr_name  
-

-
[ Top ]
-
-
- -

method getIsObsolete [line 1137]

-
-
-
- bool getIsObsolete( -) -
-

- - Gets whether this MatchingRule is flagged as obsolete by the LDAP server.



-

Tags:

-
- - - - -
return:  True if this MatchingRule is obsolete and false otherwise.
-
-

- - -
[ Top ]
-
-
- -

method getName [line 1128]

-
-
-
- string getName( -) -
-

- - Gets this MatchingRule's name.



-

Tags:

-
- - - - -
return:  The name.
-
-

- - -
[ Top ]
-
-
- -

method getUsedByAttrs [line 1146]

-
-
-
- array getUsedByAttrs( -) -
-

- - Gets an array of attribute names (strings) which use this MatchingRule



-

Tags:

-
- - - - -
return:  The array of attribute names (strings).
-
-

- - -
[ Top ]
-
-
- -

method initVars [line 1031]

-
-
-
- void initVars( -) -
-

- - Initialize the class' member variables



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

-
[ Top ]
-
-
- -

method setUsedByAttrs [line 1106]

-
-
-
- void setUsedByAttrs( -array -$attrs) -
-

- - Sets the list of used_by_attrs to the array specified by $attrs;



- - -

Parameters:

-
- - - - - - -
array  $attrs  The array of attribute names (strings) which use this MatchingRule
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:28 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/MatchingRuleUse.html b/lam-web/developers/phpdoc/lib/MatchingRuleUse.html deleted file mode 100644 index d08f209e..00000000 --- a/lam-web/developers/phpdoc/lib/MatchingRuleUse.html +++ /dev/null @@ -1,350 +0,0 @@ - - -Docs For Class MatchingRuleUse - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: MatchingRuleUse

-Source Location: /lib/schema.inc

- - - - - - - - - - -
- -

Class Overview

-
SchemaItem
-   |
-   --MatchingRuleUse

-
Represents an LDAP schema matchingRuleUse entry


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: SchemaItem

-
-
- SchemaItem::$description -
-
- -
-
- SchemaItem::$oid -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: SchemaItem

-
-
- SchemaItem::SchemaItem() -
-
- Default constructor. -
-
- SchemaItem::getDescription() -
-
- -
-
- SchemaItem::getOID() -
-
- -
-
- SchemaItem::initVars() -
-
- Initialize class members to default values. -
-
- SchemaItem::setDescription() -
-
- -
-
- SchemaItem::setOID() -
-
- -
-
-
-
-
- - -

Class Details

-
-[line 1157]
-Represents an LDAP schema matchingRuleUse entry



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$name =

-

[line 1160]

- The name of the MathingRule this applies to

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


-
[ Top ]

- -

-

$used_by_attrs =

-

[line 1163]

- An array of attributeType names who make use of the mathingRule

identified by $this->oid and $this->name


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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor MatchingRuleUse [line 1174]

-
-
-
- MatchingRuleUse MatchingRuleUse( - -$raw_matching_rule_use_string) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $raw_matching_rule_use_string  
-

-
[ Top ]
-
-
- -

method getName [line 1239]

-
-
-
- string getName( -) -
-

- - Gets this MatchingRuleUse's name



-

Tags:

-
- - - - -
return:  The name
-
-

- - -
[ Top ]
-
-
- -

method getUsedByAttrs [line 1248]

-
-
-
- array getUsedByAttrs( -) -
-

- - Gets an array of attribute names (strings) which use this MatchingRuleUse object.



-

Tags:

-
- - - - -
return:  The array of attribute names (strings).
-
-

- - -
[ Top ]
-
-
- -

method initVars [line 1166]

-
-
-
- void initVars( -) -
-

- - Initialize the class' member variables



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

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:29 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/ObjectClass.html b/lam-web/developers/phpdoc/lib/ObjectClass.html deleted file mode 100644 index afece7fb..00000000 --- a/lam-web/developers/phpdoc/lib/ObjectClass.html +++ /dev/null @@ -1,770 +0,0 @@ - - -Docs For Class ObjectClass - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: ObjectClass

-Source Location: /lib/schema.inc

- - - - - - - - - - -
- -

Class Overview

-
SchemaItem
-   |
-   --ObjectClass

-
Represents an LDAP objectClass


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: SchemaItem

-
-
- SchemaItem::$description -
-
- -
-
- SchemaItem::$oid -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: SchemaItem

-
-
- SchemaItem::SchemaItem() -
-
- Default constructor. -
-
- SchemaItem::getDescription() -
-
- -
-
- SchemaItem::getOID() -
-
- -
-
- SchemaItem::initVars() -
-
- Initialize class members to default values. -
-
- SchemaItem::setDescription() -
-
- -
-
- SchemaItem::setOID() -
-
- -
-
-
-
-
- - -

Class Details

-
-[line 91]
-Represents an LDAP objectClass



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$children_objectclasses =

-

[line 106]

- array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)

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


-
[ Top ]

- -

-

$is_obsolete =

-

[line 104]

- boolean value indicating whether this objectClass is obsolete

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


-
[ Top ]

- -

-

$may_attrs =

-

[line 102]

- arrays of attribute names that this objectClass allows, but does not require

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


-
[ Top ]

- -

-

$must_attrs =

-

[line 100]

- arrays of attribute names that this objectClass requires

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


-
[ Top ]

- -

-

$name =

-

[line 94]

- This objectClass' name, ie "inetOrgPerson"

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


-
[ Top ]

- -

-

$sup_classes =

-

[line 96]

- array of objectClass names from which this objectClass inherits

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


-
[ Top ]

- -

-

$type =

-

[line 98]

- one of STRUCTURAL, ABSTRACT, or AUXILIARY

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor ObjectClass [line 126]

-
-
-
- ObjectClass ObjectClass( - -$raw_ldap_schema_string) -
-

- - Creates a new ObjectClass object given a raw LDAP objectClass string.



- - -

Parameters:

-
- - - - - - -
  $raw_ldap_schema_string  
-

-
[ Top ]
-
-
- -

method addChildObjectClass [line 376]

-
-
-
- bool addChildObjectClass( -String -$object_class_name) -
-

- - Adds an objectClass to the list of objectClasses that inherit from this objectClass.



-

Tags:

-
- - - - -
return:  Returns true on success or false on failure (objectclass already existed for example)
-
-

- - -

Parameters:

-
- - - - - - -
String  $object_class_name  The name of the objectClass to add
-

-
[ Top ]
-
-
- -

method addMayAttrs [line 454]

-
-
-
- void addMayAttrs( -array -$new_may_attrs) -
-

- - Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.



- - -

Parameters:

-
- - - - - - -
array  $new_may_attrs  An array of attribute names (strings) to add.
-

-
[ Top ]
-
-
- -

method addMustAttrs [line 439]

-
-
-
- void addMustAttrs( -array -$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:

-
- - - - - - -
array  $new_must_attrs  An array of attribute names (strings) to add.
-

-
[ Top ]
-
-
- -

method getChildObjectClasses [line 392]

-
-
-
- Array getChildObjectClasses( -) -
-

- - Returns the array of objectClass names which inherit from this objectClass.



-

Tags:

-
- - - - -
return:  Names of objectClasses which inherit from this objectClass.
-
-

- - -
[ Top ]
-
-
- -

method getIsObsolete [line 427]

-
-
-
- void getIsObsolete( -) -
-

- - Gets whether this objectClass is flagged as obsolete by the LDAP server.



- - -
[ Top ]
-
-
- -

method getMayAttrNames [line 361]

-
-
-
- array getMayAttrNames( -[array -$oclasses = null]) -
-

- - Gets an array of attribute names (strings) that entries of this ObjectClass must define.

This differs from getMayAttrs in that it returns an array of strings rather than array of AttributeType objects




-

Tags:

-
- - - - - - - - - - - - - -
return:  The array of allowed attribute names (strings).
see:  ObjectClass::getMustAttrNames()
see:  ObjectClass::getMayAttrs()
see:  ObjectClass::getMustAttrs()
-
-

- - -

Parameters:

-
- - - - - - -
array  $oclasses  An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides.
-

-
[ Top ]
-
-
- -

method getMayAttrs [line 303]

-
-
-
- array getMayAttrs( -[array -$oclasses = NULL]) -
-

- - Gets an array of AttributeType objects that entries of this ObjectClass may define.

This differs from getMayAttrNames in that it returns an array of AttributeType objects




-

Tags:

-
- - - - - - - - - - - - - - - - -
return:  The array of allowed AttributeType objects.
see:  AttributeType
see:  ObjectClass::getMayAttrNames()
see:  ObjectClass::getMustAttrs()
see:  ObjectClass::getMustAttrNames()
-
-

- - -

Parameters:

-
- - - - - - -
array  $oclasses  An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides.
-

-
[ Top ]
-
-
- -

method getMustAttrNames [line 337]

-
-
-
- array getMustAttrNames( -[array -$oclasses = null]) -
-

- - Gets an array of attribute names (strings) that entries of this ObjectClass must define.

This differs from getMustAttrs in that it returns an array of strings rather than array of AttributeType objects




-

Tags:

-
- - - - - - - - - - - - - -
return:  The array of allowed attribute names (strings).
see:  ObjectClass::getMayAttrNames()
see:  ObjectClass::getMayAttrs()
see:  ObjectClass::getMustAttrs()
-
-

- - -

Parameters:

-
- - - - - - -
array  $oclasses  An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides.
-

-
[ Top ]
-
-
- -

method getMustAttrs [line 269]

-
-
-
- array getMustAttrs( -[array -$oclasses = NULL]) -
-

- - Gets an array of AttributeType objects that entries of this ObjectClass must define.

This differs from getMustAttrNames in that it returns an array of AttributeType objects




-

Tags:

-
- - - - - - - - - - - - - -
return:  The array of required AttributeType objects.
see:  ObjectClass::getMayAttrNames()
see:  ObjectClass::getMayAttrs()
see:  ObjectClass::getMustAttrNames()
-
-

- - -

Parameters:

-
- - - - - - -
array  $oclasses  An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass requires.
-

-
[ Top ]
-
-
- -

method getName [line 401]

-
-
-
- string getName( -) -
-

- - Gets the name of this objectClass (ie, "inetOrgPerson")



-

Tags:

-
- - - - -
return:  The name of the objectClass
-
-

- - -
[ Top ]
-
-
- -

method getSupClasses [line 411]

-
-
-
- array getSupClasses( -) -
-

- - Gets the objectClass names from which this objectClass inherits.



-

Tags:

-
- - - - -
return:  An array of objectClass names (strings)
-
-

- - -
[ Top ]
-
-
- -

method getType [line 419]

-
-
-
- void getType( -) -
-

- - Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.



- - -
[ Top ]
-
-
- -

method initVars [line 109]

-
-
-
- void initVars( -) -
-

- - Initialize the class' member variables



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

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:29 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/ObjectClassAttribute.html b/lam-web/developers/phpdoc/lib/ObjectClassAttribute.html deleted file mode 100644 index 04daa212..00000000 --- a/lam-web/developers/phpdoc/lib/ObjectClassAttribute.html +++ /dev/null @@ -1,255 +0,0 @@ - - -Docs For Class ObjectClassAttribute - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: ObjectClassAttribute

-Source Location: /lib/schema.inc

- - - - - - - - - - -
- -

Class Overview

-

-
A simple class for representing AttributeTypes used only by the ObjectClass class.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 476]
-A simple class for representing AttributeTypes used only by the ObjectClass class.

Users should never instantiate this class. It represents an attribute internal to an ObjectClass. If PHP supported inner-classes and variable permissions, this would be interior to class ObjectClass and flagged private. The reason this class is used and not the "real" class AttributeType is because this class supports the notion of a "source" objectClass, meaning that it keeps track of which objectClass originally specified it. This class is therefore used by the class ObjectClass to determine inheritance.




-
[ Top ]

- -
- -

Class Variables

-
- -

-

$name =

-

[line 479]

- This Attribute's name

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


-
[ Top ]

- -

-

$source =

-

[line 481]

- This Attribute's root

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor ObjectClassAttribute [line 489]

-
-
-
- ObjectClassAttribute ObjectClassAttribute( -string -$name, string -$source) -
-

- - Creates a new ObjectClassAttribute with specified name and source objectClass.



- - -

Parameters:

-
- - - - - - - - - - - -
string  $name  the name of the new attribute.
string  $source  the name of the ObjectClass which specifies this attribute.
-

-
[ Top ]
-
-
- -

method getName [line 496]

-
-
-
- void getName( -) -
-

- - Gets this attribute's name



- - -
[ Top ]
-
-
- -

method getSource [line 502]

-
-
-
- void getSource( -) -
-

- - Gets the name of the ObjectClass which originally specified this attribute.



- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:29 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/SchemaItem.html b/lam-web/developers/phpdoc/lib/SchemaItem.html deleted file mode 100644 index 9ce28613..00000000 --- a/lam-web/developers/phpdoc/lib/SchemaItem.html +++ /dev/null @@ -1,358 +0,0 @@ - - -Docs For Class SchemaItem - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: SchemaItem

-Source Location: /lib/schema.inc

- - - - - - - - - - -
- -

Class Overview

-

-
Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
ObjectClass
-
Represents an LDAP objectClass
-
-
-
AttributeType
-
Represents an LDAP AttributeType
-
-
-
Syntax
-
Represents an LDAP Syntax
-
-
-
MatchingRule
-
Represents an LDAP MatchingRule
-
-
-
MatchingRuleUse
-
Represents an LDAP schema matchingRuleUse entry
-
-
-
-
- - -

Class Details

-
-[line 45]
-Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.

All schema items have at least two things in common: An OID and a description. This class provides an implementation for these two data.




-
[ Top ]

- -
- -

Class Variables

-
- -

-

$description =

-

[line 50]

- The description of this schema item.

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


-
[ Top ]

- -

-

$oid =

-

[line 48]

- The OID of this schema item.

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor SchemaItem [line 60]

-
-
-
- SchemaItem SchemaItem( -) -
-

- - Default constructor.



- - -
[ Top ]
-
-
- -

method getDescription [line 80]

-
-
-
- void getDescription( -) -
-

- -

- - -
[ Top ]
-
-
- -

method getOID [line 75]

-
-
-
- void getOID( -) -
-

- -

- - -
[ Top ]
-
-
- -

method initVars [line 53]

-
-
-
- void initVars( -) -
-

- - Initialize class members to default values.



- -

Overridden in child classes as:
-

-
ObjectClass::initVars()
-
Initialize the class' member variables
-
-
-
AttributeType::initVars()
-
Initialize the class' member variables
-
-
-
Syntax::initVars()
-
Initializes the class' member variables
-
-
-
MatchingRule::initVars()
-
Initialize the class' member variables
-
-
-
MatchingRuleUse::initVars()
-
Initialize the class' member variables
-
-

- -
[ Top ]
-
-
- -

method setDescription [line 70]

-
-
-
- void setDescription( - -$new_desc) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $new_desc  
-

-
[ Top ]
-
-
- -

method setOID [line 65]

-
-
-
- void setOID( - -$new_oid) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $new_oid  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:29 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/Syntax.html b/lam-web/developers/phpdoc/lib/Syntax.html deleted file mode 100644 index 27d37a09..00000000 --- a/lam-web/developers/phpdoc/lib/Syntax.html +++ /dev/null @@ -1,256 +0,0 @@ - - -Docs For Class Syntax - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: Syntax

-Source Location: /lib/schema.inc

- - - - - - - - - -
- -

Class Overview

-
SchemaItem
-   |
-   --Syntax

-
Represents an LDAP Syntax


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: SchemaItem

-
-
- SchemaItem::$description -
-
- -
-
- SchemaItem::$oid -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: SchemaItem

-
-
- SchemaItem::SchemaItem() -
-
- Default constructor. -
-
- SchemaItem::getDescription() -
-
- -
-
- SchemaItem::getOID() -
-
- -
-
- SchemaItem::initVars() -
-
- Initialize class members to default values. -
-
- SchemaItem::setDescription() -
-
- -
-
- SchemaItem::setOID() -
-
- -
-
-
-
-
- - -

Class Details

-
-[line 973]
-Represents an LDAP Syntax



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor Syntax [line 986]

-
-
-
- Syntax Syntax( - -$raw_ldap_syntax_string) -
-

- - Creates a new Syntax object from a raw LDAP syntax string.



- - -

Parameters:

-
- - - - - - -
  $raw_ldap_syntax_string  
-

-
[ Top ]
-
-
- -

method initVars [line 976]

-
-
-
- void initVars( -) -
-

- - Initializes the class' member variables



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

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:29 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/_lib---account.inc.html b/lam-web/developers/phpdoc/lib/_lib---account.inc.html deleted file mode 100644 index 681831fe..00000000 --- a/lam-web/developers/phpdoc/lib/_lib---account.inc.html +++ /dev/null @@ -1,588 +0,0 @@ - - -Docs for page account.inc - - - - - - - - - - - - - -
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
-
-

-

-

-
-
- -

array_delete [line 69]

-
-
-
- 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 ]


-
-
- -

cmp_domain [line 342]

-
-
-
- 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 ]


-
-
- -

generateRandomPassword [line 293]

-
-
-
- String generateRandomPassword( -) -
-

- - Generates a random password with 12 digits.



-

Tags:

-
- - - - -
return:  password
-
-

- -
[ Top ]


-
-
- -

getdays [line 102]

-
-
-
- number getdays( -) -
-

- - This function will return the days from 1.1.1970 until now.



-

Tags:

-
- - - - -
return:  of days
-
-

- -
[ Top ]


-
-
- -

getshells [line 40]

-
-
-
- array getshells( -) -
-

- - Returns a list of shells listed in config/shells.



-

Tags:

-
- - - - -
return:  list of shell names
-
-

- -
[ Top ]


-
-
- -

get_preg [line 385]

-
-
-
- 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 85]

-
-
-
- void in_array_ignore_case( - $needle, $haystack) -
-

- - Checks if a string exists in an array, ignoring case.



- -

Parameters

- - - - - - - - - - - -
  $needle  
  $haystack  
-
[ Top ]


-
-
- -

lmPassword [line 137]

-
-
-
- string lmPassword( -string $password) -
-

- - Generates the LM hash of a password.



-

Tags:

-
- - - - -
return:  password hash
-
-

- -

Parameters

- - - - - - -
string  $password  password original password
-
[ Top ]


-
-
- -

ntPassword [line 151]

-
-
-
- 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 251]

-
-
-
- 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 226]

-
-
-
- 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 171]

-
-
-
- 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 276]

-
-
-
- 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 308]

-
-
-
- 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 114]

-
-
-
- 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, 06 Jan 2008 18:58:49 +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 deleted file mode 100644 index 91b2b4f1..00000000 --- a/lam-web/developers/phpdoc/lib/_lib---cache.inc.html +++ /dev/null @@ -1,123 +0,0 @@ - - -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, 06 Jan 2008 18:58:54 +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 deleted file mode 100644 index 6c987c6d..00000000 --- a/lam-web/developers/phpdoc/lib/_lib---schema.inc.html +++ /dev/null @@ -1,595 +0,0 @@ - - -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, 06 Jan 2008 18:59:27 +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 deleted file mode 100644 index 42a0111f..00000000 --- a/lam-web/developers/phpdoc/lib/_lib---security.inc.html +++ /dev/null @@ -1,237 +0,0 @@ - - -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 ]


-
-
- -

checkIfPasswordChangeIsAllowed [line 202]

-
-
-
- boolean checkIfPasswordChangeIsAllowed( -) -
-

- - Checks if passwords may be changed.



-

Tags:

-
- - - - -
return:  true, if allowed
-
-

- -
[ Top ]


-
-
- -

checkIfWriteAccessIsAllowed [line 187]

-
-
-
- boolean checkIfWriteAccessIsAllowed( -) -
-

- - Checks if write access to LDAP is allowed.



-

Tags:

-
- - - - -
return:  true, if allowed
-
-

- -
[ 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, 06 Jan 2008 18:59:30 +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 deleted file mode 100644 index 215bfb60..00000000 --- a/lam-web/developers/phpdoc/lib/_lib---status.inc.html +++ /dev/null @@ -1,149 +0,0 @@ - - -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, 06 Jan 2008 18:59:32 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/lib/_lib_account_inc.html b/lam-web/developers/phpdoc/lib/_lib_account_inc.html deleted file mode 100644 index 75cb80b3..00000000 --- a/lam-web/developers/phpdoc/lib/_lib_account_inc.html +++ /dev/null @@ -1,623 +0,0 @@ - - -Docs for page account.inc - - - - - - - - - - - - - -
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:  Roland Gruber
author:  Tilo Lutz
-
-

-

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 ]


-
-
- -

cmp_domain [line 421]

-
-
-
- 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 ]


-
-
- -

genpasswd [line 104]

-
-
-
- string genpasswd( -) -
-

- - This function will return a password with max. 8 characters.



-

Tags:

-
- - - - -
return:  password
-
-

- - -
[ Top ]


-
-
- -

getdays [line 165]

-
-
-
- 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 464]

-
-
-
- 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( -mixed $needle, mixed $haystack) -
-

- - Checks if a string exists in an array, ignoring case.



- - -
[ Top ]


-
-
- -

lmPassword [line 200]

-
-
-
- string lmPassword( -string $password) -
-

- - Generates the LM hash of a password.



-

Tags:

-
- - - - -
return:  password hash
-
-

- - -

Parameters

- - - - - - -
string  $password  password original password
-
[ Top ]


-
-
- -

ntPassword [line 211]

-
-
-
- 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 345]

-
-
-
- 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 320]

-
-
-
- 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 228]

-
-
-
- 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 370]

-
-
-
- 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 ]


-
-
- -

RndInt [line 142]

-
-
-
- integer RndInt( -string $Format) -
-

- - THIS FUNCTION GENERATES A RANDOM NUMBER THAT WILL BE USED TO RANDOMLY SELECT CHARACTERS.



-

Tags:

-
- - - - -
return:  random number
-
-

- - -

Parameters

- - - - - - -
string  $Format  "letter" or "number"
-
[ Top ]


-
-
- -

search_domains [line 387]

-
-
-
- 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 177]

-
-
-
- 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 Wed, 15 Nov 2006 18:00:35 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/_lib_cache_inc.html b/lam-web/developers/phpdoc/lib/_lib_cache_inc.html deleted file mode 100644 index c506e858..00000000 --- a/lam-web/developers/phpdoc/lib/_lib_cache_inc.html +++ /dev/null @@ -1,116 +0,0 @@ - - -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
-
-

-

Includes:

-
-include_once('ldap.inc') [line 32]
-en/decryption functions

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:38 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/_lib_schema_inc.html b/lam-web/developers/phpdoc/lib/_lib_schema_inc.html deleted file mode 100644 index fd9dfa45..00000000 --- a/lam-web/developers/phpdoc/lib/_lib_schema_inc.html +++ /dev/null @@ -1,505 +0,0 @@ - - -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:  Roland Gruber
author:  The phpLDAPadmin development team
-
-

-

-

-
- -

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 1701]

-
-
-
- void add_aliases_to_attrs( -mixed &$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'.




- - -
[ Top ]


-
-
- -

add_sup_to_attrs [line 1726]

-
-
-
- void add_sup_to_attrs( -mixed &$attrs, mixed &$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




- - -
[ Top ]


-
-
- -

cached_schema_available [line 1933]

-
-
-
- void cached_schema_available( -mixed $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.




- - -
[ Top ]


-
-
- -

get_cached_schema [line 1970]

-
-
-
- void get_cached_schema( -mixed $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.




- - -
[ Top ]


-
-
- -

get_schema_attribute [line 1588]

-
-
-
- AttributeType get_schema_attribute( -mixed $attr_name, [string $dn = null], [mixed $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).
-
[ Top ]


-
-
- -

get_schema_attributes [line 1609]

-
-
-
- array get_schema_attributes( -[string $dn = null], [mixed $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).
-
[ Top ]


-
-
- -

get_schema_matching_rules [line 1838]

-
-
-
- void get_schema_matching_rules( -[mixed $dn = null], [mixed $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.




- - -
[ Top ]


-
-
- -

get_schema_objectclass [line 1564]

-
-
-
- ObjectClass get_schema_objectclass( -string $oclass_name, [string $dn = null], [mixed $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).
-
[ Top ]


-
-
- -

get_schema_objectclasses [line 1524]

-
-
-
- array get_schema_objectclasses( -[string $dn = null], [mixed $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).
-
[ Top ]


-
-
- -

get_schema_syntaxes [line 1892]

-
-
-
- void get_schema_syntaxes( -[mixed $dn = null], [mixed $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.



- - -
[ Top ]


-
-
- -

set_cached_schema [line 2001]

-
-
-
- void set_cached_schema( -mixed $schema_type, mixed $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.




- - -
[ Top ]


-
-
- -

set_schema_cache_unavailable [line 2030]

-
-
-
- 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 Wed, 15 Nov 2006 18:01:04 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/_lib_security_inc.html b/lam-web/developers/phpdoc/lib/_lib_security_inc.html deleted file mode 100644 index 2b844416..00000000 --- a/lam-web/developers/phpdoc/lib/_lib_security_inc.html +++ /dev/null @@ -1,189 +0,0 @@ - - -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 77]

-
-
-
- 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 151]

-
-
-
- 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 104]

-
-
-
- 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 Wed, 15 Nov 2006 18:01:07 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/_lib_status_inc.html b/lam-web/developers/phpdoc/lib/_lib_status_inc.html deleted file mode 100644 index 26d822e4..00000000 --- a/lam-web/developers/phpdoc/lib/_lib_status_inc.html +++ /dev/null @@ -1,146 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:09 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lib/cache.html b/lam-web/developers/phpdoc/lib/cache.html deleted file mode 100644 index c1fe96a3..00000000 --- a/lam-web/developers/phpdoc/lib/cache.html +++ /dev/null @@ -1,459 +0,0 @@ - - -Docs For Class cache - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: cache

-Source Location: /lib/cache.inc

- - - - - - - - - -
- -

Class Overview

-

-
This class contains all functions which are needed to manage the LDAP cache.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 42]
-This class contains all functions which are needed to manage the LDAP cache.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 56]

-
-
-
- cache __construct( -) -
-

- - Constructor.



-

Tags:

-
- - - - -
return:  cache object
-
-

- - -
[ Top ]
-
-
- -

method add_cache [line 66]

-
-
-
- void add_cache( -array -$attributes) -
-

- - This function adds attributes to the cache.



- - -

Parameters:

-
- - - - - - -
array  $attributes  syntax: is array( scope1 => array ( attributes ), scope2 => array ( attributes ), ...)
-

-
[ Top ]
-
-
- -

method findgroups [line 241]

-
-
-
- array findgroups( -) -
-

- - This function returns an array with all group names which were found in the LDAP directory.



-

Tags:

-
- - - - -
return:  group names
-
-

- - -
[ Top ]
-
-
- -

method getgid [line 223]

-
-
-
- string getgid( -string -$groupname) -
-

- - This function will return the GID number to an existing group name (using the cache).



-

Tags:

-
- - - - -
return:  GID number
-
-

- - -

Parameters:

-
- - - - - - -
string  $groupname  name of group
-

-
[ Top ]
-
-
- -

method getgrnam [line 259]

-
-
-
- group getgrnam( -string -$gidNumber) -
-

- - This function returns the group name to an existing gidNumber.



-

Tags:

-
- - - - -
return:  name
-
-

- - -

Parameters:

-
- - - - - - -
string  $gidNumber  GID number
-

-
[ Top ]
-
-
- -

method get_cache [line 95]

-
-
-
- array get_cache( -mixed -$attributes, string -$objectClass, mixed -$scopelist) -
-

- - Queries the cache for a list of LDAP entries and their attributes.



-

Tags:

-
- - - - -
return:  The found LDAP entries.
Format: array(dn1 => array(uidnumber1), dn2 => array(uidnumber2), ... ) if $attributes is of type string
or array(dn1 => array(uid => array(myuid), uidNumber => array(1234)), ... ) if $attributes is an array
-
-

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
mixed  $attributes  One (string) or many (array) attribute names.
string  $objectClass  The resulting entries need to contain this object class.
mixed  $scopelist  the account type(s) as string or array, all scopes if NULL given
-

-
[ Top ]
-
-
- -

method in_cache [line 140]

-
-
-
- void in_cache( -string -$value, string -$attribute, mixed -$scopelist) -
-

- - This function returns the DN if an LDAP entry with $attribute=$value is found.



- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
string  $value  is the searched value of the attribute $attribute
string  $attribute  name of the LDAP attribute
mixed  $scopelist  the account type(s) as string or array, all scopes if NULL given
-

-
[ Top ]
-
-
- -

method refresh_cache [line 175]

-
-
-
- void refresh_cache( -[boolean -$rebuild = false]) -
-

- - This function refreshes the cache.



- - -

Parameters:

-
- - - - - - -
boolean  $rebuild  forces a refresh if set to true
-

-
[ Top ]
-
-
- -

method __sleep [line 277]

-
-
-
- array __sleep( -) -
-

- - Encrypts LDAP cache before saving to session file.



-

Tags:

-
- - - - -
return:  list of variables to save
-
-

- - -
[ Top ]
-
-
- -

method __wakeup [line 286]

-
-
-
- void __wakeup( -) -
-

- - Decrypts LDAP cache after loading from session file.



- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:54 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/_lib---lists.inc.html b/lam-web/developers/phpdoc/lists/_lib---lists.inc.html deleted file mode 100644 index dbe2f280..00000000 --- a/lam-web/developers/phpdoc/lists/_lib---lists.inc.html +++ /dev/null @@ -1,190 +0,0 @@ - - -Docs for page lists.inc - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: lists.inc

-Source Location: /lib/lists.inc

- -
-
- -
-

Classes:

-
lamList
-
Generates the list view.
-
lamListTool
-
Represents a tool which can be included in the account lists.
-
lamListOption
-
Represents a list configuration option.
-
lamBooleanListOption
-
Boolean option for list configuration.
-
lamSelectListOption
-
Boolean option for list configuration.
-


- -

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, 06 Jan 2008 18:59:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/lists/_lib_lists_inc.html b/lam-web/developers/phpdoc/lists/_lib_lists_inc.html deleted file mode 100644 index 7bb76611..00000000 --- a/lam-web/developers/phpdoc/lists/_lib_lists_inc.html +++ /dev/null @@ -1,170 +0,0 @@ - - -Docs for page lists.inc - - - - - - - - - - - - - -
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 Wed, 15 Nov 2006 18:00:51 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/_templates---lists---changePassword.php.html b/lam-web/developers/phpdoc/lists/_templates---lists---changePassword.php.html deleted file mode 100644 index e065ac58..00000000 --- a/lam-web/developers/phpdoc/lists/_templates---lists---changePassword.php.html +++ /dev/null @@ -1,307 +0,0 @@ - - -Docs for page changePassword.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: changePassword.php

-Source Location: /templates/lists/changePassword.php

- -
-
- - -

Page Details:

-Change password page for helpdesk employees.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../../lib/ldap.inc") [line 22]
-LDAP object

include_once('../../lib/status.inc') [line 18]
-status messages

include_once("../../lib/security.inc") [line 20]
-security functions

-

-

-
-
- -

generatePassword [line 274]

-
-
-
- void generatePassword( -String $dn, String $template, array $user, String $mailTo) -
-

- - Sets a generated password and displays it or sends it via mail.



- -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
String  $dn  LDAP DN
String  $template  mail template file
array  $user  LDAP attributes of user
String  $mailTo  mail address
-
[ Top ]


-
-
- -

readUser [line 222]

-
-
-
- array readUser( -String $dn) -
-

- - Returns the LDAP attributes of the given DN.



-

Tags:

-
- - - - -
return:  attributes
-
-

- -

Parameters

- - - - - - -
String  $dn  DN
-
[ Top ]


-
-
- -

setPassword [line 332]

-
-
-
- boolean setPassword( -String $dn, String $pwd) -
-

- - Sets the password to LDAP.



-

Tags:

-
- - - - -
return:  true, if change succeeded
-
-

- -

Parameters

- - - - - - - - - - - -
String  $dn  LDAP DN
String  $pwd  password
-
[ Top ]


-
-
- -

setSpecifiedPassword [line 246]

-
-
-
- void setSpecifiedPassword( -String $dn) -
-

- - Sets the new password.



- -

Parameters

- - - - - - -
String  $dn  LDAP DN
-
[ Top ]


-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:54 +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 deleted file mode 100644 index 8ceb062f..00000000 --- a/lam-web/developers/phpdoc/lists/_templates---lists---deletelink.php.html +++ /dev/null @@ -1,177 +0,0 @@ - - -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, 06 Jan 2008 18:58:59 +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 deleted file mode 100644 index a0a80285..00000000 --- a/lam-web/developers/phpdoc/lists/_templates---lists---list.php.html +++ /dev/null @@ -1,177 +0,0 @@ - - -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, 06 Jan 2008 18:59:13 +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 deleted file mode 100644 index 88b0786c..00000000 --- a/lam-web/developers/phpdoc/lists/_templates---lists---userlink.php.html +++ /dev/null @@ -1,209 +0,0 @@ - - -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, 06 Jan 2008 18:59:36 +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 deleted file mode 100644 index cb049685..00000000 --- a/lam-web/developers/phpdoc/lists/_templates_lists_list_php.html +++ /dev/null @@ -1,165 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:51 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/_templates_lists_userlink_php.html b/lam-web/developers/phpdoc/lists/_templates_lists_userlink_php.html deleted file mode 100644 index 70b6e83e..00000000 --- a/lam-web/developers/phpdoc/lists/_templates_lists_userlink_php.html +++ /dev/null @@ -1,198 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/lamBooleanListOption.html b/lam-web/developers/phpdoc/lists/lamBooleanListOption.html deleted file mode 100644 index 22e0f88d..00000000 --- a/lam-web/developers/phpdoc/lists/lamBooleanListOption.html +++ /dev/null @@ -1,397 +0,0 @@ - - -Docs For Class lamBooleanListOption - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamBooleanListOption

-Source Location: /lib/lists.inc

- - - - - - - - - -
- -

Class Overview

-
lamListOption
-   |
-   --lamBooleanListOption

-
Boolean option for list configuration.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: lamListOption

-
-
- lamListOption::__construct() -
-
- Creates a new config option. -
-
- lamListOption::fillFromPostData() -
-
- Fills the config option from POST data. -
-
- lamListOption::getID() -
-
- Returns the option ID. -
-
- lamListOption::getMetaHTML() -
-
- Returns the meta HTML data to display this option. -
-
- lamListOption::getValue() -
-
- Returns the option value. The value must not contain "=" and ";". -
-
- lamListOption::setValue() -
-
- Sets the config option value. The value must not contain "=" and ";". -
-
-
-
-
- - -

Class Details

-
-[line 1066]
-Boolean option for list configuration.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 1077]

-
-
-
- lamBooleanListOption __construct( -String -$name, String -$ID) -
-

- - Creates a new boolean option.



-

Tags:

-
- - - - - - - -
return:  config option
access:  public
-
-

- - Overrides lamListOption::__construct() (Creates a new config option.)

-

Parameters:

-
- - - - - - - - - - - -
String  $name  name to show on config page
String  $ID  unique ID
-

-
[ Top ]
-
-
- -

method fillFromPostData [line 1096]

-
-
-
- array fillFromPostData( -) -
-

- - Fills the config option from POST data.



-

Tags:

-
- - - - - - - -
return:  list of StatusMessages (array(<type>, <head line>, <body>))
access:  public
-
-

- - Overrides lamListOption::fillFromPostData() (Fills the config option from POST data.)

-
[ Top ]
-
-
- -

method getMetaHTML [line 1110]

-
-
-
- array getMetaHTML( -) -
-

- - Returns the meta HTML data to display this option.



-

Tags:

-
- - - - - - - -
return:  meta HTML
access:  public
-
-

- - Overrides lamListOption::getMetaHTML() (Returns the meta HTML data to display this option.)

-
[ Top ]
-
-
- -

method isSelected [line 1087]

-
-
-
- boolean isSelected( -) -
-

- - Returns if this option is selected.



-

Tags:

-
- - - - - - - -
return:  true, if selected
access:  public
-
-

- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/lamGroupList.html b/lam-web/developers/phpdoc/lists/lamGroupList.html deleted file mode 100644 index 8fd1ebf9..00000000 --- a/lam-web/developers/phpdoc/lists/lamGroupList.html +++ /dev/null @@ -1,661 +0,0 @@ - - -Docs For Class lamGroupList - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamGroupList

-Source Location: /lib/types/group.inc

- - - - - - - - - - -
- -

Class Overview

-
lamList
-   |
-   --lamGroupList

-
Generates the list view.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Constants

- -
-

Methods

- -
-
- - - - - - - - - - - -
-

Inherited Constants

-
-

Class: lamList

-
-
- lamList::LIST_SIZE_OPTION_NAME -
-
- -
-
-
-
-

Inherited Variables

-
-

Class: lamList

-
-
- lamList::$attrArray -
-
- -
-
- lamList::$descArray -
-
- -
-
- lamList::$entries -
-
- -
-
- lamList::$filterText -
-
- -
-
- lamList::$labels -
-
- -
-
- lamList::$maxPageEntries -
-
- -
-
- lamList::$page -
-
- -
-
- lamList::$possibleSuffixes -
-
- -
-
- lamList::$refresh -
-
- -
-
- lamList::$sortColumn -
-
- -
-
- lamList::$sortDirection -
-
- -
-
- lamList::$suffix -
-
- -
-
- lamList::$type -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: lamList

-
-
- lamList::__construct() -
-
- Constructor -
-
- lamList::cmp_array() -
-
- Compare function used for usort-method -
-
- lamList::getAdditionalTools() -
-
- Returns a list of lamListTool objects to display next to the edit/delete buttons. -
-
- lamList::listBuildFilter() -
-
- Builds the regular expressions from the filter values. -
-
- lamList::listConfigurationChanged() -
-
- Called when the configuration options changed. -
-
- lamList::listDrawNavigationBar() -
-
- Draws a navigation bar to switch between pages -
-
- lamList::listFilterAccounts() -
-
- Removes all entries which do not fit to the filter. -
-
- lamList::listGetAllConfigOptions() -
-
- Returns a list of possible configuration options. -
-
- lamList::listGetConfigOptionByID() -
-
- Returns the configuration option with the given ID. -
-
- lamList::listGetParams() -
-
- Sets some internal parameters. -
-
- lamList::listPrintButtons() -
-
- Prints the create and delete buttons. -
-
- lamList::listPrintConfigurationPage() -
-
- Prints the list configuration page. -
-
- lamList::listPrintFooter() -
-
- Prints the HTML footer. -
-
- lamList::listPrintHeader() -
-
- Prints the HTML header. -
-
- 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::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. -
-
-
-
-
- - -

Class Details

-
-[line 100]
-Generates the list view.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 117]

-
-
-
- lamList __construct( -string -$type) -
-

- - Constructor



-

Tags:

-
- - - - -
return:  list object
-
-

- - Overrides lamList::__construct() (Constructor)

-

Parameters:

-
- - - - - - -
string  $type  account type
-

-
[ Top ]
-
-
- -

method groupRefreshPrimary [line 222]

-
-
-
- void groupRefreshPrimary( -) -
-

- - Refreshes the primary group members list.



- - -
[ Top ]
-
-
- -

method listConfigurationChanged [line 268]

-
-
-
- void listConfigurationChanged( -) -
-

- - Called when the configuration options changed.



-

Tags:

-
- - - - -
access:  protected
-
-

- - Overrides lamList::listConfigurationChanged() (Called when the configuration options changed.)

-
[ Top ]
-
-
- -

method listGetAllConfigOptions [line 259]

-
-
-
- array listGetAllConfigOptions( -) -
-

- - Returns a list of possible configuration options.



-

Tags:

-
- - - - - - - -
return:  list of lamListOption objects
access:  protected
-
-

- - Overrides lamList::listGetAllConfigOptions() (Returns a list of possible configuration options.)

-
[ Top ]
-
-
- -

method listGetParams [line 131]

-
-
-
- void listGetParams( -) -
-

- - Sets some internal parameters.



- - Overrides lamList::listGetParams() (Sets some internal parameters.)

-
[ Top ]
-
-
- -

method listPrintTableCellContent [line 145]

-
-
-
- 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  $entry  LDAP attributes
string  $attribute  attribute name
  &$entry  
  &$attribute  
-

-
[ Top ]
-
-
- -

method listRefreshData [line 212]

-
-
-
- void listRefreshData( -) -
-

- - Rereads the entries from LDAP.



- - Overrides lamList::listRefreshData() (Rereads the entries from LDAP.)

-
[ Top ]
-
-

- -
- -

Class Constants

-
- -

-

TRANS_PRIMARY_OPTION_NAME =  "LG_TP"

-

[line 109]

- ID for config option

-
-
[ Top ]

-

- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:04 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/lamHostList.html b/lam-web/developers/phpdoc/lists/lamHostList.html deleted file mode 100644 index a1e9fea9..00000000 --- a/lam-web/developers/phpdoc/lists/lamHostList.html +++ /dev/null @@ -1,491 +0,0 @@ - - -Docs For Class lamHostList - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamHostList

-Source Location: /lib/types/host.inc

- - - - - - - - - -
- -

Class Overview

-
lamList
-   |
-   --lamHostList

-
Generates the list view.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - - -
-

Inherited Constants

-
-

Class: lamList

-
-
- lamList::LIST_SIZE_OPTION_NAME -
-
- -
-
-
-
-

Inherited Variables

-
-

Class: lamList

-
-
- lamList::$attrArray -
-
- -
-
- lamList::$descArray -
-
- -
-
- lamList::$entries -
-
- -
-
- lamList::$filterText -
-
- -
-
- lamList::$labels -
-
- -
-
- lamList::$maxPageEntries -
-
- -
-
- lamList::$page -
-
- -
-
- lamList::$possibleSuffixes -
-
- -
-
- lamList::$refresh -
-
- -
-
- lamList::$sortColumn -
-
- -
-
- lamList::$sortDirection -
-
- -
-
- lamList::$suffix -
-
- -
-
- lamList::$type -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: lamList

-
-
- lamList::__construct() -
-
- Constructor -
-
- lamList::cmp_array() -
-
- Compare function used for usort-method -
-
- lamList::getAdditionalTools() -
-
- Returns a list of lamListTool objects to display next to the edit/delete buttons. -
-
- lamList::listBuildFilter() -
-
- Builds the regular expressions from the filter values. -
-
- lamList::listConfigurationChanged() -
-
- Called when the configuration options changed. -
-
- lamList::listDrawNavigationBar() -
-
- Draws a navigation bar to switch between pages -
-
- lamList::listFilterAccounts() -
-
- Removes all entries which do not fit to the filter. -
-
- lamList::listGetAllConfigOptions() -
-
- Returns a list of possible configuration options. -
-
- lamList::listGetConfigOptionByID() -
-
- Returns the configuration option with the given ID. -
-
- lamList::listGetParams() -
-
- Sets some internal parameters. -
-
- lamList::listPrintButtons() -
-
- Prints the create and delete buttons. -
-
- lamList::listPrintConfigurationPage() -
-
- Prints the list configuration page. -
-
- lamList::listPrintFooter() -
-
- Prints the HTML footer. -
-
- lamList::listPrintHeader() -
-
- Prints the HTML header. -
-
- 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::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. -
-
-
-
-
- - -

Class Details

-
-[line 101]
-Generates the list view.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 109]

-
-
-
- lamList __construct( -string -$type) -
-

- - Constructor



-

Tags:

-
- - - - -
return:  list object
-
-

- - Overrides lamList::__construct() (Constructor)

-

Parameters:

-
- - - - - - -
string  $type  account type
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:07 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/lamList.html b/lam-web/developers/phpdoc/lists/lamList.html deleted file mode 100644 index 29319066..00000000 --- a/lam-web/developers/phpdoc/lists/lamList.html +++ /dev/null @@ -1,1377 +0,0 @@ - - -Docs For Class lamList - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamList

-Source Location: /lib/lists.inc

- - - - - - - - - - - -
- -

Class Overview

-

-
Generates the list view.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Variables

- -
-

Constants

- -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
lamMailAliasList
-
Generates the list view.
-
-
-
lamHostList
-
Generates the list view.
-
-
-
lamSmbDomainList
-
Generates the list view.
-
-
-
lamGroupList
-
Generates the list view.
-
-
-
lamUserList
-
Generates the list view.
-
-
-
-
- - -

Class Details

-
-[line 47]
-Generates the list view.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$attrArray = array()

-

[line 56]

- list of LDAP attributes



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$descArray = array()

-

[line 59]

- list of attribute descriptions



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$entries =

-

[line 77]

- LDAP entries



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$filterText =

-

[line 80]

- filter string to include in URL



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$labels =

-

[line 86]

- list of account specific labels



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$maxPageEntries =  30

-

[line 62]

- maximum count of entries per page



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$page =  1

-

[line 53]

- current page number



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$possibleSuffixes =

-

[line 83]

- list of possible LDAP suffixes(organizational units)



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$refresh =  true

-

[line 74]

- refresh page switch



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$sortColumn =

-

[line 65]

- sort column name



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$sortDirection =  1

-

[line 68]

- sort direction: 1 for ascending, -1 for descending



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$suffix =

-

[line 71]

- LDAP suffix



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$type =

-

[line 50]

- Account type



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor __construct [line 100]

-
-
-
- lamList __construct( -string -$type) -
-

- - Constructor



-

Tags:

-
- - - - - - - -
return:  list object
access:  public
-
-

- -

Overridden in child classes as:
-

-
lamMailAliasList::__construct()
-
Constructor
-
-
-
lamHostList::__construct()
-
Constructor
-
-
-
lamSmbDomainList::__construct()
-
Constructor
-
-
-
lamGroupList::__construct()
-
Constructor
-
-
-
lamUserList::__construct()
-
Constructor
-
-

- -

Parameters:

-
- - - - - - -
string  $type  account type
-

-
[ Top ]
-
-
- -

method cmp_array [line 302]

-
-
-
- integer cmp_array( - -&$a, -&$b, array -$a, array -$b) -
-

- - Compare function used for usort-method

Rows are sorted with the first attribute entry of the sort column. If objects have attributes with multiple values only the first is used for sorting.




-

Tags:

-
- - - - - - - -
return:  0 if both are equal, 1 if $a is greater, -1 if $b is greater
access:  protected
-
-

- - -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $a  first row which is compared
array  $b  second row which is compared
  &$a  
  &$b  
-

-
[ Top ]
-
-
- -

method getAdditionalTools [line 865]

-
-
-
- lamListTool[] getAdditionalTools( -) -
-

- - Returns a list of lamListTool objects to display next to the edit/delete buttons.



-

Tags:

-
- - - - - - - -
return:  tools
access:  protected
-
-

- -

Overridden in child classes as:
-

-
lamUserList::getAdditionalTools()
-
Returns a list of lamListTool objects to display next to the edit/delete buttons.
-
-

- -
[ Top ]
-
-
- -

method listBuildFilter [line 204]

-
-
-
- array listBuildFilter( -) -
-

- - Builds the regular expressions from the filter values.



-

Tags:

-
- - - - - - - -
return:  filter data array($attribute => array('regex' => $reg, 'original' => $orig)) $reg is the regular expression to use, $orig the user's unmodified input string
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listConfigurationChanged [line 924]

-
-
-
- void listConfigurationChanged( -) -
-

- - Called when the configuration options changed.



-

Tags:

-
- - - - -
access:  protected
-
-

- -

Overridden in child classes as:
-

-
lamGroupList::listConfigurationChanged()
-
Called when the configuration options changed.
-
-
-
lamUserList::listConfigurationChanged()
-
Called when the configuration options changed.
-
-

- -
[ Top ]
-
-
- -

method listDrawNavigationBar [line 321]

-
-
-
- void listDrawNavigationBar( -integer -$count) -
-

- - Draws a navigation bar to switch between pages



-

Tags:

-
- - - - -
access:  protected
-
-

- - -

Parameters:

-
- - - - - - -
integer  $count  number of account entries
-

-
[ Top ]
-
-
- -

method listFilterAccounts [line 248]

-
-
-
- array listFilterAccounts( -) -
-

- - Removes all entries which do not fit to the filter.



-

Tags:

-
- - - - - - - -
return:  filtered list of accounts
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listGetAllConfigOptions [line 874]

-
-
-
- array listGetAllConfigOptions( -) -
-

- - Returns a list of possible configuration options.



-

Tags:

-
- - - - - - - -
return:  list of lamListOption objects
access:  protected
-
-

- -

Overridden in child classes as:
-

-
lamGroupList::listGetAllConfigOptions()
-
Returns a list of possible configuration options.
-
-
-
lamUserList::listGetAllConfigOptions()
-
Returns a list of possible configuration options.
-
-

- -
[ Top ]
-
-
- -

method listGetConfigOptionByID [line 912]

-
-
-
- void listGetConfigOptionByID( -String -$ID) -
-

- - Returns the configuration option with the given ID.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -

Parameters:

-
- - - - - - -
String  $ID  ID
-

-
[ Top ]
-
-
- -

method listGetParams [line 791]

-
-
-
- void listGetParams( -) -
-

- - Sets some internal parameters.



-

Tags:

-
- - - - -
access:  protected
-
-

- -

Overridden in child classes as:
-

-
lamGroupList::listGetParams()
-
Sets some internal parameters.
-
-
-
lamUserList::listGetParams()
-
Sets some internal parameters.
-
-

- -
[ Top ]
-
-
- -

method listPrintButtons [line 707]

-
-
-
- void listPrintButtons( -boolean -$createOnly) -
-

- - Prints the create and delete buttons.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -

Parameters:

-
- - - - - - -
boolean  $createOnly  true if only the create button should be displayed
-

-
[ Top ]
-
-
- -

method listPrintConfigurationPage [line 882]

-
-
-
- void listPrintConfigurationPage( -) -
-

- - Prints the list configuration page.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listPrintFooter [line 746]

-
-
-
- void listPrintFooter( -) -
-

- - Prints the HTML footer.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listPrintHeader [line 734]

-
-
-
- void listPrintHeader( -) -
-

- - Prints the HTML header.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listPrintTableBody [line 412]

-
-
-
- void listPrintTableBody( - -&$info, array -$info) -
-

- - Prints the entry list



-

Tags:

-
- - - - -
access:  protected
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
array  $info  entries
  &$info  
-

-
[ Top ]
-
-
- -

method listPrintTableCellContent [line 487]

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



-

Tags:

-
- - - - -
access:  protected
-
-

- -

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  
-

-
[ Top ]
-
-
- -

method listPrintTableHeader [line 360]

-
-
-
- void listPrintTableHeader( -) -
-

- - Prints the attribute and filter row at the account table head



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listRefreshData [line 830]

-
-
-
- void listRefreshData( -) -
-

- - Rereads the entries from LDAP.



-

Tags:

-
- - - - -
access:  protected
-
-

- -

Overridden in child classes as:
-

-
lamGroupList::listRefreshData()
-
Rereads the entries from LDAP.
-
-
-
lamUserList::listRefreshData()
-
Rereads the entries from LDAP.
-
-

- -
[ Top ]
-
-
- -

method listShowOUSelection [line 687]

-
-
-
- void listShowOUSelection( -) -
-

- - Prints a combobox with possible sub-DNs.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listSort [line 283]

-
-
-
- array listSort( - -&$info, array -$info) -
-

- - Sorts an account list by a given attribute



-

Tags:

-
- - - - - - - -
return:  sorted account list
access:  protected
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
array  $info  the account list
  &$info  
-

-
[ Top ]
-
-
- -

method showPage [line 142]

-
-
-
- void showPage( -) -
-

- - Prints the HTML code to display the list view.



-

Tags:

-
- - - - -
access:  public
-
-

- - -
[ Top ]
-
-

- -
- -

Class Constants

-
- -

-

LIST_SIZE_OPTION_NAME =  "L_SIZE"

-

[line 92]

- ID for list size config option

-
-
[ Top ]

-

- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/lamListOption.html b/lam-web/developers/phpdoc/lists/lamListOption.html deleted file mode 100644 index 0e4b1c61..00000000 --- a/lam-web/developers/phpdoc/lists/lamListOption.html +++ /dev/null @@ -1,463 +0,0 @@ - - -Docs For Class lamListOption - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamListOption

-Source Location: /lib/lists.inc

- - - - - - - - - -
- -

Class Overview

-

-
Represents a list configuration option.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
lamBooleanListOption
-
Boolean option for list configuration.
-
-
-
lamSelectListOption
-
Boolean option for list configuration.
-
-
-
-
- - -

Class Details

-
-[line 998]
-Represents a list configuration option.



-

Tags:

-
- - - - - - - -
author:  Roland Gruber
abstract:  
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 1010]

-
-
-
- lamConfigOption __construct( -String -$ID) -
-

- - Creates a new config option.



-

Tags:

-
- - - - - - - -
return:  config option
access:  public
-
-

- -

Overridden in child classes as:
-

-
lamBooleanListOption::__construct()
-
Creates a new boolean option.
-
-
-
lamSelectListOption::__construct()
-
Creates a new selection list option.
-
-

- -

Parameters:

-
- - - - - - -
String  $ID  unique ID
-

-
[ Top ]
-
-
- -

method fillFromPostData [line 1028]

-
-
-
- array fillFromPostData( -) -
-

- - Fills the config option from POST data.



-

Tags:

-
- - - - - - - - - - -
return:  list of StatusMessages (array(<type>, <head line>, <body>))
abstract:  
access:  public
-
-

- -

Overridden in child classes as:
-

-
lamBooleanListOption::fillFromPostData()
-
Fills the config option from POST data.
-
-
-
lamSelectListOption::fillFromPostData()
-
Fills the config option from POST data.
-
-

- -
[ Top ]
-
-
- -

method getID [line 1019]

-
-
-
- String getID( -) -
-

- - Returns the option ID.



-

Tags:

-
- - - - - - - -
return:  ID
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getMetaHTML [line 1056]

-
-
-
- array getMetaHTML( -) -
-

- - Returns the meta HTML data to display this option.



-

Tags:

-
- - - - - - - - - - -
return:  meta HTML
abstract:  
access:  public
-
-

- -

Overridden in child classes as:
-

-
lamBooleanListOption::getMetaHTML()
-
Returns the meta HTML data to display this option.
-
-
-
lamSelectListOption::getMetaHTML()
-
Returns the meta HTML data to display this option.
-
-

- -
[ Top ]
-
-
- -

method getValue [line 1035]

-
-
-
- String getValue( -) -
-

- - Returns the option value. The value must not contain "=" and ";".



-

Tags:

-
- - - - - - - -
return:  value
access:  public
-
-

- - -
[ Top ]
-
-
- -

method setValue [line 1044]

-
-
-
- void setValue( -String -$value) -
-

- - Sets the config option value. The value must not contain "=" and ";".



-

Tags:

-
- - - - -
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
String  $value  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/lamListTool.html b/lam-web/developers/phpdoc/lists/lamListTool.html deleted file mode 100644 index 43281d82..00000000 --- a/lam-web/developers/phpdoc/lists/lamListTool.html +++ /dev/null @@ -1,357 +0,0 @@ - - -Docs For Class lamListTool - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamListTool

-Source Location: /lib/lists.inc

- - - - - - - - - -
- -

Class Overview

-

-
Represents a tool which can be included in the account lists.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 940]
-Represents a tool which can be included in the account lists.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 954]

-
-
-
- lamListTool __construct( -String -$name, String -$image, String -$target) -
-

- - Constructor



-

Tags:

-
- - - - - - - -
return:  tool object
access:  public
-
-

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
String  $name  tool name
String  $image  image file
String  $target  target page
-

-
[ Top ]
-
-
- -

method getImage [line 966]

-
-
-
- String getImage( -) -
-

- - Returns the name of the tool image.

The image is returned without path (e.g. mytool.png). All images must reside in the graphics folder.




-

Tags:

-
- - - - - - - -
return:  image name
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getLinkTarget [line 986]

-
-
-
- String getLinkTarget( -) -
-

- - Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.

The target page will be opened with two GET parameters: DN and type (e.g. user)




-

Tags:

-
- - - - - - - -
return:  page file (e.g. 'mytool.php')
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getName [line 976]

-
-
-
- String getName( -) -
-

- - Returns the tool name.

This is used for the tool tip.




-

Tags:

-
- - - - - - - -
return:  name
access:  public
-
-

- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:15 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/lamMailAliasList.html b/lam-web/developers/phpdoc/lists/lamMailAliasList.html deleted file mode 100644 index 5426951b..00000000 --- a/lam-web/developers/phpdoc/lists/lamMailAliasList.html +++ /dev/null @@ -1,491 +0,0 @@ - - -Docs For Class lamMailAliasList - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamMailAliasList

-Source Location: /lib/types/mailAlias.inc

- - - - - - - - - -
- -

Class Overview

-
lamList
-   |
-   --lamMailAliasList

-
Generates the list view.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - - -
-

Inherited Constants

-
-

Class: lamList

-
-
- lamList::LIST_SIZE_OPTION_NAME -
-
- -
-
-
-
-

Inherited Variables

-
-

Class: lamList

-
-
- lamList::$attrArray -
-
- -
-
- lamList::$descArray -
-
- -
-
- lamList::$entries -
-
- -
-
- lamList::$filterText -
-
- -
-
- lamList::$labels -
-
- -
-
- lamList::$maxPageEntries -
-
- -
-
- lamList::$page -
-
- -
-
- lamList::$possibleSuffixes -
-
- -
-
- lamList::$refresh -
-
- -
-
- lamList::$sortColumn -
-
- -
-
- lamList::$sortDirection -
-
- -
-
- lamList::$suffix -
-
- -
-
- lamList::$type -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: lamList

-
-
- lamList::__construct() -
-
- Constructor -
-
- lamList::cmp_array() -
-
- Compare function used for usort-method -
-
- lamList::getAdditionalTools() -
-
- Returns a list of lamListTool objects to display next to the edit/delete buttons. -
-
- lamList::listBuildFilter() -
-
- Builds the regular expressions from the filter values. -
-
- lamList::listConfigurationChanged() -
-
- Called when the configuration options changed. -
-
- lamList::listDrawNavigationBar() -
-
- Draws a navigation bar to switch between pages -
-
- lamList::listFilterAccounts() -
-
- Removes all entries which do not fit to the filter. -
-
- lamList::listGetAllConfigOptions() -
-
- Returns a list of possible configuration options. -
-
- lamList::listGetConfigOptionByID() -
-
- Returns the configuration option with the given ID. -
-
- lamList::listGetParams() -
-
- Sets some internal parameters. -
-
- lamList::listPrintButtons() -
-
- Prints the create and delete buttons. -
-
- lamList::listPrintConfigurationPage() -
-
- Prints the list configuration page. -
-
- lamList::listPrintFooter() -
-
- Prints the HTML footer. -
-
- lamList::listPrintHeader() -
-
- Prints the HTML header. -
-
- 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::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. -
-
-
-
-
- - -

Class Details

-
-[line 97]
-Generates the list view.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 105]

-
-
-
- lamList __construct( -string -$type) -
-

- - Constructor



-

Tags:

-
- - - - -
return:  list object
-
-

- - Overrides lamList::__construct() (Constructor)

-

Parameters:

-
- - - - - - -
string  $type  account type
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:15 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/lamSelectListOption.html b/lam-web/developers/phpdoc/lists/lamSelectListOption.html deleted file mode 100644 index 753aa255..00000000 --- a/lam-web/developers/phpdoc/lists/lamSelectListOption.html +++ /dev/null @@ -1,411 +0,0 @@ - - -Docs For Class lamSelectListOption - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamSelectListOption

-Source Location: /lib/lists.inc

- - - - - - - - - -
- -

Class Overview

-
lamListOption
-   |
-   --lamSelectListOption

-
Boolean option for list configuration.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: lamListOption

-
-
- lamListOption::__construct() -
-
- Creates a new config option. -
-
- lamListOption::fillFromPostData() -
-
- Fills the config option from POST data. -
-
- lamListOption::getID() -
-
- Returns the option ID. -
-
- lamListOption::getMetaHTML() -
-
- Returns the meta HTML data to display this option. -
-
- lamListOption::getValue() -
-
- Returns the option value. The value must not contain "=" and ";". -
-
- lamListOption::setValue() -
-
- Sets the config option value. The value must not contain "=" and ";". -
-
-
-
-
- - -

Class Details

-
-[line 1127]
-Boolean option for list configuration.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 1141]

-
-
-
- lamBooleanListOption __construct( -String -$name, array -$options, String -$ID) -
-

- - Creates a new selection list option.



-

Tags:

-
- - - - - - - -
return:  config option
access:  public
-
-

- - Overrides lamListOption::__construct() (Creates a new config option.)

-

Parameters:

-
- - - - - - - - - - - - - - - - -
String  $name  name to show on config page
array  $options  list of possible values
String  $ID  unique ID
-

-
[ Top ]
-
-
- -

method fillFromPostData [line 1161]

-
-
-
- array fillFromPostData( -) -
-

- - Fills the config option from POST data.



-

Tags:

-
- - - - - - - -
return:  list of StatusMessages (array(<type>, <head line>, <body>))
access:  public
-
-

- - Overrides lamListOption::fillFromPostData() (Fills the config option from POST data.)

-
[ Top ]
-
-
- -

method getMetaHTML [line 1175]

-
-
-
- array getMetaHTML( -) -
-

- - Returns the meta HTML data to display this option.



-

Tags:

-
- - - - - - - -
return:  meta HTML
access:  public
-
-

- - Overrides lamListOption::getMetaHTML() (Returns the meta HTML data to display this option.)

-
[ Top ]
-
-
- -

method setHelpID [line 1152]

-
-
-
- void setHelpID( -Strign -$id) -
-

- - Sets the help ID.



-

Tags:

-
- - - - -
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
Strign  $id  help ID
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:15 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/lamSmbDomainList.html b/lam-web/developers/phpdoc/lists/lamSmbDomainList.html deleted file mode 100644 index f473e977..00000000 --- a/lam-web/developers/phpdoc/lists/lamSmbDomainList.html +++ /dev/null @@ -1,491 +0,0 @@ - - -Docs For Class lamSmbDomainList - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamSmbDomainList

-Source Location: /lib/types/smbDomain.inc

- - - - - - - - - -
- -

Class Overview

-
lamList
-   |
-   --lamSmbDomainList

-
Generates the list view.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - - -
-

Inherited Constants

-
-

Class: lamList

-
-
- lamList::LIST_SIZE_OPTION_NAME -
-
- -
-
-
-
-

Inherited Variables

-
-

Class: lamList

-
-
- lamList::$attrArray -
-
- -
-
- lamList::$descArray -
-
- -
-
- lamList::$entries -
-
- -
-
- lamList::$filterText -
-
- -
-
- lamList::$labels -
-
- -
-
- lamList::$maxPageEntries -
-
- -
-
- lamList::$page -
-
- -
-
- lamList::$possibleSuffixes -
-
- -
-
- lamList::$refresh -
-
- -
-
- lamList::$sortColumn -
-
- -
-
- lamList::$sortDirection -
-
- -
-
- lamList::$suffix -
-
- -
-
- lamList::$type -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: lamList

-
-
- lamList::__construct() -
-
- Constructor -
-
- lamList::cmp_array() -
-
- Compare function used for usort-method -
-
- lamList::getAdditionalTools() -
-
- Returns a list of lamListTool objects to display next to the edit/delete buttons. -
-
- lamList::listBuildFilter() -
-
- Builds the regular expressions from the filter values. -
-
- lamList::listConfigurationChanged() -
-
- Called when the configuration options changed. -
-
- lamList::listDrawNavigationBar() -
-
- Draws a navigation bar to switch between pages -
-
- lamList::listFilterAccounts() -
-
- Removes all entries which do not fit to the filter. -
-
- lamList::listGetAllConfigOptions() -
-
- Returns a list of possible configuration options. -
-
- lamList::listGetConfigOptionByID() -
-
- Returns the configuration option with the given ID. -
-
- lamList::listGetParams() -
-
- Sets some internal parameters. -
-
- lamList::listPrintButtons() -
-
- Prints the create and delete buttons. -
-
- lamList::listPrintConfigurationPage() -
-
- Prints the list configuration page. -
-
- lamList::listPrintFooter() -
-
- Prints the HTML footer. -
-
- lamList::listPrintHeader() -
-
- Prints the HTML header. -
-
- 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::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. -
-
-
-
-
- - -

Class Details

-
-[line 97]
-Generates the list view.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 105]

-
-
-
- lamList __construct( -string -$type) -
-

- - Constructor



-

Tags:

-
- - - - -
return:  list object
-
-

- - Overrides lamList::__construct() (Constructor)

-

Parameters:

-
- - - - - - -
string  $type  account type
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:31 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/lamUserList.html b/lam-web/developers/phpdoc/lists/lamUserList.html deleted file mode 100644 index c1000ffa..00000000 --- a/lam-web/developers/phpdoc/lists/lamUserList.html +++ /dev/null @@ -1,729 +0,0 @@ - - -Docs For Class lamUserList - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamUserList

-Source Location: /lib/types/user.inc

- - - - - - - - - - -
- -

Class Overview

-
lamList
-   |
-   --lamUserList

-
Generates the list view.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Constants

- -
-

Methods

- -
-
- - - - - - - - - - - -
-

Inherited Constants

-
-

Class: lamList

-
-
- lamList::LIST_SIZE_OPTION_NAME -
-
- -
-
-
-
-

Inherited Variables

-
-

Class: lamList

-
-
- lamList::$attrArray -
-
- -
-
- lamList::$descArray -
-
- -
-
- lamList::$entries -
-
- -
-
- lamList::$filterText -
-
- -
-
- lamList::$labels -
-
- -
-
- lamList::$maxPageEntries -
-
- -
-
- lamList::$page -
-
- -
-
- lamList::$possibleSuffixes -
-
- -
-
- lamList::$refresh -
-
- -
-
- lamList::$sortColumn -
-
- -
-
- lamList::$sortDirection -
-
- -
-
- lamList::$suffix -
-
- -
-
- lamList::$type -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: lamList

-
-
- lamList::__construct() -
-
- Constructor -
-
- lamList::cmp_array() -
-
- Compare function used for usort-method -
-
- lamList::getAdditionalTools() -
-
- Returns a list of lamListTool objects to display next to the edit/delete buttons. -
-
- lamList::listBuildFilter() -
-
- Builds the regular expressions from the filter values. -
-
- lamList::listConfigurationChanged() -
-
- Called when the configuration options changed. -
-
- lamList::listDrawNavigationBar() -
-
- Draws a navigation bar to switch between pages -
-
- lamList::listFilterAccounts() -
-
- Removes all entries which do not fit to the filter. -
-
- lamList::listGetAllConfigOptions() -
-
- Returns a list of possible configuration options. -
-
- lamList::listGetConfigOptionByID() -
-
- Returns the configuration option with the given ID. -
-
- lamList::listGetParams() -
-
- Sets some internal parameters. -
-
- lamList::listPrintButtons() -
-
- Prints the create and delete buttons. -
-
- lamList::listPrintConfigurationPage() -
-
- Prints the list configuration page. -
-
- lamList::listPrintFooter() -
-
- Prints the HTML footer. -
-
- lamList::listPrintHeader() -
-
- Prints the HTML header. -
-
- 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::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. -
-
-
-
-
- - -

Class Details

-
-[line 106]
-Generates the list view.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 123]

-
-
-
- lamList __construct( -string -$type) -
-

- - Constructor



-

Tags:

-
- - - - - - - -
return:  list object
access:  public
-
-

- - Overrides lamList::__construct() (Constructor)

-

Parameters:

-
- - - - - - -
string  $type  account type
-

-
[ Top ]
-
-
- -

method getAdditionalTools [line 224]

-
-
-
- lamListTool[] getAdditionalTools( -) -
-

- - Returns a list of lamListTool objects to display next to the edit/delete buttons.



-

Tags:

-
- - - - - - - -
return:  tools
access:  protected
-
-

- - Overrides lamList::getAdditionalTools() (Returns a list of lamListTool objects to display next to the edit/delete buttons.)

-
[ Top ]
-
-
- -

method listConfigurationChanged [line 248]

-
-
-
- void listConfigurationChanged( -) -
-

- - Called when the configuration options changed.



-

Tags:

-
- - - - -
access:  protected
-
-

- - Overrides lamList::listConfigurationChanged() (Called when the configuration options changed.)

-
[ Top ]
-
-
- -

method listGetAllConfigOptions [line 239]

-
-
-
- array listGetAllConfigOptions( -) -
-

- - Returns a list of possible configuration options.



-

Tags:

-
- - - - - - - -
return:  list of lamListOption objects
access:  protected
-
-

- - Overrides lamList::listGetAllConfigOptions() (Returns a list of possible configuration options.)

-
[ Top ]
-
-
- -

method listGetParams [line 137]

-
-
-
- void listGetParams( -) -
-

- - Sets some internal parameters.



-

Tags:

-
- - - - -
access:  protected
-
-

- - Overrides lamList::listGetParams() (Sets some internal parameters.)

-
[ Top ]
-
-
- -

method listPrintTableCellContent [line 179]

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



-

Tags:

-
- - - - -
access:  protected
-
-

- - Overrides lamList::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  
-

-
[ Top ]
-
-
- -

method listRefreshData [line 148]

-
-
-
- void listRefreshData( -) -
-

- - Rereads the entries from LDAP.



-

Tags:

-
- - - - -
access:  protected
-
-

- - Overrides lamList::listRefreshData() (Rereads the entries from LDAP.)

-
[ Top ]
-
-
- -

method refreshPrimaryGroupTranslation [line 158]

-
-
-
- void refreshPrimaryGroupTranslation( -) -
-

- - Refreshes the GID to group name cache.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-

- -
- -

Class Constants

-
- -

-

TRANS_PRIMARY_OPTION_NAME =  "LU_TP"

-

[line 115]

- ID for config option

-
-
[ Top ]

-

- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:36 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/lists/tree/_lib---tree.inc.html b/lam-web/developers/phpdoc/lists/tree/_lib---tree.inc.html deleted file mode 100644 index 0ffa6e55..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_lib---tree.inc.html +++ /dev/null @@ -1,1200 +0,0 @@ - - -Docs for page tree.inc - - - - - - - - - - - - - -
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 940]

-
-
-
- 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 209]

-
-
-
- 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 228]

-
-
-
- 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 676]

-
-
-
- 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 1151]

-
-
-
- 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 1329]

-
-
-
- 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 274]

-
-
-
- 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 1121]

-
-
-
- void get_enc_type( - $user_password) -
-

- -

- -

Parameters

- - - - - - -
  $user_password  
-
[ Top ]


-
-
- -

get_entry_system_attrs [line 912]

-
-
-
- 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 311]

-
-
-
- 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 455]

-
-
-
- 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 750]

-
-
-
- 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 489]

-
-
-
- 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 172]

-
-
-
- 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 802]

-
-
-
- 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 988]

-
-
-
- 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 1095]

-
-
-
- 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 956]

-
-
-
- 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 1008]

-
-
-
- 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 1056]

-
-
-
- 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 1024]

-
-
-
- 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 591]

-
-
-
- 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 521]

-
-
-
- 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 1255]

-
-
-
- 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 657]

-
-
-
- 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 546]

-
-
-
- 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 875]

-
-
-
- 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 1034]

-
-
-
- void sortAttrs( - $a, $b) -
-

- -

- -

Parameters

- - - - - - - - - - - -
  $a  
  $b  
-
[ Top ]


-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:32 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/lists/tree/_lib_tree_inc.html b/lam-web/developers/phpdoc/lists/tree/_lib_tree_inc.html deleted file mode 100644 index bf687f48..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_lib_tree_inc.html +++ /dev/null @@ -1,1022 +0,0 @@ - - -Docs for page tree.inc - - - - - - - - - - - - - -
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:  Roland Gruber
author:  David Smith
-
-

-

-

-
-
- -

arrayLower [line 911]

-
-
-
- void arrayLower( -mixed $array) -
-

- -

- - -
[ Top ]


-
-
- -

build_initial_tree_icons [line 180]

-
-
-
- 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 [0] => Array
4 (
5 [dc=example,dc=com] => "dcobject.png"
6 )
7 [1] => Array
8 [o=Corporation] => "o.png"
9 )
10 )
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 199]

-
-
-
- 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 647]

-
-
-
- void draw_formatted_dn( -mixed $dn) -
-

- - Gets a DN string using the user-configured tree_display_format string to format it.



- - -
[ Top ]


-
-
- -

draw_jpeg_photos [line 1122]

-
-
-
- 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="left"'], [mixed $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_photos( 0, "cn=Bob,ou=People,dc=example,dc=com", "jpegPhoto" true, false, "border: 1px; width: 150px" );
2 draw_jpeg_photos( 1, "cn=Fred,ou=People,dc=example,dc=com" );




- - -

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


-
-
- -

draw_server_tree [line 49]

-
-
-
- void draw_server_tree( -) -
-

- - Prints the HTML of the tree view.



- - -
[ Top ]


-
-
- -

get_container [line 1300]

-
-
-
- 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 245]

-
-
-
- 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 ou=People
3 cn=Dave
4 cn=Fred
5 cn=Joe
6 ou=More People
7 cn=Mark
8 cn=Bob

Calling


1 get_container_contents( "ou=people,dc=example,dc=com" )
would return the following list:


1 cn=Dave
2 cn=Fred
3 cn=Joe
4 ou=More People




-

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 1092]

-
-
-
- void get_enc_type( -mixed $user_password) -
-

- -

- - -
[ Top ]


-
-
- -

get_entry_system_attrs [line 883]

-
-
-
- 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 [creatorsName] => Array
4 (
5 [0] => "cn=Admin,dc=example,dc=com"
6 )
7 [createTimeStamp]=> Array
8 (
9 [0] => "10401040130"
10 )
11 [hasSubordinates] => Array
12 (
13 [0] => "FALSE"
14 )
15 )




-

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 282]

-
-
-
- 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 426]

-
-
-
- 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_r( get_object_attr( 0, "cn=Bob,ou=people,dc=example,dc=com", "sn" ) );
2 // prints:
3 // Array
4 // (
5 // [0] => "Smith"
6 // )
7
8 print_r( get_object_attr( 0, "cn=Bob,ou=people,dc=example,dc=com", "objectClass" ) );
9 // prints:
10 // Array
11 // (
12 // [0] => "top"
13 // [1] => "person"
14 // )




-

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 721]

-
-
-
- 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_attrs( 0, "cn=Bob,ou=pepole,dc=example,dc=com" )


1 Array
2 (
3 [objectClass] => Array
4 (
5 [0] => person
6 [1] => top
7 )
8 [cn] => Array
9 (
10 [0] => Bob
11 )
12 [sn] => Array
13 (
14 [0] => Jones
15 )
16 [dn] => Array
17 (
18 [0] => cn=Bob,ou=pepole,dc=example,dc=com
19 )
20 )




-

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 460]

-
-
-
- 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 143]

-
-
-
- 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 773]

-
-
-
- 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 959]

-
-
-
- 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 1066]

-
-
-
- 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 927]

-
-
-
- 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 979]

-
-
-
- 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 1027]

-
-
-
- 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 if( is_muli_line_attr( "postalAddress" ) )
2 echo "<textarea name=\"postalAddress\"></textarea>";
3 else
4 echo "<input name=\"postalAddress\" type=\"text\">";




- - -

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 995]

-
-
-
- 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 562]

-
-
-
- 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 cn=Admin,ou=People,dc=example,dc=com
3 cn=Joe,ou=people,dc=example,dc=com
4 dc=example,dc=com
5 cn=Fred,ou=people,dc=example,dc=org
6 cn=Dave,ou=people,dc=example,dc=org
Will be sorted thus using usort( $list, "pla_compare_dns" ):

1 dc=com
2 dc=example,dc=com
3 ou=people,dc=example,dc=com
4 cn=Admin,ou=People,dc=example,dc=com
5 cn=Joe,ou=people,dc=example,dc=com
6 cn=Dave,ou=people,dc=example,dc=org
7 cn=Fred,ou=people,dc=example,dc=org




- - -

Parameters

- - - - - - - - - - - -
string  $dn1  The first of two DNs to compare
string  $dn2  The second of two DNs to compare
-
[ Top ]


-
-
- -

pla_explode_dn [line 492]

-
-
-
- array pla_explode_dn( -string $dn, [mixed $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 [0] => uid=ppratt
4 [1] => ou=People
5 [2] => dc=example
6 [3] => dc=com
7 )
-
-

- - -

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)
-
[ Top ]


-
-
- -

pla_ldap_search [line 1226]

-
-
-
- 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_search( 0, "(&(objectClass=sambaAccount)(objectClass=posixAccount))",
2 "ou=People,dc=example,dc=com", array( "uid", "homeDirectory" ) );
3 print_r( $samba_users );
4 // prints (for example):
5 // Array
6 // (
7 // [uid=jsmith,ou=People,dc=example,dc=com] => Array
8 // (
9 // [dn] => "uid=jsmith,ou=People,dc=example,dc=com"
10 // [uid] => "jsmith"
11 // [homeDirectory] => "\\server\jsmith"
12 // )
13 // [uid=byoung,ou=People,dc=example,dc=com] => Array
14 // (
15 // [dn] => "uid=byoung,ou=Samba,ou=People,dc=example,dc=com"
16 // [uid] => "byoung"
17 // [homeDirectory] => "\\server\byoung"
18 // )
19 // )

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 628]

-
-
-
- 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
Becomes:

1 dc=com,dc=example,ou=People,cn=Brigham
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 517]

-
-
-
- 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 846]

-
-
-
- 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 1005]

-
-
-
- void sortAttrs( -mixed $a, mixed $b) -
-

- -

- - -
[ Top ]


-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:01:09 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index ba2c1fd8..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_attr.php.html +++ /dev/null @@ -1,206 +0,0 @@ - - -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 140]

-
-
-
- void is_binary_option_required( - $attr) -
-

- -

- -

Parameters

- - - - - - -
  $attr  
-
[ Top ]


-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:50 +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 deleted file mode 100644 index 4525dd61..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_attr_form.php.html +++ /dev/null @@ -1,205 +0,0 @@ - - -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, 06 Jan 2008 18:58:51 +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 deleted file mode 100644 index a2afdff8..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_oclass.php.html +++ /dev/null @@ -1,182 +0,0 @@ - - -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, 06 Jan 2008 18:58:51 +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 deleted file mode 100644 index ff151eda..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_oclass_form.php.html +++ /dev/null @@ -1,182 +0,0 @@ - - -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, 06 Jan 2008 18:58:51 +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 deleted file mode 100644 index c982d1f8..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_value.php.html +++ /dev/null @@ -1,182 +0,0 @@ - - -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, 06 Jan 2008 18:58:51 +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 deleted file mode 100644 index e108d93a..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---add_value_form.php.html +++ /dev/null @@ -1,182 +0,0 @@ - - -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, 06 Jan 2008 18:58:51 +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 deleted file mode 100644 index 783ba1c2..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---collapse.php.html +++ /dev/null @@ -1,181 +0,0 @@ - - -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, 06 Jan 2008 18:58:55 +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 deleted file mode 100644 index 27c13051..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---create.php.html +++ /dev/null @@ -1,183 +0,0 @@ - - -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, 06 Jan 2008 18:58:57 +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 deleted file mode 100644 index a673873f..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---create_form.php.html +++ /dev/null @@ -1,183 +0,0 @@ - - -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, 06 Jan 2008 18:58:58 +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 deleted file mode 100644 index 789f414f..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---creation_template.php.html +++ /dev/null @@ -1,184 +0,0 @@ - - -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, 06 Jan 2008 18:58:58 +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 deleted file mode 100644 index d562268a..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---delete.php.html +++ /dev/null @@ -1,182 +0,0 @@ - - -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, 06 Jan 2008 18:58:59 +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 deleted file mode 100644 index 2ce81644..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---delete_attr.php.html +++ /dev/null @@ -1,182 +0,0 @@ - - -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, 06 Jan 2008 18:58:59 +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 deleted file mode 100644 index 1b34f586..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---delete_form.php.html +++ /dev/null @@ -1,182 +0,0 @@ - - -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, 06 Jan 2008 18:58:59 +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 deleted file mode 100644 index 82e8e332..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---download_binary_attr.php.html +++ /dev/null @@ -1,182 +0,0 @@ - - -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, 06 Jan 2008 18:58:59 +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 deleted file mode 100644 index fb894210..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---edit.php.html +++ /dev/null @@ -1,183 +0,0 @@ - - -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, 06 Jan 2008 18:58:59 +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 deleted file mode 100644 index b865ba14..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---expand.php.html +++ /dev/null @@ -1,181 +0,0 @@ - - -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, 06 Jan 2008 18:59:00 +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 deleted file mode 100644 index 79762e77..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---export.php.html +++ /dev/null @@ -1,183 +0,0 @@ - - -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, 06 Jan 2008 18:59:02 +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 deleted file mode 100644 index 18d417cc..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---export_form.php.html +++ /dev/null @@ -1,206 +0,0 @@ - - -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, 06 Jan 2008 18:59:02 +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 deleted file mode 100644 index 87591cba..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---rdelete.php.html +++ /dev/null @@ -1,205 +0,0 @@ - - -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 129]

-
-
-
- void pla_rdelete( - $dn) -
-

- -

- -

Parameters

- - - - - - -
  $dn  
-
[ Top ]


-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:23 +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 deleted file mode 100644 index 97c50741..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---refresh.php.html +++ /dev/null @@ -1,181 +0,0 @@ - - -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, 06 Jan 2008 18:59:23 +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 deleted file mode 100644 index 8cc6fa1a..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---creation---custom.php.html +++ /dev/null @@ -1,253 +0,0 @@ - - -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, 06 Jan 2008 18:58:59 +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 deleted file mode 100644 index fd4d2650..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---creation---new_ou_template.php.html +++ /dev/null @@ -1,174 +0,0 @@ - - -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, 06 Jan 2008 18:59:17 +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 deleted file mode 100644 index ade791cf..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---templates---templates.inc.html +++ /dev/null @@ -1,174 +0,0 @@ - - -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, 06 Jan 2008 18:59:32 +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 deleted file mode 100644 index 3e20fc80..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---tree.php.html +++ /dev/null @@ -1,242 +0,0 @@ - - -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, 06 Jan 2008 18:59:35 +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 deleted file mode 100644 index 172366f2..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---tree_view.php.html +++ /dev/null @@ -1,178 +0,0 @@ - - -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, 06 Jan 2008 18:59:35 +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 deleted file mode 100644 index b9553ef8..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---update.php.html +++ /dev/null @@ -1,182 +0,0 @@ - - -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, 06 Jan 2008 18:59:35 +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 deleted file mode 100644 index 761b9898..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates---tree---update_confirm.php.html +++ /dev/null @@ -1,182 +0,0 @@ - - -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, 06 Jan 2008 18:59:36 +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 deleted file mode 100644 index e05ae208..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_attr_form_php.html +++ /dev/null @@ -1,186 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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( -mixed $x) -
-

- - Given an attribute $x, this returns true if it is NOT already specified in the current entry, returns false otherwise.



- - -
[ Top ]


-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index abdb7e00..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_attr_php.html +++ /dev/null @@ -1,187 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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( -mixed $attr) -
-

- -

- - -
[ Top ]


-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:35 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 7813c8c9..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_oclass_form_php.html +++ /dev/null @@ -1,170 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index ad62516b..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_oclass_php.html +++ /dev/null @@ -1,170 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 229c67f1..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_value_form_php.html +++ /dev/null @@ -1,170 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 23b40b00..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_value_php.html +++ /dev/null @@ -1,170 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index bbe956ba..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_collapse_php.html +++ /dev/null @@ -1,169 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:39 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 0cae6331..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_create_form_php.html +++ /dev/null @@ -1,171 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index eac1fe9e..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_create_php.html +++ /dev/null @@ -1,171 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 098b594c..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_creation_template_php.html +++ /dev/null @@ -1,172 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 89302503..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_attr_php.html +++ /dev/null @@ -1,170 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 40b37ced..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_form_php.html +++ /dev/null @@ -1,170 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 2c7c4d0f..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_php.html +++ /dev/null @@ -1,170 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index c152cfee..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_download_binary_attr_php.html +++ /dev/null @@ -1,170 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 92b7b971..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_edit_php.html +++ /dev/null @@ -1,171 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 1ff6867f..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_expand_php.html +++ /dev/null @@ -1,169 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index f6135d55..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_export_form_php.html +++ /dev/null @@ -1,195 +0,0 @@ - - -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:  Roland Gruber
author:  The phpLDAPadmin development team
-
-

-

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 Wed, 15 Nov 2006 18:00:45 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 84448d53..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_export_php.html +++ /dev/null @@ -1,171 +0,0 @@ - - -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:  Roland Gruber
author:  The phpLDAPadmin development team
-
-

-

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 Wed, 15 Nov 2006 18:00:44 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index d2f1cd99..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_rdelete_php.html +++ /dev/null @@ -1,186 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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( -mixed $dn) -
-

- -

- - -
[ Top ]


-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:01:00 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index fd02adbe..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_refresh_php.html +++ /dev/null @@ -1,169 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:01:01 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 40e5bc1e..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_creation_custom_php.html +++ /dev/null @@ -1,210 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

-

-
-
- -

get_attr_select_html [line 245]

-
-
-
- void get_attr_select_html( -mixed $all_attrs, [mixed $highlight_attr = null]) -
-

- - Returns option values.



- - -
[ Top ]


-
-
- -

get_binary_attr_select_html [line 264]

-
-
-
- void get_binary_attr_select_html( -mixed $binary_attrs, [mixed $highlight_attr = null]) -
-

- - Returns option values.



- - -
[ Top ]


-
-
- -

remove_aliases [line 285]

-
-
-
- void remove_aliases( -mixed &$attribute_list) -
-

- - Removes attributes from the array that are aliases for eachother

(just removes the second instance of the aliased attr)




- - -
[ Top ]


-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 90879a3f..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_creation_new_ou_template_php.html +++ /dev/null @@ -1,162 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:55 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index b76bdd80..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_templates_inc.html +++ /dev/null @@ -1,162 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:01:09 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 29b8b8fc..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_tree_php.html +++ /dev/null @@ -1,201 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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( -mixed $rdn, mixed $level, mixed $encoded_dn) -
-

- -

- - -
[ Top ]


-
-
- -

draw_tree_html [line 102]

-
-
-
- void draw_tree_html( -mixed $dn, [mixed $level = 0]) -
-

- - Recursively descend on the given dn and draw the tree in html



- - -
[ Top ]


-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:01:12 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 94539cd4..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_tree_view_php.html +++ /dev/null @@ -1,166 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:12 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index c137ff99..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_update_confirm_php.html +++ /dev/null @@ -1,170 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file 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 deleted file mode 100644 index 10901eeb..00000000 --- a/lam-web/developers/phpdoc/lists/tree/_templates_tree_update_php.html +++ /dev/null @@ -1,170 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:01:12 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/main/_templates---delete.php.html b/lam-web/developers/phpdoc/main/_templates---delete.php.html deleted file mode 100644 index 845305ce..00000000 --- a/lam-web/developers/phpdoc/main/_templates---delete.php.html +++ /dev/null @@ -1,178 +0,0 @@ - - -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 272]

-
-
-
- array deleteDN( -string $dn) -
-

- - Deletes a DN and all child entries.



-

Tags:

-
- - - - -
return:  error messages
-
-

- -

Parameters

- - - - - - -
string  $dn  DN to delete
-
[ Top ]


-
-
- -

getChildCount [line 256]

-
-
-
- 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, 06 Jan 2008 18:58:59 +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 deleted file mode 100644 index c500f3b3..00000000 --- a/lam-web/developers/phpdoc/main/_templates---initsuff.php.html +++ /dev/null @@ -1,108 +0,0 @@ - - -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, 06 Jan 2008 18:59:10 +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 deleted file mode 100644 index e168da01..00000000 --- a/lam-web/developers/phpdoc/main/_templates---login.php.html +++ /dev/null @@ -1,132 +0,0 @@ - - -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 100]
-access to configuration options

include_once("../lib/ldap.inc") [line 380]
-include_once("../lib/selfService.inc") [line 36]
-self service functions

-

-

-
-
- -

display_LoginPage [line 110]

-
-
-
- void display_LoginPage( -object $config_object) -
-

- - Displays the login window.



- -

Parameters

- - - - - - -
object  $config_object  current active configuration
-
[ Top ]


-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:15 +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 deleted file mode 100644 index bf38e948..00000000 --- a/lam-web/developers/phpdoc/main/_templates---logout.php.html +++ /dev/null @@ -1,107 +0,0 @@ - - -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, 06 Jan 2008 18:59:15 +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 deleted file mode 100644 index 9693c593..00000000 --- a/lam-web/developers/phpdoc/main/_templates---main.php.html +++ /dev/null @@ -1,106 +0,0 @@ - - -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, 06 Jan 2008 18:59:16 +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 deleted file mode 100644 index 211b2b83..00000000 --- a/lam-web/developers/phpdoc/main/_templates---main_header.php.html +++ /dev/null @@ -1,107 +0,0 @@ - - -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, 06 Jan 2008 18:59:16 +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 deleted file mode 100644 index 1786f21e..00000000 --- a/lam-web/developers/phpdoc/main/_templates_delete_php.html +++ /dev/null @@ -1,174 +0,0 @@ - - -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
-
-

-

Includes:

-
-include_once('../lib/status.inc') [line 39]
-message displaying

include_once("../lib/security.inc") [line 33]
-security functions

include_once('../lib/config.inc') [line 37]
-current configuration options

include_once('../lib/ldap.inc') [line 41]
-LDAP connection

include_once('../lib/modules.inc') [line 45]
-module interface

include_once('../lib/lamdaemon.inc') [line 43]
-lamdaemon interface

include_once('../lib/account.inc') [line 35]
-account functions

-

-

-
-
- -

deleteDN [line 264]

-
-
-
- array deleteDN( -string $dn) -
-

- - Deletes a DN and all child entries.



-

Tags:

-
- - - - -
return:  error messages
-
-

- - -

Parameters

- - - - - - -
string  $dn  DN to delete
-
[ Top ]


-
-
- -

getChildCount [line 248]

-
-
-
- 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 Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/main/_templates_initsuff_php.html b/lam-web/developers/phpdoc/main/_templates_initsuff_php.html deleted file mode 100644 index 58cee4e1..00000000 --- a/lam-web/developers/phpdoc/main/_templates_initsuff_php.html +++ /dev/null @@ -1,105 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:49 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/main/_templates_login_php.html b/lam-web/developers/phpdoc/main/_templates_login_php.html deleted file mode 100644 index 26912904..00000000 --- a/lam-web/developers/phpdoc/main/_templates_login_php.html +++ /dev/null @@ -1,131 +0,0 @@ - - -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("./main.php") [line 400]
-include_once("../lib/selfService.inc") [line 36]
-self service functions

include_once("../lib/status.inc") [line 32]
-status messages

include_once("../lib/config.inc") [line 88]
-access to configuration options

include_once("../lib/ldap.inc") [line 367]
-include_once("../lib/security.inc") [line 34]
-security functions

-

-

-
-
- -

display_LoginPage [line 98]

-
-
-
- void display_LoginPage( -object $config_object) -
-

- - Displays the login window.



- - -

Parameters

- - - - - - -
object  $config_object  current active configuration
-
[ Top ]


-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:52 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/main/_templates_logout_php.html b/lam-web/developers/phpdoc/main/_templates_logout_php.html deleted file mode 100644 index c2a0b05e..00000000 --- a/lam-web/developers/phpdoc/main/_templates_logout_php.html +++ /dev/null @@ -1,104 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:52 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/main/_templates_main_header_php.html b/lam-web/developers/phpdoc/main/_templates_main_header_php.html deleted file mode 100644 index bba15cce..00000000 --- a/lam-web/developers/phpdoc/main/_templates_main_header_php.html +++ /dev/null @@ -1,104 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/main/_templates_main_php.html b/lam-web/developers/phpdoc/main/_templates_main_php.html deleted file mode 100644 index de95c5f5..00000000 --- a/lam-web/developers/phpdoc/main/_templates_main_php.html +++ /dev/null @@ -1,102 +0,0 @@ - - -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

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/media/background.png b/lam-web/developers/phpdoc/media/background.png deleted file mode 100644 index 638060d2d86d16f12b518f2521d3072b8c20d251..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 237 zcmeAS@N?&q;$mQ6;PUiv2?Ek5fmnot8AuB3czFy+X_vT0lsFfqCYEI8=P86_=B6@~ z=PMYQE9B*uDHs_T7%3Qe!-ttOXD&6Ze*hFQ z@pN$vskrs_(m_rJ2M%V(xBFjeADmv%GLvi5gjE8ywho>Joc~W&P8XW-bdNXZnWB43 bTU_~z9T>O-CUKhr^)q<7`njxgN@xNA`nX3A diff --git a/lam-web/developers/phpdoc/media/empty.png b/lam-web/developers/phpdoc/media/empty.png deleted file mode 100644 index b26eb55a05da825ee7cbe419de5468e3b47fd6ed..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 205 zcmeAS@N?&q;$mQ6;PUiv2?ElLAk4uGBsET(>;_WWC9V-A&PAz-C7Jno3L%-fsSM@$ z3P$D%dHH1uMg|5(3WjD@hUQkr#tPa7h6V=yg*O|3+Sp4xeO=ivaZB?HYF6Im@&XER z7I;J!Gca%qfiUBxyLEqnf-LEdzK#qG8~eHcB(ehe%mF?juK)l4Uw%aT1dz*E666=m n;PC858j!=~>EaktaVt3i$Yx?-e5!sAWCDYytDnm{r-UW|AR#o6 diff --git a/lam-web/developers/phpdoc/media/style.css b/lam-web/developers/phpdoc/media/style.css deleted file mode 100644 index bc65d896..00000000 --- a/lam-web/developers/phpdoc/media/style.css +++ /dev/null @@ -1,195 +0,0 @@ -.php { - padding: 1em; -} -.php-src { font-family: 'Courier New', Courier, monospace; font-weight: normal; } - -body -{ - color: #000000; - background-color: #ffffff; - background-image: url("background.png"); - background-repeat: repeat-y; - font-family: tahoma, verdana, arial, sans-serif; - font-size: 10pt; - margin: 0; - padding: 0; -} - -a -{ - color: #000099; - background-color: transparent; - text-decoration: none; -} - -a:hover -{ - text-decoration: underline; -} - -a.menu -{ - color: #ffffff; - background-color: transparent; -} - -td -{ - font-size: 10pt; -} - -td.header_top -{ - color: #ffffff; - background-color: #9999cc; - font-size: 16pt; - font-weight: bold; - text-align: right; - padding: 10px; -} - -td.header_line -{ - color: #ffffff; - background-color: #333366; -} - -td.header_menu -{ - color: #ffffff; - background-color: #666699; - font-size: 8pt; - text-align: right; - padding: 2px; - padding-right: 5px; -} - -td.menu -{ - padding: 2px; - padding-left: 5px; -} - -td.code_border -{ - color: #000000; - background-color: #c0c0c0; -} - -td.code -{ - color: #000000; - background-color: #f0f0f0; -} - -td.type -{ - font-style: italic; -} - -div.credit -{ - font-size: 8pt; - text-align: center; -} - -div.package -{ - padding-left: 5px; -} - -div.tags -{ - padding-left: 15px; -} - -div.function -{ - padding-left: 15px; -} - -div.top -{ - font-size: 8pt; -} - -div.warning -{ - color: #ff0000; - background-color: transparent; -} - -div.description -{ - padding-left: 15px; -} - -hr -{ - height: 1px; - border-style: solid; - border-color: #c0c0c0; - margin-top: 10px; - margin-bottom: 10px; -} - -span.smalllinenumber -{ - font-size: 8pt; -} - -ul { - margin-left: 0px; - padding-left: 8px; -} -/* Syntax highlighting */ - -.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; } - -.src-comm { color: green; } -.src-id { } -.src-inc { color: #0000FF; } -.src-key { color: #0000FF; } -.src-num { color: #CC0000; } -.src-str { color: #66cccc; } -.src-sym { font-weight: bold; } -.src-var { } - -.src-php { font-weight: bold; } - -.src-doc { color: #009999 } -.src-doc-close-template { color: #0000FF } -.src-doc-coretag { color: #0099FF; font-weight: bold } -.src-doc-inlinetag { color: #0099FF } -.src-doc-internal { color: #6699cc } -.src-doc-tag { color: #0080CC } -.src-doc-template { color: #0000FF } -.src-doc-type { font-style: italic } -.src-doc-var { font-style: italic } - -.tute-tag { color: #009999 } -.tute-attribute-name { color: #0000FF } -.tute-attribute-value { color: #0099FF } -.tute-entity { font-weight: bold; } -.tute-comment { font-style: italic } -.tute-inline-tag { color: #636311; font-weight: bold } - -/* tutorial */ - -.authors { } -.author { font-style: italic; font-weight: bold } -.author-blurb { margin: .5em 0em .5em 2em; font-size: 85%; font-weight: normal; font-style: normal } -.example { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; } -.listing { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; white-space: nowrap; } -.release-info { font-size: 85%; font-style: italic; margin: 1em 0em } -.ref-title-box { } -.ref-title { } -.ref-purpose { font-style: italic; color: #666666 } -.ref-synopsis { } -.title { font-weight: bold; margin: 1em 0em 0em 0em; padding: .25em; border: 2px solid #999999; background-color: #9999CC } -.cmd-synopsis { margin: 1em 0em } -.cmd-title { font-weight: bold } -.toc { margin-left: 2em; padding-left: 0em } - diff --git a/lam-web/developers/phpdoc/modules/_lib---baseModule.inc.html b/lam-web/developers/phpdoc/modules/_lib---baseModule.inc.html deleted file mode 100644 index 36a27e72..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---baseModule.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -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, 06 Jan 2008 18:58:52 +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 deleted file mode 100644 index 4846c5bc..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---createntlm.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -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, 06 Jan 2008 18:58:58 +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 deleted file mode 100644 index 12d5420f..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---lamdaemon.inc.html +++ /dev/null @@ -1,241 +0,0 @@ - - -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, 06 Jan 2008 18:59:11 +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 deleted file mode 100644 index 2ad87fbd..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---account.inc.html +++ /dev/null @@ -1,172 +0,0 @@ - - -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, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---groupOfNames.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---groupOfNames.inc.html deleted file mode 100644 index 28b4baf2..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---groupOfNames.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -Docs for page groupOfNames.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: groupOfNames.inc

-Source Location: /lib/modules/groupOfNames.inc

- -
-
- -
-

Classes:

-
groupOfNames
-
Manages group members for the object class groupOfNames.
-


- -

Page Details:

-Manages group members for the object class groupOfNames.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:04 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/modules/_lib---modules---groupOfUniqueNames.inc.html b/lam-web/developers/phpdoc/modules/_lib---modules---groupOfUniqueNames.inc.html deleted file mode 100644 index 57004fb2..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---groupOfUniqueNames.inc.html +++ /dev/null @@ -1,170 +0,0 @@ - - -Docs for page groupOfUniqueNames.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: groupOfUniqueNames.inc

-Source Location: /lib/modules/groupOfUniqueNames.inc

- -
-
- -
-

Classes:

-
groupOfUniqueNames
-
Manages group members for the object class groupOfUniqueNames.
-


- -

Page Details:

-Manages group members for the object class groupOfUniqueNames.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("groupOfNames.inc") [line 18]
-include parent class

-

-

-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:05 +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 deleted file mode 100644 index 298d95ac..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---ieee802device.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -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, 06 Jan 2008 18:59:07 +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 deleted file mode 100644 index 02646e54..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---inetLocalMailRecipient.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -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, 06 Jan 2008 18:59:08 +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 deleted file mode 100644 index a4a62739..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---inetOrgPerson.inc.html +++ /dev/null @@ -1,172 +0,0 @@ - - -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, 06 Jan 2008 18:59:09 +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 deleted file mode 100644 index aee1e291..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---kolabUser.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -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, 06 Jan 2008 18:59:10 +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 deleted file mode 100644 index 29f31d1e..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---ldapPublicKey.inc.html +++ /dev/null @@ -1,169 +0,0 @@ - - -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, 06 Jan 2008 18:59:12 +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 deleted file mode 100644 index 7646a4a1..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---nisMailAlias.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -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, 06 Jan 2008 18:59:17 +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 deleted file mode 100644 index 66439baa..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---posixAccount.inc.html +++ /dev/null @@ -1,175 +0,0 @@ - - -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, 06 Jan 2008 18:59:19 +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 deleted file mode 100644 index 7a9acbfc..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---posixGroup.inc.html +++ /dev/null @@ -1,172 +0,0 @@ - - -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, 06 Jan 2008 18:59:20 +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 deleted file mode 100644 index c35a764f..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---quota.inc.html +++ /dev/null @@ -1,172 +0,0 @@ - - -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, 06 Jan 2008 18:59:22 +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 deleted file mode 100644 index e01faeb4..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---sambaAccount.inc.html +++ /dev/null @@ -1,172 +0,0 @@ - - -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, 06 Jan 2008 18:59:23 +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 deleted file mode 100644 index fb0529c4..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---sambaDomain.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -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, 06 Jan 2008 18:59:24 +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 deleted file mode 100644 index 796a9744..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---sambaGroupMapping.inc.html +++ /dev/null @@ -1,172 +0,0 @@ - - -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, 06 Jan 2008 18:59:25 +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 deleted file mode 100644 index 39f6e511..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html +++ /dev/null @@ -1,192 +0,0 @@ - - -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, 06 Jan 2008 18:59:26 +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 deleted file mode 100644 index 8cc38261..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---sambaSamAccount.inc.html +++ /dev/null @@ -1,176 +0,0 @@ - - -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, 06 Jan 2008 18:59:26 +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 deleted file mode 100644 index 441d03a7..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules---shadowAccount.inc.html +++ /dev/null @@ -1,172 +0,0 @@ - - -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, 06 Jan 2008 18:59:30 +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 deleted file mode 100644 index c51a219b..00000000 --- a/lam-web/developers/phpdoc/modules/_lib---modules.inc.html +++ /dev/null @@ -1,887 +0,0 @@ - - -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, 06 Jan 2008 18:59:16 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/modules/_lib_baseModule_inc.html b/lam-web/developers/phpdoc/modules/_lib_baseModule_inc.html deleted file mode 100644 index 3a2c3f56..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_baseModule_inc.html +++ /dev/null @@ -1,153 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_createntlm_inc.html b/lam-web/developers/phpdoc/modules/_lib_createntlm_inc.html deleted file mode 100644 index f66d8e55..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_createntlm_inc.html +++ /dev/null @@ -1,153 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_lamdaemon_inc.html b/lam-web/developers/phpdoc/modules/_lib_lamdaemon_inc.html deleted file mode 100644 index a864e337..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_lamdaemon_inc.html +++ /dev/null @@ -1,217 +0,0 @@ - - -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:  Roland Gruber
author:  Tilo Lutz
-
-

-

-

-
-
- -

lamdaemon [line 40]

-
-
-
- array lamdaemon( -array $commands) -
-

- - Sends commands to lamdaemon script.



-

Tags:

-
- - - - -
return:  Output of lamdaemon
-
-

- - -

Parameters

- - - - - - -
array  $commands  List of command lines
-
[ Top ]


-
-
- -

lamdaemonSSH [line 109]

-
-
-
- array lamdaemonSSH( -array $commands) -
-

- - Sends commands to lamdaemon script via PHP SSH functions.



-

Tags:

-
- - - - -
return:  Output of lamdaemon
-
-

- - -

Parameters

- - - - - - -
array  $commands  List of command lines
-
[ Top ]


-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:50 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_account_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_account_inc.html deleted file mode 100644 index f8b503ed..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_account_inc.html +++ /dev/null @@ -1,159 +0,0 @@ - - -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:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_ieee802device_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_ieee802device_inc.html deleted file mode 100644 index bbd91127..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_ieee802device_inc.html +++ /dev/null @@ -1,153 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:47 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_inc.html deleted file mode 100644 index 3bafb2a0..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_inc.html +++ /dev/null @@ -1,878 +0,0 @@ - - -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:  Roland Gruber
author:  Michael Duergner
author:  Tilo Lutz
-
-

-

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 394]

-
-
-
- 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 474]

-
-
-
- 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 348]

-
-
-
- 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 337]

-
-
-
- array getHelp( -string $module, string $helpID, [mixed $scope = '']) -
-

- - Returns a help entry from an account module.



-

Tags:

-
- - - - -
return:  help entry
-
-

- - -

Parameters

- - - - - - - - - - - -
string  $helpID  help identifier
string  $module  module name
-
[ 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 510]

-
-
-
- array getRequiredExtensions( -) -
-

- - Returns true if the module is a base module



-

Tags:

-
- - - - -
return:  required extensions
-
-

- - -
[ Top ]


-
-
- -

getUploadColumns [line 374]

-
-
-
- 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 538]

-
-
-
- array parseHtml( -string $module, array $input, array $values, boolean $restricted, integer &$tabindex, integer &$tabindexLink, string $scope) -
-

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


-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_inetLocalMailRecipient_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_inetLocalMailRecipient_inc.html deleted file mode 100644 index fc18b647..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_inetLocalMailRecipient_inc.html +++ /dev/null @@ -1,153 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:48 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_inetOrgPerson_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_inetOrgPerson_inc.html deleted file mode 100644 index 943569b4..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_inetOrgPerson_inc.html +++ /dev/null @@ -1,159 +0,0 @@ - - -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 class contains all account LDAP attributes and funtioncs required to deal with inetOrgPerson.
-


- -

Page Details:

-Manages the atrributes of object class inetOrgPerson.



-

Tags:

-
- - - - - - - - - - -
author:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:48 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_kolabUser_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_kolabUser_inc.html deleted file mode 100644 index dc783956..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_kolabUser_inc.html +++ /dev/null @@ -1,153 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:49 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_ldapPublicKey_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_ldapPublicKey_inc.html deleted file mode 100644 index 95e6f756..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_ldapPublicKey_inc.html +++ /dev/null @@ -1,156 +0,0 @@ - - -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:  Andrew Dibble <mailto:adibble@mobitv.com>
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:51 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_nisMailAlias_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_nisMailAlias_inc.html deleted file mode 100644 index 9888c50f..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_nisMailAlias_inc.html +++ /dev/null @@ -1,153 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:55 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_posixAccount_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_posixAccount_inc.html deleted file mode 100644 index 5a61a7e2..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_posixAccount_inc.html +++ /dev/null @@ -1,159 +0,0 @@ - - -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:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:56 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_posixGroup_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_posixGroup_inc.html deleted file mode 100644 index aed05f4c..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_posixGroup_inc.html +++ /dev/null @@ -1,159 +0,0 @@ - - -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:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:58 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_quota_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_quota_inc.html deleted file mode 100644 index 7d47cf4c..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_quota_inc.html +++ /dev/null @@ -1,159 +0,0 @@ - - -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:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:01:00 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_sambaAccount_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_sambaAccount_inc.html deleted file mode 100644 index 1a696231..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_sambaAccount_inc.html +++ /dev/null @@ -1,159 +0,0 @@ - - -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:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:01:01 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_sambaDomain_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_sambaDomain_inc.html deleted file mode 100644 index 1f13c2a6..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_sambaDomain_inc.html +++ /dev/null @@ -1,153 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:02 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_sambaGroupMapping_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_sambaGroupMapping_inc.html deleted file mode 100644 index 0a40469d..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_sambaGroupMapping_inc.html +++ /dev/null @@ -1,159 +0,0 @@ - - -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:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:01:02 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_sambaSamAccount_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_sambaSamAccount_inc.html deleted file mode 100644 index db6e90ae..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_sambaSamAccount_inc.html +++ /dev/null @@ -1,159 +0,0 @@ - - -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:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:01:03 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_shadowAccount_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_shadowAccount_inc.html deleted file mode 100644 index ba065efd..00000000 --- a/lam-web/developers/phpdoc/modules/_lib_modules_shadowAccount_inc.html +++ /dev/null @@ -1,159 +0,0 @@ - - -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:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:01:07 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/_templates---account---edit.php.html b/lam-web/developers/phpdoc/modules/_templates---account---edit.php.html deleted file mode 100644 index eb86d392..00000000 --- a/lam-web/developers/phpdoc/modules/_templates---account---edit.php.html +++ /dev/null @@ -1,170 +0,0 @@ - - -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, 06 Jan 2008 18:59:00 +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 deleted file mode 100644 index 5525560c..00000000 --- a/lam-web/developers/phpdoc/modules/_templates_account_edit_php.html +++ /dev/null @@ -1,157 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/account.html b/lam-web/developers/phpdoc/modules/account.html deleted file mode 100644 index c48c8bdd..00000000 --- a/lam-web/developers/phpdoc/modules/account.html +++ /dev/null @@ -1,797 +0,0 @@ - - -Docs For Class account - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: account

-Source Location: /lib/modules/account.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --account

-
Manages the object class "account" for users and hosts.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 39]
-Manages the object class "account" for users and hosts.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 251]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 213]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - -
[ Top ]
-
-
- -

method getButtonStatus [line 155]

-
-
-
- string getButtonStatus( -) -
-

- - Controls if the module button the account page is visible and activated.



-

Tags:

-
- - - - -
return:  status ("enabled", "disabled", "hidden")
-
-

- - Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

-
[ Top ]
-
-
- -

method get_metaData [line 46]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 236]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 132]

-
-
-
- void load_Messages( -) -
-

- - This function fills the message array.



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method module_complete [line 144]

-
-
-
- boolean module_complete( -) -
-

- - This functions returns true if all needed settings are done.



-

Tags:

-
- - - - -
return:  true if LDAP operation can be done
-
-

- - Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

-
[ Top ]
-
-
- -

method process_attributes [line 194]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 177]

-
-
-
- array save_attributes( -) -
-

- - 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 ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/accountContainer.html b/lam-web/developers/phpdoc/modules/accountContainer.html deleted file mode 100644 index 7bb2a9be..00000000 --- a/lam-web/developers/phpdoc/modules/accountContainer.html +++ /dev/null @@ -1,767 +0,0 @@ - - -Docs For Class accountContainer - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: accountContainer

-Source Location: /lib/modules.inc

- - - - - - - - - - -
- -

Class Overview

-

-
This class includes all modules and attributes of an account.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 730]
-This class includes all modules and attributes of an account.



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$attributes =

-

[line 759]

- Array of all used attributes

Syntax is attribute => array ( objectClass => MUST or MAY, ...)


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


-
[ Top ]

- -

-

$attributes_orig =

-

[line 780]

- original LDAP attributes when account was loaded from LDAP

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


-
[ Top ]

- -

-

$dn =

-

[line 771]

- DN suffix of the account

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


-
[ Top ]

- -

-

$dn_orig =

-

[line 774]

- DN suffix of account when it was loaded

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


-
[ Top ]

- -

-

$isNewAccount =

-

[line 795]

- True if this is a newly created account

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


-
[ Top ]

- -

-

$rdn =

-

[line 777]

- RDN attribute of this account

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor __construct [line 738]

-
-
-
- accountContainer __construct( -string -$type, string -$base) -
-

- - Constructor



- - -

Parameters:

-
- - - - - - - - - - - -
string  $type  account type
string  $base  key in $_SESSION where this object is saved
-

-
[ Top ]
-
-
- -

method continue_main [line 836]

-
-
-
- void continue_main( -) -
-

- - 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 1347]

-
-
-
- array fixLDAPAttributes( -array -$attributes, array -$modules) -
-

- - Fixes spelling errors in the attribute names.



-

Tags:

-
- - - - -
return:  fixed attributes
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
array  $attributes  LDAP attributes
array  $modules  list of active modules
-

-
[ Top ]
-
-
- -

method getAccountModule [line 805]

-
-
-
- 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 819]

-
-
-
- array getAccountModules( -) -
-

- - Returns the included account modules.



-

Tags:

-
- - - - -
return:  modules
-
-

- - -
[ Top ]
-
-
- -

method getParentDN [line 1684]

-
-
-
- String getParentDN( -String -$dn) -
-

- - Returns the parent DN of a given DN.



-

Tags:

-
- - - - -
return:  DN
-
-

- - -

Parameters:

-
- - - - - - -
String  $dn  DN
-

-
[ Top ]
-
-
- -

method getRDN [line 1672]

-
-
-
- String getRDN( -String -$dn) -
-

- - Returns the RDN part of a given DN.



-

Tags:

-
- - - - -
return:  RDN
-
-

- - -

Parameters:

-
- - - - - - -
String  $dn  DN
-

-
[ Top ]
-
-
- -

method get_pdfEntries [line 1596]

-
-
-
- list get_pdfEntries( -) -
-

- - Returns a list of possible PDF entries for this account.



-

Tags:

-
- - - - -
return:  of PDF entries (array(<name> => <PDF lines>))
-
-

- - -
[ Top ]
-
-
- -

method get_type [line 828]

-
-
-
- string get_type( -) -
-

- - Returns the accout type of this object (e.g. user, group, host).



-

Tags:

-
- - - - -
return:  account type
-
-

- - -
[ Top ]
-
-
- -

method load_account [line 1288]

-
-
-
- array load_account( -string -$dn) -
-

- - Loads an LDAP account with the given DN.



-

Tags:

-
- - - - -
return:  error messages
-
-

- - -

Parameters:

-
- - - - - - -
string  $dn  the DN of the account
-

-
[ Top ]
-
-
- -

method new_account [line 1420]

-
-
-
- void new_account( -) -
-

- - This function will prepare the object for a new account.



- - -
[ Top ]
-
-
- -

method save_account [line 1450]

-
-
-
- array save_account( -) -
-

- - This function will save an account to the LDAP database.



-

Tags:

-
- - - - -
return:  list of status messages if any errors occured
-
-

- - -
[ Top ]
-
-
- -

method save_module_attributes [line 1210]

-
-
-
- array save_module_attributes( -array -$attributes, array -$orig) -
-

- - This function checks which LDAP attributes have changed while the account was edited.



-

Tags:

-
- - - - -
return:  an array which can be passed to $this->saveAccount()
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
array  $attributes  list of current LDAP attributes
array  $orig  list of old attributes when account was loaded
-

-
[ Top ]
-
-
- -

method sortModules [line 1609]

-
-
-
- void sortModules( -) -
-

- - Sorts the module buttons for the account page.



- - -
[ Top ]
-
-
- -

method __sleep [line 1695]

-
-
-
- array __sleep( -) -
-

- - Encrypts sensitive data before storing in session.



-

Tags:

-
- - - - -
return:  list of attributes which are serialized
-
-

- - -
[ Top ]
-
-
- -

method __wakeup [line 1707]

-
-
-
- void __wakeup( -) -
-

- - Decrypts sensitive data after accountContainer was loaded from session.



- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:16 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/baseModule.html b/lam-web/developers/phpdoc/modules/baseModule.html deleted file mode 100644 index fe488c9b..00000000 --- a/lam-web/developers/phpdoc/modules/baseModule.html +++ /dev/null @@ -1,2426 +0,0 @@ - - -Docs For Class baseModule - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: baseModule

-Source Location: /lib/baseModule.inc

- - - - - - - - - - -
- -

Class Overview

-

-
Parent class of all account modules.


-

Author(s):

-
    -
- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
account
-
Manages the object class "account" for users and hosts.
-
-
-
ieee802Device
-
Provides MAC addresses for hosts.
-
-
-
posixGroup
-
Manages the object class "posixGroup" for groups.
-
-
-
quota
-
Manages quotas for users and groups.
-
-
-
sambaAccount
-
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.
-
-
-
sambaGroupMapping
-
Manages the object class "sambaGroupMapping" for groups.
-
-
-
shadowAccount
-
Manages the object class "shadowAccount" for users.
-
-
-
ldapPublicKey
-
Manages SSH public keys.
-
-
-
sambaDomain
-
Manages Samba 3 domain entries.
-
-
-
inetOrgPerson
-
This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).
-
-
-
inetLocalMailRecipient
-
Provides mail routing for users.
-
-
-
groupOfNames
-
Manages group members for the object class groupOfNames.
-
-
-
nisMailAlias
-
Provides NIS mail alias management.
-
-
-
-
- - -

Class Details

-
-[line 40]
-Parent class of all account modules.



-

Tags:

-
- - - - -
abstract:  
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$attributes =

-

[line 58]

- contains all ldap attributes which should be written



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$autoAddObjectClasses =

-

[line 67]

- if true, managed object classes are added when an account is created or loaded (default: true)



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$messages =

-

[line 64]

- contains all error messages of a module



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$meta =

-

[line 43]

- includes all meta data provided by the sub class



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$moduleSettings =

-

[line 49]

- configuration settings of all modules



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$orig =

-

[line 61]

- contains all ldap attributes which are loaded from ldap



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$selfServiceSettings =

-

[line 52]

- self service settings of all modules



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor __construct [line 74]

-
-
-
- baseModule __construct( -string -$scope) -
-

- - Creates a new base module class



-

Tags:

-
- - - - -
access:  public
-
-

- -

Overridden in child classes as:
-

-
sambaAccount::__construct()
-
Creates a new sambaAccount object.
-
-
-
sambaSamAccount::__construct()
-
Creates a new sambaSamAccount object.
-
-
-
kolabUser::__construct()
-
Creates a new kolabUser object.
-
-
-
sambaGroupMapping::__construct()
-
Creates a new module for Samba 3 groups.
-
-

- -

Parameters:

-
- - - - - - -
string  $scope  the account type (user, group, host)
-

-
[ Top ]
-
-
- -

method build_uploadAccounts [line 507]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- -

Overridden in child classes as:
-

-
account::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
ieee802Device::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
posixGroup::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
sambaAccount::build_uploadAccounts()
-
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()
-
In this function the LDAP account is built up.
-
-
-
sambaGroupMapping::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.
-
-
-
groupOfNames::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
nisMailAlias::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method can_manage [line 172]

-
-
-
- boolean can_manage( -) -
-

- - Returns true if this module fits for the current scope.



-

Tags:

-
- - - - -
return:  true if module fits
-
-

- - -
[ Top ]
-
-
- -

method checkSelfServiceOptions [line 738]

-
-
-
- array checkSelfServiceOptions( -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()))
-
-

- -

Overridden in child classes as:
-

-
sambaSamAccount::checkSelfServiceOptions()
-
Checks if all input values are correct and returns the LDAP commands which should be executed.
-
-
-
posixAccount::checkSelfServiceOptions()
-
Checks if all input values are correct and returns the LDAP commands which should be executed.
-
-
-
inetOrgPerson::checkSelfServiceOptions()
-
Checks if all input values are correct and returns the LDAP commands which should be executed.
-
-

- -

Parameters:

-
- - - - - - - - - - - -
string  $fields  input fields
array  $attributes  LDAP attributes
-

-
[ Top ]
-
-
- -

method checkSelfServiceSettings [line 759]

-
-
-
- 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 367]

-
-
-
- array check_configOptions( -array -$scopes, array -$options) -
-

- - Checks input values of module settings.



-

Tags:

-
- - - - -
return:  list of error messages
-
-

- -

Overridden in child classes as:
-

-
posixAccount::check_configOptions()
-
Checks input values of module settings.
-
-

- -

Parameters:

-
- - - - - - - - - - - -
array  $scopes  list of account types which are used
array  $options  hash array containing the settings (array('option' => array('value')))
-

-
[ Top ]
-
-
- -

method check_profileOptions [line 252]

-
-
-
- array check_profileOptions( -array -$options) -
-

- - Checks input values of account profiles.



-

Tags:

-
- - - - -
return:  list of error messages (array(type, title, text)) to generate StatusMessages, if any
-
-

- -

Overridden in child classes as:
-

-
quota::check_profileOptions()
-
Checks input values of account profiles.
-
-

- -

Parameters:

-
- - - - - - -
array  $options  a hash array (name => value) containing the options
-

-
[ Top ]
-
-
- -

method delete_attributes [line 640]

-
-
-
- List delete_attributes( -) -
-

- - Dummy function for modules which use no special options on account deletion.



-

Tags:

-
- - - - -
return:  of LDAP operations, same as for save_attributes()
-
-

- -

Overridden in child classes as:
-

-
posixGroup::delete_attributes()
-
Checks if the group which should be deleted is still used as primary group.
-
-
-
posixAccount::delete_attributes()
-
Additional LDAP operations on delete.
-
-

- -
[ Top ]
-
-
- -

method display_html_delete [line 649]

-
-
-
- meta display_html_delete( -) -
-

- - Dummy function for modules which do not print extra HTML code on account deletion.



-

Tags:

-
- - - - -
return:  HTML code
-
-

- -

Overridden in child classes as:
-

-
posixAccount::display_html_delete()
-
Displays the delete homedir option for the delete page.
-
-

- -
[ Top ]
-
-
- -

method doUploadPostActions [line 575]

-
-
-
- array doUploadPostActions( -array -$data, array -$ids, array -$failed, -&$temp, array -$temp) -
-

- - This function executes one post upload action.



-

Tags:

-
- - - - -
return:  current status
array (
'status' => 'finished' | 'inProgress'
'progress' => 0..100
'errors' => array (<array of parameters for StatusMessage>)
)
-
-

- -

Overridden in child classes as:
-

-
quota::doUploadPostActions()
-
This function executes one post upload action.
-
-
-
posixAccount::doUploadPostActions()
-
This function executes one post upload action.
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
array  $data  array containing one account in each element
array  $ids  array(<column_name> => <column number>)
array  $failed  list of accounts which were not created successfully
array  $temp  variable to store temporary data between two post actions
  &$temp  
-

-
[ Top ]
-
-
- -

method getAccountContainer [line 770]

-
-
-
- accountContainer getAccountContainer( -) -
-

- - Returns the accountContainer object.



-

Tags:

-
- - - - - - - -
return:  accountContainer object
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method getAttributes [line 784]

-
-
-
- array getAttributes( -) -
-

- - Returns the LDAP attributes which are managed in this module.



-

Tags:

-
- - - - - - - -
return:  attributes
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getButtonStatus [line 557]

-
-
-
- string getButtonStatus( -) -
-

- - Controls if the module button the account page is visible and activated.



-

Tags:

-
- - - - -
return:  status ("enabled", "disabled", "hidden")
-
-

- -

Overridden in child classes as:
-

-
account::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.
-
-
-
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.
-
-

- -
[ Top ]
-
-
- -

method getIcon [line 804]

-
-
-
- unknown getIcon( -) -
-

- - Returns the path to the module icon.

The path must be releative to graphics (e.g. key.png). You can also set $this->meta['icon']. The preferred size is 32x32px.




-

Tags:

-
- - - - -
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getLDAPAliases [line 670]

-
-
-
- array getLDAPAliases( -) -
-

- - Returns a list of aliases for LDAP attributes.

All alias attributes will be renamed to the given attribute names.




-

Tags:

-
- - - - -
return:  list of aliases (alias name => attribute name)
-
-

- - -
[ Top ]
-
-
- -

method getManagedAttributes [line 681]

-
-
-
- array getManagedAttributes( -) -
-

- - Returns a list of LDAP attributes which are managed by this module.

All attribute names will be renamed to match the given spelling.




-

Tags:

-
- - - - -
return:  list of attributes
-
-

- - -
[ Top ]
-
-
- -

method getManagedObjectClasses [line 659]

-
-
-
- array getManagedObjectClasses( -) -
-

- - Returns a list of managed object classes for this module.

This is used to fix incorrect spelled object class names.




-

Tags:

-
- - - - -
return:  list of object classes
-
-

- - -
[ Top ]
-
-
- -

method getOriginalAttributes [line 793]

-
-
-
- array getOriginalAttributes( -) -
-

- - Returns the LDAP attributes which are managed in this module (with unchanged values).



-

Tags:

-
- - - - - - - -
return:  attributes
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getRequiredExtensions [line 691]

-
-
-
- array getRequiredExtensions( -) -
-

- - Returns a list of required PHP extensions.



-

Tags:

-
- - - - -
return:  extensions
-
-

- - -
[ Top ]
-
-
- -

method getSelfServiceFields [line 712]

-
-
-
- array getSelfServiceFields( -) -
-

- - Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)



-

Tags:

-
- - - - -
return:  fields
-
-

- - -
[ Top ]
-
-
- -

method getSelfServiceOptions [line 726]

-
-
-
- array getSelfServiceOptions( -array -$fields, array -$attributes) -
-

- - Returns the meta HTML code for each input field.

format: array(<field1> => array(<META HTML>), ...) It is not possible to display help links.




-

Tags:

-
- - - - -
return:  meta HTML
-
-

- -

Overridden in child classes as:
-

-
posixAccount::getSelfServiceOptions()
-
Returns the meta HTML code for each input field.
-
-
-
inetOrgPerson::getSelfServiceOptions()
-
Returns the meta HTML code for each input field.
-
-

- -

Parameters:

-
- - - - - - - - - - - -
array  $fields  list of active fields
array  $attributes  attributes of LDAP account (attribute names in lower case)
-

-
[ Top ]
-
-
- -

method getSelfServiceSearchAttributes [line 701]

-
-
-
- array getSelfServiceSearchAttributes( -) -
-

- - Returns a list of possible search attributes for the self service.



-

Tags:

-
- - - - -
return:  attributes
-
-

- - -
[ Top ]
-
-
- -

method getSelfServiceSettings [line 748]

-
-
-
- array getSelfServiceSettings( -) -
-

- - Returns a list of self service configuration settings.



-

Tags:

-
- - - - -
return:  settings
-
-

- - -
[ Top ]
-
-
- -

method get_alias [line 207]

-
-
-
- string get_alias( -) -
-

- - Returns an alias name for the module.

This alias is used in various places instead of the less descriptive class name. The alias also has less syntax restrictions and may contain spaces or special characters.




-

Tags:

-
- - - - -
return:  alias name
-
-

- - -
[ Top ]
-
-
- -

method get_configOptions [line 351]

-
-
-
- array get_configOptions( -array -$scopes, array -$allScopes) -
-

- - Returns a list of elements for the configuration.



-

Tags:

-
- - - - -
return:  configuration elements
-
-

- -

Overridden in child classes as:
-

-
posixGroup::get_configOptions()
-
Returns a list of elements for the configuration.
-
-

- -

Parameters:

-
- - - - - - - - - - - -
array  $scopes  account types (user, group, host)
array  $allScopes  list of all modules and active scopes
-

-
[ Top ]
-
-
- -

method get_dependencies [line 231]

-
-
-
- array get_dependencies( -) -
-

- - This function returns a list with all depending and conflicting modules.



-

Tags:

-
- - - - -
return:  list of dependencies and conflicts
-
-

- - -
[ Top ]
-
-
- -

method get_help [line 521]

-
-
-
- array get_help( -string -$id, string -$scope) -
-

- - This function return the help entry array for a specific help id. Normally this->meta can be used.



-

Tags:

-
- - - - -
return:  The desired help entry.
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
string  $id  The id string for the help entry needed.
string  $scope  The scope for which the help entry should be retrieved. May be empty when there is now difference of the help entry depending on the actual scope.
-

-
[ Top ]
-
-
- -

method get_ldap_filter [line 194]

-
-
-
- string get_ldap_filter( -) -
-

- - returns an LDAP filter for the account lists



-

Tags:

-
- - - - -
return:  LDAP filter
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 154]

-
-
-
- array get_metaData( -) -
-

- - Dummy function, meta data is provided by sub classes.



-

Tags:

-
- - - - -
return:  empty array
-
-

- -

Overridden in child classes as:
-

-
account::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
ieee802Device::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
posixGroup::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
quota::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
sambaAccount::get_metaData()
-
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()
-
Returns meta data that is interpreted by parent class
-
-
-
sambaGroupMapping::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
-
-
-
groupOfNames::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
groupOfUniqueNames::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 451]

-
-
-
- array get_pdfFields( -string -$scope) -
-

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



-

Tags:

-
- - - - -
return:  list of available fields for PDF output
-
-

- - -

Parameters:

-
- - - - - - -
string  $scope  account type
-

-
[ Top ]
-
-
- -

method get_pdf_entries [line 466]

-
-
-
- array get_pdf_entries( -[string -$scope = 'user']) -
-

- - Returns a hastable with all entries that may be printed out in the PDF. The

syntax of the hashtable is specified by the module specification and the corresponding DTD. This method must be overwritten in case that there are non static things to be returned. The $this->meta['PDF_entries'] array may be used when there is only static content.




-

Tags:

-
- - - - -
return:  hastable of entries for the PDF. Each entry is an array where each entry is treated as a new line in the PDF.
-
-

- - -

Parameters:

-
- - - - - - -
string  $scope  account type
-

-
[ Top ]
-
-
- -

method get_profileOptions [line 241]

-
-
-
- profile get_profileOptions( -) -
-

- - Returns a list of elements for the account profiles.



-

Tags:

-
- - - - -
return:  elements
-
-

- -

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.
-
-
-
sambaGroupMapping::get_profileOptions()
-
Returns a list of elements for the account profiles.
-
-

- -
[ Top ]
-
-
- -

method get_RDNAttributes [line 221]

-
-
-
- array get_RDNAttributes( -) -
-

- - Returns a list of possible LDAP attributes which can be used to form the RDN.

The returned elements have this form: <attribute> => <priority>
<attribute> is the name of the LDAP attribute
<priority> defines the priority of the attribute (can be "low", "normal", "high")




-

Tags:

-
- - - - -
return:  list of attributes
-
-

- - -
[ Top ]
-
-
- -

method get_scope [line 163]

-
-
-
- string get_scope( -) -
-

- - Returns the account type of this module (user, group, host)



-

Tags:

-
- - - - -
return:  account type
-
-

- - -
[ Top ]
-
-
- -

method get_uploadColumns [line 484]

-
-
-
- array get_uploadColumns( -) -
-

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

- -

Overridden in child classes as:
-

-
quota::get_uploadColumns()
-
Returns an array containing all input columns for the file upload.
-
-

- -
[ Top ]
-
-
- -

method get_uploadPreDepends [line 494]

-
-
-
- array get_uploadPreDepends( -) -
-

- - Returns a list of module names which must be processed in building the account befor this module.



-

Tags:

-
- - - - -
return:  list of module names
-
-

- - -
[ Top ]
-
-
- -

method init [line 95]

-
-
-
- void init( -string -$base) -
-

- - Initializes the module after it became part of an accountContainer



- -

Overridden in child classes as:
-

-
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()
-
Initializes the module after it became part of an accountContainer
-
-
-
posixAccount::init()
-
Initializes the module after it became part of an accountContainer
-
-
-
sambaGroupMapping::init()
-
Initializes the module after it became part of an accountContainer
-
-

- -

Parameters:

-
- - - - - - -
string  $base  the name of the accountContainer object ($_SESSION[$base])
-

-
[ Top ]
-
-
- -

method is_base_module [line 184]

-
-
-
- boolean is_base_module( -) -
-

- - Returns true if this module is enough to provide a sensible account.

There is no relation to the name of this class.




-

Tags:

-
- - - - -
return:  true if base module
-
-

- - -
[ Top ]
-
-
- -

method load_attributes [line 118]

-
-
-
- void load_attributes( -array -$attributes) -
-

- - This function loads the LDAP attributes for this module.



- -

Overridden in child classes as:
-

-
sambaAccount::load_attributes()
-
This function loads the LDAP attributes for this module.
-
-
-
sambaSamAccount::load_attributes()
-
This function loads the LDAP attributes for this module.
-
-
-
posixAccount::load_attributes()
-
This function loads all needed LDAP attributes.
-
-

- -

Parameters:

-
- - - - - - -
array  $attributes  attribute list
-

-
[ Top ]
-
-
- -

method load_Messages [line 87]

-
-
-
- void load_Messages( -) -
-

- - This function fills the $messages variable with output messages from this module.



-

Tags:

-
- - - - -
access:  protected
-
-

- -

Overridden in child classes as:
-

-
account::load_Messages()
-
This function fills the message array.
-
-
-
ieee802Device::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.
-
-
-
quota::load_Messages()
-
this functin fills the error message array with messages
-
-
-
sambaAccount::load_Messages()
-
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()
-
This function fills the error message array with messages
-
-
-
sambaGroupMapping::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
-
-
-
groupOfNames::load_Messages()
-
This function fills the $messages variable with output messages from this module.
-
-
-
nisMailAlias::load_Messages()
-
This function fills the error message array with messages
-
-

- -
[ Top ]
-
-
- -

method load_profile [line 333]

-
-
-
- void load_profile( -array -$profile) -
-

- - Loads the values of an account profile into internal variables.



- -

Overridden in child classes as:
-

-
quota::load_profile()
-
Loads the values of an account profile into internal variables.
-
-
-
sambaAccount::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.
-
-
-
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.
-
-
-
shadowAccount::load_profile()
-
Loads the values of an account profile into internal variables.
-
-

- -

Parameters:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method module_complete [line 548]

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

- -

Overridden in child classes as:
-

-
account::module_complete()
-
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.
-
-
-
sambaAccount::module_complete()
-
This functions returns true if all needed settings are done
-
-
-
posixAccount::module_complete()
-
This functions is used to check if all settings for this module have been made.
-
-
-
kolabUser::module_complete()
-
This function returns true if all needed settings are done.
-
-
-
inetOrgPerson::module_complete()
-
This functions return true if all needed settings are done.
-
-
-
groupOfNames::module_complete()
-
This functions is used to check if all settings for this module have been made.
-
-

- -
[ Top ]
-
-
- -

method module_ready [line 539]

-
-
-
- boolean module_ready( -) -
-

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

- -

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.
-
-
-
sambaSamAccount::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.
-
-

- -
[ Top ]
-
-
- -

method postDeleteActions [line 631]

-
-
-
- void postDeleteActions( -) -
-

- - Allows the module to run commands after the LDAP entry is deleted.



- - -
[ Top ]
-
-
- -

method postModifyActions [line 614]

-
-
-
- void postModifyActions( -boolean -$newAccount) -
-

- - Allows the module to run commands after the LDAP entry is changed or created.



- -

Overridden in child classes as:
-

-
quota::postModifyActions()
-
Allows the module to run commands after the LDAP entry is changed or created.
-
-
-
posixAccount::postModifyActions()
-
Allows the module to run commands after the LDAP entry was changed or created.
-
-

- -

Parameters:

-
- - - - - - -
boolean  $newAccount  new account
-

-
[ Top ]
-
-
- -

method preDeleteActions [line 624]

-
-
-
- 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:
-

-
quota::preDeleteActions()
-
Allows the module to run commands before the LDAP entry is deleted.
-
-
-
posixAccount::preDeleteActions()
-
Allows the module to run commands before the LDAP entry is deleted.
-
-

- -
[ Top ]
-
-
- -

method preModifyActions [line 605]

-
-
-
- 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 594]

-
-
-
- array save_attributes( -) -
-

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

- -

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()
-
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.
-
-
-
sambaSamAccount::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.
-
-
-
kolabUser::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.
-
-
-
shadowAccount::save_attributes()
-
Returns a list of modifications which have to be made to the LDAP account.
-
-
-
inetOrgPerson::save_attributes()
-
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.
-
-

- -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:52 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/groupOfNames.html b/lam-web/developers/phpdoc/modules/groupOfNames.html deleted file mode 100644 index 05c03d83..00000000 --- a/lam-web/developers/phpdoc/modules/groupOfNames.html +++ /dev/null @@ -1,897 +0,0 @@ - - -Docs For Class groupOfNames - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: groupOfNames

-Source Location: /lib/modules/groupOfNames.inc

- - - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --groupOfNames

-
Manages group members for the object class groupOfNames.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - - -
-

Child classes:

-
-
-
groupOfUniqueNames
-
Manages group members for the object class groupOfUniqueNames.
-
-
-
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 22]
-Manages group members for the object class groupOfNames.



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$ATTR_MEMBER_NAME =  "member"

-

[line 28]

- name of member attribute



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$OBJECT_CLASS_NAME =  "groupOfNames"

-

[line 25]

- name of managed object class



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 395]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 128]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - -
[ Top ]
-
-
- -

method display_html_members [line 282]

-
-
-
- void display_html_members( -) -
-

- - This function will create the meta HTML code to show a page to change the member attribute.



- - -
[ Top ]
-
-
- -

method display_html_owner [line 212]

-
-
-
- void display_html_owner( -) -
-

- - This function will create the meta HTML code to show a page to change the owner attribute.



- - -
[ Top ]
-
-
- -

method get_metaData [line 35]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- -

Overridden in child classes as:
-

-
groupOfUniqueNames::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-

- Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 433]

-
-
-
- void get_pdfEntries( -) -
-

- - Returns a list of PDF entries



- - -
[ Top ]
-
-
- -

method load_Messages [line 117]

-
-
-
- void 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 421]

-
-
-
- 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 process_attributes [line 192]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module 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_members [line 361]

-
-
-
- array process_members( -) -
-

- - Processes user input of the members 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_owner [line 270]

-
-
-
- array process_owner( -) -
-

- - Processes user input of the owner page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:04 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/groupOfUniqueNames.html b/lam-web/developers/phpdoc/modules/groupOfUniqueNames.html deleted file mode 100644 index 3764eb0f..00000000 --- a/lam-web/developers/phpdoc/modules/groupOfUniqueNames.html +++ /dev/null @@ -1,708 +0,0 @@ - - -Docs For Class groupOfUniqueNames - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: groupOfUniqueNames

-Source Location: /lib/modules/groupOfUniqueNames.inc

- - - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --groupOfNames
-      |
-      --groupOfUniqueNames

-
Manages group members for the object class groupOfUniqueNames.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: groupOfNames

-
-
- groupOfNames::build_uploadAccounts() -
-
- In this function the LDAP account is built up. -
-
- groupOfNames::display_html_attributes() -
-
- Returns the HTML meta data for the main account page. -
-
- groupOfNames::display_html_members() -
-
- This function will create the meta HTML code to show a page to change the member attribute. -
-
- groupOfNames::display_html_owner() -
-
- This function will create the meta HTML code to show a page to change the owner attribute. -
-
- groupOfNames::get_metaData() -
-
- Returns meta data that is interpreted by parent class -
-
- groupOfNames::get_pdfEntries() -
-
- Returns a list of PDF entries -
-
- groupOfNames::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- groupOfNames::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- groupOfNames::process_attributes() -
-
- Processes user input of the primary module page. -
-
- groupOfNames::process_members() -
-
- Processes user input of the members page. -
-
- groupOfNames::process_owner() -
-
- Processes user input of the owner page. -
-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 25]
-Manages group members for the object class groupOfUniqueNames.



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$ATTR_MEMBER_NAME =  "uniqueMember"

-

[line 31]

- name of member attribute



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - - - - - -
Type:  mixed
Overrides:  Array
-


-
[ Top ]

- -

-

$OBJECT_CLASS_NAME =  "groupOfUniqueNames"

-

[line 28]

- name of managed object class



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - - - - - -
Type:  mixed
Overrides:  Array
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

method get_metaData [line 38]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides groupOfNames::get_metaData() (Returns meta data that is interpreted by parent class)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:05 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/ieee802Device.html b/lam-web/developers/phpdoc/modules/ieee802Device.html deleted file mode 100644 index 7501c982..00000000 --- a/lam-web/developers/phpdoc/modules/ieee802Device.html +++ /dev/null @@ -1,719 +0,0 @@ - - -Docs For Class ieee802Device - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: ieee802Device

-Source Location: /lib/modules/ieee802device.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --ieee802Device

-
Provides MAC addresses for hosts.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 35]
-Provides MAC addresses for hosts.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 163]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 95]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 42]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 192]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 85]

-
-
-
- void load_Messages( -) -
-

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

-
[ Top ]
-
-
- -

method process_attributes [line 121]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:07 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/inetLocalMailRecipient.html b/lam-web/developers/phpdoc/modules/inetLocalMailRecipient.html deleted file mode 100644 index a3d51cba..00000000 --- a/lam-web/developers/phpdoc/modules/inetLocalMailRecipient.html +++ /dev/null @@ -1,719 +0,0 @@ - - -Docs For Class inetLocalMailRecipient - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: inetLocalMailRecipient

-Source Location: /lib/modules/inetLocalMailRecipient.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --inetLocalMailRecipient

-
Provides mail routing for users.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 35]
-Provides mail routing for users.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 255]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 135]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 42]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 308]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 121]

-
-
-
- void load_Messages( -) -
-

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

-
[ Top ]
-
-
- -

method process_attributes [line 177]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:08 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/inetOrgPerson.html b/lam-web/developers/phpdoc/modules/inetOrgPerson.html deleted file mode 100644 index c0625947..00000000 --- a/lam-web/developers/phpdoc/modules/inetOrgPerson.html +++ /dev/null @@ -1,969 +0,0 @@ - - -Docs For Class inetOrgPerson - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: inetOrgPerson

-Source Location: /lib/modules/inetOrgPerson.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --inetOrgPerson

-
This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 38]
-This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 968]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method checkSelfServiceOptions [line 1351]

-
-
-
- array checkSelfServiceOptions( -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()))
-
-

- - Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP commands which should be executed.)

-

Parameters:

-
- - - - - - - - - - - -
string  $fields  input fields
array  $attributes  LDAP attributes
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 637]

-
-
-
- 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 877]

-
-
-
- array display_html_password( -) -
-

- - Displays the password changing dialog.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method display_html_photo [line 917]

-
-
-
- array display_html_photo( -) -
-

- - Displays the photo upload page.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method getButtonStatus [line 463]

-
-
-
- string getButtonStatus( -) -
-

- - Controls if the module button the account page is visible and activated.



-

Tags:

-
- - - - -
return:  status ("enabled", "disabled", "hidden")
-
-

- - Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

-
[ Top ]
-
-
- -

method getSelfServiceOptions [line 1210]

-
-
-
- array getSelfServiceOptions( -array -$fields, array -$attributes) -
-

- - Returns the meta HTML code for each input field.

format: array(<field1> => array(<META HTML>), ...) It is not possible to display help links.




-

Tags:

-
- - - - -
return:  meta HTML
-
-

- - Overrides baseModule::getSelfServiceOptions() (Returns the meta HTML code for each input field.)

-

Parameters:

-
- - - - - - - - - - - -
array  $fields  list of active fields
array  $attributes  attributes of LDAP account (attribute names in lower case)
-

-
[ Top ]
-
-
- -

method get_metaData [line 116]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 936]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 70]

-
-
-
- void load_Messages( -) -
-

- - This function fills the message array.



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method module_complete [line 446]

-
-
-
- boolean module_complete( -) -
-

- - This functions return true if all needed settings are done.



-

Tags:

-
- - - - -
return:  true, if all is ok
-
-

- - Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

-
[ Top ]
-
-
- -

method process_attributes [line 523]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module 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_password [line 855]

-
-
-
- void process_password( -) -
-

- - Sets a new password.



- - -
[ Top ]
-
-
- -

method process_photo [line 897]

-
-
-
- void process_photo( -) -
-

- - Sets a new photo.



- - -
[ Top ]
-
-
- -

method save_attributes [line 485]

-
-
-
- array save_attributes( -) -
-

- - 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 ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:09 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/kolabUser.html b/lam-web/developers/phpdoc/modules/kolabUser.html deleted file mode 100644 index c626e7a5..00000000 --- a/lam-web/developers/phpdoc/modules/kolabUser.html +++ /dev/null @@ -1,833 +0,0 @@ - - -Docs For Class kolabUser - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: kolabUser

-Source Location: /lib/modules/kolabUser.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --kolabUser

-
Manages Kolab user accounts.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 35]
-Manages Kolab user accounts.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 45]

-
-
-
- kolabUser __construct( -string -$scope) -
-

- - Creates a new kolabUser object.



- - Overrides baseModule::__construct() (Creates a new base module class)

-

Parameters:

-
- - - - - - -
string  $scope  account type (user, group, host)
-

-
[ Top ]
-
-
- -

method build_uploadAccounts [line 612]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 266]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - -
[ Top ]
-
-
- -

method display_html_deleteUser [line 562]

-
-
-
- void display_html_deleteUser( -) -
-

- - This function will create the meta HTML code to show a page to delete accounts.



- - -
[ Top ]
-
-
- -

method get_metaData [line 63]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 750]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 225]

-
-
-
- void load_Messages( -) -
-

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

-
[ Top ]
-
-
- -

method module_complete [line 589]

-
-
-
- true, module_complete( -) -
-

- - This function returns true if all needed settings are done.



-

Tags:

-
- - - - -
return:  if account can be saved
-
-

- - Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

-
[ Top ]
-
-
- -

method process_attributes [line 418]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module 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_deleteUser [line 577]

-
-
-
- void process_deleteUser( -) -
-

- - Write variables into object and do some regex checks



- - -
[ Top ]
-
-
- -

method save_attributes [line 253]

-
-
-
- array save_attributes( -) -
-

- - 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 ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:10 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/ldapPublicKey.html b/lam-web/developers/phpdoc/modules/ldapPublicKey.html deleted file mode 100644 index 02407b10..00000000 --- a/lam-web/developers/phpdoc/modules/ldapPublicKey.html +++ /dev/null @@ -1,693 +0,0 @@ - - -Docs For Class ldapPublicKey - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: ldapPublicKey

-Source Location: /lib/modules/ldapPublicKey.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --ldapPublicKey

-
Manages SSH public keys.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 36]
-Manages SSH public keys.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 142]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 89]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 43]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 162]

-
-
-
- void get_pdfEntries( -) -
-

- - Returns a list of PDF entries



- - -
[ Top ]
-
-
- -

method process_attributes [line 115]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:12 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/nisMailAlias.html b/lam-web/developers/phpdoc/modules/nisMailAlias.html deleted file mode 100644 index cbf68846..00000000 --- a/lam-web/developers/phpdoc/modules/nisMailAlias.html +++ /dev/null @@ -1,771 +0,0 @@ - - -Docs For Class nisMailAlias - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: nisMailAlias

-Source Location: /lib/modules/nisMailAlias.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --nisMailAlias

-
Provides NIS mail alias management.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 35]
-Provides NIS mail alias management.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 232]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 133]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - -
[ Top ]
-
-
- -

method getButtonStatus [line 213]

-
-
-
- string getButtonStatus( -) -
-

- - Controls if the module button the account page is visible and activated.



-

Tags:

-
- - - - -
return:  status ("enabled", "disabled", "hidden")
-
-

- - Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

-
[ Top ]
-
-
- -

method get_metaData [line 42]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 271]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 102]

-
-
-
- void load_Messages( -) -
-

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

-
[ Top ]
-
-
- -

method process_attributes [line 164]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 120]

-
-
-
- array save_attributes( -) -
-

- - 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 ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:17 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/posixAccount.html b/lam-web/developers/phpdoc/modules/posixAccount.html deleted file mode 100644 index 95055832..00000000 --- a/lam-web/developers/phpdoc/modules/posixAccount.html +++ /dev/null @@ -1,1396 +0,0 @@ - - -Docs For Class posixAccount - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: posixAccount

-Source Location: /lib/modules/posixAccount.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --posixAccount

-
Manages the object class "posixAccount" for users and hosts.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 40]
-Manages the object class "posixAccount" for users and hosts.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 1271]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method checkASCII [line 855]

-
-
-
- string checkASCII( -string -$attribute) -
-

- - Checks if an attribute contains only ASCII charaters and replaces invalid characters.



-

Tags:

-
- - - - -
return:  attribute value with replaced non-ASCII characters
-
-

- - -

Parameters:

-
- - - - - - -
string  $attribute  attribute value
-

-
[ Top ]
-
-
- -

method checkSelfServiceOptions [line 1718]

-
-
-
- array checkSelfServiceOptions( -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()))
-
-

- - Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP commands which should be executed.)

-

Parameters:

-
- - - - - - - - - - - -
string  $fields  input fields
array  $attributes  LDAP attributes
-

-
[ Top ]
-
-
- -

method check_configOptions [line 1212]

-
-
-
- array check_configOptions( -array -$scopes, array -$options) -
-

- - Checks input values of module settings.



-

Tags:

-
- - - - -
return:  list of error messages
-
-

- - Overrides baseModule::check_configOptions() (Checks input values of module settings.)

-

Parameters:

-
- - - - - - - - - - - -
array  $scopes  list of account types which are used
array  $options  hash array containing the settings (array('option' => array('value')))
-

-
[ Top ]
-
-
- -

method delete_attributes [line 576]

-
-
-
- List delete_attributes( -) -
-

- - Additional LDAP operations on delete.



-

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 926]

-
-
-
- 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 1032]

-
-
-
- meta display_html_delete( -) -
-

- - 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 1047]

-
-
-
- array display_html_group( -) -
-

- - Displays the group selection.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method display_html_password [line 1092]

-
-
-
- array display_html_password( -) -
-

- - Displays the password changing dialog.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method doUploadPostActions [line 1523]

-
-
-
- array doUploadPostActions( -array -$data, array -$ids, array -$failed, -&$temp, array -$temp) -
-

- - This function executes one post upload action.



-

Tags:

-
- - - - -
return:  current status
array (
'status' => 'finished' | 'inProgress'
'progress' => 0..100
'errors' => array (<array of parameters for StatusMessage>)
)
-
-

- - Overrides baseModule::doUploadPostActions() (This function executes one post upload action.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
array  $data  array containing one account in each element
array  $ids  array(<column_name> => <column number>)
array  $failed  list of accounts which were not created successfully
array  $temp  variable to store temporary data between two post actions
  &$temp  
-

-
[ Top ]
-
-
- -

method getClearTextPassword [line 1747]

-
-
-
- string getClearTextPassword( -) -
-

- - Returns the clear text password.



-

Tags:

-
- - - - - - - -
return:  password
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getNextUIDs [line 1632]

-
-
-
- mixed getNextUIDs( -integer -$count, -&$errors, array -$errors) -
-

- - Returns one or more free UID numbers.



-

Tags:

-
- - - - -
return:  Null if no UIDs are free else an array of free UIDs.
-
-

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
integer  $count  Number of needed free UIDs.
array  $errors  list of error messages where errors can be added
  &$errors  
-

-
[ Top ]
-
-
- -

method getSelfServiceOptions [line 1698]

-
-
-
- array getSelfServiceOptions( -array -$fields, array -$attributes) -
-

- - Returns the meta HTML code for each input field.

format: array(<field1> => array(<META HTML>), ...) It is not possible to display help links.




-

Tags:

-
- - - - -
return:  meta HTML
-
-

- - Overrides baseModule::getSelfServiceOptions() (Returns the meta HTML code for each input field.)

-

Parameters:

-
- - - - - - - - - - - -
array  $fields  list of active fields
array  $attributes  attributes of LDAP account (attribute names in lower case)
-

-
[ Top ]
-
-
- -

method get_metaData [line 102]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 1187]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method get_profileOptions [line 1123]

-
-
-
- profile get_profileOptions( -) -
-

- - Returns a list of elements for the account profiles.



-

Tags:

-
- - - - -
return:  elements
-
-

- - Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

-
[ Top ]
-
-
- -

method init [line 430]

-
-
-
- void init( -string -$base) -
-

- - 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 462]

-
-
-
- void load_attributes( -array -$attr) -
-

- - This function loads all needed LDAP attributes.



- - Overrides baseModule::load_attributes() (This function loads the LDAP attributes for this module.)

-

Parameters:

-
- - - - - - -
array  $attr  list of attributes
-

-
[ Top ]
-
-
- -

method load_Messages [line 54]

-
-
-
- void load_Messages( -) -
-

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

-
[ Top ]
-
-
- -

method load_profile [line 1165]

-
-
-
- void load_profile( -array -$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:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method module_complete [line 448]

-
-
-
- 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 postModifyActions [line 538]

-
-
-
- void postModifyActions( -boolean -$newAccount) -
-

- - 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 594]

-
-
-
- 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 628]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module 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_group [line 880]

-
-
-
- array process_group( -) -
-

- - Processes user input of the group selection 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_password [line 897]

-
-
-
- array process_password( -) -
-

- - Processes user input of the password page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 489]

-
-
-
- array save_attributes( -) -
-

- - 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 ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:19 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/posixGroup.html b/lam-web/developers/phpdoc/modules/posixGroup.html deleted file mode 100644 index 33a7ae37..00000000 --- a/lam-web/developers/phpdoc/modules/posixGroup.html +++ /dev/null @@ -1,1047 +0,0 @@ - - -Docs For Class posixGroup - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: posixGroup

-Source Location: /lib/modules/posixGroup.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --posixGroup

-
Manages the object class "posixGroup" for groups.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 39]
-Manages the object class "posixGroup" for groups.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 53]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method delete_attributes [line 130]

-
-
-
- List delete_attributes( -) -
-

- - 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 152]

-
-
-
- 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 255]

-
-
-
- array display_html_password( -) -
-

- - Displays the password changing dialog.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method display_html_user [line 208]

-
-
-
- array display_html_user( -) -
-

- - Displays selections to add or remove users from current group.



-

Tags:

-
- - - - -
return:  meta HTML output
-
-

- - -
[ Top ]
-
-
- -

method getButtonStatus [line 503]

-
-
-
- string getButtonStatus( -) -
-

- - Controls if the module button the account page is visible and activated.



-

Tags:

-
- - - - -
return:  status ("enabled", "disabled", "hidden")
-
-

- - Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

-
[ Top ]
-
-
- -

method getNextGIDs [line 722]

-
-
-
- mixed getNextGIDs( -integer -$count, -&$errors, array -$errors) -
-

- - Returns one or more free GID numbers.



-

Tags:

-
- - - - -
return:  Null if no GIDs are free else an array of free GIDs.
-
-

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
integer  $count  Number of needed free GIDs.
array  $errors  list of error messages where errors can be added
  &$errors  
-

-
[ Top ]
-
-
- -

method get_configOptions [line 418]

-
-
-
- array get_configOptions( -array -$scopes, array -$allScopes) -
-

- - Returns a list of elements for the configuration.



-

Tags:

-
- - - - -
return:  configuration elements
-
-

- - Overrides baseModule::get_configOptions() (Returns a list of elements for the configuration.)

-

Parameters:

-
- - - - - - - - - - - -
array  $scopes  account types (user, group, host)
array  $allScopes  list of all modules and active scopes
-

-
[ Top ]
-
-
- -

method get_metaData [line 277]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 439]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method init [line 449]

-
-
-
- void init( - -$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)

-

Parameters:

-
- - - - - - -
  $base  
-

-
[ Top ]
-
-
- -

method load_Messages [line 459]

-
-
-
- void 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 484]

-
-
-
- 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 process_attributes [line 521]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module 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_password [line 667]

-
-
-
- array process_password( -) -
-

- - Processes user input of the password 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_user [line 648]

-
-
-
- array process_user( -) -
-

- - Processes user input of the user selection page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 692]

-
-
-
- array save_attributes( -) -
-

- - 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 ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:20 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/quota.html b/lam-web/developers/phpdoc/modules/quota.html deleted file mode 100644 index ceb413fb..00000000 --- a/lam-web/developers/phpdoc/modules/quota.html +++ /dev/null @@ -1,976 +0,0 @@ - - -Docs For Class quota - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: quota

-Source Location: /lib/modules/quota.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --quota

-
Manages quotas for users and groups.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 39]
-Manages quotas for users and groups.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method check_profileOptions [line 475]

-
-
-
- array check_profileOptions( -array -$options) -
-

- - Checks input values of account profiles.



-

Tags:

-
- - - - -
return:  list of error messages (array(type, title, text)) to generate StatusMessages, if any
-
-

- - Overrides baseModule::check_profileOptions() (Checks input values of account profiles.)

-

Parameters:

-
- - - - - - -
array  $options  a hash array (name => value) containing the options
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 335]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - -
[ Top ]
-
-
- -

method doUploadPostActions [line 629]

-
-
-
- array doUploadPostActions( -array -$data, array -$ids, array -$failed, -&$temp, array -$temp) -
-

- - This function executes one post upload action.



-

Tags:

-
- - - - -
return:  current status
array (
'status' => 'finished' | 'inProgress'
'progress' => 0..100
'errors' => array (<array of parameters for StatusMessage>)
)
-
-

- - Overrides baseModule::doUploadPostActions() (This function executes one post upload action.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
array  $data  array containing one account in each element
array  $ids  array(<column_name> => <column number>)
array  $failed  list of accounts which were not created successfully
array  $temp  variable to store temporary data between two post actions
  &$temp  
-

-
[ Top ]
-
-
- -

method get_metaData [line 65]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 531]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method get_profileOptions [line 418]

-
-
-
- profile get_profileOptions( -) -
-

- - Returns a list of elements for the account profiles.



-

Tags:

-
- - - - -
return:  elements
-
-

- - Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

-
[ Top ]
-
-
- -

method get_uploadColumns [line 585]

-
-
-
- array get_uploadColumns( -) -
-

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

- - Overrides baseModule::get_uploadColumns() (Returns an array containing all input columns for the file upload.)

-
[ Top ]
-
-
- -

method initQuotas [line 152]

-
-
-
- void initQuotas( -) -
-

- - Initializes the quota values.



- - -
[ Top ]
-
-
- -

method load_Messages [line 43]

-
-
-
- void load_Messages( -) -
-

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

-
[ Top ]
-
-
- -

method load_profile [line 509]

-
-
-
- void load_profile( -array -$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:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method module_ready [line 191]

-
-
-
- boolean module_ready( -) -
-

- - 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 postModifyActions [line 208]

-
-
-
- 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 247]

-
-
-
- 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 288]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method replaceSpecialChars [line 408]

-
-
-
- string replaceSpecialChars( -string -$input) -
-

- - Replaces special characters in HTML name values.



-

Tags:

-
- - - - -
return:  output string
-
-

- - -

Parameters:

-
- - - - - - -
string  $input  input string
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:22 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/samba3domain.html b/lam-web/developers/phpdoc/modules/samba3domain.html deleted file mode 100644 index 52dbf60b..00000000 --- a/lam-web/developers/phpdoc/modules/samba3domain.html +++ /dev/null @@ -1,369 +0,0 @@ - - -Docs For Class samba3domain - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: samba3domain

-Source Location: /lib/account.inc

- - - - - - - - - -
- -

Class Overview

-

-
Represents a Samba 3 domain entry


- - - - - - - -
-

Variables

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 354]
-Represents a Samba 3 domain entry



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$dn =

-

[line 357]

- DN



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$name =

-

[line 360]

- Domain name



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$nextGroupRID =

-

[line 372]

- Next group RID



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$nextRID =

-

[line 366]

- Next RID



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$nextUserRID =

-

[line 369]

- Next user RID



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$RIDbase =  1000

-

[line 375]

- RID base to calculate RIDs, default 1000



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$SID =

-

[line 363]

- Domain SID



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- - - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:50 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/sambaAccount.html b/lam-web/developers/phpdoc/modules/sambaAccount.html deleted file mode 100644 index 6da3fb37..00000000 --- a/lam-web/developers/phpdoc/modules/sambaAccount.html +++ /dev/null @@ -1,976 +0,0 @@ - - -Docs For Class sambaAccount - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: sambaAccount

-Source Location: /lib/modules/sambaAccount.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --sambaAccount

-
Manages the object class "sambaAccount" for users and hosts.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 38]
-Manages the object class "sambaAccount" for users and hosts.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 45]

-
-
-
- sambaAccount __construct( -string -$scope) -
-

- - Creates a new sambaAccount object.



-

Tags:

-
- - - - -
access:  public
-
-

- - Overrides baseModule::__construct() (Creates a new base module class)

-

Parameters:

-
- - - - - - -
string  $scope  account type (user, group, host)
-

-
[ Top ]
-
-
- -

method build_uploadAccounts [line 907]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 724]

-
-
-
- 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 854]

-
-
-
- array display_html_userWorkstations( -) -
-

- - This function will create the HTML page to edit the allowed workstations.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 96]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 888]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method init [line 418]

-
-
-
- void init( -string -$base) -
-

- - 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 469]

-
-
-
- void load_attributes( - -$attr, array -$attributes) -
-

- - 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 59]

-
-
-
- void load_Messages( -) -
-

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

-
[ Top ]
-
-
- -

method load_profile [line 1157]

-
-
-
- void load_profile( -array -$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:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method module_complete [line 458]

-
-
-
- boolean module_complete( -) -
-

- - This functions returns true if all needed settings are done



-

Tags:

-
- - - - -
return:  true if ready to save account
-
-

- - Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

-
[ Top ]
-
-
- -

method module_ready [line 446]

-
-
-
- boolean module_ready( -) -
-

- - 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 524]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module 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_userWorkstations [line 675]

-
-
-
- array process_userWorkstations( -) -
-

- - Processes user input of the workstation selection page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 492]

-
-
-
- array save_attributes( -) -
-

- - 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 ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:23 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/sambaDomain.html b/lam-web/developers/phpdoc/modules/sambaDomain.html deleted file mode 100644 index cca12ff8..00000000 --- a/lam-web/developers/phpdoc/modules/sambaDomain.html +++ /dev/null @@ -1,719 +0,0 @@ - - -Docs For Class sambaDomain - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: sambaDomain

-Source Location: /lib/modules/sambaDomain.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --sambaDomain

-
Manages Samba 3 domain entries.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 35]
-Manages Samba 3 domain entries.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 549]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 211]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 42]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 628]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 185]

-
-
-
- void load_Messages( -) -
-

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

-
[ Top ]
-
-
- -

method process_attributes [line 393]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:24 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/sambaGroupMapping.html b/lam-web/developers/phpdoc/modules/sambaGroupMapping.html deleted file mode 100644 index db7d9b01..00000000 --- a/lam-web/developers/phpdoc/modules/sambaGroupMapping.html +++ /dev/null @@ -1,881 +0,0 @@ - - -Docs For Class sambaGroupMapping - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: sambaGroupMapping

-Source Location: /lib/modules/sambaGroupMapping.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --sambaGroupMapping

-
Manages the object class "sambaGroupMapping" for groups.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 39]
-Manages the object class "sambaGroupMapping" for groups.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 52]

-
-
-
- sambaGroupMapping __construct( -string -$scope) -
-

- - Creates a new module for Samba 3 groups.



- - Overrides baseModule::__construct() (Creates a new base module class)

-

Parameters:

-
- - - - - - -
string  $scope  account type
-

-
[ Top ]
-
-
- -

method build_uploadAccounts [line 102]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 172]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 250]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 342]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method get_profileOptions [line 356]

-
-
-
- profile get_profileOptions( -) -
-

- - Returns a list of elements for the account profiles.



-

Tags:

-
- - - - -
return:  elements
-
-

- - Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

-
[ Top ]
-
-
- -

method init [line 84]

-
-
-
- void init( -string -$base) -
-

- - 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_Messages [line 394]

-
-
-
- void load_Messages( -) -
-

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

-
[ Top ]
-
-
- -

method load_profile [line 379]

-
-
-
- void load_profile( -array -$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:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method module_ready [line 407]

-
-
-
- boolean module_ready( -) -
-

- - 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 420]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 480]

-
-
-
- array save_attributes( -) -
-

- - 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 ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:25 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/sambaMungedDial.html b/lam-web/developers/phpdoc/modules/sambaMungedDial.html deleted file mode 100644 index 6d36cefd..00000000 --- a/lam-web/developers/phpdoc/modules/sambaMungedDial.html +++ /dev/null @@ -1,1144 +0,0 @@ - - -Docs For Class sambaMungedDial - - - - - - - - - - - - - -
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, 06 Jan 2008 18:59:26 +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 deleted file mode 100644 index 8b2cb1e2..00000000 --- a/lam-web/developers/phpdoc/modules/sambaSamAccount.html +++ /dev/null @@ -1,1166 +0,0 @@ - - -Docs For Class sambaSamAccount - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: sambaSamAccount

-Source Location: /lib/modules/sambaSamAccount.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --sambaSamAccount

-
Manages the object class "sambaSamAccount" for users and hosts.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 42]
-Manages the object class "sambaSamAccount" for users and hosts.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 66]

-
-
-
- sambaSamAccount __construct( -string -$scope) -
-

- - Creates a new sambaSamAccount object.



- - Overrides baseModule::__construct() (Creates a new base module class)

-

Parameters:

-
- - - - - - -
string  $scope  account type (user, group, host)
-

-
[ Top ]
-
-
- -

method build_uploadAccounts [line 1750]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method checkSelfServiceOptions [line 2084]

-
-
-
- array checkSelfServiceOptions( -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()))
-
-

- - Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP commands which should be executed.)

-

Parameters:

-
- - - - - - - - - - - -
string  $fields  input fields
array  $attributes  LDAP attributes
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 923]

-
-
-
- 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 1197]

-
-
-
- array display_html_logonHours( -) -
-

- - This function will create the HTML page to edit logon hours.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method display_html_sambaUserWorkstations [line 1163]

-
-
-
- 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 1310]

-
-
-
- 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 1260]

-
-
-
- array display_html_time( -) -
-

- - This function will create the meta HTML code to show a page to change time values.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 118]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 1648]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method get_profileOptions [line 1431]

-
-
-
- profile get_profileOptions( -) -
-

- - Returns a list of elements for the account profiles.



-

Tags:

-
- - - - -
return:  elements
-
-

- - Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

-
[ Top ]
-
-
- -

method init [line 514]

-
-
-
- void init( -string -$base) -
-

- - 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 547]

-
-
-
- void load_attributes( - -$attr, array -$attributes) -
-

- - 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 79]

-
-
-
- void load_Messages( -) -
-

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

-
[ Top ]
-
-
- -

method load_profile [line 1556]

-
-
-
- void load_profile( -array -$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:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method module_ready [line 534]

-
-
-
- boolean module_ready( -) -
-

- - 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 604]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module 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_logonHours [line 824]

-
-
-
- array process_logonHours( -) -
-

- - Processes user input of the logon hours 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_sambaUserWorkstations [line 774]

-
-
-
- array process_sambaUserWorkstations( -) -
-

- - Processes user input of the primary module 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_terminalServer [line 892]

-
-
-
- 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 850]

-
-
-
- array process_time( -) -
-

- - Processes user input of the time selection page.



-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 570]

-
-
-
- array save_attributes( -) -
-

- - 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 ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:26 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/shadowAccount.html b/lam-web/developers/phpdoc/modules/shadowAccount.html deleted file mode 100644 index 4991450f..00000000 --- a/lam-web/developers/phpdoc/modules/shadowAccount.html +++ /dev/null @@ -1,825 +0,0 @@ - - -Docs For Class shadowAccount - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: shadowAccount

-Source Location: /lib/modules/shadowAccount.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --shadowAccount

-
Manages the object class "shadowAccount" for users.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- 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::getIcon() -
-
- Returns the path to the module icon. -
-
- 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. -
-
-
-
-
- - -

Class Details

-
-[line 39]
-Manages the object class "shadowAccount" for users.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 377]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 261]

-
-
-
- array display_html_attributes( -) -
-

- - This function will create the meta HTML code to show a page with all attributes.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method display_html_expire [line 327]

-
-
-
- array display_html_expire( -) -
-

- - This function will create the meta HTML code to show a page with the expiration date.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 64]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 362]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 44]

-
-
-
- void load_Messages( -) -
-

- - This function builds up the message array.



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method load_profile [line 457]

-
-
-
- void load_profile( -array -$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:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method process_attributes [line 241]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module 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_expire [line 308]

-
-
-
- array process_expire( -) -
-

- - Processes user input of the expiration page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 223]

-
-
-
- array save_attributes( -) -
-

- - 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 ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:30 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/modules/smbHash.html b/lam-web/developers/phpdoc/modules/smbHash.html deleted file mode 100644 index 0371f284..00000000 --- a/lam-web/developers/phpdoc/modules/smbHash.html +++ /dev/null @@ -1,764 +0,0 @@ - - -Docs For Class smbHash - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: smbHash

-Source Location: /lib/createntlm.inc

- - - - - - - - - - -
- -

Class Overview

-

-
Calculates NT and LM hashes.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 41]
-Calculates NT and LM hashes.

The important functions are lmhash($password) and nthash($password).




-
[ Top ]

- -
- -

Class Variables

-
- -

-

$perm1 = array(57, 49, 41, 33, 25, 17,  9,
-              1, 58, 50, 42, 34, 26, 18,
-             10,  2, 59, 51, 43, 35, 27,
-             19, 11,  3, 60, 52, 44, 36,
-             63, 55, 47, 39, 31, 23, 15,
-              7, 62, 54, 46, 38, 30, 22,
-             14,  6, 61, 53, 45, 37, 29,
-             21, 13,  5, 28, 20, 12,  4)

-

[line 45]

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


-
[ Top ]

- -

-

$perm2 = array(14, 17, 11, 24,  1,  5,
-              3, 28, 15,  6, 21, 10,
-             23, 19, 12,  4, 26,  8,
-             16,  7, 27, 20, 13,  2,
-             41, 52, 31, 37, 47, 55,
-             30, 40, 51, 45, 33, 48,
-             44, 49, 39, 56, 34, 53,
-             46, 42, 50, 36, 29, 32)

-

[line 54]

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


-
[ Top ]

- -

-

$perm3 = array(58, 50, 42, 34, 26, 18, 10,  2,
-             60, 52, 44, 36, 28, 20, 12,  4,
-             62, 54, 46, 38, 30, 22, 14,  6,
-             64, 56, 48, 40, 32, 24, 16,  8,
-             57, 49, 41, 33, 25, 17,  9,  1,
-             59, 51, 43, 35, 27, 19, 11,  3,
-             61, 53, 45, 37, 29, 21, 13,  5,
-             63, 55, 47, 39, 31, 23, 15,  7)

-

[line 63]

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


-
[ Top ]

- -

-

$perm4 = array(32,  1,  2,  3,  4,  5,
-                 4,  5,  6,  7,  8,  9,
-                 8,  9, 10, 11, 12, 13,
-                12, 13, 14, 15, 16, 17,
-                16, 17, 18, 19, 20, 21,
-                20, 21, 22, 23, 24, 25,
-                24, 25, 26, 27, 28, 29,
-                28, 29, 30, 31, 32,  1)

-

[line 72]

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


-
[ Top ]

- -

-

$perm5 = array(16,  7, 20, 21,
-                   29, 12, 28, 17,
-                    1, 15, 23, 26,
-                    5, 18, 31, 10,
-                    2,  8, 24, 14,
-                   32, 27,  3,  9,
-                   19, 13, 30,  6,
-                   22, 11,  4, 25)

-

[line 81]

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


-
[ Top ]

- -

-

$perm6 = array(40,  8, 48, 16, 56, 24, 64, 32,
-             39,  7, 47, 15, 55, 23, 63, 31,
-             38,  6, 46, 14, 54, 22, 62, 30,
-             37,  5, 45, 13, 53, 21, 61, 29,
-             36,  4, 44, 12, 52, 20, 60, 28,
-             35,  3, 43, 11, 51, 19, 59, 27,
-             34,  2, 42, 10, 50, 18, 58, 26,
-             33,  1, 41,  9, 49, 17, 57, 25)

-

[line 90]

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


-
[ Top ]

- -

-

$sbox = array(array(array(14,  4, 13,  1,  2, 15, 11,  8,  3, 10,  6, 12,  5,  9,  0,  7),array(0,15,7,4,14,2,13,1,10,6,12,11,9,5,3,8),array(4,1,14,8,13,6,2,11,15,12,9,7,3,10,5,0),array(15,12,8,2,4,9,1,7,5,11,3,14,10,0,6,13)),array(array(15,1,8,14,6,11,3,4,9,7,2,13,12,0,5,10),array(3,13,4,7,15,2,8,14,12,0,1,10,6,9,11,5),array(0,14,7,11,10,4,13,1,5,8,12,6,9,3,2,15),array(13,8,10,1,3,15,4,2,11,6,7,12,0,5,14,9)),array(array(10,0,9,14,6,3,15,5,1,13,12,7,11,4,2,8),array(13,7,0,9,3,4,6,10,2,8,5,14,12,11,15,1),array(13,6,4,9,8,15,3,0,11,1,2,12,5,10,14,7),array(1,10,13,0,6,9,8,7,4,15,14,3,11,5,2,12)),array(array(7,13,14,3,0,6,9,10,1,2,8,5,11,12,4,15),array(13,8,11,5,6,15,0,3,4,7,2,12,1,10,14,9),array(10,6,9,0,12,11,7,13,15,1,3,14,5,2,8,4),array(3,15,0,6,10,1,13,8,9,4,5,11,12,7,2,14)),array(array(2,12,4,1,7,10,11,6,8,5,3,15,13,0,14,9),array(14,11,2,12,4,7,13,1,5,0,15,10,3,9,8,6),array(4,2,1,11,10,13,7,8,15,9,12,5,6,3,0,14),array(11,8,12,7,1,14,2,13,6,15,0,9,10,4,5,3)),array(array(12,1,10,15,9,2,6,8,0,13,3,4,14,7,5,11),array(10,15,4,2,7,12,9,5,6,1,13,14,0,11,3,8),array(9,14,15,5,2,8,12,3,7,0,4,10,1,13,11,6),array(4,3,2,12,9,5,15,10,11,14,1,7,6,0,8,13)),array(array(4,11,2,14,15,0,8,13,3,12,9,7,5,10,6,1),array(13,0,11,7,4,9,1,10,14,3,5,12,2,15,8,6),array(1,4,11,13,12,3,7,14,10,15,6,8,0,5,9,2),array(6,11,13,8,1,4,10,7,9,5,0,15,14,2,3,12)),array(array(13,2,8,4,6,15,11,1,10,9,3,14,5,0,12,7),array(1,15,13,8,10,3,7,4,12,5,6,11,0,14,9,2),array(7,11,4,1,9,12,14,2,0,6,10,13,15,3,5,8),array(2,1,14,7,4,10,8,13,15,12,9,0,3,5,6,11)))

-

[line 103]

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


-
[ Top ]

- -

-

$sc = array(1, 1, 2, 2, 2, 2, 2, 2, 1, 2, 2, 2, 2, 2, 2, 1)

-

[line 99]

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

method doHash [line 189]

-
-
-
- array doHash( -array -$in, array -$key, boolean -$forw) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
array  $in  
array  $key  
boolean  $forw  
-

-
[ Top ]
-
-
- -

method E_P16 [line 310]

-
-
-
- unknown E_P16( -unknown_type -$in) -
-

- - E_P16



- - -

Parameters:

-
- - - - - - -
unknown_type  $in  
-

-
[ Top ]
-
-
- -

method lmhash [line 334]

-
-
-
- string lmhash( -[string -$password = ""]) -
-

- - Calculates the LM hash of a given password.



-

Tags:

-
- - - - -
return:  hash value
-
-

- - -

Parameters:

-
- - - - - - -
string  $password  password
-

-
[ Top ]
-
-
- -

method lshift [line 149]

-
-
-
- array lshift( -integer -$count, array -$data) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
array  $data  
integer  $count  count
-

-
[ Top ]
-
-
- -

method mxor [line 175]

-
-
-
- array mxor( -array -$in1, array -$in2) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
array  $in1  
array  $in2  
-

-
[ Top ]
-
-
- -

method nthash [line 351]

-
-
-
- string nthash( -[string -$password = ""]) -
-

- - Calculates the NT hash of a given password.



-

Tags:

-
- - - - -
return:  hash value
-
-

- - -

Parameters:

-
- - - - - - -
string  $password  password
-

-
[ Top ]
-
-
- -

method permute [line 162]

-
-
-
- array permute( -array -$in, array -$p, -$n) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
array  $in  in input data
array  $p  p permutation
  $n  
-

-
[ Top ]
-
-
- -

method smb_hash [line 284]

-
-
-
- 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 261]

-
-
-
- string str_to_key( -string -$str) -
-

- - str_to_key



-

Tags:

-
- - - - -
return:  key
-
-

- - -

Parameters:

-
- - - - - - -
string  $str  
-

-
[ Top ]
-
-
- -

method unsigned_shift_r [line 360]

-
-
-
- void unsigned_shift_r( - -$a, -$b) -
-

- - Unsigned shift operation for 32bit values.

PHP 4 only supports signed shifts by default.




- - -

Parameters:

-
- - - - - - - - - - - -
  $a  
  $b  
-

-
[ Top ]
-
-
- -

method x [line 139]

-
-
-
- void x( - -$i) -
-

- - Fixes too large numbers



- - -

Parameters:

-
- - - - - - -
  $i  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:58 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/profiles/_lib---profiles.inc.html b/lam-web/developers/phpdoc/profiles/_lib---profiles.inc.html deleted file mode 100644 index 85238311..00000000 --- a/lam-web/developers/phpdoc/profiles/_lib---profiles.inc.html +++ /dev/null @@ -1,245 +0,0 @@ - - -Docs for page profiles.inc - - - - - - - - - - - - - -
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, 06 Jan 2008 18:59:21 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/profiles/_lib_profiles_inc.html b/lam-web/developers/phpdoc/profiles/_lib_profiles_inc.html deleted file mode 100644 index 6765b2ff..00000000 --- a/lam-web/developers/phpdoc/profiles/_lib_profiles_inc.html +++ /dev/null @@ -1,246 +0,0 @@ - - -Docs for page profiles.inc - - - - - - - - - - - - - -
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 Wed, 15 Nov 2006 18:00:59 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/profiles/_templates---profedit---profiledelete.php.html b/lam-web/developers/phpdoc/profiles/_templates---profedit---profiledelete.php.html deleted file mode 100644 index 95baad98..00000000 --- a/lam-web/developers/phpdoc/profiles/_templates---profedit---profiledelete.php.html +++ /dev/null @@ -1,104 +0,0 @@ - - -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, 06 Jan 2008 18:59:21 +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 deleted file mode 100644 index f8dcffeb..00000000 --- a/lam-web/developers/phpdoc/profiles/_templates---profedit---profilemain.php.html +++ /dev/null @@ -1,104 +0,0 @@ - - -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, 06 Jan 2008 18:59:21 +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 deleted file mode 100644 index eda9fb9b..00000000 --- a/lam-web/developers/phpdoc/profiles/_templates---profedit---profilepage.php.html +++ /dev/null @@ -1,106 +0,0 @@ - - -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, 06 Jan 2008 18:59:21 +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 deleted file mode 100644 index 33eb6699..00000000 --- a/lam-web/developers/phpdoc/profiles/_templates_profedit_profiledelete_php.html +++ /dev/null @@ -1,101 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:59 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/profiles/_templates_profedit_profilemain_php.html b/lam-web/developers/phpdoc/profiles/_templates_profedit_profilemain_php.html deleted file mode 100644 index df8ded4b..00000000 --- a/lam-web/developers/phpdoc/profiles/_templates_profedit_profilemain_php.html +++ /dev/null @@ -1,101 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:59 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/profiles/_templates_profedit_profilepage_php.html b/lam-web/developers/phpdoc/profiles/_templates_profedit_profilepage_php.html deleted file mode 100644 index 5e9eb270..00000000 --- a/lam-web/developers/phpdoc/profiles/_templates_profedit_profilepage_php.html +++ /dev/null @@ -1,103 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:59 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/ric_INSTALL.html b/lam-web/developers/phpdoc/ric_INSTALL.html deleted file mode 100644 index 917be2aa..00000000 --- a/lam-web/developers/phpdoc/ric_INSTALL.html +++ /dev/null @@ -1,124 +0,0 @@ - - -INSTALL - - - - - - - - - - - - - -
default
- - [ all elements ] -
- - - - - - -
-
- -

INSTALL

-
-
-Installation Instructions for LAM
----------------------------------
-
-
-1. Requirements
-
-   - Apache webserver (SSL optional) with PHP module (PHP 5 (>= 5.1) with
-     ldap, gettext, xml and optional mcrypt)
-   - some LAM plugins may require additional PHP extensions (you will get a
-     note on the login page if something is missing)
-   - Perl (optional, needed only for lamdaemon)
-   - OpenLDAP (>2.0)
-   - A web browser :-)
-
-   MHash is only needed for Samba password hashes.
-   MCrypt will be used to store your LDAP password encrypted in the session file.
-
-
-   See docs/README.schema.txt for information about used LDAP schema files.
-
-
-2. Installation
-
-   1. Extract package with:
-      tar xzf ldap-account-manager-<version>.tar.gz
-
-   2a. Copy the files into the html-file scope of the webserver. For example
-       /apache/htdocs.
-
-       Set appropriate file permissions:
-        - lam/sess: write permission for apache user
-        - lam/tmp: write permission for apache user
-        - lam/config (with subdirectories): write permission for apache user
-        - lam/lib: lamdaemon.pl must be set executable (See also
-          docs/readme.lamdeamon.txt)
-
-   2b. You can also use the included configure script to install LAM. See
-       "./configure --help" for a list of install options.
-
-   3. Configure config.cfg and create a configuration profile.
-      Copy config.cfg_sample to config.cfg and set the master password and default
-      profile.
-
-      Open the index.html in your web browser:
-       - Follow the link "Configuration Login" from the start page.
-        (The default password to edit the options is "lam")
-       - Select the default lam profile or create a new profile.
-       - Change the settings to fit your environment.
-
-
-
-3. Setting up PHP
-
-   LAM runs with PHP5 (>= 5.1).
-
-   Needed changes in your php.ini:
-
-    * memory_limit = 64M
-
-
-
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/ric_README.html b/lam-web/developers/phpdoc/ric_README.html deleted file mode 100644 index 8f707b2e..00000000 --- a/lam-web/developers/phpdoc/ric_README.html +++ /dev/null @@ -1,142 +0,0 @@ - - -README - - - - - - - - - - - - - -
default
- - [ all elements ] -
- - - - - - -
-
- -

README

-
-
-LAM - Readme
-============
-
-  LDAP Account Manager (LAM) manages user, group and host accounts in an LDAP
-  directory. LAM runs on any webserver with PHP5 support and connects to your
-  LDAP server unencrypted or via SSL/TLS.
-  Currently LAM supports these account types: Samba 2 and 3, Unix, Kolab 2,
-  address book entries, NIS mail aliases and MAC addresses. There is a tree
-  viewer included to allow access to the raw LDAP attributes. You can use
-  templates for account creation and use multiple configuration profiles.
-  LAM is translated to Catalan, Chinese (Traditional + Simplified), Czech,
-  Dutch, English, French, German, Hungarian, Italian, Japanese, Portuguese,
-  Russian and Spanish.
-
-  http://sourceforge.net/projects/lam/
-
-    Copyright (C) 2003 - 2007 Michael Duergner <michael@duergner.com>
-                              Roland Gruber <post@rolandgruber.de>
-                              Tilo Lutz <tilolutz@gmx.de>
-
-  Requirements:
-    PHP5 (>= 5.1)
-    Openldap (2.0 or greater)
-    A web-browser that supports CSS
-
-  Summary:
-    With LAM you can easily manage user, group and machine accounts stored in
-    an LDAP directory over a web interface. At the moment it supports:
-
-      - managing user/group/host/domain entries
-      - filtering and sorting
-      - account profiles
-      - multiple configuration profiles
-      - tree viwer
-      - schema browser
-      - OU Editor
-      - account creation via file upload
-      - PDF export for all accounts
-      - manage user/group Quota and create home directories
-
-  Important:
-    The default password to edit the configuration options is "lam".
-
-  Installation:
-    Please see the INSTALL file.
-
-  Documentation:
-    Basic documentation is available in the directory "docs".
-
-  Upgrade from older versions:
-    See docs/README.upgrade.txt for upgrade instructions.
-
-  Internationalisation:
-    If you want to use a translated version of LAM be sure to install the
-    needed locales. See the LAM "locale" directory for a list of supported locales and languages.
-    You can get a list of all installed locales on your sysem by executing: locale -a
-    Debian users can add locales with "dpkg-reconfigure locales".
-
-  Security:
-    It is strongly recommended to use a SSL connection to your web server.
-
-    LAM needs to store your LDAP user name + password in the session. The session
-    files are saved in sess/ and are accessible only by the web server. To increase
-    security username and password are encrypted with MCrypt/AES if available.
-    The key and IV are generated at random when you log in. They are stored in two
-    cookies.
- 
-  Download:
-    You can get the newest version at http://lam.sourceforge.net/.
-
-  License:
-    LAM is published under the GNU General Public License.
-    The complete list of licenses can be found in the copyright file.
-
-
-    Have fun!
-        The LAM devel team
-
-
-
-
- Documentation generated on Sun, 06 Jan 2008 18:58:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/selfService/_lib---selfService.inc.html b/lam-web/developers/phpdoc/selfService/_lib---selfService.inc.html deleted file mode 100644 index 30250d13..00000000 --- a/lam-web/developers/phpdoc/selfService/_lib---selfService.inc.html +++ /dev/null @@ -1,460 +0,0 @@ - - -Docs for page selfService.inc - - - - - - - - - - - - - -
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, 06 Jan 2008 18:59:30 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/selfService/_templates---selfService---adminLogin.php.html b/lam-web/developers/phpdoc/selfService/_templates---selfService---adminLogin.php.html deleted file mode 100644 index e00ba316..00000000 --- a/lam-web/developers/phpdoc/selfService/_templates---selfService---adminLogin.php.html +++ /dev/null @@ -1,112 +0,0 @@ - - -Docs for page adminLogin.php - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: adminLogin.php

-Source Location: /templates/selfService/adminLogin.php

- -
-
- - -

Page Details:

-Login page for self service configuration.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/selfService.inc') [line 18]
-Access to self service profiles

include_once('../../lib/status.inc') [line 20]
-status messages

include_once('../../lib/config.inc') [line 22]
-Access config options

-

-

-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:51 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/selfService/_templates---selfService---adminMain.php.html b/lam-web/developers/phpdoc/selfService/_templates---selfService---adminMain.php.html deleted file mode 100644 index d4e3bf6c..00000000 --- a/lam-web/developers/phpdoc/selfService/_templates---selfService---adminMain.php.html +++ /dev/null @@ -1,111 +0,0 @@ - - -Docs for page adminMain.php - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: adminMain.php

-Source Location: /templates/selfService/adminMain.php

- -
-
- - -

Page Details:

-Configuration page for self service.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/selfService.inc') [line 18]
-Access to self service profiles

include_once('../../lib/config.inc') [line 20]
-Access config options

-

-

-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:51 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/selfService/_templates---selfService---profManage.php.html b/lam-web/developers/phpdoc/selfService/_templates---selfService---profManage.php.html deleted file mode 100644 index da517990..00000000 --- a/lam-web/developers/phpdoc/selfService/_templates---selfService---profManage.php.html +++ /dev/null @@ -1,111 +0,0 @@ - - -Docs for page profManage.php - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: profManage.php

-Source Location: /templates/selfService/profManage.php

- -
-
- - -

Page Details:

-Self service profile management.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/selfService.inc') [line 20]
-Access to self service functions

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

-

-

-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:22 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/selfService/_templates---selfService---selfServiceLogin.php.html b/lam-web/developers/phpdoc/selfService/_templates---selfService---selfServiceLogin.php.html deleted file mode 100644 index 1bdb2a2e..00000000 --- a/lam-web/developers/phpdoc/selfService/_templates---selfService---selfServiceLogin.php.html +++ /dev/null @@ -1,111 +0,0 @@ - - -Docs for page selfServiceLogin.php - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: selfServiceLogin.php

-Source Location: /templates/selfService/selfServiceLogin.php

- -
-
- - -

Page Details:

-User login page for self service.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/selfService.inc') [line 18]
-Access to self service profiles

include_once('../../lib/status.inc') [line 20]
-status messages

-

-

-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:30 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/selfService/_templates---selfService---selfServiceMain.php.html b/lam-web/developers/phpdoc/selfService/_templates---selfService---selfServiceMain.php.html deleted file mode 100644 index 744d7e59..00000000 --- a/lam-web/developers/phpdoc/selfService/_templates---selfService---selfServiceMain.php.html +++ /dev/null @@ -1,111 +0,0 @@ - - -Docs for page selfServiceMain.php - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: selfServiceMain.php

-Source Location: /templates/selfService/selfServiceMain.php

- -
-
- - -

Page Details:

-User page for self service.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/selfService.inc') [line 18]
-Access to self service profiles

include_once('../../lib/status.inc') [line 20]
-status messages

-

-

-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:30 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/selfService/selfServiceProfile.html b/lam-web/developers/phpdoc/selfService/selfServiceProfile.html deleted file mode 100644 index 79ee4c14..00000000 --- a/lam-web/developers/phpdoc/selfService/selfServiceProfile.html +++ /dev/null @@ -1,417 +0,0 @@ - - -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 __construct [line 295]

-
-
-
- selfServiceProfile __construct( -) -
-

- - Constructor



- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:30 +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 deleted file mode 100644 index 6d78861b..00000000 --- a/lam-web/developers/phpdoc/tests/_tests---conf-main-test.php.html +++ /dev/null @@ -1,99 +0,0 @@ - - -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, 06 Jan 2008 18:58:55 +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 deleted file mode 100644 index a585246c..00000000 --- a/lam-web/developers/phpdoc/tests/_tests---conf-test.php.html +++ /dev/null @@ -1,99 +0,0 @@ - - -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, 06 Jan 2008 18:58:55 +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 deleted file mode 100644 index 7963ae5c..00000000 --- a/lam-web/developers/phpdoc/tests/_tests---status-test.php.html +++ /dev/null @@ -1,99 +0,0 @@ - - -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, 06 Jan 2008 18:59:32 +0100 by phpDocumentor 1.4.0 -
-
-
- - - 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 deleted file mode 100644 index 6a65c396..00000000 --- a/lam-web/developers/phpdoc/tests/_tests_conf-main-test_php.html +++ /dev/null @@ -1,96 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:39 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tests/_tests_conf-test_php.html b/lam-web/developers/phpdoc/tests/_tests_conf-test_php.html deleted file mode 100644 index b4446f97..00000000 --- a/lam-web/developers/phpdoc/tests/_tests_conf-test_php.html +++ /dev/null @@ -1,96 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:39 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tests/_tests_status-test_php.html b/lam-web/developers/phpdoc/tests/_tests_status-test_php.html deleted file mode 100644 index 8b94bfa8..00000000 --- a/lam-web/developers/phpdoc/tests/_tests_status-test_php.html +++ /dev/null @@ -1,96 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:09 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/LAMTool.html b/lam-web/developers/phpdoc/tools/LAMTool.html deleted file mode 100644 index 5086e0de..00000000 --- a/lam-web/developers/phpdoc/tools/LAMTool.html +++ /dev/null @@ -1,294 +0,0 @@ - - -Docs For Class LAMTool - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: LAMTool

-Source Location: /templates/tools.php

- - - - - - - - - -
- -

Class Overview

-

-
Represents a tool.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Variables

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 140]
-Represents a tool.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$description =

-

[line 146]

- description text



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$link =

-

[line 149]

- link to tool page (relative to templates/)



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$name =

-

[line 143]

- name of the tool



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$requiresPasswordChanges =  false

-

[line 155]

- tool requires password change rights



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$requiresWriteAccess =  false

-

[line 152]

- tool requires write access to LDAP



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- - - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:32 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/LdapExportInfo.html b/lam-web/developers/phpdoc/tools/LdapExportInfo.html deleted file mode 100644 index 6c68d4a1..00000000 --- a/lam-web/developers/phpdoc/tools/LdapExportInfo.html +++ /dev/null @@ -1,255 +0,0 @@ - - -Docs For Class LdapExportInfo - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: LdapExportInfo

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-

-
This class encapsulate informations about the ldap server from which the export is done.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 84]
-This class encapsulate informations about the ldap server from which the export is done.

The following info are provided within this class:

$base_dn: if the source of the export is the ldap server, it indicates the base dn of the search. $query_filter: if the source of the export is the ldap server, it indicates the query filter for the search. $scope: if the source of the export is the ldap server, it indicates the scope of the search.




-
[ Top ]

- -
- -

Class Variables

-
- -

-

$base_dn =

-

[line 86]

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


-
[ Top ]

- -

-

$query_filter =

-

[line 87]

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


-
[ Top ]

- -

-

$scope =

-

[line 88]

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor LdapExportInfo [line 98]

-
-
-
- LdapExportInfo LdapExportInfo( -[String -$base_dn = NULL], [String -$query_filter = NULL], [String -$scope = NULL]) -
-

- - Create a new LdapExportInfo object



- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
String  $base_dn  the base_dn for the search in a ldap server
String  $query_filter  the query filter for the search
String  $scope  the scope of the search in a ldap server
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:00 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/MyCustomExporter.html b/lam-web/developers/phpdoc/tools/MyCustomExporter.html deleted file mode 100644 index 28a1258e..00000000 --- a/lam-web/developers/phpdoc/tools/MyCustomExporter.html +++ /dev/null @@ -1,321 +0,0 @@ - - -Docs For Class MyCustomExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: MyCustomExporter

-Source Location: /lib/export.inc

- - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaExporter
-      |
-      --MyCustomExporter

-


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: PlaExporter

-
-
- PlaExporter::$br -
-
- -
-
- PlaExporter::$exporter -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: PlaExporter

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

Class: PlaAbstractExporter

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

Class Details

-
-[line 792]
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method export [line 804]

-
-
-
- void export( -) -
-

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

-
[ Top ]
-
-
- -

method MyCutsomExporter [line 794]

-
-
-
- void MyCutsomExporter( - -$exporter) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $exporter  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:00 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/PlaAbstractExporter.html b/lam-web/developers/phpdoc/tools/PlaAbstractExporter.html deleted file mode 100644 index b467f3ae..00000000 --- a/lam-web/developers/phpdoc/tools/PlaAbstractExporter.html +++ /dev/null @@ -1,362 +0,0 @@ - - -Docs For Class PlaAbstractExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaAbstractExporter

-Source Location: /lib/export.inc

- - - - - - - - - -
- -

Class Overview

-

-
This class represents the base class of all exporters


-

Author(s):

-
    -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
PlaExporter
-
PlaExporter acts a wrapper around another exporter.
-
-
-
PlaLdapExporter
-
Export data from a ldap server
-
-
-
-
- - -

Class Details

-
-[line 119]
-This class represents the base class of all exporters

It can be subclassed directly if your intend is to write a source exporter(ie. it will act only as a decoree which will be wrapped by an another exporter.) If you consider writting an exporter for filtering data or directly display entries, please consider subclass the PlaExporter




-

Tags:

-
- - - - -
see:  PlaExporter
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method pla_fetch_entry_array [line 137]

-
-
-
- array pla_fetch_entry_array( -) -
-

- - Return the entry as an array



-

Tags:

-
- - - - -
return:  an entry as an array
-
-

- -

Overridden in child classes as:
-

-
PlaExporter::pla_fetch_entry_array()
-
Return the entry as an array
-
-
-
PlaLdapExporter::pla_fetch_entry_array()
-
Return the entry as an array
-
-

- -
[ Top ]
-
-
- -

method pla_fetch_entry_object [line 143]

-
-
-
- Entry pla_fetch_entry_object( -) -
-

- - Return the entry as an Entry object



-

Tags:

-
- - - - -
return:  an entry as an Entry Object
-
-

- -

Overridden in child classes as:
-

-
PlaExporter::pla_fetch_entry_object()
-
Return the entry as an Entry object
-
-
-
PlaLdapExporter::pla_fetch_entry_object()
-
Return the entry as an Entry object
-
-

- -
[ Top ]
-
-
- -

method pla_get_ldap_info [line 149]

-
-
-
- LdapInfo pla_get_ldap_info( -) -
-

- - Return a PlaLdapInfo Object



-

Tags:

-
- - - - -
return:  Object with info from the ldap serveur
-
-

- -

Overridden in child classes as:
-

-
PlaExporter::pla_get_ldap_info()
-
Return a PlaLdapInfo Object
-
-
-
PlaLdapExporter::pla_get_ldap_info()
-
Return a PlaLdapInfo Object
-
-

- -
[ Top ]
-
-
- -

method pla_has_entry [line 131]

-
-
-
- bool pla_has_entry( -) -
-

- - Return true if there is some more entries to be processed



-

Tags:

-
- - - - -
return:  if there is some more entries to be processed
-
-

- -

Overridden in child classes as:
-

-
PlaExporter::pla_has_entry()
-
Return true if there is some more entries to be processed
-
-
-
PlaLdapExporter::pla_has_entry()
-
Return true if there is some more entries to be processed
-
-

- -
[ Top ]
-
-
- -

method pla_num_entries [line 125]

-
-
-
- int pla_num_entries( -) -
-

- - Return the number of entries



-

Tags:

-
- - - - -
return:  the number of entries to be exported
-
-

- -

Overridden in child classes as:
-

-
PlaExporter::pla_num_entries()
-
Return the number of entries
-
-
-
PlaLdapExporter::pla_num_entries()
-
Return the number of entries
-
-

- -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:00 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/PlaCSVExporter.html b/lam-web/developers/phpdoc/tools/PlaCSVExporter.html deleted file mode 100644 index 103ca612..00000000 --- a/lam-web/developers/phpdoc/tools/PlaCSVExporter.html +++ /dev/null @@ -1,436 +0,0 @@ - - -Docs For Class PlaCSVExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaCSVExporter

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaExporter
-      |
-      --PlaCSVExporter

-
Export to cvs format


-

Author(s):

-
    -
  • Glen Ogilvie
  • -
- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: PlaExporter

-
-
- PlaExporter::$br -
-
- -
-
- PlaExporter::$exporter -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: PlaExporter

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

Class: PlaAbstractExporter

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

Class Details

-
-[line 684]
-Export to cvs format



-

Tags:

-
- - - - -
author:  Glen Ogilvie
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$escapeCode =  '"'

-

[line 698]

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


-
[ Top ]

- -

-

$multivalue_separator =  " | "

-

[line 697]

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


-
[ Top ]

- -

-

$qualifier =  '"'

-

[line 696]

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


-
[ Top ]

- -

-

$separator =  ","

-

[line 695]

- When doing an exporter, the method export need to be overriden.

A basic implementation is provided here. Customize to your need


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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor PlaCSVExporter [line 686]

-
-
-
- PlaCSVExporter PlaCSVExporter( - -$exporter) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $exporter  
-

-
[ Top ]
-
-
- -

method export [line 700]

-
-
-
- void export( -) -
-

- -

- - Overrides PlaExporter::export() (Abstract method use to export data.)

-
[ Top ]
-
-
- -

method LdapEscape [line 780]

-
-
-
- void LdapEscape( - -$var) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $var  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:00 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/PlaDsmlExporter.html b/lam-web/developers/phpdoc/tools/PlaDsmlExporter.html deleted file mode 100644 index 230d67b1..00000000 --- a/lam-web/developers/phpdoc/tools/PlaDsmlExporter.html +++ /dev/null @@ -1,375 +0,0 @@ - - -Docs For Class PlaDsmlExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaDsmlExporter

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaExporter
-      |
-      --PlaDsmlExporter

-
Export entries to DSML v.1


-

Author(s):

-
    -
- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: PlaExporter

-
-
- PlaExporter::$br -
-
- -
-
- PlaExporter::$exporter -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: PlaExporter

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

Class: PlaAbstractExporter

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

Class Details

-
-[line 478]
-Export entries to DSML v.1



-

Tags:

-
- - - - -
extends:  PlaExporter
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$counter =  0

-

[line 482]

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


-
[ Top ]

- -

-

$indent_step =  2

-

[line 481]

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor PlaDsmlExporter [line 488]

-
-
-
- PlaDsmlExporter PlaDsmlExporter( -PlaAbstractExporter -$exporter) -
-

- - Create a PlaDsmlExporter object



- - -

Parameters:

-
- - - - - - -
PlaAbstractExporter  $exporter  the decoree exporter
-

-
[ Top ]
-
-
- -

method export [line 495]

-
-
-
- void export( -) -
-

- - Export the entries to DSML



- - Overrides PlaExporter::export() (Abstract method use to export data.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:01 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/PlaExporter.html b/lam-web/developers/phpdoc/tools/PlaExporter.html deleted file mode 100644 index 1e8b39e0..00000000 --- a/lam-web/developers/phpdoc/tools/PlaExporter.html +++ /dev/null @@ -1,526 +0,0 @@ - - -Docs For Class PlaExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaExporter

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaExporter

-
PlaExporter acts a wrapper around another exporter.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Child classes:

-
-
-
PlaLdifExporter
-
Export entries to ldif format
-
-
-
PlaDsmlExporter
-
Export entries to DSML v.1
-
-
-
PlaVcardExporter
-
-
-
-
PlaCSVExporter
-
Export to cvs format
-
-
-
MyCustomExporter
-
-
-
-
-

Inherited Methods

-
-

Class: PlaAbstractExporter

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

Class Details

-
-[line 161]
-PlaExporter acts a wrapper around another exporter.

In other words, it will act as a decorator for another decorator




-
[ Top ]

- -
- -

Class Variables

-
- -

-

$br = "\n"

-

[line 163]

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


-
[ Top ]

- -

-

$exporter =

-

[line 165]

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor PlaExporter [line 171]

-
-
-
- PlaExporter PlaExporter( -source -$source) -
-

- - Constructor



- - -

Parameters:

-
- - - - - - -
source  $source  the decoree for this exporter
-

-
[ Top ]
-
-
- -

method export [line 233]

-
-
-
- void export( -) -
-

- - Abstract method use to export data.

Must be implemented in a sub-class if you write an exporter which export data. Leave it empty if you write a sub-class which do only some filtering.




- -

Overridden in child classes as:
-

-
PlaLdifExporter::export()
-
Export entries to ldif format
-
-
-
PlaDsmlExporter::export()
-
Export the entries to DSML
-
-
-
PlaVcardExporter::export()
-
When doing an exporter, the method export need to be overriden.
-
-
-
PlaCSVExporter::export()
-
-
-
-
MyCustomExporter::export()
-
When doing an exporter, the method export need to be overriden.
-
-

- -
[ Top ]
-
-
- -

method is_safe_ascii [line 220]

-
-
-
- bool is_safe_ascii( -String -$str) -
-

- - Helper method to check if the attribute value should be base 64 encoded.



-

Tags:

-
- - - - -
return:  true if the string is safe ascii, false otherwise.
-
-

- - -

Parameters:

-
- - - - - - -
String  $str  the string to check.
-

-
[ Top ]
-
-
- -

method pla_fetch_entry_array [line 195]

-
-
-
- array pla_fetch_entry_array( -) -
-

- - Return the entry as an array



-

Tags:

-
- - - - -
return:  an entry as an array
-
-

- - Overrides PlaAbstractExporter::pla_fetch_entry_array() (Return the entry as an array)

-
[ Top ]
-
-
- -

method pla_fetch_entry_object [line 203]

-
-
-
- Entry pla_fetch_entry_object( -) -
-

- - Return the entry as an Entry object



-

Tags:

-
- - - - -
return:  an entry as an Entry Object
-
-

- - Overrides PlaAbstractExporter::pla_fetch_entry_object() (Return the entry as an Entry object)

-
[ Top ]
-
-
- -

method pla_get_ldap_info [line 211]

-
-
-
- LdapInfo pla_get_ldap_info( -) -
-

- - Return a PlaLdapInfo Object



-

Tags:

-
- - - - -
return:  Object with info from the ldap serveur
-
-

- - Overrides PlaAbstractExporter::pla_get_ldap_info() (Return a PlaLdapInfo Object)

-
[ Top ]
-
-
- -

method pla_has_entry [line 187]

-
-
-
- bool pla_has_entry( -) -
-

- - Return true if there is some more entries to be processed



-

Tags:

-
- - - - -
return:  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 ]
-
-
- -

method pla_num_entries [line 179]

-
-
-
- int pla_num_entries( -) -
-

- - Return the number of entries



-

Tags:

-
- - - - -
return:  the number of entries to be exported
-
-

- - Overrides PlaAbstractExporter::pla_num_entries() (Return the number of entries)

-
[ Top ]
-
-
- -

method setOutputFormat [line 239]

-
-
-
- void setOutputFormat( -String -$br) -
-

- - Set the carriage return /linefeed for the export



- - -

Parameters:

-
- - - - - - -
String  $br  the CRLF to be set
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:01 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/PlaLdapExporter.html b/lam-web/developers/phpdoc/tools/PlaLdapExporter.html deleted file mode 100644 index e577e299..00000000 --- a/lam-web/developers/phpdoc/tools/PlaLdapExporter.html +++ /dev/null @@ -1,539 +0,0 @@ - - -Docs For Class PlaLdapExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaLdapExporter

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaLdapExporter

-
Export data from a ldap server


-

Author(s):

-
    -
- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: PlaAbstractExporter

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

Class Details

-
-[line 252]
-Export data from a ldap server



-

Tags:

-
- - - - -
extends:  PlaAbstractExporter
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$attributes =

-

[line 261]

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


-
[ Top ]

- -

-

$entry_array =

-

[line 256]

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


-
[ Top ]

- -

-

$entry_id =

-

[line 253]

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


-
[ Top ]

- -

-

$hasNext =

-

[line 260]

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


-
[ Top ]

- -

-

$ldap_info =

-

[line 258]

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


-
[ Top ]

- -

-

$num_entries =

-

[line 257]

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


-
[ Top ]

- -

-

$queryFilter =

-

[line 259]

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


-
[ Top ]

- -

-

$results =

-

[line 254]

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


-
[ Top ]

- -

-

$scope =

-

[line 255]

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor PlaLdapExporter [line 268]

-
-
-
- PlaLdapExporter PlaLdapExporter( -String -$queryFilter, String -$base_dn, String -$scope, -$attributes) -
-

- - Create a PlaLdapExporter object.



- - -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
String  $queryFilter  the queryFilter for the export
String  $base_dn  the base_dn for the data to export
String  $scope  the scope for export
  $attributes  
-

-
[ Top ]
-
-
- -

method pla_fetch_entry_array [line 306]

-
-
-
- array pla_fetch_entry_array( -) -
-

- - Return the entry as an array



-

Tags:

-
- - - - -
return:  an entry as an array
-
-

- - Overrides PlaAbstractExporter::pla_fetch_entry_array() (Return the entry as an array)

-
[ Top ]
-
-
- -

method pla_fetch_entry_object [line 314]

-
-
-
- Entry pla_fetch_entry_object( -) -
-

- - Return the entry as an Entry object



-

Tags:

-
- - - - -
return:  an entry as an Entry Object
-
-

- - Overrides PlaAbstractExporter::pla_fetch_entry_object() (Return the entry as an Entry object)

-
[ Top ]
-
-
- -

method pla_get_ldap_info [line 322]

-
-
-
- LdapInfo pla_get_ldap_info( -) -
-

- - Return a PlaLdapInfo Object



-

Tags:

-
- - - - -
return:  Object with info from the ldap serveur
-
-

- - Overrides PlaAbstractExporter::pla_get_ldap_info() (Return a PlaLdapInfo Object)

-
[ Top ]
-
-
- -

method pla_has_entry [line 338]

-
-
-
- bool pla_has_entry( -) -
-

- - Return true if there is some more entries to be processed



-

Tags:

-
- - - - -
return:  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 ]
-
-
- -

method pla_num_entries [line 330]

-
-
-
- int pla_num_entries( -) -
-

- - Return the number of entries



-

Tags:

-
- - - - -
return:  the number of entries to be exported
-
-

- - Overrides PlaAbstractExporter::pla_num_entries() (Return the number of entries)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:01 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/PlaLdifExporter.html b/lam-web/developers/phpdoc/tools/PlaLdifExporter.html deleted file mode 100644 index db91416d..00000000 --- a/lam-web/developers/phpdoc/tools/PlaLdifExporter.html +++ /dev/null @@ -1,431 +0,0 @@ - - -Docs For Class PlaLdifExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaLdifExporter

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaExporter
-      |
-      --PlaLdifExporter

-
Export entries to ldif format


-

Author(s):

-
    -
- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: PlaExporter

-
-
- PlaExporter::$br -
-
- -
-
- PlaExporter::$exporter -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: PlaExporter

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

Class: PlaAbstractExporter

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

Class Details

-
-[line 378]
-Export entries to ldif format



-

Tags:

-
- - - - -
extends:  PlaExporter
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$counter =  0

-

[line 381]

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


-
[ Top ]

- -

-

$MAX_LDIF_LINE_LENGTH =  76

-

[line 384]

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor PlaLdifExporter [line 390]

-
-
-
- PlaLdifExporter PlaLdifExporter( -PlaAbstractExporter -$exporter) -
-

- - Create a PlaLdifExporter object



- - -

Parameters:

-
- - - - - - -
PlaAbstractExporter  $exporter  the source exporter
-

-
[ Top ]
-
-
- -

method displayExportInfo [line 439]

-
-
-
- void displayExportInfo( - -$pla_ldap_info) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $pla_ldap_info  
-

-
[ Top ]
-
-
- -

method export [line 397]

-
-
-
- void export( -) -
-

- - Export entries to ldif format



- - Overrides PlaExporter::export() (Abstract method use to export data.)

-
[ Top ]
-
-
- -

method multi_lines_display [line 452]

-
-
-
- void multi_lines_display( -String -$str) -
-

- - Helper method to wrap ldif lines



- - -

Parameters:

-
- - - - - - -
String  $str  the line to be wrapped if needed.
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/PlaVcardExporter.html b/lam-web/developers/phpdoc/tools/PlaVcardExporter.html deleted file mode 100644 index 161e8e03..00000000 --- a/lam-web/developers/phpdoc/tools/PlaVcardExporter.html +++ /dev/null @@ -1,380 +0,0 @@ - - -Docs For Class PlaVcardExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaVcardExporter

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaExporter
-      |
-      --PlaVcardExporter

-


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: PlaExporter

-
-
- PlaExporter::$br -
-
- -
-
- PlaExporter::$exporter -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: PlaExporter

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

Class: PlaAbstractExporter

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

Class Details

-
-[line 565]
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$deliveryAddress = array("postOfficeBox",
-            "street",
-            "l",
-            "st",
-            "postalCode",
-            "c")

-

[line 582]

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


-
[ Top ]

- -

-

$vcardMapping = array('cn' => 'FN',
-             'title' => 'TITLE',
-             'homePhone' => 'TEL;HOME',
-             'mobile' => 'TEL;CELL',
-             'mail' => 'EMAIL;Internet',
-             'labeledURI' =>'URL',
-             'o' => 'ORG',
-             'audio' => 'SOUND',
-             'facsmileTelephoneNumber' =>'TEL;WORK;HOME;VOICE;FAX',
-             'jpegPhoto' => 'PHOTO;ENCODING=BASE64',
-             'businessCategory' => 'ROLE',
-             'description' => 'NOTE'
-             )

-

[line 568]

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


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor PlaVcardExporter [line 589]

-
-
-
- PlaVcardExporter PlaVcardExporter( - -$exporter) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $exporter  
-

-
[ Top ]
-
-
- -

method export [line 598]

-
-
-
- void export( -) -
-

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

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/_lib---export.inc.html b/lam-web/developers/phpdoc/tools/_lib---export.inc.html deleted file mode 100644 index dd754a17..00000000 --- a/lam-web/developers/phpdoc/tools/_lib---export.inc.html +++ /dev/null @@ -1,247 +0,0 @@ - - -Docs for page export.inc - - - - - - - - - - - - - -
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, 06 Jan 2008 18:59:00 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/tools/_lib_export_inc.html b/lam-web/developers/phpdoc/tools/_lib_export_inc.html deleted file mode 100644 index 3fd1e6da..00000000 --- a/lam-web/developers/phpdoc/tools/_lib_export_inc.html +++ /dev/null @@ -1,244 +0,0 @@ - - -Docs for page export.inc - - - - - - - - - - - - - -
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:  Roland Gruber
author:  The phpLDAPadmin development team
-
-

-

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 Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/_templates---massBuildAccounts.php.html b/lam-web/developers/phpdoc/tools/_templates---massBuildAccounts.php.html deleted file mode 100644 index c292ab0a..00000000 --- a/lam-web/developers/phpdoc/tools/_templates---massBuildAccounts.php.html +++ /dev/null @@ -1,130 +0,0 @@ - - -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, 06 Jan 2008 18:59:16 +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 deleted file mode 100644 index ca7a8bc9..00000000 --- a/lam-web/developers/phpdoc/tools/_templates---massDoUpload.php.html +++ /dev/null @@ -1,132 +0,0 @@ - - -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, 06 Jan 2008 18:59:16 +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 deleted file mode 100644 index 85cab87a..00000000 --- a/lam-web/developers/phpdoc/tools/_templates---masscreate.php.html +++ /dev/null @@ -1,186 +0,0 @@ - - -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 296]

-
-
-
- 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 123]

-
-
-
- void showMainPage( -string $scope) -
-

- - Displays the acount type specific main page of the upload.



- -

Parameters

- - - - - - -
string  $scope  account type
-
[ Top ]


-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:16 +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 deleted file mode 100644 index 9383be6c..00000000 --- a/lam-web/developers/phpdoc/tools/_templates---ou_edit.php.html +++ /dev/null @@ -1,145 +0,0 @@ - - -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 144]

-
-
-
- void display_main( -) -
-

- -

- -
[ Top ]


-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:18 +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 deleted file mode 100644 index 0b7c0708..00000000 --- a/lam-web/developers/phpdoc/tools/_templates---schema---schema.php.html +++ /dev/null @@ -1,133 +0,0 @@ - - -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, 06 Jan 2008 18:59:29 +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 deleted file mode 100644 index 2d386364..00000000 --- a/lam-web/developers/phpdoc/tools/_templates---tests---index.php.html +++ /dev/null @@ -1,128 +0,0 @@ - - -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, 06 Jan 2008 18:59:08 +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 deleted file mode 100644 index 3f6ae560..00000000 --- a/lam-web/developers/phpdoc/tools/_templates---tests---lamdaemonTest.php.html +++ /dev/null @@ -1,178 +0,0 @@ - - -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 66]

-
-
-
- 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, 06 Jan 2008 18:59:11 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/phpdoc/tools/_templates---tests---schemaTest.php.html b/lam-web/developers/phpdoc/tools/_templates---tests---schemaTest.php.html deleted file mode 100644 index 83a91f3e..00000000 --- a/lam-web/developers/phpdoc/tools/_templates---tests---schemaTest.php.html +++ /dev/null @@ -1,199 +0,0 @@ - - -Docs for page schemaTest.php - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: schemaTest.php

-Source Location: /templates/tests/schemaTest.php

- -
-
- - -

Page Details:

-Tests the lamdaemon script.



-

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/schema.inc") [line 38]
-LDAP schema

include_once("../../lib/modules.inc") [line 36]
-account modules

-

-

-
-
- -

checkSchemaForModule [line 109]

-
-
-
- String checkSchemaForModule( -String $name, String $type) -
-

- - Checks if the object classes and attributes for this module are available.



-

Tags:

-
- - - - -
return:  error message or null
-
-

- -

Parameters

- - - - - - - - - - - -
String  $name  module name
String  $type  type (user, group, ...)
-
[ Top ]


-
-
- -

getRecursiveAttributesFromObjectClass [line 145]

-
-
-
- array getRecursiveAttributesFromObjectClass( -ObjectClass $oClass) -
-

- - Returns the names of all attributes which are managed by the given object class and its parents.



-

Tags:

-
- - - - -
return:  list of attribute names
-
-

- -

Parameters

- - - - - - -
ObjectClass  $oClass  object class
-
[ Top ]


-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:29 +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 deleted file mode 100644 index 8684bcb0..00000000 --- a/lam-web/developers/phpdoc/tools/_templates---tools.php.html +++ /dev/null @@ -1,133 +0,0 @@ - - -Docs for page tools.php - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: tools.php

-Source Location: /templates/tools.php

- -
-
- -
-

Classes:

-
LAMTool
-
Represents a tool.
-


- -

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, 06 Jan 2008 18:59:32 +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 deleted file mode 100644 index 7c7ca500..00000000 --- a/lam-web/developers/phpdoc/tools/_templates_massBuildAccounts_php.html +++ /dev/null @@ -1,123 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/_templates_massDoUpload_php.html b/lam-web/developers/phpdoc/tools/_templates_massDoUpload_php.html deleted file mode 100644 index c41019cd..00000000 --- a/lam-web/developers/phpdoc/tools/_templates_massDoUpload_php.html +++ /dev/null @@ -1,125 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/_templates_masscreate_php.html b/lam-web/developers/phpdoc/tools/_templates_masscreate_php.html deleted file mode 100644 index a1cf24fc..00000000 --- a/lam-web/developers/phpdoc/tools/_templates_masscreate_php.html +++ /dev/null @@ -1,181 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/_templates_ou_edit_php.html b/lam-web/developers/phpdoc/tools/_templates_ou_edit_php.html deleted file mode 100644 index 96007e4a..00000000 --- a/lam-web/developers/phpdoc/tools/_templates_ou_edit_php.html +++ /dev/null @@ -1,139 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:55 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/_templates_schema_schema_php.html b/lam-web/developers/phpdoc/tools/_templates_schema_schema_php.html deleted file mode 100644 index 5b5d3340..00000000 --- a/lam-web/developers/phpdoc/tools/_templates_schema_schema_php.html +++ /dev/null @@ -1,126 +0,0 @@ - - -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:  Roland Gruber
author:  David Smith
-
-

-

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 Wed, 15 Nov 2006 18:01:06 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/_templates_tests_index_php.html b/lam-web/developers/phpdoc/tools/_templates_tests_index_php.html deleted file mode 100644 index 8ad8bad8..00000000 --- a/lam-web/developers/phpdoc/tools/_templates_tests_index_php.html +++ /dev/null @@ -1,121 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:47 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/_templates_tests_lamdaemonTest_php.html b/lam-web/developers/phpdoc/tools/_templates_tests_lamdaemonTest_php.html deleted file mode 100644 index b24d6f01..00000000 --- a/lam-web/developers/phpdoc/tools/_templates_tests_lamdaemonTest_php.html +++ /dev/null @@ -1,169 +0,0 @@ - - -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
-
-

-

Includes:

-
-include_once("../../lib/config.inc") [line 34]
-access to configuration options

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

-

-

-
-
- -

lamTestLamdaemon [line 159]

-
-
-
- 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 Wed, 15 Nov 2006 18:00:50 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/tools/_templates_tools_php.html b/lam-web/developers/phpdoc/tools/_templates_tools_php.html deleted file mode 100644 index ecbc098e..00000000 --- a/lam-web/developers/phpdoc/tools/_templates_tools_php.html +++ /dev/null @@ -1,121 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:09 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/_lib---baseType.inc.html b/lam-web/developers/phpdoc/types/_lib---baseType.inc.html deleted file mode 100644 index bec147da..00000000 --- a/lam-web/developers/phpdoc/types/_lib---baseType.inc.html +++ /dev/null @@ -1,118 +0,0 @@ - - -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, 06 Jan 2008 18:58:53 +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 deleted file mode 100644 index abb122e6..00000000 --- a/lam-web/developers/phpdoc/types/_lib---types---group.inc.html +++ /dev/null @@ -1,123 +0,0 @@ - - -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, 06 Jan 2008 18:59:04 +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 deleted file mode 100644 index 152c107d..00000000 --- a/lam-web/developers/phpdoc/types/_lib---types---host.inc.html +++ /dev/null @@ -1,120 +0,0 @@ - - -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, 06 Jan 2008 18:59:07 +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 deleted file mode 100644 index c0a184f1..00000000 --- a/lam-web/developers/phpdoc/types/_lib---types---mailAlias.inc.html +++ /dev/null @@ -1,120 +0,0 @@ - - -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, 06 Jan 2008 18:59:15 +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 deleted file mode 100644 index eab9704e..00000000 --- a/lam-web/developers/phpdoc/types/_lib---types---smbDomain.inc.html +++ /dev/null @@ -1,120 +0,0 @@ - - -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, 06 Jan 2008 18:59:31 +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 deleted file mode 100644 index 08b04ad1..00000000 --- a/lam-web/developers/phpdoc/types/_lib---types---user.inc.html +++ /dev/null @@ -1,120 +0,0 @@ - - -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, 06 Jan 2008 18:59:36 +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 deleted file mode 100644 index c40970bf..00000000 --- a/lam-web/developers/phpdoc/types/_lib---types.inc.html +++ /dev/null @@ -1,304 +0,0 @@ - - -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($typesINC_dirname.'/'.$entry) [line 47]
-This includes all type definitions.

include_once("selfService.inc") [line 36]
-Used to check if this is a LAM Pro release.

include_once("lists.inc") [line 34]
-parent class of list views

-

-

-
-
- -

getDefaultListAttributes [line 109]

-
-
-
- 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 121]

-
-
-
- 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 97]

-
-
-
- string getListClassName( -string $type) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- -

Parameters

- - - - - - -
string  $type  account type
-
[ Top ]


-
-
- -

getTypeAlias [line 75]

-
-
-
- string getTypeAlias( -string $type) -
-

- - Returns the alias name of an account type.



-

Tags:

-
- - - - -
return:  type alias
-
-

- -

Parameters

- - - - - - -
string  $type  type name
-
[ Top ]


-
-
- -

getTypeDescription [line 86]

-
-
-
- string getTypeDescription( -string $type) -
-

- - Returns the description of an account type.



-

Tags:

-
- - - - -
return:  type description
-
-

- -

Parameters

- - - - - - -
string  $type  type name
-
[ Top ]


-
-
- -

getTypes [line 56]

-
-
-
- array getTypes( -) -
-

- - Returns a list of available account types.



-

Tags:

-
- - - - -
return:  list of types
-
-

- -
[ Top ]


-
- -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:35 +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 deleted file mode 100644 index 8f5e1849..00000000 --- a/lam-web/developers/phpdoc/types/_lib_baseType_inc.html +++ /dev/null @@ -1,114 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:38 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/_lib_types_group_inc.html b/lam-web/developers/phpdoc/types/_lib_types_group_inc.html deleted file mode 100644 index 9e62cf13..00000000 --- a/lam-web/developers/phpdoc/types/_lib_types_group_inc.html +++ /dev/null @@ -1,116 +0,0 @@ - - -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
-
-

-

-

-
- -
-
- Documentation generated on Wed, 15 Nov 2006 18:00:46 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/_lib_types_host_inc.html b/lam-web/developers/phpdoc/types/_lib_types_host_inc.html deleted file mode 100644 index c236bd9f..00000000 --- a/lam-web/developers/phpdoc/types/_lib_types_host_inc.html +++ /dev/null @@ -1,116 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:46 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/_lib_types_inc.html b/lam-web/developers/phpdoc/types/_lib_types_inc.html deleted file mode 100644 index cece370a..00000000 --- a/lam-web/developers/phpdoc/types/_lib_types_inc.html +++ /dev/null @@ -1,305 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:12 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/_lib_types_mailAlias_inc.html b/lam-web/developers/phpdoc/types/_lib_types_mailAlias_inc.html deleted file mode 100644 index 10a01811..00000000 --- a/lam-web/developers/phpdoc/types/_lib_types_mailAlias_inc.html +++ /dev/null @@ -1,116 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:00:52 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/_lib_types_smbDomain_inc.html b/lam-web/developers/phpdoc/types/_lib_types_smbDomain_inc.html deleted file mode 100644 index 25887982..00000000 --- a/lam-web/developers/phpdoc/types/_lib_types_smbDomain_inc.html +++ /dev/null @@ -1,116 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:08 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/_lib_types_user_inc.html b/lam-web/developers/phpdoc/types/_lib_types_user_inc.html deleted file mode 100644 index 8df9ff2c..00000000 --- a/lam-web/developers/phpdoc/types/_lib_types_user_inc.html +++ /dev/null @@ -1,116 +0,0 @@ - - -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 Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/baseType.html b/lam-web/developers/phpdoc/types/baseType.html deleted file mode 100644 index fe92472c..00000000 --- a/lam-web/developers/phpdoc/types/baseType.html +++ /dev/null @@ -1,412 +0,0 @@ - - -Docs For Class baseType - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class: baseType

-Source Location: /lib/baseType.inc

- - - - - - - - - -
- -

Class Overview

-

-
This is the parent class of all account types.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
mailAlias
-
The account type for mail aliases.
-
-
-
host
-
The account type for host accounts (e.g. Samba).
-
-
-
smbDomain
-
The account type for Samba domains.
-
-
-
group
-
The account type for group accounts (e.g. Unix and Samba).
-
-
-
user
-
The account type for user accounts (e.g. Unix, Samba and Kolab).
-
-
-
-
- - -

Class Details

-
-[line 36]
-This is the parent class of all account types.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method getAlias [line 44]

-
-
-
- string getAlias( -) -
-

- - Returns the alias name of this account type.

This function must be overwritten by the child classes.




-

Tags:

-
- - - - -
return:  alias name
-
-

- -

Overridden in child classes as:
-

-
mailAlias::getAlias()
-
Returns the alias name of this account type.
-
-
-
host::getAlias()
-
Returns the alias name of this account type.
-
-
-
smbDomain::getAlias()
-
Returns the alias name of this account type.
-
-
-
group::getAlias()
-
Returns the alias name of this account type.
-
-
-
user::getAlias()
-
Returns the alias name of this account type.
-
-

- -
[ Top ]
-
-
- -

method getDefaultListAttributes [line 73]

-
-
-
- string getDefaultListAttributes( -) -
-

- - Returns the default attribute list for this account type.

This function must be overwritten by the child classes.




-

Tags:

-
- - - - -
return:  attribute list
-
-

- -

Overridden in child classes as:
-

-
mailAlias::getDefaultListAttributes()
-
Returns the default attribute list for this account type.
-
-
-
host::getDefaultListAttributes()
-
Returns the default attribute list for this account type.
-
-
-
smbDomain::getDefaultListAttributes()
-
Returns the default attribute list for this account type.
-
-
-
group::getDefaultListAttributes()
-
Returns the default attribute list for this account type.
-
-
-
user::getDefaultListAttributes()
-
Returns the default attribute list for this account type.
-
-

- -
[ Top ]
-
-
- -

method getDescription [line 54]

-
-
-
- string getDescription( -) -
-

- - Returns the description of this account type.

This function must be overwritten by the child classes.




-

Tags:

-
- - - - -
return:  description
-
-

- -

Overridden in child classes as:
-

-
mailAlias::getDescription()
-
Returns the description of this account type.
-
-
-
host::getDescription()
-
Returns the description of this account type.
-
-
-
smbDomain::getDescription()
-
Returns the description of this account type.
-
-
-
group::getDescription()
-
Returns the description of this account type.
-
-
-
user::getDescription()
-
Returns the description of this account type.
-
-

- -
[ Top ]
-
-
- -

method getListAttributeDescriptions [line 83]

-
-
-
- array getListAttributeDescriptions( -) -
-

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

- -

Overridden in child classes as:
-

-
mailAlias::getListAttributeDescriptions()
-
Returns a list of attributes which have a translated description.
-
-
-
host::getListAttributeDescriptions()
-
Returns a list of attributes which have a translated description.
-
-
-
smbDomain::getListAttributeDescriptions()
-
Returns a list of attributes which have a translated description.
-
-
-
group::getListAttributeDescriptions()
-
Returns a list of attributes which have a translated description.
-
-
-
user::getListAttributeDescriptions()
-
Returns a list of attributes which have a translated description.
-
-

- -
[ Top ]
-
-
- -

method getListClassName [line 63]

-
-
-
- string getListClassName( -) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- -

Overridden in child classes as:
-

-
mailAlias::getListClassName()
-
Returns the class name for the list object.
-
-
-
host::getListClassName()
-
Returns the class name for the list object.
-
-
-
smbDomain::getListClassName()
-
Returns the class name for the list object.
-
-
-
group::getListClassName()
-
Returns the class name for the list object.
-
-
-
user::getListClassName()
-
Returns the class name for the list object.
-
-

- -
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:58:53 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/group.html b/lam-web/developers/phpdoc/types/group.html deleted file mode 100644 index 792c1d87..00000000 --- a/lam-web/developers/phpdoc/types/group.html +++ /dev/null @@ -1,317 +0,0 @@ - - -Docs For Class group - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class: group

-Source Location: /lib/types/group.inc

- - - - - - - - - -
- -

Class Overview

-
baseType
-   |
-   --group

-
The account type for group accounts (e.g. Unix and Samba).


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: baseType

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

Class Details

-
-[line 37]
-The account type for group accounts (e.g. Unix and Samba).



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method getAlias [line 44]

-
-
-
- string getAlias( -) -
-

- - Returns the alias name of this account type.



-

Tags:

-
- - - - -
return:  alias name
-
-

- - Overrides baseType::getAlias() (Returns the alias name of this account type.)

-
[ Top ]
-
-
- -

method getDefaultListAttributes [line 71]

-
-
-
- string getDefaultListAttributes( -) -
-

- - Returns the default attribute list for this account type.



-

Tags:

-
- - - - -
return:  attribute list
-
-

- - Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

-
[ Top ]
-
-
- -

method getDescription [line 53]

-
-
-
- string getDescription( -) -
-

- - Returns the description of this account type.



-

Tags:

-
- - - - -
return:  description
-
-

- - Overrides baseType::getDescription() (Returns the description of this account type.)

-
[ Top ]
-
-
- -

method getListAttributeDescriptions [line 81]

-
-
-
- array getListAttributeDescriptions( -) -
-

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

- - Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

-
[ Top ]
-
-
- -

method getListClassName [line 62]

-
-
-
- string getListClassName( -) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- - Overrides baseType::getListClassName() (Returns the class name for the list object.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:04 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/host.html b/lam-web/developers/phpdoc/types/host.html deleted file mode 100644 index eb78c00a..00000000 --- a/lam-web/developers/phpdoc/types/host.html +++ /dev/null @@ -1,317 +0,0 @@ - - -Docs For Class host - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class: host

-Source Location: /lib/types/host.inc

- - - - - - - - - -
- -

Class Overview

-
baseType
-   |
-   --host

-
The account type for host accounts (e.g. Samba).


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: baseType

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

Class Details

-
-[line 36]
-The account type for host accounts (e.g. Samba).



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method getAlias [line 43]

-
-
-
- string getAlias( -) -
-

- - Returns the alias name of this account type.



-

Tags:

-
- - - - -
return:  alias name
-
-

- - Overrides baseType::getAlias() (Returns the alias name of this account type.)

-
[ Top ]
-
-
- -

method getDefaultListAttributes [line 70]

-
-
-
- string getDefaultListAttributes( -) -
-

- - Returns the default attribute list for this account type.



-

Tags:

-
- - - - -
return:  attribute list
-
-

- - Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

-
[ Top ]
-
-
- -

method getDescription [line 52]

-
-
-
- string getDescription( -) -
-

- - Returns the description of this account type.



-

Tags:

-
- - - - -
return:  description
-
-

- - Overrides baseType::getDescription() (Returns the description of this account type.)

-
[ Top ]
-
-
- -

method getListAttributeDescriptions [line 80]

-
-
-
- array getListAttributeDescriptions( -) -
-

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

- - Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

-
[ Top ]
-
-
- -

method getListClassName [line 61]

-
-
-
- string getListClassName( -) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- - Overrides baseType::getListClassName() (Returns the class name for the list object.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:07 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/mailAlias.html b/lam-web/developers/phpdoc/types/mailAlias.html deleted file mode 100644 index 0bdc5058..00000000 --- a/lam-web/developers/phpdoc/types/mailAlias.html +++ /dev/null @@ -1,317 +0,0 @@ - - -Docs For Class mailAlias - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class: mailAlias

-Source Location: /lib/types/mailAlias.inc

- - - - - - - - - -
- -

Class Overview

-
baseType
-   |
-   --mailAlias

-
The account type for mail aliases.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: baseType

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

Class Details

-
-[line 36]
-The account type for mail aliases.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method getAlias [line 43]

-
-
-
- string getAlias( -) -
-

- - Returns the alias name of this account type.



-

Tags:

-
- - - - -
return:  alias name
-
-

- - Overrides baseType::getAlias() (Returns the alias name of this account type.)

-
[ Top ]
-
-
- -

method getDefaultListAttributes [line 70]

-
-
-
- string getDefaultListAttributes( -) -
-

- - Returns the default attribute list for this account type.



-

Tags:

-
- - - - -
return:  attribute list
-
-

- - Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

-
[ Top ]
-
-
- -

method getDescription [line 52]

-
-
-
- string getDescription( -) -
-

- - Returns the description of this account type.



-

Tags:

-
- - - - -
return:  description
-
-

- - Overrides baseType::getDescription() (Returns the description of this account type.)

-
[ Top ]
-
-
- -

method getListAttributeDescriptions [line 80]

-
-
-
- array getListAttributeDescriptions( -) -
-

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

- - Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

-
[ Top ]
-
-
- -

method getListClassName [line 61]

-
-
-
- string getListClassName( -) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- - Overrides baseType::getListClassName() (Returns the class name for the list object.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:15 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/smbDomain.html b/lam-web/developers/phpdoc/types/smbDomain.html deleted file mode 100644 index 4a76005b..00000000 --- a/lam-web/developers/phpdoc/types/smbDomain.html +++ /dev/null @@ -1,317 +0,0 @@ - - -Docs For Class smbDomain - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class: smbDomain

-Source Location: /lib/types/smbDomain.inc

- - - - - - - - - -
- -

Class Overview

-
baseType
-   |
-   --smbDomain

-
The account type for Samba domains.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: baseType

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

Class Details

-
-[line 36]
-The account type for Samba domains.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method getAlias [line 43]

-
-
-
- string getAlias( -) -
-

- - Returns the alias name of this account type.



-

Tags:

-
- - - - -
return:  alias name
-
-

- - Overrides baseType::getAlias() (Returns the alias name of this account type.)

-
[ Top ]
-
-
- -

method getDefaultListAttributes [line 70]

-
-
-
- string getDefaultListAttributes( -) -
-

- - Returns the default attribute list for this account type.



-

Tags:

-
- - - - -
return:  attribute list
-
-

- - Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

-
[ Top ]
-
-
- -

method getDescription [line 52]

-
-
-
- string getDescription( -) -
-

- - Returns the description of this account type.



-

Tags:

-
- - - - -
return:  description
-
-

- - Overrides baseType::getDescription() (Returns the description of this account type.)

-
[ Top ]
-
-
- -

method getListAttributeDescriptions [line 80]

-
-
-
- array getListAttributeDescriptions( -) -
-

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

- - Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

-
[ Top ]
-
-
- -

method getListClassName [line 61]

-
-
-
- string getListClassName( -) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- - Overrides baseType::getListClassName() (Returns the class name for the list object.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:31 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/phpdoc/types/user.html b/lam-web/developers/phpdoc/types/user.html deleted file mode 100644 index 3075c705..00000000 --- a/lam-web/developers/phpdoc/types/user.html +++ /dev/null @@ -1,317 +0,0 @@ - - -Docs For Class user - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class: user

-Source Location: /lib/types/user.inc

- - - - - - - - - -
- -

Class Overview

-
baseType
-   |
-   --user

-
The account type for user accounts (e.g. Unix, Samba and Kolab).


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: baseType

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

Class Details

-
-[line 36]
-The account type for user accounts (e.g. Unix, Samba and Kolab).



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method getAlias [line 43]

-
-
-
- string getAlias( -) -
-

- - Returns the alias name of this account type.



-

Tags:

-
- - - - -
return:  alias name
-
-

- - Overrides baseType::getAlias() (Returns the alias name of this account type.)

-
[ Top ]
-
-
- -

method getDefaultListAttributes [line 70]

-
-
-
- string getDefaultListAttributes( -) -
-

- - Returns the default attribute list for this account type.



-

Tags:

-
- - - - -
return:  attribute list
-
-

- - Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

-
[ Top ]
-
-
- -

method getDescription [line 52]

-
-
-
- string getDescription( -) -
-

- - Returns the description of this account type.



-

Tags:

-
- - - - -
return:  description
-
-

- - Overrides baseType::getDescription() (Returns the description of this account type.)

-
[ Top ]
-
-
- -

method getListAttributeDescriptions [line 80]

-
-
-
- array getListAttributeDescriptions( -) -
-

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

- - Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

-
[ Top ]
-
-
- -

method getListClassName [line 61]

-
-
-
- string getListClassName( -) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- - Overrides baseType::getListClassName() (Returns the class name for the list object.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Sun, 06 Jan 2008 18:59:36 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file