modules

# Class: sambaAccount Source Location: /lib/modules/sambaAccount.inc
### Class Overview
    baseModule
       |
       --sambaAccount
Manages the object class "sambaAccount" for users and hosts. | ### Variables $deactivated $noexpire $nopwd $rids $useunixpwd | ### Methods sambaAccount build_uploadAccounts display_html_attributes display_html_userWorkstations get_metaData get_pdfEntries init load_attributes load_Messages load_profile module_complete module_ready process_attributes process_userWorkstations save_attributes
### Inherited Variables #### Class: baseModule baseModule::$attributes baseModule::$base baseModule::$messages baseModule::$meta baseModule::$moduleSettings baseModule::$orig baseModule::$scope baseModule::$triggered_messages | ### Inherited Methods #### Class: baseModule baseModule::baseModule() Creates a new base module class baseModule::build_uploadAccounts() In this function the LDAP account is built up. baseModule::can_manage() Returns true if this module fits for the current scope. baseModule::check_configOptions() Checks input values of module settings. baseModule::check_profileOptions() Checks input values of account profiles. baseModule::delete_attributes() Dummy function for modules which use no special options on account deletion. baseModule::display_html_delete() Dummy function for modules which do not print extra HTML code on account deletion. baseModule::doUploadPostActions() This function executes one post upload action. baseModule::getButtonStatus() Controls if the module button the account page is visible and activated. baseModule::get_alias() Returns an alias name for the module. baseModule::get_configDescriptions() Returns an array containing descriptions shown on configuration pages. baseModule::get_configOptions() Returns a list of elements for the configuration. baseModule::get_dependencies() This function returns a list with all depending and conflicting modules. baseModule::get_help() This function return the help entry array for a specific help id. Normally this->meta can be used. baseModule::get_ldap_filter() returns an LDAP filter for the account lists baseModule::get_metaData() Dummy function, meta data is provided by sub classes. baseModule::get_pdfFields() Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class. baseModule::get_pdf_entries() Returns a hastable with all entries that may be printed out in the PDF. The baseModule::get_profileOptions() Returns a list of elements for the account profiles. baseModule::get_RDNAttributes() Returns a list of possible LDAP attributes which can be used to form the RDN. baseModule::get_scope() Returns the account type of this module (user, group, host) baseModule::get_uploadColumns() Returns an array containing all input columns for the file upload. baseModule::get_uploadPreDepends() Returns a list of module names which must be processed in building the account befor this module. baseModule::init() Initializes the module after it became part of an accountContainer baseModule::input_check() Checks if the attribute values follow the LDAP syntax. baseModule::is_base_module() Returns true if this module is enough to provide a sensible account. baseModule::load_attributes() This function loads all standard LDAP attributes. It is used by the modules to reduce code baseModule::load_Messages() This function fills the $messages variable with output messages from this module. baseModule::load_profile() Loads the values of an account profile into internal variables. baseModule::module_complete() This functions is used to check if all settings for this module have been made. baseModule::module_ready() This function is used to check if this module page can be displayed. baseModule::save_attributes() Returns a list of modifications which have to be made to the LDAP account.
### Class Details [line 38] Manages the object class "sambaAccount" for users and hosts. [ Top ] ### Class Variables #### $deactivated = [line 425] account deactivated?
Type: | mixed
[ Top ] #### $noexpire = [line 423] password does not expire?
Type: | mixed
[ Top ] #### $nopwd = [line 421] use no password?
Type: | mixed
[ Top ] #### $rids = [line 428] Array of well known rids
Type: | mixed
[ Top ] #### $useunixpwd = [line 419] use unix password as samba password?
Type: | mixed
[ Top ] ### Class Methods ### constructor sambaAccount [line 45]
`sambaAccount sambaAccount( string $scope)`
Creates a new sambaAccount object. #### Parameters:
string | $scope | account type (user, group, host)
[ Top ] ### method build_uploadAccounts [line 865]
`array build_uploadAccounts( array $rawAccounts, array $ids, array &$partialAccounts)`
In this function the LDAP account is built up. #### Tags:
return: | list of error messages if any
Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.) #### Parameters:
array | $rawAccounts | list of hash arrays (name => value) from user input
array | $partialAccounts | list of hash arrays (name => value) which are later added to LDAP
array | $ids | list of IDs for column position (e.g. "posixAccount_uid" => 5)
[ Top ] ### method display_html_attributes [line 691]
`void display_html_attributes( mixed &$post)`
[ Top ] ### method display_html_userWorkstations [line 812]
`void display_html_userWorkstations( mixed &$post)`
[ Top ] ### method get_metaData [line 96]
`array get_metaData( )`
Returns meta data that is interpreted by parent class #### Tags:
return: | array with meta data
Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.) [ Top ] ### method get_pdfEntries [line 846]
`array get_pdfEntries( )`
Returns the PDF entries for this module. #### Tags:
return: | list of possible PDF entries
[ Top ] ### method init [line 408]
`void init( string $base)`
Initializes the module after it became part of an accountContainer Overrides baseModule::init() (Initializes the module after it became part of an accountContainer) #### Parameters:
string | $base | the name of the accountContainer object ($_SESSION[$base])
[ Top ] ### method load_attributes [line 450]
`void load_attributes( mixed $attr)`
Overrides baseModule::load_attributes() (This function loads all standard LDAP attributes. It is used by the modules to reduce code) [ Top ] ### method load_Messages [line 59]
`void load_Messages( )`
this functin fills the error message array with messages Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.) [ Top ] ### method load_profile [line 1115]
`void load_profile( array $profile)`
Loads the values of an account profile into internal variables. Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.) #### Parameters:
array | $profile | hash array with profile values (identifier => value)
[ Top ] ### method module_complete [line 441]
`boolean module_complete( )`
This functions returns true if all needed settings are done #### Tags:
return: | true if ready to save account
Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.) [ Top ] ### method module_ready [line 430]
`void module_ready( )`
Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.) [ Top ] ### method process_attributes [line 498]
`array process_attributes( array &$post)`
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
#### Parameters:
array | $post | HTTP-POST values
[ Top ] ### method process_userWorkstations [line 644]
`array process_userWorkstations( array &$post)`
Processes user input of the workstation selection page. It checks if all input values are correct and updates the associated LDAP attributes. #### Tags:
return: | list of info/error messages
#### Parameters:
array | $post | HTTP-POST values
[ Top ] ### method save_attributes [line 471]
`void save_attributes( )`
Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.) [ Top ] Documentation generated on Tue, 07 Feb 2006 17:03:54 +0100 by phpDocumentor 1.2.3