Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
InformationCenterHandler Class Reference
Inheritance diagram for InformationCenterHandler:
Handler PKPHandler PKPSubmissionInformationCenterHandler SubmissionInformationCenterHandler

Public Member Functions

 _getAssocId ()
 
 _getAssocType ()
 
 _getLinkParams ()
 
 _logEvent ($itemId, $eventType, $userId)
 
 authorize ($request, &$args, $roleAssignments)
 
 deleteNote ($args, $request)
 
 InformationCenterHandler ()
 
 initialize ($request, $args=null)
 
 listNotes ($args, $request)
 
 metadata ($args, $request)
 
 saveForm ($args, $request)
 
 saveNote ($args, $request)
 
 viewInformationCenter ($request)
 
 viewNotes ($args, $request)
 
- Public Member Functions inherited from Handler
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, $bestGuess=true)
 
 getWorkingContexts ($request)
 
 Handler ()
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getWorkingContexts ($request)
 
 index ($args, $request)
 
 initialize ($request, $args=null)
 
 PKPHandler ()
 
 setDispatcher ($dispatcher)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_roleAssignments = array()
 

Detailed Description

Parent class for file/submission information center handlers.

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

Member Function Documentation

InformationCenterHandler::_getAssocId ( )

Get the association ID for this information center view

Returns
int

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

InformationCenterHandler::_getAssocType ( )

Get the association type for this information center view

Returns
int

Definition at line 236 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. submission ID to the delete note handler).

Returns
array

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

InformationCenterHandler::_logEvent (   $itemId,
  $eventType,
  $userId 
)

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

Parameters
$argsarray
$requestPKPRequest

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

InformationCenterHandler::authorize (   $request,
$args,
  $roleAssignments 
)

Authorize this request.

Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.

NB: This method will be called once for every request only.

Parameters
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
$enforceRestrictedSiteboolean True iff site restrictions are to be enforced
Returns
boolean

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

InformationCenterHandler::deleteNote (   $args,
  $request 
)

Delete a note.

Parameters
$argsarray
$requestPKPRequest

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

InformationCenterHandler::InformationCenterHandler ( )

Constructor

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

InformationCenterHandler::initialize (   $request,
  $args = null 
)

Fetch and store away objects

Parameters
$requestPKPRequest
$argsarray optional

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

InformationCenterHandler::listNotes (   $args,
  $request 
)

Display the list of existing notes.

Parameters
$argsarray
$requestPKPRequest

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

InformationCenterHandler::metadata (   $args,
  $request 
)

Display the metadata tab.

Parameters
$argsarray
$requestPKPRequest

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

InformationCenterHandler::saveForm (   $args,
  $request 
)

Save the metadata tab.

Parameters
$argsarray
$requestPKPRequest

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

InformationCenterHandler::saveNote (   $args,
  $request 
)

Save a note. Subclasses must implement.

Parameters
$argsarray
$requestPKPRequest

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

InformationCenterHandler::viewInformationCenter (   $request)

Display the main information center modal.

Parameters
$requestPKPRequest

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

InformationCenterHandler::viewNotes (   $args,
  $request 
)

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

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


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