Open Preprint Systems  3.3.0
PreprintsHandler Class Reference
Inheritance diagram for PreprintsHandler:
Handler PKPHandler

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 
 index ($args, $request)
 
 setupTemplate ($request)
 
- Public Member Functions inherited from PKPHandler
 __construct ()
 
 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)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 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())
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle requests for preprints archive functions.

Definition at line 18 of file PreprintsHandler.inc.php.

Member Function Documentation

◆ authorize()

PreprintsHandler::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 23 of file PreprintsHandler.inc.php.

References PKPHandler\addPolicy().

◆ index()

PreprintsHandler::index (   $args,
  $request 
)

Display the preprint archive listings

Parameters
$argsarray
$requestPKPRequest
Returns
null|JSONMessage

Reimplemented from PKPHandler.

Definition at line 40 of file PreprintsHandler.inc.php.

References PKPServices\get(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), Config\getVar(), PluginRegistry\loadCategory(), and setupTemplate().

◆ setupTemplate()

PreprintsHandler::setupTemplate (   $request)

Set up the basic template.

Parameters
$requestPKPRequest

Reimplemented from PKPHandler.

Definition at line 88 of file PreprintsHandler.inc.php.

References AppLocale\requireComponents().

Referenced by index().


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