Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
UserApiHandler Class Reference
Inheritance diagram for UserApiHandler:

Public Member Functions

 _settingType ($settingName)
 authorize (&$request, $args, $roleAssignments)
 updateUserMessageState ($args, &$request)
 UserApiHandler ()
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 addPolicy (&$authorizationPolicy, $addToTop=false)
 addRoleAssignment ($roleIds, $operations)
 authorize (&$request, &$args, $roleAssignments)
getAuthorizedContext ()
getAuthorizedContextObject ($assocType)
getDispatcher ()
 getId ()
 getLastAuthorizationMessage ()
 getLoginExemptions ()
getRangeInfo ($rangeName, $contextData=null)
 getRoleAssignment ($roleId)
 getRoleAssignments ()
 hashPageContext ($contextData=array())
 index ()
 initialize (&$request, $args=null)
 PKPHandler ()
 setDispatcher (&$dispatcher)
 setId ($id)
 validate ($requiredContexts=null, $request=null)

Detailed Description

Class defining the headless AJAX API for backend user manipulation.

Definition at line 25 of file

Member Function Documentation

UserApiHandler::_settingType (   $settingName)

Checks the requested setting against a whitelist of settings that can be changed remotely.

string a string representation of the setting type for further validation if the setting is whitelisted, otherwise null.

Definition at line 110 of file

Referenced by updateUserMessageState().

UserApiHandler::authorize ( $request,
See Also

Definition at line 40 of file

References PKPHandler\addPolicy().

UserApiHandler::updateUserMessageState (   $args,

Update the information whether user messages should be displayed or not.

string a JSON message

Definition at line 61 of file

References _settingType(), and DAORegistry\getDAO().

UserApiHandler::UserApiHandler ( )


Definition at line 29 of file

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