Docs For Class baseModule

baseModule __construct(
string
$scope)

Creates a new base module class

Tags:

access:

public

Overridden in child classes as:

sambaAccount::__construct(): Creates a new sambaAccount object.

sambaSamAccount::__construct(): Creates a new sambaSamAccount object.

kolabUser::__construct(): Creates a new kolabUser object.

sambaGroupMapping::__construct(): Creates a new module for Samba 3 groups.

Parameters:

string

$scope

the account type (user, group, host)

[ Top ]

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

Overridden in child classes as:

account::build_uploadAccounts(): In this function the LDAP account is built up.

ieee802Device::build_uploadAccounts(): In this function the LDAP account is built up.

posixGroup::build_uploadAccounts(): In this function the LDAP account is built up.

sambaAccount::build_uploadAccounts(): In this function the LDAP account is built up.

sambaSamAccount::build_uploadAccounts(): In this function the LDAP account is built up.

posixAccount::build_uploadAccounts(): In this function the LDAP account is built up.

kolabUser::build_uploadAccounts(): In this function the LDAP account is built up.

sambaGroupMapping::build_uploadAccounts(): In this function the LDAP account is built up.

shadowAccount::build_uploadAccounts(): In this function the LDAP account is built up.

ldapPublicKey::build_uploadAccounts(): In this function the LDAP account is built up.

sambaDomain::build_uploadAccounts(): In this function the LDAP account is built up.

inetOrgPerson::build_uploadAccounts(): In this function the LDAP account is built up.

inetLocalMailRecipient::build_uploadAccounts(): In this function the LDAP account is built up.

groupOfNames::build_uploadAccounts(): In this function the LDAP account is built up.

nisMailAlias::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)
	&$partialAccounts

[ Top ]

boolean can_manage(
)

Returns true if this module fits for the current scope.

Tags:

return:

true if module fits

[ Top ]

array checkSelfServiceOptions(
string
$fields, array
$attributes)

Checks if all input values are correct and returns the LDAP commands which should be executed.

Tags:

return:

messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))

Overridden in child classes as:

sambaSamAccount::checkSelfServiceOptions(): Checks if all input values are correct and returns the LDAP commands which should be executed.

posixAccount::checkSelfServiceOptions(): Checks if all input values are correct and returns the LDAP commands which should be executed.

inetOrgPerson::checkSelfServiceOptions(): Checks if all input values are correct and returns the LDAP commands which should be executed.

Parameters:

string	$fields	input fields
array	$attributes	LDAP attributes

[ Top ]

array checkSelfServiceSettings(
array
$options)

Checks if the self service settings are valid.

Tags:

return:

error messages

Parameters:

array

$options

settings

[ Top ]

array check_configOptions(
array
$scopes, array
$options)

Checks input values of module settings.

Tags:

return:

list of error messages

Overridden in child classes as:

posixAccount::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 ]

array check_profileOptions(
array
$options)

Checks input values of account profiles.

Tags:

return:

list of error messages (array(type, title, text)) to generate StatusMessages, if any

Overridden in child classes as:

quota::check_profileOptions(): Checks input values of account profiles.

Parameters:

array

$options

a hash array (name => value) containing the options

[ Top ]

List delete_attributes(
)

Dummy function for modules which use no special options on account deletion.

Tags:

return:

of LDAP operations, same as for save_attributes()

Overridden in child classes as:

posixGroup::delete_attributes(): Checks if the group which should be deleted is still used as primary group.

posixAccount::delete_attributes(): Additional LDAP operations on delete.

[ Top ]

meta display_html_delete(
)

Dummy function for modules which do not print extra HTML code on account deletion.

Tags:

return:

HTML code

Overridden in child classes as:

posixAccount::display_html_delete(): Displays the delete homedir option for the delete page.

[ Top ]

array doUploadPostActions(
array
$data, array
$ids, array
$failed, 
&$temp, 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>)
)

Overridden in child classes as:

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

posixAccount::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
	&$temp

[ Top ]

accountContainer getAccountContainer(
)

Returns the accountContainer object.

Tags:

return:	accountContainer object
access:	protected

[ Top ]

array getAttributes(
)

Returns the LDAP attributes which are managed in this module.

Tags:

return:	attributes
access:	public

[ Top ]

string getButtonStatus(
)

Controls if the module button the account page is visible and activated.

Tags:

return:

status ("enabled", "disabled", "hidden")

Overridden in child classes as:

account::getButtonStatus(): Controls if the module button the account page is visible and activated.

posixGroup::getButtonStatus(): Controls if the module button the account page is visible and activated.

inetOrgPerson::getButtonStatus(): Controls if the module button the account page is visible and activated.

nisMailAlias::getButtonStatus(): Controls if the module button the account page is visible and activated.

[ Top ]

unknown getIcon(
)

Returns the path to the module icon.

The path must be releative to graphics (e.g. key.png). You can also set $this->meta['icon']. The preferred size is 32x32px.

Tags:

access:

public

[ Top ]

array getLDAPAliases(
)

Returns a list of aliases for LDAP attributes.

All alias attributes will be renamed to the given attribute names.

Tags:

return:

list of aliases (alias name => attribute name)

[ Top ]

array getManagedAttributes(
)

Returns a list of LDAP attributes which are managed by this module.

All attribute names will be renamed to match the given spelling.

Tags:

return:

list of attributes

[ Top ]

array getManagedObjectClasses(
)

Returns a list of managed object classes for this module.

This is used to fix incorrect spelled object class names.

Tags:

return:

list of object classes

[ Top ]

array getOriginalAttributes(
)

Returns the LDAP attributes which are managed in this module (with unchanged values).

Tags:

return:	attributes
access:	public

[ Top ]

array getRequiredExtensions(
)

Returns a list of required PHP extensions.

Tags:

return:

extensions

[ Top ]

array getSelfServiceFields(
)

Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)

Tags:

return:

fields

[ Top ]

array getSelfServiceOptions(
array
$fields, array
$attributes)

Returns the meta HTML code for each input field.

format: array(<field1> => array(<META HTML>), ...) It is not possible to display help links.

Tags:

return:

meta HTML

Overridden in child classes as:

posixAccount::getSelfServiceOptions(): Returns the meta HTML code for each input field.

inetOrgPerson::getSelfServiceOptions(): Returns the meta HTML code for each input field.

Parameters:

array	$fields	list of active fields
array	$attributes	attributes of LDAP account (attribute names in lower case)

[ Top ]

array getSelfServiceSearchAttributes(
)

Returns a list of possible search attributes for the self service.

Tags:

return:

attributes

[ Top ]

array getSelfServiceSettings(
)

Returns a list of self service configuration settings.

Tags:

return:

settings

[ Top ]

string get_alias(
)

Returns an alias name for the module.

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.

Tags:

return:

alias name

[ Top ]

array get_configOptions(
array
$scopes, array
$allScopes)

Returns a list of elements for the configuration.

Tags:

return:

configuration elements

Overridden in child classes as:

posixGroup::get_configOptions(): Returns a list of elements for the configuration.

Parameters:

array	$scopes	account types (user, group, host)
array	$allScopes	list of all modules and active scopes

[ Top ]

array get_dependencies(
)

This function returns a list with all depending and conflicting modules.

Tags:

return:

list of dependencies and conflicts

[ Top ]

array get_help(
string
$id, string
$scope)

This function return the help entry array for a specific help id. Normally this->meta can be used.

Tags:

return:

The desired help entry.

Parameters:

string	$id	The id string for the help entry needed.
string	$scope	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.

[ Top ]

string get_ldap_filter(
)

returns an LDAP filter for the account lists

Tags:

return:

LDAP filter

[ Top ]

array get_metaData(
)

Dummy function, meta data is provided by sub classes.

Tags:

return:

empty array

Overridden in child classes as:

account::get_metaData(): Returns meta data that is interpreted by parent class

ieee802Device::get_metaData(): Returns meta data that is interpreted by parent class

posixGroup::get_metaData(): Returns meta data that is interpreted by parent class

quota::get_metaData(): Returns meta data that is interpreted by parent class

sambaAccount::get_metaData(): Returns meta data that is interpreted by parent class

sambaSamAccount::get_metaData(): Returns meta data that is interpreted by parent class

posixAccount::get_metaData(): Returns meta data that is interpreted by parent class

kolabUser::get_metaData(): Returns meta data that is interpreted by parent class

sambaGroupMapping::get_metaData(): Returns meta data that is interpreted by parent class

shadowAccount::get_metaData(): Returns meta data that is interpreted by parent class

ldapPublicKey::get_metaData(): Returns meta data that is interpreted by parent class

sambaDomain::get_metaData(): Returns meta data that is interpreted by parent class

inetOrgPerson::get_metaData(): Returns meta data that is interpreted by parent class

inetLocalMailRecipient::get_metaData(): Returns meta data that is interpreted by parent class

groupOfNames::get_metaData(): Returns meta data that is interpreted by parent class

groupOfUniqueNames::get_metaData(): Returns meta data that is interpreted by parent class

nisMailAlias::get_metaData(): Returns meta data that is interpreted by parent class

[ Top ]

array get_pdfFields(
string
$scope)

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.

Tags:

return:

list of available fields for PDF output

Parameters:

string

$scope

account type

[ Top ]

array get_pdf_entries(
[string
$scope = 'user'])

Returns a hastable with all entries that may be printed out in the PDF. The

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.

Tags:

return:

hastable of entries for the PDF. Each entry is an array where each entry is treated as a new line in the PDF.

Parameters:

string

$scope

account type

[ Top ]

profile get_profileOptions(
)

Returns a list of elements for the account profiles.

Tags:

return:

elements

Overridden in child classes as:

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

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

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

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

[ Top ]

array get_RDNAttributes(
)

Returns a list of possible LDAP attributes which can be used to form the RDN.

The returned elements have this form: <attribute> => <priority>
<attribute> is the name of the LDAP attribute
<priority> defines the priority of the attribute (can be "low", "normal", "high")

Tags:

return:

list of attributes

[ Top ]

string get_scope(
)

Returns the account type of this module (user, group, host)

Tags:

return:

account type

[ Top ]

array get_uploadColumns(
)

Returns an array containing all input columns for the file upload.

Syntax:
array(
string: name, // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
string: description, // short descriptive name
string: help, // help ID
string: example, // example value
boolean: required // true, if user must set a value for this column
)

Tags:

return:

column list

Overridden in child classes as:

quota::get_uploadColumns(): Returns an array containing all input columns for the file upload.

[ Top ]

array get_uploadPreDepends(
)

Returns a list of module names which must be processed in building the account befor this module.

Tags:

return:

list of module names

[ Top ]

void init(
string
$base)

Initializes the module after it became part of an accountContainer

Overridden in child classes as:

posixGroup::init(): This functin will be called when the module will be loaded *

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

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

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

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

Parameters:

string

$base

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

[ Top ]

boolean is_base_module(
)

Returns true if this module is enough to provide a sensible account.

There is no relation to the name of this class.

Tags:

return:

true if base module

[ Top ]

void load_attributes(
array
$attributes)

This function loads the LDAP attributes for this module.

Overridden in child classes as:

sambaAccount::load_attributes(): This function loads the LDAP attributes for this module.

sambaSamAccount::load_attributes(): This function loads the LDAP attributes for this module.

posixAccount::load_attributes(): This function loads all needed LDAP attributes.

Parameters:

array

$attributes

attribute list

[ Top ]

void load_Messages(
)

This function fills the $messages variable with output messages from this module.

Tags:

access:

protected

Overridden in child classes as:

account::load_Messages(): This function fills the message array.

ieee802Device::load_Messages(): This function fills the error message array with messages

posixGroup::load_Messages(): This function fills the $messages variable with output messages from this module.

quota::load_Messages(): this functin fills the error message array with messages

sambaAccount::load_Messages(): this functin fills the error message array with messages

sambaSamAccount::load_Messages(): this functin fills the error message array with messages

posixAccount::load_Messages(): This function fills the error message array with messages.

kolabUser::load_Messages(): This function fills the error message array with messages

sambaGroupMapping::load_Messages(): this functin fills the error message array with messages

shadowAccount::load_Messages(): This function builds up the message array.

sambaDomain::load_Messages(): This function fills the error message array with messages

inetOrgPerson::load_Messages(): This function fills the message array.

inetLocalMailRecipient::load_Messages(): This function fills the error message array with messages

groupOfNames::load_Messages(): This function fills the $messages variable with output messages from this module.

nisMailAlias::load_Messages(): This function fills the error message array with messages

[ Top ]

void load_profile(
array
$profile)

Loads the values of an account profile into internal variables.

Overridden in child classes as:

quota::load_profile(): Loads the values of an account profile into internal variables.

sambaAccount::load_profile(): Loads the values of an account profile into internal variables.

sambaSamAccount::load_profile(): Loads the values of an account profile into internal variables.

posixAccount::load_profile(): Loads the values of an account profile into internal variables.

sambaGroupMapping::load_profile(): Loads the values of an account profile into internal variables.

shadowAccount::load_profile(): Loads the values of an account profile into internal variables.

Parameters:

array

$profile

hash array with profile values (identifier => value)

[ Top ]

boolean module_complete(
)

This functions is used to check if all settings for this module have been made.

Tags:

return:

true, if settings are complete

Overridden in child classes as:

account::module_complete(): This functions returns true if all needed settings are done.

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

sambaAccount::module_complete(): This functions returns true if all needed settings are done

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

kolabUser::module_complete(): This function returns true if all needed settings are done.

inetOrgPerson::module_complete(): This functions return true if all needed settings are done.

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

[ Top ]

boolean module_ready(
)

This function is used to check if this module page can be displayed.

It returns false if a module depends on data from other modules which was not yet entered.

Tags:

return:

true, if page can be displayed

Overridden in child classes as:

quota::module_ready(): This function is used to check if this module page can be displayed.

sambaAccount::module_ready(): This function is used to check if this module page can be displayed.

sambaSamAccount::module_ready(): This function is used to check if this module page can be displayed.

sambaGroupMapping::module_ready(): This function is used to check if this module page can be displayed.

[ Top ]

void postDeleteActions(
)

Allows the module to run commands after the LDAP entry is deleted.

[ Top ]

void postModifyActions(
boolean
$newAccount)

Allows the module to run commands after the LDAP entry is changed or created.

Overridden in child classes as:

quota::postModifyActions(): Allows the module to run commands after the LDAP entry is changed or created.

posixAccount::postModifyActions(): Allows the module to run commands after the LDAP entry was changed or created.

Parameters:

boolean

$newAccount

new account

[ Top ]

true, preDeleteActions(
)

Allows the module to run commands before the LDAP entry is deleted.

An error message should be printed if the function returns false.

Tags:

return:

if no problems occured

Overridden in child classes as:

quota::preDeleteActions(): Allows the module to run commands before the LDAP entry is deleted.

posixAccount::preDeleteActions(): Allows the module to run commands before the LDAP entry is deleted.

[ Top ]

true, preModifyActions(
boolean
$newAccount)

Allows the module to run commands before the LDAP entry is changed or created.

An error message should be printed if the function returns false.

Tags:

return:

if no problems occured

Parameters:

boolean

$newAccount

new account

[ Top ]

array save_attributes(
)

Returns a list of modifications which have to be made to the LDAP account.

Tags:

return:

list of modifications
This function returns an array with 3 entries:
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
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)
"add" are attributes which have to be added to LDAP entry
"remove" are attributes which have to be removed from LDAP entry
"modify" are attributes which have to been modified in LDAP entry

Overridden in child classes as:

account::save_attributes(): Returns a list of modifications which have to be made to the LDAP account.

posixGroup::save_attributes(): Returns a list of modifications which have to be made to the LDAP account.

sambaAccount::save_attributes(): Returns a list of modifications which have to be made to the LDAP account.

sambaSamAccount::save_attributes(): Returns a list of modifications which have to be made to the LDAP account.

posixAccount::save_attributes(): Returns a list of modifications which have to be made to the LDAP account.

kolabUser::save_attributes(): Returns a list of modifications which have to be made to the LDAP account.

sambaGroupMapping::save_attributes(): Returns a list of modifications which have to be made to the LDAP account.

shadowAccount::save_attributes(): Returns a list of modifications which have to be made to the LDAP account.

inetOrgPerson::save_attributes(): Returns a list of modifications which have to be made to the LDAP account.

nisMailAlias::save_attributes(): Returns a list of modifications which have to be made to the LDAP account.

[ Top ]

Class: baseModule

Class Overview

Author(s):

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$attributes =

Tags:

$autoAddObjectClasses =

Tags:

$messages =

Tags:

$meta =

Tags:

$moduleSettings =

Tags:

$orig =

Tags:

$selfServiceSettings =

Tags:

Class Methods

constructor __construct [line 74]

Tags:

Parameters:

method build_uploadAccounts [line 507]

Tags:

Parameters:

method can_manage [line 172]

Tags:

method checkSelfServiceOptions [line 738]

Tags:

Parameters:

method checkSelfServiceSettings [line 759]

Tags:

Parameters:

method check_configOptions [line 367]

Tags:

Parameters:

method check_profileOptions [line 252]

Tags:

Parameters:

method delete_attributes [line 640]

Tags:

method display_html_delete [line 649]

Tags:

method doUploadPostActions [line 575]

Tags:

Parameters:

method getAccountContainer [line 770]

Tags:

method getAttributes [line 784]

Tags:

method getButtonStatus [line 557]

Tags:

method getIcon [line 804]

Tags:

method getLDAPAliases [line 670]

Tags:

method getManagedAttributes [line 681]

Tags:

method getManagedObjectClasses [line 659]

Tags:

method getOriginalAttributes [line 793]

Tags:

method getRequiredExtensions [line 691]

Tags:

method getSelfServiceFields [line 712]

Tags:

method getSelfServiceOptions [line 726]

Tags:

Parameters:

method getSelfServiceSearchAttributes [line 701]

Tags:

method getSelfServiceSettings [line 748]

Tags:

method get_alias [line 207]

Tags: