Open Journal Systems  3.3.0
DocumentLibraryHandler Class Reference
Inheritance diagram for DocumentLibraryHandler:
Handler PKPHandler

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 documentLibrary ($args, $request)
 
 getSubmission ()
 
 initialize ($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)
 
 setupTemplate ($request)
 
 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

Submission document library modal handler.

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

Constructor & Destructor Documentation

◆ __construct()

DocumentLibraryHandler::__construct ( )

Constructor.

Reimplemented from PKPHandler.

Definition at line 27 of file DocumentLibraryHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

DocumentLibraryHandler::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.
Returns
boolean

Reimplemented from PKPHandler.

Definition at line 51 of file DocumentLibraryHandler.inc.php.

References PKPHandler\addPolicy().

◆ documentLibrary()

DocumentLibraryHandler::documentLibrary (   $args,
  $request 
)

Display a list of the review form elements within a review form.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 78 of file DocumentLibraryHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and PKPTemplateManager\getManager().

◆ getSubmission()

DocumentLibraryHandler::getSubmission ( )

Get the Submission

Returns
Submission

Definition at line 65 of file DocumentLibraryHandler.inc.php.

References $_submission.

◆ initialize()

DocumentLibraryHandler::initialize (   $request)

Subclasses can override this method to configure the handler.

NB: This method will be called after validation and authorization.

Parameters
$requestPKPRequest

Reimplemented from PKPHandler.

Definition at line 41 of file DocumentLibraryHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and PKPHandler\setupTemplate().

Field Documentation

◆ $_submission

DocumentLibraryHandler::$_submission

The submission

Definition at line 22 of file DocumentLibraryHandler.inc.php.

Referenced by getSubmission().


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