modules

# Class: dhcp_settings Source Location: /lib/modules/dhcp_settings.inc
### Class Overview
    baseModule
       |
       --dhcp_settings
Manages DHCP entries. #### Author(s): Roland Gruber | ### Variables $attributes $dhcpSettings $dn $netbios_node_type | ### Methods __construct build_uploadAccounts display_html_attributes get_metaData get_pdfEntries load_attributes load_Messages load_profile module_complete process_attributes save_attributes
### Inherited Variables #### Class: baseModule baseModule::$autoAddObjectClasses baseModule::$messages baseModule::$meta baseModule::$moduleSettings baseModule::$orig baseModule::$selfServiceSettings | ### Inherited Methods #### Class: baseModule baseModule::__construct() Creates a new base module class baseModule::build_uploadAccounts() In this function the LDAP accounts are built. baseModule::can_manage() Returns true if this module can manage accounts of the current type, otherwise false. baseModule::checkSelfServiceOptions() Checks if all input values are correct and returns the LDAP attributes which should be changed. baseModule::checkSelfServiceSettings() Checks if the self service settings are valid. baseModule::check_configOptions() Checks input values of module settings. baseModule::check_profileOptions() Checks input values of account profiles. baseModule::delete_attributes() This function returns an array with the same syntax as save_attributes(). baseModule::display_html_attributes() This function creates meta HTML code to display the module page. baseModule::display_html_delete() This function creates meta HTML code which will be displayed when an account should be deleted. baseModule::doUploadPostActions() This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). baseModule::getAccountContainer() Returns the accountContainer object. baseModule::getAttributes() Returns the LDAP attributes which are managed in this module. baseModule::getButtonStatus() Controls if the module button the account page is visible and activated. baseModule::getIcon() Returns the path to the module icon. baseModule::getLDAPAliases() Returns a list of aliases for LDAP attributes. baseModule::getManagedAttributes() Returns a list of LDAP attributes which are managed by this module. baseModule::getManagedObjectClasses() Returns a list of managed object classes for this module. baseModule::getOriginalAttributes() Returns the LDAP attributes which are managed in this module (with unchanged values). baseModule::getRequiredExtensions() This function returns a list of PHP extensions (e.g. hash) which are needed by this module. baseModule::getSelfServiceFields() Returns a list of possible input fields and their descriptions. baseModule::getSelfServiceOptions() Returns the meta HTML code for each input field. baseModule::getSelfServiceSearchAttributes() This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. baseModule::getSelfServiceSettings() Returns a list of self service configuration settings. baseModule::get_alias() Returns an alias name for the module. baseModule::get_configOptions() Returns a list of configuration options. baseModule::get_dependencies() This function returns a list with all depending and conflicting modules. baseModule::get_help() This function returns the help entry array for a specific help id. baseModule::get_ldap_filter() Returns an LDAP filter for the account lists baseModule::get_metaData() This function provides meta data which is interpreted by baseModule. baseModule::get_pdfEntries() Returns the PDF entries for this module. baseModule::get_pdfFields() Returns a hashtable with all entries that may be printed out in the PDF. baseModule::get_profileOptions() This function defines what attributes will be used in the account profiles and their appearance in the profile editor. baseModule::get_RDNAttributes() Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). baseModule::get_scope() Returns the account type of this module (user, group, host) baseModule::get_uploadColumns() Returns an array containing all input columns for the file upload. baseModule::get_uploadPreDepends() Returns a list of module names which must be processed in building the account befor this module. baseModule::init() Initializes the module after it became part of an accountContainer baseModule::is_base_module() Returns true if your module is a base module and otherwise false. baseModule::load_attributes() This function loads the LDAP attributes when an account should be loaded. baseModule::load_Messages() This function fills the $messages variable with output messages from this module. baseModule::load_profile() This function loads the values from an account profile to the module's internal data structures. baseModule::module_complete() This function is used to check if all settings for this module have been made. baseModule::module_ready() This function is used to check if this module page can be displayed. baseModule::postDeleteActions() Allows the module to run commands after the LDAP entry is deleted. baseModule::postModifyActions() Allows the module to run commands after the LDAP entry is changed or created. baseModule::preDeleteActions() Allows the module to run commands before the LDAP entry is deleted. baseModule::preModifyActions() Allows the module to run commands before the LDAP entry is changed or created. baseModule::process_attributes() This function processes user input. baseModule::save_attributes() Returns a list of modifications which have to be made to the LDAP account.
### Class Details [line 72] Manages DHCP entries. #### Tags:
author: | Roland Gruber
[ Top ] ### Class Variables #### $attributes = [line 86] #### Tags:
access: | public
Type: | mixed
Overrides: | Array
[ Top ] #### $dhcpSettings = [line 81] #### Tags:
access: | public
Type: | mixed
[ Top ] #### $dn = "" [line 84] #### Tags:
access: | public
Type: | mixed
[ Top ] #### $netbios_node_type = [line 75] #### Tags:
access: | public
Type: | mixed
[ Top ] ### Class Methods ### constructor __construct [line 93]
`dhcp_settings __construct( string $scope)`
Creates a new dhcp_settings object. Overrides baseModule::__construct() (Creates a new base module class) #### Parameters:
string | $scope | account type
[ Top ] ### method build_uploadAccounts [line 957]
`array build_uploadAccounts( array $rawAccounts, array $ids, &$partialAccounts, array $partialAccounts)`
In this function the LDAP account is built up. #### Tags:
return: | list of error messages if any
Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.) #### Parameters:
array | $rawAccounts | list of hash arrays (name => value) from user input
array | $partialAccounts | list of hash arrays (name => value) which are later added to LDAP
array | $ids | list of IDs for column position (e.g. "posixAccount_uid" => 5)
| &$partialAccounts |
[ Top ] ### method display_html_attributes [line 725]
`void display_html_attributes( )`
#### Tags:
access: | public
Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.) [ Top ] ### method get_metaData [line 105]
`void get_metaData( )`
#### Tags:
access: | public
Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.) [ Top ] ### method get_pdfEntries [line 858]
`array get_pdfEntries( )`
Returns the PDF entries for this module. #### Tags:
return: | list of possible PDF entries
Overrides baseModule::get_pdfEntries() (Returns the PDF entries for this module.) [ Top ] ### method load_attributes [line 424]
`void load_attributes( array $attr)`
This function loads all needed LDAP attributes. Overrides baseModule::load_attributes() (This function loads the LDAP attributes when an account should be loaded.) #### Parameters:
array | $attr | list of attributes
[ Top ] ### method load_Messages [line 298]
`void load_Messages( )`
This function fills the message array. #### Tags:
access: | public
Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.) [ Top ] ### method load_profile [line 815]
`void load_profile( array $profile)`
Loads the values of an account profile into internal variables. Overrides baseModule::load_profile() (This function loads the values from an account profile to the module's internal data structures.) #### Parameters:
array | $profile | hash array with profile values (identifier => value)
[ Top ] ### method module_complete [line 334]
`boolean module_complete( )`
This functions returns true if all needed settings are done. #### Tags:
return: | true if LDAP operation can be done
access: | public
Overrides baseModule::module_complete() (This function is used to check if all settings for this module have been made.) [ Top ] ### method process_attributes [line 492]
`array process_attributes( )`
Processes user input of the primary module page. It checks if all input values are correct and updates the associated LDAP attributes. #### Tags:
return: | list of info/error messages
access: | public
Overrides baseModule::process_attributes() (This function processes user input.) [ Top ] ### method save_attributes [line 380]
`void save_attributes( )`
#### Tags:
access: | public
Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.) [ Top ] Documentation generated on Tue, 07 Apr 2009 20:35:02 +0200 by phpDocumentor 1.4.1