2006-11-15 17:12:15 +00:00
< html >
< head >
< title > Docs For Class baseModule< / title >
< link rel = "stylesheet" type = "text/css" href = "../media/style.css" >
< / head >
< body >
< table border = "0" cellspacing = "0" cellpadding = "0" height = "48" width = "100%" >
< tr >
< td class = "header_top" > modules< / td >
< / tr >
< tr > < td class = "header_line" > < img src = "../media/empty.png" width = "1" height = "1" border = "0" alt = "" / > < / td > < / tr >
< tr >
< td class = "header_menu" >
2007-11-04 11:19:11 +00:00
[ < a href = "../classtrees_modules.html" class = "menu" > class tree: modules< / a > ]
2006-11-15 17:12:15 +00:00
[ < a href = "../elementindex_modules.html" class = "menu" > index: modules< / a > ]
2007-11-04 11:19:11 +00:00
[ < a href = "../elementindex.html" class = "menu" > all elements< / a > ]
2006-11-15 17:12:15 +00:00
< / td >
< / tr >
< tr > < td class = "header_line" > < img src = "../media/empty.png" width = "1" height = "1" border = "0" alt = "" / > < / td > < / tr >
< / table >
< table width = "100%" border = "0" cellpadding = "0" cellspacing = "0" >
< tr valign = "top" >
< td width = "200" class = "menu" >
< div id = "ric" >
< p > < a href = "../ric_INSTALL.html" > INSTALL< / a > < / p >
2007-11-04 11:19:11 +00:00
< p > < a href = "../ric_README.html" > README< / a > < / p >
2006-11-15 17:12:15 +00:00
< / div >
< b > Packages:< / b > < br / >
< a href = "../li_configuration.html" > configuration< / a > < br / >
< a href = "../li_Help.html" > Help< / a > < br / >
< a href = "../li_LDAP.html" > LDAP< / a > < br / >
< a href = "../li_lib.html" > lib< / a > < br / >
< a href = "../li_lists.html" > lists< / a > < br / >
< a href = "../li_main.html" > main< / a > < br / >
< a href = "../li_modules.html" > modules< / a > < br / >
< a href = "../li_PDF.html" > PDF< / a > < br / >
< a href = "../li_profiles.html" > profiles< / a > < br / >
< a href = "../li_selfService.html" > selfService< / a > < br / >
< a href = "../li_tests.html" > tests< / a > < br / >
< a href = "../li_tools.html" > tools< / a > < br / >
< a href = "../li_types.html" > types< / a > < br / >
< br / > < br / >
< b > Files:< / b > < br / >
< div class = "package" >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---account.inc.html" > account.inc
< / a > < br >
< a href = "../modules/_lib---baseModule.inc.html" > baseModule.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---createntlm.inc.html" > createntlm.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_templates---account---edit.php.html" > edit.php
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---ieee802device.inc.html" > ieee802device.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---inetLocalMailRecipient.inc.html" > inetLocalMailRecipient.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---inetOrgPerson.inc.html" > inetOrgPerson.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---kolabUser.inc.html" > kolabUser.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---lamdaemon.inc.html" > lamdaemon.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---ldapPublicKey.inc.html" > ldapPublicKey.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules.inc.html" > modules.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---nisMailAlias.inc.html" > nisMailAlias.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---posixAccount.inc.html" > posixAccount.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---posixGroup.inc.html" > posixGroup.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---quota.inc.html" > quota.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---sambaAccount.inc.html" > sambaAccount.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---sambaDomain.inc.html" > sambaDomain.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---sambaGroupMapping.inc.html" > sambaGroupMapping.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html" > sambaMungedDial.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---sambaSamAccount.inc.html" > sambaSamAccount.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../modules/_lib---modules---shadowAccount.inc.html" > shadowAccount.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
< / div > < br / >
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
< b > Classes:< / b > < br / >
< div class = "package" >
< a href = "../modules/account.html" > account< / a > < br / >
< a href = "../modules/accountContainer.html" > accountContainer< / a > < br / >
< a href = "../modules/baseModule.html" > baseModule< / a > < br / >
< a href = "../modules/ieee802Device.html" > ieee802Device< / a > < br / >
< a href = "../modules/inetLocalMailRecipient.html" > inetLocalMailRecipient< / a > < br / >
< a href = "../modules/inetOrgPerson.html" > inetOrgPerson< / a > < br / >
< a href = "../modules/kolabUser.html" > kolabUser< / a > < br / >
< a href = "../modules/ldapPublicKey.html" > ldapPublicKey< / a > < br / >
< a href = "../modules/nisMailAlias.html" > nisMailAlias< / a > < br / >
< a href = "../modules/posixAccount.html" > posixAccount< / a > < br / >
< a href = "../modules/posixGroup.html" > posixGroup< / a > < br / >
< a href = "../modules/quota.html" > quota< / a > < br / >
< a href = "../modules/samba3domain.html" > samba3domain< / a > < br / >
< a href = "../modules/sambaAccount.html" > sambaAccount< / a > < br / >
< a href = "../modules/sambaDomain.html" > sambaDomain< / a > < br / >
< a href = "../modules/sambaGroupMapping.html" > sambaGroupMapping< / a > < br / >
2007-11-04 11:19:11 +00:00
< a href = "../modules/sambaMungedDial.html" > sambaMungedDial< / a > < br / >
2006-11-15 17:12:15 +00:00
< a href = "../modules/sambaSamAccount.html" > sambaSamAccount< / a > < br / >
< a href = "../modules/shadowAccount.html" > shadowAccount< / a > < br / >
< a href = "../modules/smbHash.html" > smbHash< / a > < br / >
< / div >
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
< / td >
< td >
< table cellpadding = "10" cellspacing = "0" width = "100%" border = "0" > < tr > < td valign = "top" >
< h1 > Class: baseModule< / h1 >
Source Location: /lib/baseModule.inc< br / > < br / >
< table width = "100%" border = "0" >
< tr > < td valign = "top" >
< h3 > < a href = "#class_details" > Class Overview< / a > < / h3 >
< pre > < / pre > < br / >
2007-11-04 11:19:11 +00:00
< div class = "description" > Parent class of all account modules.< / div > < br / > < br / >
< h4 > Author(s):< / h4 >
< ul >
< / ul >
2006-11-15 17:12:15 +00:00
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
< / td >
< td valign = "top" >
< h3 > < a href = "#class_vars" > Variables< / a > < / h3 >
< ul >
< li > < a href = "../modules/baseModule.html#var$attributes" > $attributes< / a > < / li >
< li > < a href = "../modules/baseModule.html#var$messages" > $messages< / a > < / li >
< li > < a href = "../modules/baseModule.html#var$meta" > $meta< / a > < / li >
< li > < a href = "../modules/baseModule.html#var$moduleSettings" > $moduleSettings< / a > < / li >
< li > < a href = "../modules/baseModule.html#var$orig" > $orig< / a > < / li >
2007-11-04 11:19:11 +00:00
< li > < a href = "../modules/baseModule.html#var$selfServiceSettings" > $selfServiceSettings< / a > < / li >
2006-11-15 17:12:15 +00:00
< / ul >
< / td >
< td valign = "top" >
< h3 > < a href = "#class_methods" > Methods< / a > < / h3 >
< ul >
< li > < a href = "../modules/baseModule.html#methodbaseModule" > baseModule< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodbuild_uploadAccounts" > build_uploadAccounts< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodcan_manage" > can_manage< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodcheckSelfServiceOptions" > checkSelfServiceOptions< / a > < / li >
2007-11-04 11:19:11 +00:00
< li > < a href = "../modules/baseModule.html#methodcheckSelfServiceSettings" > checkSelfServiceSettings< / a > < / li >
2006-11-15 17:12:15 +00:00
< li > < a href = "../modules/baseModule.html#methodcheck_configOptions" > check_configOptions< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodcheck_profileOptions" > check_profileOptions< / a > < / li >
< li > < a href = "../modules/baseModule.html#methoddelete_attributes" > delete_attributes< / a > < / li >
< li > < a href = "../modules/baseModule.html#methoddisplay_html_delete" > display_html_delete< / a > < / li >
< li > < a href = "../modules/baseModule.html#methoddoUploadPostActions" > doUploadPostActions< / a > < / li >
2007-11-04 11:19:11 +00:00
< li > < a href = "../modules/baseModule.html#methodgetAccountContainer" > getAccountContainer< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodgetAttributes" > getAttributes< / a > < / li >
2006-11-15 17:12:15 +00:00
< li > < a href = "../modules/baseModule.html#methodgetButtonStatus" > getButtonStatus< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodgetLDAPAliases" > getLDAPAliases< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodgetManagedAttributes" > getManagedAttributes< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodgetManagedObjectClasses" > getManagedObjectClasses< / a > < / li >
2007-11-04 11:19:11 +00:00
< li > < a href = "../modules/baseModule.html#methodgetOriginalAttributes" > getOriginalAttributes< / a > < / li >
2006-11-15 17:12:15 +00:00
< li > < a href = "../modules/baseModule.html#methodgetRequiredExtensions" > getRequiredExtensions< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodgetSelfServiceFields" > getSelfServiceFields< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodgetSelfServiceOptions" > getSelfServiceOptions< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodgetSelfServiceSearchAttributes" > getSelfServiceSearchAttributes< / a > < / li >
2007-11-04 11:19:11 +00:00
< li > < a href = "../modules/baseModule.html#methodgetSelfServiceSettings" > getSelfServiceSettings< / a > < / li >
2006-11-15 17:12:15 +00:00
< li > < a href = "../modules/baseModule.html#methodget_alias" > get_alias< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodget_configOptions" > get_configOptions< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodget_dependencies" > get_dependencies< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodget_help" > get_help< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodget_ldap_filter" > get_ldap_filter< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodget_metaData" > get_metaData< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodget_pdfFields" > get_pdfFields< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodget_pdf_entries" > get_pdf_entries< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodget_profileOptions" > get_profileOptions< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodget_RDNAttributes" > get_RDNAttributes< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodget_scope" > get_scope< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodget_uploadColumns" > get_uploadColumns< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodget_uploadPreDepends" > get_uploadPreDepends< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodinit" > init< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodis_base_module" > is_base_module< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodload_attributes" > load_attributes< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodload_Messages" > load_Messages< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodload_profile" > load_profile< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodmodule_complete" > module_complete< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodmodule_ready" > module_ready< / a > < / li >
2007-11-04 11:19:11 +00:00
< li > < a href = "../modules/baseModule.html#methodpostDeleteActions" > postDeleteActions< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodpostModifyActions" > postModifyActions< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodpreDeleteActions" > preDeleteActions< / a > < / li >
< li > < a href = "../modules/baseModule.html#methodpreModifyActions" > preModifyActions< / a > < / li >
2006-11-15 17:12:15 +00:00
< li > < a href = "../modules/baseModule.html#methodsave_attributes" > save_attributes< / a > < / li >
< / ul >
< / td >
< / tr > < / table >
< hr / >
< table width = "100%" border = "0" > < tr >
< td valign = "top" >
< h3 > Child classes:< / h3 >
< div class = "tags" >
< dl >
< dt > < a href = "../modules/account.html" > account< / a > < / dt >
< dd > Manages the object class " account" for users and hosts.< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/ieee802Device.html" > ieee802Device< / a > < / dt >
< dd > Provides MAC addresses for hosts.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/inetLocalMailRecipient.html" > inetLocalMailRecipient< / a > < / dt >
< dd > Provides mail routing for users.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/inetOrgPerson.html" > inetOrgPerson< / a > < / dt >
< dd > This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/kolabUser.html" > kolabUser< / a > < / dt >
< dd > Manages Kolab user accounts.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/ldapPublicKey.html" > ldapPublicKey< / a > < / dt >
< dd > Manages SSH public keys.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/nisMailAlias.html" > nisMailAlias< / a > < / dt >
< dd > Provides NIS mail alias management.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixAccount.html" > posixAccount< / a > < / dt >
< dd > Manages the object class " posixAccount" for users and hosts.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixGroup.html" > posixGroup< / a > < / dt >
< dd > Manages the object class " posixGroup" for groups.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/quota.html" > quota< / a > < / dt >
< dd > Manages quotas for users and groups.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaAccount.html" > sambaAccount< / a > < / dt >
< dd > Manages the object class " sambaAccount" for users and hosts.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
< dt > < a href = "../modules/sambaDomain.html" > sambaDomain< / a > < / dt >
< dd > Manages Samba 3 domain entries.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaGroupMapping.html" > sambaGroupMapping< / a > < / dt >
< dd > Manages the object class " sambaGroupMapping" for groups.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaSamAccount.html" > sambaSamAccount< / a > < / dt >
< dd > Manages the object class " sambaSamAccount" for users and hosts.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/shadowAccount.html" > shadowAccount< / a > < / dt >
< dd > Manages the object class " shadowAccount" for users.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< / div >
< / td >
< / tr > < / table >
< hr / >
< a name = "class_details" > < / a >
< h3 > Class Details< / h3 >
< div class = "tags" >
[line 40]< br / >
2007-11-04 11:19:11 +00:00
Parent class of all account modules.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > abstract:< / b > < / td > < td > < / td >
< / tr >
< / table >
< / div >
< / div > < br / > < br / >
2006-11-15 17:12:15 +00:00
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div > < br / >
< hr / >
< a name = "class_vars" > < / a >
< h3 > Class Variables< / h3 >
< div class = "tags" >
< a name = "var$attributes" > < / a >
< p > < / p >
< h4 > $attributes = < span class = "value" > < / span > < / h4 >
2007-11-04 11:19:11 +00:00
< p > [line 58]< / p >
contains all ldap attributes which should be written< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > access:< / b > < / td > < td > protected< / td >
< / tr >
< / table >
< / div >
2006-11-15 17:12:15 +00:00
< br / >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > Type:< / b > < / td >
< td > mixed< / td >
< / tr >
< / table >
< / div > < br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div > < br / >
< a name = "var$messages" > < / a >
< p > < / p >
< h4 > $messages = < span class = "value" > < / span > < / h4 >
2007-11-04 11:19:11 +00:00
< p > [line 64]< / p >
contains all error messages of a module< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > access:< / b > < / td > < td > protected< / td >
< / tr >
< / table >
< / div >
2006-11-15 17:12:15 +00:00
< br / >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > Type:< / b > < / td >
< td > mixed< / td >
< / tr >
< / table >
< / div > < br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div > < br / >
< a name = "var$meta" > < / a >
< p > < / p >
< h4 > $meta = < span class = "value" > < / span > < / h4 >
< p > [line 43]< / p >
2007-11-04 11:19:11 +00:00
includes all meta data provided by the sub class< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > access:< / b > < / td > < td > protected< / td >
< / tr >
< / table >
< / div >
2006-11-15 17:12:15 +00:00
< br / >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > Type:< / b > < / td >
< td > mixed< / td >
< / tr >
< / table >
< / div > < br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div > < br / >
< a name = "var$moduleSettings" > < / a >
< p > < / p >
< h4 > $moduleSettings = < span class = "value" > < / span > < / h4 >
< p > [line 49]< / p >
2007-11-04 11:19:11 +00:00
configuration settings of all modules< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > access:< / b > < / td > < td > protected< / td >
< / tr >
< / table >
< / div >
2006-11-15 17:12:15 +00:00
< br / >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > Type:< / b > < / td >
< td > mixed< / td >
< / tr >
< / table >
< / div > < br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div > < br / >
< a name = "var$orig" > < / a >
< p > < / p >
< h4 > $orig = < span class = "value" > < / span > < / h4 >
2007-11-04 11:19:11 +00:00
< p > [line 61]< / p >
contains all ldap attributes which are loaded from ldap< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > access:< / b > < / td > < td > protected< / td >
< / tr >
< / table >
< / div >
2006-11-15 17:12:15 +00:00
< br / >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > Type:< / b > < / td >
< td > mixed< / td >
< / tr >
< / table >
< / div > < br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div > < br / >
2007-11-04 11:19:11 +00:00
< a name = "var$selfServiceSettings" > < / a >
2006-11-15 17:12:15 +00:00
< p > < / p >
2007-11-04 11:19:11 +00:00
< h4 > $selfServiceSettings = < span class = "value" > < / span > < / h4 >
< p > [line 52]< / p >
self service settings of all modules< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > access:< / b > < / td > < td > protected< / td >
< / tr >
< / table >
< / div >
2006-11-15 17:12:15 +00:00
< br / >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > Type:< / b > < / td >
< td > mixed< / td >
< / tr >
< / table >
< / div > < br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div > < br / >
< / div > < br / >
< hr / >
< a name = "class_methods" > < / a >
< h3 > Class Methods< / h3 >
< div class = "tags" >
< hr / >
< a name = "methodbaseModule" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > constructor baseModule < span class = "smalllinenumber" > [line 71]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > baseModule baseModule(
string
$scope)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Creates a new base module class< br / > < br / > < br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > string < / td >
< td > < b > $scope< / b > < / td >
< td > the account type (user, group, host)< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodbuild_uploadAccounts" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method build_uploadAccounts < span class = "smalllinenumber" > [line 495]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array build_uploadAccounts(
array
$rawAccounts, array
2007-11-04 11:19:11 +00:00
$ids,
& $partialAccounts, array
$partialAccounts)< / code >
2006-11-15 17:12:15 +00:00
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
In this function the LDAP account is built up.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > list of error messages if any< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/account.html#methodbuild_uploadAccounts" > account::build_uploadAccounts()< / a > < / dt >
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/ieee802Device.html#methodbuild_uploadAccounts" > ieee802Device::build_uploadAccounts()< / a > < / dt >
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/inetLocalMailRecipient.html#methodbuild_uploadAccounts" > inetLocalMailRecipient::build_uploadAccounts()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/inetOrgPerson.html#methodbuild_uploadAccounts" > inetOrgPerson::build_uploadAccounts()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/kolabUser.html#methodbuild_uploadAccounts" > kolabUser::build_uploadAccounts()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/ldapPublicKey.html#methodbuild_uploadAccounts" > ldapPublicKey::build_uploadAccounts()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/nisMailAlias.html#methodbuild_uploadAccounts" > nisMailAlias::build_uploadAccounts()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixAccount.html#methodbuild_uploadAccounts" > posixAccount::build_uploadAccounts()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixGroup.html#methodbuild_uploadAccounts" > posixGroup::build_uploadAccounts()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaAccount.html#methodbuild_uploadAccounts" > sambaAccount::build_uploadAccounts()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/sambaDomain.html#methodbuild_uploadAccounts" > sambaDomain::build_uploadAccounts()< / a > < / dt >
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaGroupMapping.html#methodbuild_uploadAccounts" > sambaGroupMapping::build_uploadAccounts()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaSamAccount.html#methodbuild_uploadAccounts" > sambaSamAccount::build_uploadAccounts()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/shadowAccount.html#methodbuild_uploadAccounts" > shadowAccount::build_uploadAccounts()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > In this function the LDAP account is built up.< / dd >
< / dl >
< / p >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $rawAccounts< / b > < / td >
< td > list of hash arrays (name => value) from user input< / td >
< / tr >
< tr >
< td class = "type" > array < / td >
< td > < b > $partialAccounts< / b > < / td >
< td > list of hash arrays (name => value) which are later added to LDAP< / td >
< / tr >
< tr >
< td class = "type" > array < / td >
< td > < b > $ids< / b > < / td >
< td > list of IDs for column position (e.g. " posixAccount_uid" => 5)< / td >
2007-11-04 11:19:11 +00:00
< / tr >
< tr >
< td class = "type" > < / td >
< td > < b > &$partialAccounts</b> < / td >
< td > < / td >
2006-11-15 17:12:15 +00:00
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodcan_manage" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method can_manage < span class = "smalllinenumber" > [line 160]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > boolean can_manage(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns true if this module fits for the current scope.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > true if module fits< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodcheckSelfServiceOptions" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method checkSelfServiceOptions < span class = "smalllinenumber" > [line 726]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array checkSelfServiceOptions(
string
$fields, array
$attributes)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Checks if all input values are correct and returns the LDAP commands which should be executed.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/inetOrgPerson.html#methodcheckSelfServiceOptions" > inetOrgPerson::checkSelfServiceOptions()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Checks if all input values are correct and returns the LDAP commands which should be executed.< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/posixAccount.html#methodcheckSelfServiceOptions" > posixAccount::checkSelfServiceOptions()< / a > < / dt >
< dd > Checks if all input values are correct and returns the LDAP commands which should be executed.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaSamAccount.html#methodcheckSelfServiceOptions" > sambaSamAccount::checkSelfServiceOptions()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Checks if all input values are correct and returns the LDAP commands which should be executed.< / dd >
< / dl >
< / p >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > string < / td >
< td > < b > $fields< / b > < / td >
< td > input fields< / td >
< / tr >
< tr >
< td class = "type" > array < / td >
< td > < b > $attributes< / b > < / td >
< td > LDAP attributes< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
2007-11-04 11:19:11 +00:00
< hr / >
< a name = "methodcheckSelfServiceSettings" > < / a >
< h3 > method checkSelfServiceSettings < span class = "smalllinenumber" > [line 747]< / span > < / h3 >
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array checkSelfServiceSettings(
array
$options)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Checks if the self service settings are valid.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > error messages< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $options< / b > < / td >
< td > settings< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
2006-11-15 17:12:15 +00:00
< hr / >
< a name = "methodcheck_configOptions" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method check_configOptions < span class = "smalllinenumber" > [line 355]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array check_configOptions(
array
$scopes, array
$options)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Checks input values of module settings.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > list of error messages< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/posixAccount.html#methodcheck_configOptions" > posixAccount::check_configOptions()< / a > < / dt >
< dd > Checks input values of module settings.< / dd >
< / dl >
< / p >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $scopes< / b > < / td >
< td > list of account types which are used< / td >
< / tr >
< tr >
< td class = "type" > array < / td >
< td > < b > $options< / b > < / td >
< td > hash array containing the settings (array('option' => array('value')))< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodcheck_profileOptions" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method check_profileOptions < span class = "smalllinenumber" > [line 240]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array check_profileOptions(
array
$options)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Checks input values of account profiles.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > list of error messages (array(type, title, text)) to generate StatusMessages, if any< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/quota.html#methodcheck_profileOptions" > quota::check_profileOptions()< / a > < / dt >
< dd > Checks input values of account profiles.< / dd >
< / dl >
< / p >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $options< / b > < / td >
< td > a hash array (name => value) containing the options< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methoddelete_attributes" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method delete_attributes < span class = "smalllinenumber" > [line 628]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > List delete_attributes(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Dummy function for modules which use no special options on account deletion.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > of LDAP operations, same as for save_attributes()< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/posixAccount.html#methoddelete_attributes" > posixAccount::delete_attributes()< / a > < / dt >
< dd > Additional LDAP operations on delete.< / dd >
2007-11-04 11:19:11 +00:00
< / dl >
< dl >
< dt > < a href = "../modules/posixGroup.html#methoddelete_attributes" > posixGroup::delete_attributes()< / a > < / dt >
< dd > Checks if the group which should be deleted is still used as primary group.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< / p >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methoddisplay_html_delete" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method display_html_delete < span class = "smalllinenumber" > [line 637]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > meta display_html_delete(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Dummy function for modules which do not print extra HTML code on account deletion.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > HTML code< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/posixAccount.html#methoddisplay_html_delete" > posixAccount::display_html_delete()< / a > < / dt >
2007-11-04 11:19:11 +00:00
< dd > Displays the delete homedir option for the delete page.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< / p >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methoddoUploadPostActions" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method doUploadPostActions < span class = "smalllinenumber" > [line 563]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array doUploadPostActions(
array
$data, array
$ids, array
2007-11-04 11:19:11 +00:00
$failed,
& $temp, array
$temp)< / code >
2006-11-15 17:12:15 +00:00
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This function executes one post upload action.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > current status < br / > array ( < br / > 'status' => 'finished' | 'inProgress' < br / > 'progress' => 0..100 < br / > 'errors' => array (< array of parameters for StatusMessage> ) < br / > )< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixAccount.html#methoddoUploadPostActions" > posixAccount::doUploadPostActions()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > This function executes one post upload action.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/quota.html#methoddoUploadPostActions" > quota::doUploadPostActions()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > This function executes one post upload action.< / dd >
< / dl >
< / p >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $data< / b > < / td >
< td > array containing one account in each element< / td >
< / tr >
< tr >
< td class = "type" > array < / td >
< td > < b > $ids< / b > < / td >
< td > array(< column_name> => < column number> )< / td >
< / tr >
< tr >
< td class = "type" > array < / td >
< td > < b > $failed< / b > < / td >
< td > list of accounts which were not created successfully< / td >
< / tr >
< tr >
< td class = "type" > array < / td >
< td > < b > $temp< / b > < / td >
< td > variable to store temporary data between two post actions< / td >
2007-11-04 11:19:11 +00:00
< / tr >
< tr >
< td class = "type" > < / td >
< td > < b > &$temp</b> < / td >
< td > < / td >
2006-11-15 17:12:15 +00:00
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
2007-11-04 11:19:11 +00:00
< a name = "methodgetAccountContainer" > < / a >
< h3 > method getAccountContainer < span class = "smalllinenumber" > [line 758]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
2007-11-04 11:19:11 +00:00
< code > < a href = "../modules/accountContainer.html" > accountContainer< / a > getAccountContainer(
2006-11-15 17:12:15 +00:00
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
2007-11-04 11:19:11 +00:00
Returns the accountContainer object.< br / > < br / > < br / > < br / >
2006-11-15 17:12:15 +00:00
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
2007-11-04 11:19:11 +00:00
< td > < b > return:< / b > < / td > < td > accountContainer object< / td >
< / tr >
< tr >
< td > < b > access:< / b > < / td > < td > protected< / td >
2006-11-15 17:12:15 +00:00
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
2007-11-04 11:19:11 +00:00
< a name = "methodgetAttributes" > < / a >
< h3 > method getAttributes < span class = "smalllinenumber" > [line 772]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
2007-11-04 11:19:11 +00:00
< code > array getAttributes(
2006-11-15 17:12:15 +00:00
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
2007-11-04 11:19:11 +00:00
Returns the LDAP attributes which are managed in this module.< br / > < br / > < br / > < br / >
2006-11-15 17:12:15 +00:00
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
2007-11-04 11:19:11 +00:00
< td > < b > return:< / b > < / td > < td > attributes< / td >
< / tr >
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
2006-11-15 17:12:15 +00:00
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
2007-11-04 11:19:11 +00:00
< a name = "methodgetButtonStatus" > < / a >
< h3 > method getButtonStatus < span class = "smalllinenumber" > [line 545]< / span > < / h3 >
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > string getButtonStatus(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Controls if the module button the account page is visible and activated.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > status (" enabled" , " disabled" , " hidden" )< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/account.html#methodgetButtonStatus" > account::getButtonStatus()< / a > < / dt >
< dd > Controls if the module button the account page is visible and activated.< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/inetOrgPerson.html#methodgetButtonStatus" > inetOrgPerson::getButtonStatus()< / a > < / dt >
< dd > Controls if the module button the account page is visible and activated.< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/nisMailAlias.html#methodgetButtonStatus" > nisMailAlias::getButtonStatus()< / a > < / dt >
< dd > Controls if the module button the account page is visible and activated.< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/posixGroup.html#methodgetButtonStatus" > posixGroup::getButtonStatus()< / a > < / dt >
< dd > Controls if the module button the account page is visible and activated.< / dd >
< / dl >
< / p >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetLDAPAliases" > < / a >
< h3 > method getLDAPAliases < span class = "smalllinenumber" > [line 658]< / span > < / h3 >
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array getLDAPAliases(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a list of aliases for LDAP attributes.< br / > < br / > < p > All alias attributes will be renamed to the given attribute names.< / p > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > list of aliases (alias name => attribute name)< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetManagedAttributes" > < / a >
< h3 > method getManagedAttributes < span class = "smalllinenumber" > [line 669]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array getManagedAttributes(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a list of LDAP attributes which are managed by this module.< br / > < br / > < p > All attribute names will be renamed to match the given spelling.< / p > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > list of attributes< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetManagedObjectClasses" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method getManagedObjectClasses < span class = "smalllinenumber" > [line 647]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array getManagedObjectClasses(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a list of managed object classes for this module.< br / > < br / > < p > This is used to fix incorrect spelled object class names.< / p > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > list of object classes< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
2007-11-04 11:19:11 +00:00
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetOriginalAttributes" > < / a >
< h3 > method getOriginalAttributes < span class = "smalllinenumber" > [line 781]< / span > < / h3 >
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array getOriginalAttributes(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns the LDAP attributes which are managed in this module (with unchanged values).< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > attributes< / td >
< / tr >
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
2006-11-15 17:12:15 +00:00
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetRequiredExtensions" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method getRequiredExtensions < span class = "smalllinenumber" > [line 679]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array getRequiredExtensions(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a list of required PHP extensions.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > extensions< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetSelfServiceFields" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method getSelfServiceFields < span class = "smalllinenumber" > [line 700]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array getSelfServiceFields(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a list of possible input fields and their descriptions Format: array(< field identifier> => < field description> )< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > fields< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetSelfServiceOptions" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method getSelfServiceOptions < span class = "smalllinenumber" > [line 714]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array getSelfServiceOptions(
array
$fields, array
$attributes)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns the meta HTML code for each input field.< br / > < br / > < p > format: array(< field1> => array(< META HTML> ), ...) It is not possible to display help links.< / p > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > meta HTML< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/inetOrgPerson.html#methodgetSelfServiceOptions" > inetOrgPerson::getSelfServiceOptions()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns the meta HTML code for each input field.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixAccount.html#methodgetSelfServiceOptions" > posixAccount::getSelfServiceOptions()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns the meta HTML code for each input field.< / dd >
< / dl >
< / p >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $fields< / b > < / td >
< td > list of active fields< / td >
< / tr >
< tr >
< td class = "type" > array < / td >
< td > < b > $attributes< / b > < / td >
< td > attributes of LDAP account (attribute names in lower case)< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetSelfServiceSearchAttributes" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method getSelfServiceSearchAttributes < span class = "smalllinenumber" > [line 689]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array getSelfServiceSearchAttributes(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a list of possible search attributes for the self service.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > attributes< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
2007-11-04 11:19:11 +00:00
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetSelfServiceSettings" > < / a >
< h3 > method getSelfServiceSettings < span class = "smalllinenumber" > [line 736]< / span > < / h3 >
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array getSelfServiceSettings(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a list of self service configuration settings.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > settings< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
2006-11-15 17:12:15 +00:00
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_alias" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_alias < span class = "smalllinenumber" > [line 195]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > string get_alias(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns an alias name for the module.< br / > < br / > < p > 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.< / p > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > alias name< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_configOptions" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_configOptions < span class = "smalllinenumber" > [line 339]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array get_configOptions(
array
$scopes, array
$allScopes)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a list of elements for the configuration.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > configuration elements< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/posixGroup.html#methodget_configOptions" > posixGroup::get_configOptions()< / a > < / dt >
< dd > Returns a list of elements for the configuration.< / dd >
< / dl >
< / p >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $scopes< / b > < / td >
< td > account types (user, group, host)< / td >
< / tr >
< tr >
< td class = "type" > array < / td >
< td > < b > $allScopes< / b > < / td >
< td > list of all modules and active scopes< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_dependencies" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_dependencies < span class = "smalllinenumber" > [line 219]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array get_dependencies(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This function returns a list with all depending and conflicting modules.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > list of dependencies and conflicts< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_help" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_help < span class = "smalllinenumber" > [line 509]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array get_help(
string
$id, string
$scope)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This function return the help entry array for a specific help id. Normally this-> meta can be used.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > The desired help entry.< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > string < / td >
< td > < b > $id< / b > < / td >
< td > The id string for the help entry needed.< / td >
< / tr >
< tr >
< td class = "type" > string < / td >
< td > < b > $scope< / b > < / td >
< td > 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.< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_ldap_filter" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_ldap_filter < span class = "smalllinenumber" > [line 182]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > string get_ldap_filter(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
returns an LDAP filter for the account lists< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > LDAP filter< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_metaData" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_metaData < span class = "smalllinenumber" > [line 142]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array get_metaData(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Dummy function, meta data is provided by sub classes.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > empty array< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/account.html#methodget_metaData" > account::get_metaData()< / a > < / dt >
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/ieee802Device.html#methodget_metaData" > ieee802Device::get_metaData()< / a > < / dt >
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/inetLocalMailRecipient.html#methodget_metaData" > inetLocalMailRecipient::get_metaData()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/inetOrgPerson.html#methodget_metaData" > inetOrgPerson::get_metaData()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/kolabUser.html#methodget_metaData" > kolabUser::get_metaData()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/ldapPublicKey.html#methodget_metaData" > ldapPublicKey::get_metaData()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/nisMailAlias.html#methodget_metaData" > nisMailAlias::get_metaData()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixAccount.html#methodget_metaData" > posixAccount::get_metaData()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixGroup.html#methodget_metaData" > posixGroup::get_metaData()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/quota.html#methodget_metaData" > quota::get_metaData()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaAccount.html#methodget_metaData" > sambaAccount::get_metaData()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/sambaDomain.html#methodget_metaData" > sambaDomain::get_metaData()< / a > < / dt >
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaGroupMapping.html#methodget_metaData" > sambaGroupMapping::get_metaData()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaSamAccount.html#methodget_metaData" > sambaSamAccount::get_metaData()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/shadowAccount.html#methodget_metaData" > shadowAccount::get_metaData()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns meta data that is interpreted by parent class< / dd >
< / dl >
< / p >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_pdfFields" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_pdfFields < span class = "smalllinenumber" > [line 439]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array get_pdfFields(
string
$scope)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
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.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > list of available fields for PDF output< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > string < / td >
< td > < b > $scope< / b > < / td >
< td > account type< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_pdf_entries" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_pdf_entries < span class = "smalllinenumber" > [line 454]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array get_pdf_entries(
[string
$scope = 'user'])< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a hastable with all entries that may be printed out in the PDF. The< br / > < br / > < p > 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.< / p > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > hastable of entries for the PDF. Each entry is an array where each entry is treated as a new line in the PDF.< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > string < / td >
< td > < b > $scope< / b > < / td >
< td > account type< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_profileOptions" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_profileOptions < span class = "smalllinenumber" > [line 229]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > profile get_profileOptions(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a list of elements for the account profiles.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > elements< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixAccount.html#methodget_profileOptions" > posixAccount::get_profileOptions()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns a list of elements for the account profiles.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/quota.html#methodget_profileOptions" > quota::get_profileOptions()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns a list of elements for the account profiles.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaGroupMapping.html#methodget_profileOptions" > sambaGroupMapping::get_profileOptions()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns a list of elements for the account profiles.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaSamAccount.html#methodget_profileOptions" > sambaSamAccount::get_profileOptions()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns a list of elements for the account profiles.< / dd >
< / dl >
< / p >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_RDNAttributes" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_RDNAttributes < span class = "smalllinenumber" > [line 209]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array get_RDNAttributes(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a list of possible LDAP attributes which can be used to form the RDN.< br / > < br / > < p > The returned elements have this form: < attribute> => < priority> < br / > < attribute> is the name of the LDAP attribute < br / > < priority> defines the priority of the attribute (can be " low" , " normal" , " high" )< / p > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > list of attributes< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_scope" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_scope < span class = "smalllinenumber" > [line 151]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > string get_scope(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns the account type of this module (user, group, host)< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > account type< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_uploadColumns" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_uploadColumns < span class = "smalllinenumber" > [line 472]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array get_uploadColumns(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns an array containing all input columns for the file upload.< br / > < br / > < p > Syntax: < br / > array( < br / > string: name, // fixed non-translated name which is used as column name (should be of format: < module name> _< column name> ) < br / > string: description, // short descriptive name < br / > string: help, // help ID < br / > string: example, // example value < br / > boolean: required // true, if user must set a value for this column < br / > )< / p > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > column list< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/quota.html#methodget_uploadColumns" > quota::get_uploadColumns()< / a > < / dt >
< dd > Returns an array containing all input columns for the file upload.< / dd >
< / dl >
< / p >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_uploadPreDepends" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_uploadPreDepends < span class = "smalllinenumber" > [line 482]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array get_uploadPreDepends(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a list of module names which must be processed in building the account befor this module.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > list of module names< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodinit" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method init < span class = "smalllinenumber" > [line 91]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > void init(
string
$base)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Initializes the module after it became part of an accountContainer< br / > < br / > < br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixAccount.html#methodinit" > posixAccount::init()< / a > < / dt >
< dd > Initializes the module after it became part of an accountContainer< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixGroup.html#methodinit" > posixGroup::init()< / a > < / dt >
< dd > This functin will be called when the module will be loaded *< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
< dt > < a href = "../modules/sambaAccount.html#methodinit" > sambaAccount::init()< / a > < / dt >
< dd > Initializes the module after it became part of an accountContainer< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaGroupMapping.html#methodinit" > sambaGroupMapping::init()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Initializes the module after it became part of an accountContainer< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaSamAccount.html#methodinit" > sambaSamAccount::init()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Initializes the module after it became part of an accountContainer< / dd >
< / dl >
< / p >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > string < / td >
< td > < b > $base< / b > < / td >
< td > the name of the accountContainer object ($_SESSION[$base])< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodis_base_module" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method is_base_module < span class = "smalllinenumber" > [line 172]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > boolean is_base_module(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns true if this module is enough to provide a sensible account.< br / > < br / > < p > There is no relation to the name of this class.< / p > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > true if base module< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodload_attributes" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method load_attributes < span class = "smalllinenumber" > [line 110]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > void load_attributes(
array
$attributes)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This function loads the LDAP attributes for this module.< br / > < br / > < br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixAccount.html#methodload_attributes" > posixAccount::load_attributes()< / a > < / dt >
< dd > This function loads all needed LDAP attributes.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
< dt > < a href = "../modules/sambaAccount.html#methodload_attributes" > sambaAccount::load_attributes()< / a > < / dt >
2007-11-04 11:19:11 +00:00
< dd > This function loads the LDAP attributes for this module.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
< dt > < a href = "../modules/sambaSamAccount.html#methodload_attributes" > sambaSamAccount::load_attributes()< / a > < / dt >
2007-11-04 11:19:11 +00:00
< dd > This function loads the LDAP attributes for this module.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< / p >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $attributes< / b > < / td >
< td > attribute list< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodload_Messages" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method load_Messages < span class = "smalllinenumber" > [line 83]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > void load_Messages(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This function fills the $messages variable with output messages from this module.< br / > < br / > < br / > < br / >
2007-11-04 11:19:11 +00:00
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > access:< / b > < / td > < td > protected< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
2006-11-15 17:12:15 +00:00
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/account.html#methodload_Messages" > account::load_Messages()< / a > < / dt >
< dd > This function fills the message array.< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/ieee802Device.html#methodload_Messages" > ieee802Device::load_Messages()< / a > < / dt >
< dd > This function fills the error message array with messages< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/inetLocalMailRecipient.html#methodload_Messages" > inetLocalMailRecipient::load_Messages()< / a > < / dt >
< dd > This function fills the error message array with messages< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/inetOrgPerson.html#methodload_Messages" > inetOrgPerson::load_Messages()< / a > < / dt >
< dd > This function fills the message array.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/kolabUser.html#methodload_Messages" > kolabUser::load_Messages()< / a > < / dt >
< dd > This function fills the error message array with messages< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/nisMailAlias.html#methodload_Messages" > nisMailAlias::load_Messages()< / a > < / dt >
< dd > This function fills the error message array with messages< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
< dt > < a href = "../modules/posixAccount.html#methodload_Messages" > posixAccount::load_Messages()< / a > < / dt >
< dd > This function fills the error message array with messages.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixGroup.html#methodload_Messages" > posixGroup::load_Messages()< / a > < / dt >
< dd > This function fills the $messages variable with output messages from this module.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/quota.html#methodload_Messages" > quota::load_Messages()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > this functin fills the error message array with messages< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaAccount.html#methodload_Messages" > sambaAccount::load_Messages()< / a > < / dt >
< dd > this functin fills the error message array with messages< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
< dt > < a href = "../modules/sambaDomain.html#methodload_Messages" > sambaDomain::load_Messages()< / a > < / dt >
< dd > This function fills the error message array with messages< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaGroupMapping.html#methodload_Messages" > sambaGroupMapping::load_Messages()< / a > < / dt >
< dd > this functin fills the error message array with messages< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaSamAccount.html#methodload_Messages" > sambaSamAccount::load_Messages()< / a > < / dt >
< dd > this functin fills the error message array with messages< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/shadowAccount.html#methodload_Messages" > shadowAccount::load_Messages()< / a > < / dt >
< dd > This function builds up the message array.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< / p >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodload_profile" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method load_profile < span class = "smalllinenumber" > [line 321]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > void load_profile(
array
$profile)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Loads the values of an account profile into internal variables.< br / > < br / > < br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixAccount.html#methodload_profile" > posixAccount::load_profile()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Loads the values of an account profile into internal variables.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/quota.html#methodload_profile" > quota::load_profile()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Loads the values of an account profile into internal variables.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaAccount.html#methodload_profile" > sambaAccount::load_profile()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Loads the values of an account profile into internal variables.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaGroupMapping.html#methodload_profile" > sambaGroupMapping::load_profile()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Loads the values of an account profile into internal variables.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaSamAccount.html#methodload_profile" > sambaSamAccount::load_profile()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Loads the values of an account profile into internal variables.< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/shadowAccount.html#methodload_profile" > shadowAccount::load_profile()< / a > < / dt >
< dd > Loads the values of an account profile into internal variables.< / dd >
< / dl >
< / p >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $profile< / b > < / td >
< td > hash array with profile values (identifier => value)< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodmodule_complete" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method module_complete < span class = "smalllinenumber" > [line 536]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > boolean module_complete(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This functions is used to check if all settings for this module have been made.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > true, if settings are complete< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/account.html#methodmodule_complete" > account::module_complete()< / a > < / dt >
< dd > This functions returns true if all needed settings are done.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/inetOrgPerson.html#methodmodule_complete" > inetOrgPerson::module_complete()< / a > < / dt >
< dd > This functions return true if all needed settings are done.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/kolabUser.html#methodmodule_complete" > kolabUser::module_complete()< / a > < / dt >
< dd > This function returns true if all needed settings are done.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixAccount.html#methodmodule_complete" > posixAccount::module_complete()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > This functions is used to check if all settings for this module have been made.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixGroup.html#methodmodule_complete" > posixGroup::module_complete()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > This functions is used to check if all settings for this module have been made.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaAccount.html#methodmodule_complete" > sambaAccount::module_complete()< / a > < / dt >
< dd > This functions returns true if all needed settings are done< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
< dt > < a href = "../modules/sambaGroupMapping.html#methodmodule_complete" > sambaGroupMapping::module_complete()< / a > < / dt >
2007-11-04 11:19:11 +00:00
< dd > This functions is used to check if all settings for this module have been made.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< / p >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodmodule_ready" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method module_ready < span class = "smalllinenumber" > [line 527]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > boolean module_ready(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This function is used to check if this module page can be displayed.< br / > < br / > < p > It returns false if a module depends on data from other modules which was not yet entered.< / p > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > true, if page can be displayed< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/quota.html#methodmodule_ready" > quota::module_ready()< / a > < / dt >
2007-11-04 11:19:11 +00:00
< dd > This function is used to check if this module page can be displayed.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
< dt > < a href = "../modules/sambaAccount.html#methodmodule_ready" > sambaAccount::module_ready()< / a > < / dt >
2007-11-04 11:19:11 +00:00
< dd > This function is used to check if this module page can be displayed.< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/sambaGroupMapping.html#methodmodule_ready" > sambaGroupMapping::module_ready()< / a > < / dt >
< dd > This function is used to check if this module page can be displayed.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
< dt > < a href = "../modules/sambaSamAccount.html#methodmodule_ready" > sambaSamAccount::module_ready()< / a > < / dt >
< dd > This function is used to check if this module page can be displayed.< / dd >
2007-11-04 11:19:11 +00:00
< / dl >
< / p >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodpostDeleteActions" > < / a >
< h3 > method postDeleteActions < span class = "smalllinenumber" > [line 619]< / span > < / h3 >
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > void postDeleteActions(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Allows the module to run commands after the LDAP entry is deleted.< br / > < br / > < br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodpostModifyActions" > < / a >
< h3 > method postModifyActions < span class = "smalllinenumber" > [line 602]< / span > < / h3 >
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > void postModifyActions(
boolean
$newAccount)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Allows the module to run commands after the LDAP entry is changed or created.< br / > < br / > < br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/posixAccount.html#methodpostModifyActions" > posixAccount::postModifyActions()< / a > < / dt >
< dd > Allows the module to run commands after the LDAP entry was changed or created.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/quota.html#methodpostModifyActions" > quota::postModifyActions()< / a > < / dt >
< dd > Allows the module to run commands after the LDAP entry is changed or created.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< / p >
2007-11-04 11:19:11 +00:00
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > boolean < / td >
< td > < b > $newAccount< / b > < / td >
< td > new account< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodpreDeleteActions" > < / a >
< h3 > method preDeleteActions < span class = "smalllinenumber" > [line 612]< / span > < / h3 >
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > true, preDeleteActions(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Allows the module to run commands before the LDAP entry is deleted.< br / > < br / > < p > An error message should be printed if the function returns false.< / p > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > if no problems occured< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
2006-11-15 17:12:15 +00:00
2007-11-04 11:19:11 +00:00
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/posixAccount.html#methodpreDeleteActions" > posixAccount::preDeleteActions()< / a > < / dt >
< dd > Allows the module to run commands before the LDAP entry is deleted.< / dd >
< / dl >
< dl >
< dt > < a href = "../modules/quota.html#methodpreDeleteActions" > quota::preDeleteActions()< / a > < / dt >
< dd > Allows the module to run commands before the LDAP entry is deleted.< / dd >
< / dl >
< / p >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodpreModifyActions" > < / a >
< h3 > method preModifyActions < span class = "smalllinenumber" > [line 593]< / span > < / h3 >
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > true, preModifyActions(
boolean
$newAccount)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Allows the module to run commands before the LDAP entry is changed or created.< br / > < br / > < p > An error message should be printed if the function returns false.< / p > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > if no problems occured< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
2006-11-15 17:12:15 +00:00
2007-11-04 11:19:11 +00:00
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > boolean < / td >
< td > < b > $newAccount< / b > < / td >
< td > new account< / td >
< / tr >
< / table >
< / div > < br / >
2006-11-15 17:12:15 +00:00
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodsave_attributes" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method save_attributes < span class = "smalllinenumber" > [line 582]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array save_attributes(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns a list of modifications which have to be made to the LDAP account.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > list of modifications < br / > This function returns an array with 3 entries: < br / > array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) < br / > 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) < br / > " add" are attributes which have to be added to LDAP entry < br / > " remove" are attributes which have to be removed from LDAP entry < br / > " modify" are attributes which have to been modified in LDAP entry< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< p > Overridden in child classes as:< br / >
< dl >
< dt > < a href = "../modules/account.html#methodsave_attributes" > account::save_attributes()< / a > < / dt >
2007-11-04 11:19:11 +00:00
< dd > Returns a list of modifications which have to be made to the LDAP account.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/inetOrgPerson.html#methodsave_attributes" > inetOrgPerson::save_attributes()< / a > < / dt >
< dd > Returns a list of modifications which have to be made to the LDAP account.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/kolabUser.html#methodsave_attributes" > kolabUser::save_attributes()< / a > < / dt >
< dd > Returns a list of modifications which have to be made to the LDAP account.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/nisMailAlias.html#methodsave_attributes" > nisMailAlias::save_attributes()< / a > < / dt >
< dd > Returns a list of modifications which have to be made to the LDAP account.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
< dt > < a href = "../modules/posixAccount.html#methodsave_attributes" > posixAccount::save_attributes()< / a > < / dt >
< dd > Returns a list of modifications which have to be made to the LDAP account.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/posixGroup.html#methodsave_attributes" > posixGroup::save_attributes()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns a list of modifications which have to be made to the LDAP account.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaAccount.html#methodsave_attributes" > sambaAccount::save_attributes()< / a > < / dt >
< dd > Returns a list of modifications which have to be made to the LDAP account.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaGroupMapping.html#methodsave_attributes" > sambaGroupMapping::save_attributes()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns a list of modifications which have to be made to the LDAP account.< / dd >
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/sambaSamAccount.html#methodsave_attributes" > sambaSamAccount::save_attributes()< / a > < / dt >
< dd > Returns a list of modifications which have to be made to the LDAP account.< / dd >
2006-11-15 17:12:15 +00:00
< / dl >
< dl >
2007-11-04 11:19:11 +00:00
< dt > < a href = "../modules/shadowAccount.html#methodsave_attributes" > shadowAccount::save_attributes()< / a > < / dt >
2006-11-15 17:12:15 +00:00
< dd > Returns a list of modifications which have to be made to the LDAP account.< / dd >
< / dl >
< / p >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< / div > < br / >
< div class = "credit" >
< hr / >
2007-11-04 11:19:11 +00:00
Documentation generated on Sun, 04 Nov 2007 12:10:39 +0100 by < a href = "http://www.phpdoc.org" > phpDocumentor 1.4.0< / a >
2006-11-15 17:12:15 +00:00
< / div >
< / td > < / tr > < / table >
< / td >
< / tr >
< / table >
< / body >
< / html >
