NAME

Krang::CGI::User - Abstract of web application....

SYNOPSIS

  use Krang::ClassLoader 'CGI::User';
  my $app = pkg('CGI::User')->new();
  $app->run();

DESCRIPTION

Overview of functionality and purpose of web application module Krang::CGI::User...

INTERFACE

RUN MODES

• add
  
Displays the ``Add User'' screen by means of which a new user object can be added to the system.
• cancel_add
  
Cancels edit of user object on ``Add User'' screen and returns to 'search' run mode.
• save_add
  
Saves user object visible on 'add' screen. Returns to 'search' run mode.

It retrieves the user from the session object and overwrites the fields of this object with the query parameters passed to this run mode, with the exception of the 'user_id'.

The 'new_password' field and 'confirm_password' fields are compared for equality is they are equal the value in 'new_password' will be MD5'd and stored in the password field, otherwise the end-user will be returned to the 'edit' screen.

The password will also be checked by the PasswordHandler and if validation fails, the user will be returned to the 'add' screen.

• save_stay_add
  
Saves user object to the database and redirects to the ``Edit User'' screen.

This mode function just like the 'save_add' run mode except for redirecting the user to 'edit' run mode.

• delete
  
Deletes the user from 'edit' screen and redirects to 'search' run mode.

It expects a 'user_id' query param.

• delete_selected
  
Deletes User objects selected from the 'search' screen. Returns to 'search' afterwards.

This mode expects the 'krang_pager_rows_checked' param which should contain an array of 'user_id's signifying the user objects to be deleted.

• edit
  
Display a screen allowing the end-user to edit the User object selected from the 'search' screen.

This run mode expects a 'user_id' query param and it will croak if it's missing or invalid.

N.B - propagate query params supercede object field values in populating form fields, so errant values are preserved for correction.

• cancel_edit
  
Cancels edit of user object on ``Edit User'' screen and returns to 'search' run mode.
• save_edit
  
Updates user object visible on 'edit' screen. Returns to 'search' run mode.

It retrieves the user from the session object and overwrites the fields of this object with the query parameters passed to this run mode, with the exception of the 'user_id'.

The 'new_password' field and 'confirm_password' fields are compared for equality is they are equal the value in 'new_password' will be MD5'd and stored in the password field, otherwise the end-user will be returned to the 'edit' screen.

• save_stay_edit
  
Updates user object in database and returns/remains on the ``Edit User'' screen.

This mode function just like the 'save_edit' run mode except for redirecting the user to 'edit' run mode.

• search
  
Display a list of all users or those matching the supplied search criteria.

This run mode accepts the optional parameter ``search_filter'' which is expected to contain a text string which will in turn be used to query users.

TO DO

Instead of failing to delete a user if he has assets checked out, we should check all of his assets in and then perform the deletion.