PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

---

Parent package: Foswiki::UI
Child packages:

More ...Less ...

internal package Foswiki::UI::Register

User registration handling.

StaticMethod register_cgi( $session )

register command handler. This method is designed to be invoked via the UI::run method.

StaticMethod bulkRegister($session)

Called by ManageCgiScript::bulkRegister (requires authentication) with topic = the page with the entries on it.

NB. bulkRegister is invoked from ManageCgiScript. Why? Who knows.

StaticMethod deleteUser($session)

CGI function that deletes the current user Renames the current user's topic (with renaming all links) and removes user entry from passwords.

NB. deleteUser is invoked from the manage script.

StaticMethod addUserToGroup($session)

adds users to a group

• groupname parameter must a a single groupname (group does not have to exist)
• username can be a single login/wikiname/(cuid?), a URLParam list, or a comma separated list.

NB. Invoked from the manage script

StaticMethod removeUserFromGroup($session)

Removes users from a group

• groupname parameter must a a single groupname (group does not have to exist)
• username can be a single login/wikiname/(cuid?), a URLParam list, or a comma separated list.

NB. Invoked from the manage script

StaticMethod expirePendingRegistrations()

This routine expires registration files. This is called by tick_foswiki to expire stale registrations.

_processDeleteUser()

Removes the user from the installation.