Open Monograph Press  1.1
 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, $enforceRestrictedSite=true)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getWorkingContexts ($request)
 
 index ($args, $request)
 
 initialize ($request, $args=null)
 
 PKPHandler ()
 
 setDispatcher ($dispatcher)
 
 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())
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_roleAssignments = array()
 

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 
)

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.

Parameters
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
$enforceRestrictedSiteboolean True iff site restrictions are to be enforced
Returns
boolean

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: