OAIHandler Class Reference

Inheritance diagram for OAIHandler:

Public Member Functions
	__construct ()
	authorize ($request, &$args, $roleAssignments)
	index ($args, $request)
Public Member Functions inherited from PKPHandler
	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)
	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

Detailed Description

Handle OAI protocol requests.

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

Constructor & Destructor Documentation

__construct()

OAIHandler::__construct

(

)

Constructor

Reimplemented from PKPHandler.

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

Member Function Documentation

authorize()

OAIHandler::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

$request	Request
$args	array request arguments
$roleAssignments	array the operation role assignment, see getRoleAssignment() for more details.

Returns

boolean

Reimplemented from PKPHandler.

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

References Config\getVar().

index()

OAIHandler::index	(		$args,
			$request
	)

Handle an OAI request.

Parameters

$args	array
$request	PKPRequest

Reimplemented from PKPHandler.

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

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

---

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

• OAIHandler.inc.php