Class: posixAccount

Source Location: /lib/modules/posixAccount.inc

Class Overview

baseModule
   |
   --posixAccount

Manages the object class "posixAccount" for users and hosts.

Variables

Methods

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 "posixAccount" for users and hosts.

[ Top ]

Class Variables

$createhomedir =

[line 434]

Type:

mixed

[ Top ]

$groups =

[line 432]

Type:

mixed

[ Top ]

$groups_orig =

[line 433]

Type:

mixed

[ Top ]

$userPassword_invalid =

[line 426]

Type:

mixed

[ Top ]

$userPassword_lock =

[line 428]

Type:

mixed

[ Top ]

$userPassword_nopassword =

[line 424]

Type:

mixed

[ Top ]

Class Methods

method build_uploadAccounts [line 1186]

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 check_configOptions [line 1127]

array check_configOptions(
array
$scopes, array
$options)

Checks input values of module settings.

Tags:

return:

list of error messages

Overrides baseModule::check_configOptions() (Checks input values of module settings.)

Parameters:

array	$scopes	list of account types which are used
array	$options	hash array containing the settings (array('option' => array('value')))

[ Top ]

method delete_attributes [line 555]

void delete_attributes(
mixed
$post)

Overrides baseModule::delete_attributes() (Dummy function for modules which use no special options on account deletion.)

[ Top ]

method display_html_attributes [line 839]

void display_html_attributes(
mixed
&$post)

[ Top ]

method display_html_delete [line 939]

void display_html_delete(
mixed
&$post)

Overrides baseModule::display_html_delete() (Dummy function for modules which do not print extra HTML code on account deletion.)

[ Top ]

method display_html_group [line 955]

array display_html_group(
array
&$post)

Displays the group selection.

Tags:

return:

meta HTML code

Parameters:

array

$post

HTTP-POST

[ Top ]

method display_html_password [line 1001]

array display_html_password(
array
&$post)

Displays the password changing dialog.

Tags:

return:

meta HTML code

Parameters:

array

$post

HTTP-POST

[ Top ]

method doUploadPostActions [line 1429]

array doUploadPostActions(
array
$data, array
$ids, array
$failed, array
&$temp)

This function executes one post upload action.

Tags:

return:

current status
array (
'status' => 'finished' | 'inProgress'
'progress' => 0..100
'errors' => array (<array of parameters for StatusMessage>)
)

Overrides baseModule::doUploadPostActions() (This function executes one post upload action.)

Parameters:

array	$data	array containing one account in each element
array	$ids	array(<column_name> => <column number>)
array	$failed	list of accounts which were not created successfully
array	$temp	variable to store temporary data between two post actions

[ Top ]

method dynamic_Message [line 40]

void dynamic_Message(
mixed
$attribute, mixed
$id)

[ Top ]

method getNextUIDs [line 1511]

mixed getNextUIDs(
integer
$count, array
&$triggered_messages)

Returns one or more free UID numbers.

Tags:

return:

Null if no UIDs are free else an array of free UIDs.

Parameters:

integer	$count	Number of needed free UIDs.
array	$triggered_messages	list of error messages where errors can be added

[ Top ]

method get_metaData [line 107]

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

array get_pdfEntries(
)

Returns the PDF entries for this module.

Tags:

return:

list of possible PDF entries

[ Top ]

method get_profileOptions [line 1023]

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

void init(
mixed
$base)

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

[ Top ]

method load_attributes [line 451]

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

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

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

void module_complete(
)

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

[ Top ]

method process_attributes [line 575]

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_group [line 798]

array process_group(
array
&$post)

Processes user input of the group selection page.

It checks if all input values are correct and updates the associated LDAP attributes.

Tags:

return:

list of info/error messages

Parameters:

array

$post

HTTP-POST values

[ Top ]

method process_password [line 815]

array process_password(
array
&$post)

Processes user input of the password page.

It checks if all input values are correct and updates the associated LDAP attributes.

Tags:

return:

list of info/error messages

Parameters:

array

$post

HTTP-POST values

[ Top ]

method save_attributes [line 475]

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