Class: passwordSelfReset

Source Location: /lib/modules/passwordSelfReset.inc

Class Overview

baseModule
   |
   --passwordSelfReset

Manages password self reset questions and answers.

Author(s):

Roland Gruber

Inherited Variables

Class: baseModule

baseModule::$attributes
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::displaySpecialSelfServicePage(): This function creates meta HTML code to display the module specific page for the self service.
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::getLinkToSpecialSelfServicePage(): This allows modules to create a link to a module specific page for the self service.
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::isBooleanConfigOptionSet(): Returns if the given configuration option is set.
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::postModifySelfService(): 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::preModifySelfService(): 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 22]
Manages password self reset questions and answers.

Tags:

author:

Roland Gruber

[ Top ]

Class Methods

constructor __construct [line 31]

passwordSelfReset __construct(
string
$scope)

Creates a new sambaSamAccount object.

Overrides baseModule::__construct() (Creates a new base module class)

Parameters:

string

$scope

account type (user, group, host)

[ Top ]

method build_uploadAccounts [line 274]

array build_uploadAccounts(
array
$rawAccounts, array
$ids, 
&$partialAccounts, array
$selectedModules, array
$partialAccounts)

In this function the LDAP account is built up.

Tags:

return:	list of error messages if any
access:	public

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)
array	$selectedModules	list of selected account modules
	&$partialAccounts

[ Top ]

method checkSelfServiceOptions [line 466]

array checkSelfServiceOptions(
string
$fields, array
$attributes)

Checks if all input values are correct and returns the LDAP attributes which should be changed.

Return values:
messages: array of parameters to create status messages
add: array of attributes to add
del: array of attributes to remove
mod: array of attributes to modify
info: array of values with informational value (e.g. to be used later by pre/postModify actions)

Calling this method does not require the existence of an enclosing accountContainer.

Tags:

return:

messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))

Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP attributes which should be changed.)

Parameters:

string	$fields	input fields
array	$attributes	LDAP attributes

[ Top ]

method checkSelfServiceSettings [line 401]

array checkSelfServiceSettings(
array
$options)

Checks if the self service settings are valid.

Calling this method does not require the existence of an enclosing accountContainer.

If the input data is invalid the return value is an array that contains arrays to build StatusMessages (message type, message head, message text). If no errors occured the function returns an empty array.

Tags:

return:	error messages
access:	public

Overrides baseModule::checkSelfServiceSettings() (Checks if the self service settings are valid.)

Parameters:

array

$options

hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements.

[ Top ]

method displaySpecialSelfServicePage [line 555]

htmlElement displaySpecialSelfServicePage(
selfServiceProfile
$profile)

This function creates meta HTML code to display the module specific page for the self service.

Tags:

return:	meta HTML object
see:	htmlElement
access:	public

Overrides baseModule::displaySpecialSelfServicePage() (This function creates meta HTML code to display the module specific page for the self service.)

Parameters:

selfServiceProfile

$profile

self service settings

[ Top ]

method display_html_attributes [line 173]

htmlElement display_html_attributes(
)

Returns the HTML meta data for the main account page.

Tags:

return:	HTML meta data
access:	public

Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

[ Top ]

method getLinkToSpecialSelfServicePage [line 534]

String getLinkToSpecialSelfServicePage(
array
$settings)

This allows modules to create a link to a module specific page for the self service.

The link is shown on the login page of the self service. You can use this to provide e.g. a page to reset passwords.

Tags:

return:	link text (null if no special page used)
access:	public

Overrides baseModule::getLinkToSpecialSelfServicePage() (This allows modules to create a link to a module specific page for the self service.)

Parameters:

array

$settings

self service settings

[ Top ]

method getSelfServiceOptions [line 420]

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

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

Parameters:

array	$fields	list of active fields
array	$attributes	attributes of LDAP account

[ Top ]

method get_metaData [line 44]

array get_metaData(
)

Returns meta data that is interpreted by parent class

Tags:

return:	array with meta data
see:	baseModule::get_metaData()
access:	public

Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

[ Top ]

method get_pdfEntries [line 294]

void get_pdfEntries(
)

Returns a list of PDF entries

Tags:

access:

public

Overrides baseModule::get_pdfEntries() (Returns the PDF entries for this module.)

[ Top ]

method load_Messages [line 162]

void load_Messages(
)

This function fills the error message array with messages.

Tags:

access:

public

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

[ Top ]

method load_profile [line 312]

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 process_attributes [line 219]

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

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
"info" are values with informational value (e.g. to be used later by pre/postModify actions)

access:

public

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

[ Top ]

Documentation generated on Sat, 19 Nov 2011 10:24:10 +0100 by phpDocumentor 1.4.1