|
Open Monograph Press
3.3.0
|
Public Member Functions | |
| __construct () | |
| authorize ($request, &$args, $roleAssignments) | |
| get ($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) | |
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 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 | |
Handle API requests for publication statistics.
Definition at line 20 of file PKPStatsUserHandler.inc.php.
| PKPStatsUserHandler::__construct | ( | ) |
Constructor
Reimplemented from APIHandler.
Definition at line 25 of file PKPStatsUserHandler.inc.php.
References APIHandler\getEndpointPattern().
| PKPStatsUserHandler::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.
| $request | Request |
| $args | array request arguments |
| $roleAssignments | array the operation role assignment, see getRoleAssignment() for more details. |
Reimplemented from PKPHandler.
Definition at line 42 of file PKPStatsUserHandler.inc.php.
References PKPHandler\addPolicy().
| PKPStatsUserHandler::get | ( | $slimRequest, | |
| $response, | |||
| $args | |||
| ) |
Get user stats
Returns the count of users broken down by roles
| $slimRequest | Request Slim request object |
| $response | object Response |
| $args | array |
Definition at line 68 of file PKPStatsUserHandler.inc.php.
References APIHandler\_validateStatDates(), HookRegistry\call(), PKPServices\get(), and APIHandler\getRequest().