modules
[ class tree: modules ] [ index: modules ] [ all elements ]

Class: sambaGroupMapping

Source Location: /lib/modules/sambaGroupMapping.inc

Class Overview

baseModule
   |
   --sambaGroupMapping

Manages the object class "sambaGroupMapping" for groups.


Variables

Methods


Inherited Variables

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 39]
Manages the object class "sambaGroupMapping" for groups.



[ Top ]


Class Variables

$rids =

[line 43]

Array of well known RIDs


Type:   mixed


[ Top ]

$sambaGroupTypes =

[line 45]

Array of sambaGroupTypes


Type:   mixed


[ Top ]



Class Methods


constructor sambaGroupMapping [line 52]

sambaGroupMapping sambaGroupMapping( string $scope)

Creates a new module for Samba 3 groups.



Parameters:

string   $scope   account type

[ Top ]

method build_uploadAccounts [line 101]

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

void display_html_attributes( mixed &$post)



[ Top ]

method get_metaData [line 227]

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

array get_pdfEntries( )

Returns the PDF entries for this module.



Tags:

return:  list of possible PDF entries


[ Top ]

method get_profileOptions [line 327]

profile get_profileOptions( )

Returns a list of elements for the account profiles.



Tags:

return:  elements


Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)

[ Top ]

method init [line 83]

void init( string $base)

Initializes the module after it became part of an accountContainer



Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

Parameters:

string   $base   the name of the accountContainer object ($_SESSION[$base])

[ Top ]

method load_Messages [line 365]

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

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

void module_complete( )



Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

[ Top ]

method module_ready [line 383]

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

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 save_attributes [line 449]

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:55 +0100 by phpDocumentor 1.2.3