Open Journal Systems  3.3.0
OAIHandler Class Reference
Inheritance diagram for OAIHandler:
Handler PKPHandler

Public Member Functions

 index ($args, $request)
 
 requireSSL ()
 
 validate ($requiredContexts=null, $request=null)
 
- Public Member Functions inherited from PKPHandler
 __construct ()
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments)
 
 getApiToken ()
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, &$contextsCount=null)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 setupTemplate ($request)
 

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
 

Detailed Description

Handle OAI protocol requests.

Definition at line 23 of file OAIHandler.inc.php.

Member Function Documentation

◆ index()

OAIHandler::index (   $args,
  $request 
)
Parameters
$argsarray
$requestPKPRequest

Reimplemented from PKPHandler.

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

References Config\getVar(), PluginRegistry\loadCategory(), and validate().

◆ requireSSL()

OAIHandler::requireSSL ( )
See also
PKPHandler::requireSSL()

Reimplemented from PKPHandler.

Definition at line 66 of file OAIHandler.inc.php.

◆ validate()

OAIHandler::validate (   $requiredContexts = null,
  $request = null 
)

Perform data integrity checks.

This method will be called once for every request only.

NB: Any kind of authorization check is now deprecated within this method. This method is purely meant for data integrity checks that do not lead to denial of access to resources (e.g. via redirect) like handler operations or data objects.

Parameters
$requiredContextsarray
$requestRequest

Reimplemented from PKPHandler.

Definition at line 45 of file OAIHandler.inc.php.

References Config\getVar(), and PKPHandler\setApiToken().

Referenced by index().


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