Open Journal Systems  3.3.0
StatsPublicationHandler Class Reference
Inheritance diagram for StatsPublicationHandler:
PKPStatsPublicationHandler APIHandler PKPHandler

Data Fields

 $sectionIdsQueryParam = 'sectionIds'
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 

Additional Inherited Members

- Public Member Functions inherited from PKPStatsPublicationHandler
 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 get ($slimRequest, $response, $args)
 
 getAbstract ($slimRequest, $response, $args)
 
 getGalley ($slimRequest, $response, $args)
 
 getMany ($slimRequest, $response, $args)
 
 getManyAbstract ($slimRequest, $response, $args)
 
 getManyGalley ($slimRequest, $response, $args)
 
- Public Member Functions inherited from APIHandler
 convertStringsToSchema ($schema, $params)
 
 getApp ()
 
 getEndpointPattern ()
 
 getEndpoints ()
 
 getEntityId ($parameterName)
 
 getParameter ($parameterName, $default=null)
 
 getRequest ()
 
 getSlimRequest ()
 
 setSlimRequest ($slimRequest)
 
 setupEndpoints ()
 
- 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)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 
- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Protected Member Functions inherited from PKPStatsPublicationHandler
 _processAllowedParams ($requestParams, $allowedParams)
 
 _processSearchPhrase ($searchPhrase, $submissionIds=[])
 
- Protected Member Functions inherited from APIHandler
 _validateStatDates ($params, $dateStartParam='dateStart', $dateEndParam='dateEnd')
 
- Protected Attributes inherited from APIHandler
 $_app
 
 $_endpoints = array()
 
 $_handlerPath = null
 
 $_pathPattern
 
 $_request
 
 $_slimRequest = null
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle API requests for publication statistics.

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

Field Documentation

◆ $sectionIdsQueryParam

string StatsPublicationHandler::$sectionIdsQueryParam = 'sectionIds'

The name of the section ids query param for this application

Definition at line 24 of file StatsPublicationHandler.inc.php.


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