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

Class: passwordService

Source Location: /lib/modules.inc

Interface Overview


This interface needs to be implemented by all account modules which manage passwords.


Methods



Class Details

[line 1941]
This interface needs to be implemented by all account modules which manage passwords.

It allows LAM to provide central password changes.




[ Top ]


Class Methods


method managesPasswordAttributes [line 1950]

boolean managesPasswordAttributes( )

This method specifies if a module manages password attributes. The module alias will then appear as option in the GUI.


If the module only wants to get notified about password changes then return false.




Tags:

return:  true if this module manages password attributes
access:  public


[ Top ]

method passwordChangeRequested [line 1969]

array passwordChangeRequested( String $password, array $modules, boolean $forcePasswordChange)

This function is called whenever the password should be changed. Account modules must change their password attributes only if the modules list contains their module name.



Tags:

return:  list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))
access:  public


Parameters:

String   $password   new password
array   $modules   list of modules for which the password should be changed
boolean   $forcePasswordChange   force the user to change his password at next login

[ Top ]

method supportsForcePasswordChange [line 1957]

boolean supportsForcePasswordChange( )

Specifies if this module supports to force that a user must change his password on next login.



Tags:

return:  force password change supported
access:  public


[ Top ]


Documentation generated on Sun, 25 Mar 2012 19:35:48 +0200 by phpDocumentor 1.4.1