Open Journal Systems
3.3.0
|
Public Member Functions | |
_settingType ($settingName) | |
authorize ($request, &$args, $roleAssignments) | |
suggestUsername ($args, $request) | |
updateUserMessageState ($args, $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) | |
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 Attributes inherited from PKPHandler | |
$_apiToken = null | |
Class defining the headless AJAX API for backend user manipulation.
Definition at line 25 of file UserApiHandler.inc.php.
UserApiHandler::_settingType | ( | $settingName | ) |
Checks the requested setting against a whitelist of settings that can be changed remotely.
$settingName | string |
Definition at line 117 of file UserApiHandler.inc.php.
Referenced by updateUserMessageState().
UserApiHandler::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 33 of file UserApiHandler.inc.php.
References PKPHandler\addPolicy().
UserApiHandler::suggestUsername | ( | $args, | |
$request | |||
) |
Get a suggested username, making sure it's not already used.
$args | array |
$request | PKPRequest |
Definition at line 100 of file UserApiHandler.inc.php.
References Validation\suggestUsername().
UserApiHandler::updateUserMessageState | ( | $args, | |
$request | |||
) |
Update the information whether user messages should be displayed or not.
$args | array |
$request | PKPRequest |
Definition at line 54 of file UserApiHandler.inc.php.
References _settingType(), fatalError(), and DAORegistry\getDAO().