Public Member Functions

FileInformationCenterHandler Class Reference

Handle requests to view the information center for a file. More...

Inheritance diagram for FileInformationCenterHandler:
InformationCenterHandler Handler

List of all members.

Public Member Functions

 _getAssocId ()
 _getAssocType ()
 _getLinkParams ()
 _logEvent ($request, $eventType)
 FileInformationCenterHandler ()
 initialize (&$request, $args=null)
 listHistory ($args, &$request)
 listPastHistory ($args, &$request)
 listPastNotes ($args, &$request)
 saveNote ($args, &$request)
 sendNotification ($args, &$request)
 setupTemplate ($request)
 viewInformationCenter ($args, &$request)
 viewNotes ($args, &$request)
 viewNotify ($args, &$request)

Detailed Description

Handle requests to view the information center for a file.

Definition at line 19 of file FileInformationCenterHandler.inc.php.

Member Function Documentation

FileInformationCenterHandler._getAssocId (  ) 

Get the association ID for this information center view

Returns:
int

Reimplemented from InformationCenterHandler.

Definition at line 292 of file FileInformationCenterHandler.inc.php.

FileInformationCenterHandler._getAssocType (  ) 

Get the association type for this information center view

Returns:
int

Reimplemented from InformationCenterHandler.

Definition at line 300 of file FileInformationCenterHandler.inc.php.

Referenced by listPastNotes().

FileInformationCenterHandler._getLinkParams (  ) 

Get an array representing link parameters that subclasses need to have passed to their various handlers (i.e. monograph ID to the delete note handler). Subclasses should implement.

Reimplemented from InformationCenterHandler.

Definition at line 280 of file FileInformationCenterHandler.inc.php.

FileInformationCenterHandler._logEvent ( $  request,
$  eventType 
)

Log an event for this file

Parameters:
$request PKPRequest
$eventType int MONOGRAPH_LOG_...

Definition at line 258 of file FileInformationCenterHandler.inc.php.

References MonographFileLog.logEvent().

Referenced by saveNote(), and sendNotification().

FileInformationCenterHandler.FileInformationCenterHandler (  ) 

Constructor

Definition at line 29 of file FileInformationCenterHandler.inc.php.

References InformationCenterHandler.InformationCenterHandler().

FileInformationCenterHandler.initialize ( &$  request,
$  args = null 
)

Fetch and store away objects

Definition at line 46 of file FileInformationCenterHandler.inc.php.

FileInformationCenterHandler.listHistory ( $  args,
&$  request 
)

Fetch the contents of the event log.

Parameters:
$args array
$request PKPRequest

Reimplemented from InformationCenterHandler.

Definition at line 206 of file FileInformationCenterHandler.inc.php.

References setupTemplate().

FileInformationCenterHandler.listPastHistory ( $  args,
&$  request 
)

Display the list of history log entries from prior files.

Parameters:
$args array
$request PKPRequest

Definition at line 226 of file FileInformationCenterHandler.inc.php.

References setupTemplate().

FileInformationCenterHandler.listPastNotes ( $  args,
&$  request 
)

Display the list of existing notes from prior files.

Parameters:
$args array
$request PKPRequest

Definition at line 99 of file FileInformationCenterHandler.inc.php.

References _getAssocType(), and setupTemplate().

FileInformationCenterHandler.saveNote ( $  args,
&$  request 
)

Save a note.

Parameters:
$args array
$request PKPRequest

Reimplemented from InformationCenterHandler.

Definition at line 132 of file FileInformationCenterHandler.inc.php.

References _logEvent(), and setupTemplate().

FileInformationCenterHandler.sendNotification ( $  args,
&$  request 
)

Send a notification from the notify tab.

Parameters:
$args array
$request PKPRequest

Reimplemented from InformationCenterHandler.

Definition at line 177 of file FileInformationCenterHandler.inc.php.

References _logEvent(), and setupTemplate().

FileInformationCenterHandler.setupTemplate ( $  request  ) 

Set up the template

Parameters:
$request PKPRequest

Definition at line 308 of file FileInformationCenterHandler.inc.php.

Referenced by listHistory(), listPastHistory(), listPastNotes(), saveNote(), sendNotification(), viewInformationCenter(), viewNotes(), and viewNotify().

FileInformationCenterHandler.viewInformationCenter ( $  args,
&$  request 
)

Display the main information center modal.

Parameters:
$args array
$request PKPRequest

Definition at line 64 of file FileInformationCenterHandler.inc.php.

References setupTemplate().

FileInformationCenterHandler.viewNotes ( $  args,
&$  request 
)

Display the notes tab.

Parameters:
$args array
$request PKPRequest

Reimplemented from InformationCenterHandler.

Definition at line 83 of file FileInformationCenterHandler.inc.php.

References setupTemplate().

FileInformationCenterHandler.viewNotify ( $  args,
&$  request 
)

Display the notify tab.

Parameters:
$args array
$request PKPRequest

Reimplemented from InformationCenterHandler.

Definition at line 161 of file FileInformationCenterHandler.inc.php.

References setupTemplate().

The documentation for this class was generated from the following file:
Generated on Mon Sep 17 2012 13:58:57 for Open Monograph Press by  doxygen 1.7.1