Difference: TWikiUsersDotPm (1 vs. 3)

Revision 32007-01-16 - TWikiContributor

	Package `TWiki::Users`
Added:
> >
	Singleton object that handles mapping of users to wikinames and vice versa, and user authentication checking. Package TWiki::Users ClassMethod new `($session,$impl)` ObjectMethod finish ObjectMethod findUser `($name[,$wikiname][,$nocreate]) -> $userObject` ObjectMethod findUserByEmail `($email) -> \@users` ObjectMethod createUser `($login,$wikiname) -> $userobject` ObjectMethod addUserToMapping `($user) -> $topicName` ClassMethod new `($session,$impl)`
Added:
> >
	Construct the user management object ObjectMethod finish
Added:
> >
	Complete processing after the client's HTTP request has been responded to. breaking circular references to allow garbage collection in persistent environments ObjectMethod findUser `($name[,$wikiname][,$nocreate]) -> $userObject` `$name` - login name or wiki name `$wikiname` - optional, wikiname for created user `$nocreate` - optional, disable creation of user object for user not found Find the user object corresponding to `$name`, which may be either a login name or a wiki name. If `$name` is found (either in the list of login names or the list of wiki names) the corresponding user object is returned. In this case `$wikiname` is ignored. If they are not found, and `$nocreate` is true, then return undef. If `$nocreate` is false, then a user object is returned even if the user is not known. If `$nocreate` is false, and no `$wikiname` is given, then the `$name` is used for both login name and wiki name. If nocreate is off, then a default user will be created with their wikiname set the same as their login name. This user/wiki name pair can be overridden by a later createUser call when the correct wikiname is known, if necessary.
Added:
> >	ObjectMethod findUserByEmail `($email) -> \@users` `$email` - email address to look up Return a list of user objects for the users that have this email registered with the password manager.
	ObjectMethod createUser `($login,$wikiname) -> $userobject`
Added:
> >
	Create a user, and insert them in the maps (overwriting any current entry). Use this instead of findUser when you want to be sure you are not going to pick up any default user created by findUser. All parameters are required. ObjectMethod addUserToMapping `($user) -> $topicName` Add a user to the persistant mapping that maps from usernames to wikinames and vice-versa.
Deleted:
< <	ObjectMethod initializeRemoteUser `($remoteUser) -> $loginName` Return value: $remoteUser Acts as a filter for $remoteUser. If set, $remoteUser is filtered for insecure characters and untainted. If not user is passed, the remote user defaults to $cfg{DefaultUserLogin} (usually 'guest'). If we got here via an authentication status failure, then the remote user is set to blank, effectively signalling an illegal access. If no remote user name was passed in, the user defaults to $cfg{DefaultUserLogin}.

Revision 22006-06-25 - TWikiContributor

  Package TWiki::Users 
Singleton object that handles mapping of users to wikinames and
vice versa, and user authentication checking.


 
  Package TWiki::Users 
  ClassMethod new ($session,$impl)
   ObjectMethod finish 
   ObjectMethod findUser ($name[,$wikiname][,$nocreate]) -> $userObject
   ObjectMethod findUserByEmail ($email) -> \@users
   ObjectMethod createUser ($login,$wikiname) -> $userobject
   ObjectMethod addUserToMapping ($user) -> $topicName
 
 


 ClassMethod new ($session,$impl) 
Construct the user management object
->
>
+ ObjectMethod finish  
Complete processing after the client's HTTP request has been responded
to. 
 breaking circular references to allow garbage collection in persistent     environments
  ObjectMethod findUser ($name[,$wikiname][,$nocreate]) -> $userObject 
 

 $name - login name or wiki name
  $wikiname - optional, wikiname for created user
-<
<
+ $nocreate - optional, disable creation of user object for user not found in TWikiUsers?
->
>
+ $nocreate - optional, disable creation of user object for user not found
 Find the user object corresponding to $name, which may be either a
-<
<
+login name or a wiki name. The name is looked up in the
->
>
+login name or a wiki name. If $name is found (either in the list
-<
<
+TWikiUsers? topic. If $name is found (either in the list
 of login names or the list of wiki names) the corresponding
user object is returned. In this case $wikiname is ignored.

If they are not found, and $nocreate is true, then return undef.

If $nocreate is false, then a user object is returned even if
-<
<
+the user is not listed in TWikiUsers?.
->
>
+the user is not known.
 If $nocreate is false, and no $wikiname is given, then the
$name is used for both login name and wiki name.

If nocreate is off, then a default user will be created with their wikiname
set the same as their login name. This user/wiki name pair can be overridden
by a later createUser call when the correct wikiname is known, if necessary.



 ObjectMethod createUser ($login,$wikiname) -> $userobject 
Create a user, and insert them in the maps (overwriting any current entry).
Use this instead of findUser when you want to be sure you are not going to
pick up any default user created by findUser. All parameters are required.
-<
<
+ ObjectMethod addUserToTWikiUsersTopic ($user) -> $topicName
->
>
+ ObjectMethod addUserToMapping ($user) -> $topicName
-<
<
+Add a user to the TWikiUsers? topic. This is a topic that
maps from usernames to wikinames. It is maintained by
->
>
+Add a user to the persistant mapping that maps from usernames to wikinames
and vice-versa.
-<
<
+Register.pm, or manually outside TWiki.
  ObjectMethod initializeRemoteUser ($remoteUser) -> $loginName 

Return value: $remoteUser

Acts as a filter for $remoteUser.  If set, $remoteUser is filtered for
insecure characters and untainted.

If not user is passed, the remote user defaults to $cfg{DefaultUserLogin}
(usually 'guest').

If we got here via an authentication status failure, then the remote user
is set to blank, effectively signalling an illegal access.

If no remote user name was passed in, the user defaults to
$cfg{DefaultUserLogin}.

Revision 12006-02-01 - TWikiContributor

Package `TWiki::Users`

Singleton object that handles mapping of users to wikinames and vice versa, and user authentication checking.

Package TWiki::Users

ClassMethod new `($session,$impl)`

Construct the user management object

ObjectMethod findUser `($name[,$wikiname][,$nocreate]) -> $userObject`

$name - login name or wiki name
$wikiname - optional, wikiname for created user
$nocreate - optional, disable creation of user object for user not found in TWikiUsers?

Find the user object corresponding to $name, which may be either a login name or a wiki name. The name is looked up in the TWikiUsers? topic. If $name is found (either in the list of login names or the list of wiki names) the corresponding user object is returned. In this case $wikiname is ignored.

If they are not found, and $nocreate is true, then return undef.

If $nocreate is false, then a user object is returned even if the user is not listed in TWikiUsers?.

If $nocreate is false, and no $wikiname is given, then the $name is used for both login name and wiki name.

If nocreate is off, then a default user will be created with their wikiname set the same as their login name. This user/wiki name pair can be overridden by a later createUser call when the correct wikiname is known, if necessary.

ObjectMethod createUser `($login,$wikiname) -> $userobject`

Create a user, and insert them in the maps (overwriting any current entry). Use this instead of findUser when you want to be sure you are not going to pick up any default user created by findUser. All parameters are required.

ObjectMethod addUserToTWikiUsersTopic `($user) -> $topicName`

Add a user to the TWikiUsers? topic. This is a topic that maps from usernames to wikinames. It is maintained by Register.pm, or manually outside TWiki.

ObjectMethod initializeRemoteUser `($remoteUser) -> $loginName`

Return value: $remoteUser

Acts as a filter for $remoteUser. If set, $remoteUser is filtered for insecure characters and untainted.

If not user is passed, the remote user defaults to $cfg{DefaultUserLogin} (usually 'guest').

If we got here via an authentication status failure, then the remote user is set to blank, effectively signalling an illegal access.

If no remote user name was passed in, the user defaults to $cfg{DefaultUserLogin}.

View topic | History: r3 < r2 < r1 | More topic actions...

Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding KoreaCmsWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiUsersDotPm

Difference: TWikiUsersDotPm (1 vs. 3)

Revision 32007-01-16 - TWikiContributor

Package `TWiki::Users`

ClassMethod new `($session,$impl)`

ObjectMethod finish

ObjectMethod findUser `($name[,$wikiname][,$nocreate]) -> $userObject`

ObjectMethod findUserByEmail `($email) -> \@users`

ObjectMethod createUser `($login,$wikiname) -> $userobject`

ObjectMethod addUserToMapping `($user) -> $topicName`

ObjectMethod initializeRemoteUser `($remoteUser) -> $loginName`

Revision 22006-06-25 - TWikiContributor

Package `TWiki::Users`

ClassMethod new `($session,$impl)`

ObjectMethod finish

ObjectMethod findUser `($name[,$wikiname][,$nocreate]) -> $userObject`

ObjectMethod createUser `($login,$wikiname) -> $userobject`

ObjectMethod addUserToTWikiUsersTopic `($user) -> $topicName`

ObjectMethod addUserToMapping `($user) -> $topicName`

ObjectMethod initializeRemoteUser `($remoteUser) -> $loginName`

Revision 12006-02-01 - TWikiContributor

Package `TWiki::Users`

ClassMethod new `($session,$impl)`

ObjectMethod findUser `($name[,$wikiname][,$nocreate]) -> $userObject`

ObjectMethod createUser `($login,$wikiname) -> $userobject`

ObjectMethod addUserToTWikiUsersTopic `($user) -> $topicName`

ObjectMethod initializeRemoteUser `($remoteUser) -> $loginName`