NAME

Krang::CGI::Contrib - web interface to manage Contributors

SYNOPSIS

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

DESCRIPTION

Krang::CGI::Contrib provides a web-based system through which users can add, modify or delete Contributors in a Krang instance.

This web application also provides facilities through which Contributors may be associated with Media and Story objects.

INTERFACE

Krang::CGI::Contrib is expected to be invoked via a CGI ``instance script''. The requested run-mode is specified via the query parameter ``rm''. For example, the following request would invoke the ``add'' run-mode:

  http://server-name/contributor.pl?rm=add

Following are descriptions of all the run-modes provided by Krang::CGI::Contrib. The default run-mode (start_mode) for Krang::CGI::Contrib is 'search'.

Run-Modes

• search
  
Display a list of matching contributors, or all contributors if no filter text is provided.

This run-mode expects an optional parameters ``search_filter'' which is expected to contain the text string which is used to query contributors.

• associate_story
  
Invoked by direct link from Krang::CGI::Story, this run-mode provides an entry point through which Contributors may be associated with Story objects.

It is expected that the story object with which we are to associate contributors be available via the %session in the key 'story'.

When the user clicks ``save'' or ``cancel'' they will be returned to the ``edit'' run-mode of Krang::CGI::Story, e.g.:

  http://server/story.pl?rm=edit

• associate_media
  
Invoked by direct link from Krang::CGI::Media, this run-mode provides an entry point through which Contributors may be associated with Media objects.

It is expected that the media object with which we are to associate contributors be available via the %session in the key 'media'.

When the user clicks ``save'' or ``cancel'' they will be returned to the ``edit'' run-mode of Krang::CGI::Media, e.g.:

  http://server/media.pl?rm=edit

• associate_search
  
This run-mode is activated in place of run-mode ``search'' when CGI parameter ``associate_mode'' is set. It builds the ``edit contributors'' screen, which contains a search interface, as well as a means to add or remove contributors from either media or story objects.

This run-mode expects the parameter ``associate_mode'' to exist in the query, and for it to contain either ``story'' or ``media''. It also expects that a story or media object will be stored in the %session in a key ``story'' or ``media'', respectively.

• associate_selected
  
Remove the selected contributors from the current story or media object. Return to associate_search mode.

This run-mode expects the parameter ``associate_mode'' to exist in the query, and for it to contain either ``story'' or ``media''. It also expects that a story or media object will be stored in the %session in a key ``story'' or ``media'', respectively.

• unassociate_selected
  
Remove the selected contributors from the current story or media object. Return to associate_search.

This run-mode expects the parameter ``associate_mode'' to exist in the query, and for it to contain either ``story'' or ``media''. It also expects that a story or media object will be stored in the %session in a key ``story'' or ``media'', respectively.

• reorder_contribs
  
Reorder the contributors associated with the current story or media object. Return to associate_search.

This run-mode expects the parameter ``associate_mode'' to exist in the query, and for it to contain either ``story'' or ``media''. It also expects that a story or media object will be stored in the %session in a key ``story'' or ``media'', respectively.

• delete_selected
  
Delete a set of contribuitors, specified by check-mark on the ``Contributor List'' screen provided by the ``search'' run-mode. Return to the ``search'' run-mode.

This mode expects the query param ``krang_pager_rows_checked'' to contain an array of contrib_id values which correspond to contributor records to be deleted.

• add
  
Display an ``Add Contributor'' screen, through which users may create a new Contributor object.
• save_add
  
Insert the Contributor object which was specified on the ``Add Contributor'' screen. Return to the ``search'' run-mode.

This run-mode retrieves a temporary $contributor which was created and stored in the %session by the ``add'' mode. By working with a temporary contributor object we don't have to worry about the user inadvertantly creating a deplicate contributor if thay hit reload/refresh on their web browser.

This mode expects to receive parameters which match the name of the contrib properties, excluding ``contrib_id''.

• cancel_add
  
Cancel the addition of a Contributor object which was specified on the ``Add Contributor'' screen. Return to the ``search'' run-mode.
• save_stay_add
  
Insert the Contributor object which was specified on the ``Add Contributor'' screen. Go to the ``Edit Contributor'' screen (``edit'' run-mode), so that further edits may be made.

This mode functions exactly the same as ``save_add'', with the exception that the user is returned to the ``edit'' mode when they are done.

• edit
  
Display an ``Edit Contributor'' screen, through which users may edit an existing Contributor object. Pre-populate form with properties of Contributor selected on the ``Contributor List'' screen.

This run-mode expects to receive the required parameter ``contrib_id''. It will croak() if this parameter is missing or invalid.

• save_edit
  
Update the Contributor object as specified on the ``Edit Contributor'' screen. Return to the ``search'' run-mode.

This run-mode retrieves the $contributor which was created and stored in the %session by the ``edit'' mode.

This mode expects to receive parameters which match the name of the contrib properties. This parameters will override the properties of the contributor which are in the database, except for ``contrib_id'' which cannot be changed.

• cancel_edit
  
Cancel the edit of the Contributor object currently on the ``Edit Contributor'' screen. Return to the ``search'' run-mode.
• save_stay_edit
  
Update the Contributor object as specified on the ``Edit Contributor'' screen. Return to the ``Edit Contributor'' screen (``edit'' run-mode), so that further edits may be made.

This mode functions exactly the same as ``save_edit'', with the exception that the user is returned to the ``edit'' mode when they are done.

• delete
  
Delete the Contributor object currently on the ``Edit Contributor'' screen. Return to the ``search'' run-mode.

This mode expects to receive a query parameter ``contrib_id'' which contains the contributor to be deleted.