Difference: TWikiUsersBaseUserMappingDotPm (1 vs. 2)
Revision 22011-08-21 - TWikiContributor
Package =TWiki::Users::BaseUserMappingUser mapping is the process by which TWiki maps from a username (a login name) to a display name and back. It is also where groups are maintained. The BaseMapper provides support for a small number of predefined users. No registration - this is a read only usermapper. It uses the mapper prefix 'BaseUserMapping_'.Users
Groups
On this page:
ClassMethod new ($session)Construct the BaseUserMapping objectObjectMethod finish ()Break circular references.ObjectMethod *loginTemplateName () -> templateFileallows UserMappings to come with customised login screens - that should preffereably only over-ride the UI functionObjectMethod handlesUser ($cUID,$login,$wikiname) -> $booleanSee baseclass for documentation. In the BaseUserMapping case, we know all the details of the users we specialise in.ObjectMethod login2cUID ($login) -> $cUIDConvert a login name to the corresponding canonical user name. The canonical name can be any string of 7-bit alphanumeric and underscore characters, and must correspond 1:1 to the login name. (undef on failure)ObjectMethod getLoginName ($cUID) -> loginconverts an internal cUID to that user's login (undef on failure)ObjectMethod getWikiName ($cUID) -> wikinameMap a canonical user name to a wikinameObjectMethod userExists ($user) -> $booleanDetermine if the user already exists or not.ObjectMethod eachUser () -> listIteratorofcUIDsSee baseclass for documentation.ObjectMethod *eachGroupMember ($group) -> listIteratorofcUIDsSee baseclass for documentation. The basemapper implementation assumes that there are no nested groups in the basemapper.ObjectMethod isGroup ($name) -> booleanSee baseclass for documentation.ObjectMethod eachGroup () -> ListIteratorofgroupnamesSee baseclass for documentation.ObjectMethod eachMembership ($cUID) -> ListIteratorofgroupsthisuserisinSee baseclass for documentation.ObjectMethod isAdmin ($cUID) -> $booleanTrue if the user is an admin
ObjectMethod getEmails ($name) -> @emailAddressIf $name is a cUID, return their email addresses. If it is a group, return the addresses of everyone in the group. | ||||||||
| Added: | ||||||||
| > > | ObjectMethod getUserData ($cUID) -> $dataRefReturn a reference to an array of hashes with user data, used to manage users. Each item is a hash with:
| |||||||
ObjectMethod *findUserByWikiName ($wikiname) -> listofcUIDsassociatedwiththatwikinameSee baseclass for documentation.ObjectMethod checkPassword ($login,$passwordU) -> $booleanFinds if the password is valid for the given user. Returns 1 on success, undef on failure.ObjectMethod setPassword ($cUID,$newPassU,$oldPassU) -> $booleanIf the $oldPassU matches matches the user's password, then it will replace it with $newPassU. If $oldPassU is not correct and not 1, will return 0. If $oldPassU is 1, will force the change irrespective of the existing password, adding the user if necessary. Otherwise returns 1 on success, undef on failure.ObjectMethod passwordError () -> $stringreturns a string indicating the error that happened in the password handlers TODO: these delayed error's should be replaced with Exceptions. returns undef if no error | ||||||||
Revision 12008-08-03 - TWikiContributor
Package =TWiki::Users::BaseUserMappingUser mapping is the process by which TWiki maps from a username (a login name) to a display name and back. It is also where groups are maintained. The BaseMapper provides support for a small number of predefined users. No registration - this is a read only usermapper. It uses the mapper prefix 'BaseUserMapping_'.Users
Groups
On this page:
ClassMethod new ($session)Construct the BaseUserMapping objectObjectMethod finish ()Break circular references.ObjectMethod *loginTemplateName () -> templateFileallows UserMappings to come with customised login screens - that should preffereably only over-ride the UI functionObjectMethod handlesUser ($cUID,$login,$wikiname) -> $booleanSee baseclass for documentation. In the BaseUserMapping case, we know all the details of the users we specialise in.ObjectMethod login2cUID ($login) -> $cUIDConvert a login name to the corresponding canonical user name. The canonical name can be any string of 7-bit alphanumeric and underscore characters, and must correspond 1:1 to the login name. (undef on failure)ObjectMethod getLoginName ($cUID) -> loginconverts an internal cUID to that user's login (undef on failure)ObjectMethod getWikiName ($cUID) -> wikinameMap a canonical user name to a wikinameObjectMethod userExists ($user) -> $booleanDetermine if the user already exists or not.ObjectMethod eachUser () -> listIteratorofcUIDsSee baseclass for documentation.ObjectMethod *eachGroupMember ($group) -> listIteratorofcUIDsSee baseclass for documentation. The basemapper implementation assumes that there are no nested groups in the basemapper.ObjectMethod isGroup ($name) -> booleanSee baseclass for documentation.ObjectMethod eachGroup () -> ListIteratorofgroupnamesSee baseclass for documentation.ObjectMethod eachMembership ($cUID) -> ListIteratorofgroupsthisuserisinSee baseclass for documentation.ObjectMethod isAdmin ($cUID) -> $booleanTrue if the user is an admin
ObjectMethod getEmails ($name) -> @emailAddressIf $name is a cUID, return their email addresses. If it is a group, return the addresses of everyone in the group.ObjectMethod *findUserByWikiName ($wikiname) -> listofcUIDsassociatedwiththatwikinameSee baseclass for documentation.ObjectMethod checkPassword ($login,$passwordU) -> $booleanFinds if the password is valid for the given user. Returns 1 on success, undef on failure.ObjectMethod setPassword ($cUID,$newPassU,$oldPassU) -> $booleanIf the $oldPassU matches matches the user's password, then it will replace it with $newPassU. If $oldPassU is not correct and not 1, will return 0. If $oldPassU is 1, will force the change irrespective of the existing password, adding the user if necessary. Otherwise returns 1 on success, undef on failure.ObjectMethod passwordError () -> $stringreturns a string indicating the error that happened in the password handlers TODO: these delayed error's should be replaced with Exceptions. returns undef if no error |
View topic | History: r2 < r1 | More topic actions...
Copyright © 1999-2024 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.TWikiUsersBaseUserMappingDotPm.