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

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 UserApiHandler.inc.php.

Member Function Documentation

UserApiHandler::_settingType (   $settingName)

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

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

Definition at line 110 of file UserApiHandler.inc.php.

Referenced by updateUserMessageState().

UserApiHandler::authorize ( $request,
  $args,
  $roleAssignments 
)
See Also
PKPHandler::authorize()

Definition at line 40 of file UserApiHandler.inc.php.

References PKPHandler\addPolicy().

UserApiHandler::updateUserMessageState (   $args,
$request 
)

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

Parameters
$argsarray
$requestPKPRequest
Returns
string a JSON message

Definition at line 61 of file UserApiHandler.inc.php.

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

UserApiHandler::UserApiHandler ( )

Constructor.

Definition at line 29 of file UserApiHandler.inc.php.


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