Public Member Functions

InformationCenterHandler Class Reference

Parent class for file/submission information center handlers. More...

Inheritance diagram for InformationCenterHandler:
Handler Handler FileInformationCenterHandler FileInformationCenterHandler SubmissionInformationCenterHandler SubmissionInformationCenterHandler

List of all members.

Public Member Functions

 _getAssocId ()
 _getAssocId ()
 _getAssocType ()
 _getAssocType ()
 _getLinkParams ()
 _getLinkParams ()
 _logEvent ($itemId, $eventType, $userId)
 _logEvent ($itemId, $eventType, $userId)
 authorize (&$request, $args, $roleAssignments)
 authorize (&$request, $args, $roleAssignments)
 deleteNote ($args, &$request)
 deleteNote ($args, &$request)
 InformationCenterHandler ()
 InformationCenterHandler ()
 listHistory ($args, &$request)
 listHistory ($args, &$request)
 listNotes ($args, &$request)
 listNotes ($args, &$request)
 metadata ($args, &$request)
 metadata ($args, &$request)
 saveForm ($args, &$request)
 saveForm ($args, &$request)
 saveNote ($args, &$request)
 saveNote ($args, &$request)
 sendNotification ($args, &$request)
 sendNotification ($args, &$request)
 viewHistory ($args, &$request)
 viewHistory ($args, &$request)
 viewInformationCenter (&$request)
 viewInformationCenter (&$request)
 viewNotes ($args, &$request)
 viewNotes ($args, &$request)
 viewNotify ($args, &$request)
 viewNotify ($args, &$request)

Detailed Description

Parent class for file/submission information center handlers.

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


Member Function Documentation

InformationCenterHandler._getAssocId (  ) 

Get the association ID for this information center view

Returns:
int

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 250 of file InformationCenterHandler.inc.php.

Referenced by deleteNote(), and listNotes().

InformationCenterHandler._getAssocId (  ) 

Get the association ID for this information center view

Returns:
int

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 250 of file InformationCenterHandler.inc.php.

InformationCenterHandler._getAssocType (  ) 

Get the association type for this information center view

Returns:
int

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

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

Referenced by deleteNote().

InformationCenterHandler._getAssocType (  ) 

Get the association type for this information center view

Returns:
int

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

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

InformationCenterHandler._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 in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 214 of file InformationCenterHandler.inc.php.

InformationCenterHandler._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 in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 214 of file InformationCenterHandler.inc.php.

InformationCenterHandler._logEvent ( itemId,
eventType,
userId 
)

Log an event for this item. NB: sub-classes must implement this method.

Parameters:
$args array
$request PKPRequest

Definition at line 205 of file InformationCenterHandler.inc.php.

InformationCenterHandler._logEvent ( itemId,
eventType,
userId 
)

Log an event for this item. NB: sub-classes must implement this method.

Parameters:
$args array
$request PKPRequest

Definition at line 205 of file InformationCenterHandler.inc.php.

InformationCenterHandler.authorize ( &$  request,
args,
roleAssignments 
)
See also:
PKPHandler.authorize()
Parameters:
$request PKPRequest
$args array
$roleAssignments array

Definition at line 58 of file InformationCenterHandler.inc.php.

References authorize().

InformationCenterHandler.authorize ( &$  request,
args,
roleAssignments 
)
See also:
PKPHandler.authorize()
Parameters:
$request PKPRequest
$args array
$roleAssignments array

Definition at line 58 of file InformationCenterHandler.inc.php.

Referenced by authorize().

InformationCenterHandler.deleteNote ( args,
&$  request 
)

Delete a note.

Parameters:
$args array
$request PKPRequest

Definition at line 141 of file InformationCenterHandler.inc.php.

References _getAssocId(), and _getAssocType().

InformationCenterHandler.deleteNote ( args,
&$  request 
)

Delete a note.

Parameters:
$args array
$request PKPRequest

Definition at line 141 of file InformationCenterHandler.inc.php.

References _getAssocId(), and _getAssocType().

InformationCenterHandler.InformationCenterHandler (  ) 
InformationCenterHandler.InformationCenterHandler (  ) 

Constructor

Definition at line 23 of file InformationCenterHandler.inc.php.

InformationCenterHandler.listHistory ( args,
&$  request 
)

Fetch a list of log entries. NB: sub-classes must implement this method.

Parameters:
$args array
$request PKPRequest

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 195 of file InformationCenterHandler.inc.php.

InformationCenterHandler.listHistory ( args,
&$  request 
)

Fetch a list of log entries. NB: sub-classes must implement this method.

Parameters:
$args array
$request PKPRequest

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 195 of file InformationCenterHandler.inc.php.

InformationCenterHandler.listNotes ( args,
&$  request 
)

Display the list of existing notes.

Parameters:
$args array
$request PKPRequest

Definition at line 119 of file InformationCenterHandler.inc.php.

References _getAssocId().

InformationCenterHandler.listNotes ( args,
&$  request 
)

Display the list of existing notes.

Parameters:
$args array
$request PKPRequest

Definition at line 119 of file InformationCenterHandler.inc.php.

References _getAssocId().

InformationCenterHandler.metadata ( args,
&$  request 
)

Display the metadata tab.

Parameters:
$args array
$request PKPRequest

Reimplemented in SubmissionInformationCenterHandler, and SubmissionInformationCenterHandler.

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

InformationCenterHandler.metadata ( args,
&$  request 
)

Display the metadata tab.

Parameters:
$args array
$request PKPRequest

Reimplemented in SubmissionInformationCenterHandler, and SubmissionInformationCenterHandler.

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

InformationCenterHandler.saveForm ( args,
&$  request 
)

Save the metadata tab.

Parameters:
$args array
$request PKPRequest

Reimplemented in SubmissionInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 92 of file InformationCenterHandler.inc.php.

InformationCenterHandler.saveForm ( args,
&$  request 
)

Save the metadata tab.

Parameters:
$args array
$request PKPRequest

Reimplemented in SubmissionInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 92 of file InformationCenterHandler.inc.php.

InformationCenterHandler.saveNote ( args,
&$  request 
)

Save a note. Subclasses must implement.

Parameters:
$args array
$request PKPRequest

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 110 of file InformationCenterHandler.inc.php.

InformationCenterHandler.saveNote ( args,
&$  request 
)

Save a note. Subclasses must implement.

Parameters:
$args array
$request PKPRequest

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 110 of file InformationCenterHandler.inc.php.

InformationCenterHandler.sendNotification ( args,
&$  request 
)

Send a notification from the notify tab. NB: sub-classes must implement this method.

Parameters:
$args array
$request PKPRequest

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 173 of file InformationCenterHandler.inc.php.

InformationCenterHandler.sendNotification ( args,
&$  request 
)

Send a notification from the notify tab. NB: sub-classes must implement this method.

Parameters:
$args array
$request PKPRequest

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 173 of file InformationCenterHandler.inc.php.

InformationCenterHandler.viewHistory ( args,
&$  request 
)

Display the history tab.

Parameters:
$args array
$request PKPRequest

Definition at line 182 of file InformationCenterHandler.inc.php.

InformationCenterHandler.viewHistory ( args,
&$  request 
)

Display the history tab.

Parameters:
$args array
$request PKPRequest

Definition at line 182 of file InformationCenterHandler.inc.php.

InformationCenterHandler.viewInformationCenter ( &$  request  ) 

Display the main information center modal.

Parameters:
$request PKPRequest

Definition at line 72 of file InformationCenterHandler.inc.php.

InformationCenterHandler.viewInformationCenter ( &$  request  ) 

Display the main information center modal.

Parameters:
$request PKPRequest

Definition at line 72 of file InformationCenterHandler.inc.php.

InformationCenterHandler.viewNotes ( args,
&$  request 
)

View a list of notes posted on the item. Subclasses must implement.

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 100 of file InformationCenterHandler.inc.php.

InformationCenterHandler.viewNotes ( args,
&$  request 
)

View a list of notes posted on the item. Subclasses must implement.

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 100 of file InformationCenterHandler.inc.php.

InformationCenterHandler.viewNotify ( args,
&$  request 
)

Display the notify tab. NB: sub-classes must implement this method.

Parameters:
$args array
$request PKPRequest

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 163 of file InformationCenterHandler.inc.php.

InformationCenterHandler.viewNotify ( args,
&$  request 
)

Display the notify tab. NB: sub-classes must implement this method.

Parameters:
$args array
$request PKPRequest

Reimplemented in FileInformationCenterHandler, SubmissionInformationCenterHandler, FileInformationCenterHandler, and SubmissionInformationCenterHandler.

Definition at line 163 of file InformationCenterHandler.inc.php.


The documentation for this class was generated from the following files: