Inheritance diagram for InformationCenterHandler:

Public Member Functions
	__construct ()

	_getAssocId ()

	_getAssocType ()

	_getLinkParams ()

	_listNotes ($args, $request)

	_logEvent ($request, $object, $eventType, $logClass)

	authorize ($request, &$args, $roleAssignments)

	deleteNote ($args, $request)

	initialize ($request)

	saveNote ($args, $request)

	setupTemplate ($request)

	viewInformationCenter ($args, $request)

	viewNotes ($args, $request)

Public Member Functions inherited from PKPHandler
	addPolicy ($authorizationPolicy, $addToTop=false)

	addRoleAssignment ($roleIds, $operations)

	getApiToken ()

&	getAuthorizedContext ()

&	getAuthorizedContextObject ($assocType)

&	getDispatcher ()

	getFirstUserContext ($user, $contexts)

	getId ()

	getLastAuthorizationMessage ()

	getRoleAssignment ($roleId)

	getRoleAssignments ()

	getSiteRedirectContext ($request)

	getTargetContext ($request, &$contextsCount=null)

	index ($args, $request)

	markRoleAssignmentsChecked ()

	requireSSL ()

	setApiToken ($apiToken)

	setDispatcher ($dispatcher)

	setEnforceRestrictedSite ($enforceRestrictedSite)

	setId ($id)

	validate ($requiredContexts=null, $request=null)

Data Fields
	$_submission

Data Fields inherited from PKPHandler
	$_authorizationDecisionManager

	$_checks = array()

	$_dispatcher

	$_enforceRestrictedSite = true

	$_id

	$_isBackendPage = false

	$_roleAssignments = array()

	$_roleAssignmentsChecked = false

Additional Inherited Members
Static Public Member Functions inherited from PKPHandler
static	getPageParamName ($rangeName)

static	getRangeInfo ($request, $rangeName, $contextData=null)

static	hashPageContext ($request, $contextData=array())

Protected Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Parent class for file/submission information center handlers.

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

Constructor & Destructor Documentation

◆ __construct()

InformationCenterHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Reimplemented in FileInformationCenterHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _getAssocId()

InformationCenterHandler::_getAssocId ( )

abstract

Get the association ID for this information center view

Returns: int

Reimplemented in FileInformationCenterHandler, and SubmissionInformationCenterHandler.

◆ _getAssocType()

InformationCenterHandler::_getAssocType ( )

abstract

Get the association type for this information center view

Returns: int

Reimplemented in FileInformationCenterHandler, and SubmissionInformationCenterHandler.

◆ _getLinkParams()

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

Reimplemented in FileInformationCenterHandler.

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

Referenced by setupTemplate(), and SubmissionInformationCenterHandler\viewHistory().

◆ _listNotes()

InformationCenterHandler::_listNotes	(	$args,
		$request
	)

Display the list of existing notes.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

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

References DAORegistry\getDAO(), PKPTemplateManager\getManager(), and setupTemplate().

Referenced by SubmissionInformationCenterHandler\viewNotes(), and FileInformationCenterHandler\viewNotes().

◆ _logEvent()

InformationCenterHandler::_logEvent	(	$request,
		$object,
		$eventType,
		$logClass
	)

Log an event for this file or submission

Parameters

$request	PKPRequest
$object	Submission or SubmissionFile
$eventType	int SUBMISSION_LOG_...
$logClass	SubmissionLog or SubmissionFileLog

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

Referenced by SubmissionInformationCenterHandler\saveNote(), and FileInformationCenterHandler\saveNote().

◆ authorize()

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