Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct () | |
authorizationDenied ($args, $request) | |
authorize ($request, &$args, $roleAssignments) | |
get ($slimRequest, $response, $args) | |
getInterests ($args, $request) | |
getMany ($slimRequest, $response, $args) | |
getReviewers ($slimRequest, $response, $args) | |
index ($args, $request) | |
setLocale ($args, $request) | |
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) | |
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 | |
Base class to handle API requests for user operations.
Handle requests for user functions.
Definition at line 20 of file api/v1/users/PKPUserHandler.inc.php.
PKPUserHandler::__construct | ( | ) |
Constructor
Reimplemented from APIHandler.
Definition at line 25 of file api/v1/users/PKPUserHandler.inc.php.
References APIHandler\getEndpointPattern().
PKPUserHandler::authorizationDenied | ( | $args, | |
$request | |||
) |
Display an authorization denied message.
$args | array |
$request | Request |
Definition at line 81 of file pages/user/PKPUserHandler.inc.php.
References fatalError(), PKPTemplateManager\getManager(), Validation\isLoggedIn(), Validation\redirectLogin(), AppLocale\requireComponents(), and PKPHandler\setupTemplate().
PKPUserHandler::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.
Reimplemented in ProfileHandler.
Definition at line 53 of file api/v1/users/PKPUserHandler.inc.php.
References PKPHandler\addPolicy().
PKPUserHandler::get | ( | $slimRequest, | |
$response, | |||
$args | |||
) |
Get a single user
$slimRequest | Request Slim request object |
$response | Response object |
$args | array arguments |
Definition at line 121 of file api/v1/users/PKPUserHandler.inc.php.
References PKPServices\get(), and APIHandler\getRequest().
PKPUserHandler::getInterests | ( | $args, | |
$request | |||
) |
Get interests for reviewer interests autocomplete.
$args | array |
$request | PKPRequest |
Definition at line 63 of file pages/user/PKPUserHandler.inc.php.
PKPUserHandler::getMany | ( | $slimRequest, | |
$response, | |||
$args | |||
) |
Get a collection of users
$slimRequest | Request Slim request object |
$response | Response object |
$args | array arguments |
Definition at line 67 of file api/v1/users/PKPUserHandler.inc.php.
References HookRegistry\call(), PKPServices\get(), and APIHandler\getRequest().
PKPUserHandler::getReviewers | ( | $slimRequest, | |
$response, | |||
$args | |||
) |
Get a collection of reviewers
$slimRequest | Request Slim request object |
$response | Response object |
$args | array arguments |
Definition at line 148 of file api/v1/users/PKPUserHandler.inc.php.
References HookRegistry\call(), PKPServices\get(), and APIHandler\getRequest().
PKPUserHandler::index | ( | $args, | |
$request | |||
) |
Index page; redirect to profile
Reimplemented from PKPHandler.
Definition at line 23 of file pages/user/PKPUserHandler.inc.php.
PKPUserHandler::setLocale | ( | $args, | |
$request | |||
) |
Change the locale for the current user.
$args | array first parameter is the new locale |
Definition at line 31 of file pages/user/PKPUserHandler.inc.php.
References PKPLocale\isLocaleValid().