Difference: TWikiUsersPasswordDotPm (5 vs. 6)

Revision 62011-08-21 - TWikiContributor

Line: 54 to 54

ObjectMethod setPassword ($login,$newPassU,$oldPassU) -> $boolean


ObjectMethod setPassword ($login,$newPassU,$oldPassU,$mcp) -> $boolean

  If the $oldPassU matches matches the user's password, then it will replace it with $newPassU.
Line: 64 to 64
 If $oldPassU is 1, will force the change irrespective of the existing password, adding the user if necessary.
If $mcp is true, the "must change password" flag is set
 Otherwise returns 1 on success, undef on failure.
Line: 127 to 129

ObjectMethod getMustChangePassword ($cUID) -> $flag

Returns 1 if the $cUID must change the password, else 0. Returns undef if $cUID not found.

ObjectMethod getUserData ($cUID) -> $dataRef

Return a reference to an array of hashes with user data, used to manage users. Each item is a hash with:

  • {name} - name of field, such as "email"
  • {title} - title of field, such as "E-mail"
  • {value} - value of field, such as "jimmy@example.com"
  • {type} - type of field: text, password, checkbox, label
  • {size} - size of field, such as 40
  • {note} - comment note, if any

User management forms can be build dynamically from this data structure. Each password manager may return a different set of fields.

ObjectMethod setUserData ($cUID,$dataRef)

Set the user data of a user. Same array of hashes as getUserData is assumed, although only {name} and {value} are used.

Sub classes should return an empty string if save action is OK, or an error string starting with 'Error: '.


ObjectMethod canFetchUsers () -> boolean

returns true if the fetchUsers method is implemented and can return an iterator of users.

This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2023 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiUsersPasswordDotPm.