OrcidHandler Class Reference

Inheritance diagram for OrcidHandler:

Public Member Functions
	_setOrcidData ($userOrAuthor, $orcidUri, $orcidResponse)
	about ($args, $request)
	authorize ($request, &$args, $roleAssignments)
	orcidAuthorize ($args, $request)
	orcidVerify ($args, $request)
Public Member Functions inherited from PKPHandler
	__construct ()
	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)
	index ($args, $request)
	initialize ($request)
	markRoleAssignmentsChecked ()
	requireSSL ()
	setApiToken ($apiToken)
	setDispatcher ($dispatcher)
	setEnforceRestrictedSite ($enforceRestrictedSite)
	setId ($id)
	setupTemplate ($request)
	validate ($requiredContexts=null, $request=null)

Data Fields
const	TEMPLATE = 'orcidVerify.tpl'
Data Fields inherited from PKPHandler
	$_authorizationDecisionManager
	$_checks = array()
	$_dispatcher
	$_enforceRestrictedSite = true
	$_id
	$_isBackendPage = false
	$_roleAssignments = array()
	$_roleAssignmentsChecked = false

Additional Inherited Members
Static Public Member Functions inherited from PKPHandler
static	getPageParamName ($rangeName)
static	getRangeInfo ($request, $rangeName, $contextData=null)
static	hashPageContext ($request, $contextData=array())
Protected Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Pass off internal ORCID API requests to ORCID.

Definition at line 19 of file OrcidHandler.inc.php.

Member Function Documentation

_setOrcidData()

OrcidHandler::_setOrcidData	(		$userOrAuthor,
			$orcidUri,
			$orcidResponse
	)

Definition at line 332 of file OrcidHandler.inc.php.

Referenced by orcidAuthorize(), and orcidVerify().

about()

OrcidHandler::about	(		$args,
			$request
	)

Definition at line 351 of file OrcidHandler.inc.php.

References PKPTemplateManager\getManager(), and PluginRegistry\getPlugin().

authorize()

OrcidHandler::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 25 of file OrcidHandler.inc.php.

References $op, PKPHandler\addPolicy(), Config\getVar(), and PKPHandler\setEnforceRestrictedSite().

orcidAuthorize()

OrcidHandler::orcidAuthorize	(		$args,
			$request
	)

Authorize handler

Parameters

$args	array
$request	Request

Definition at line 54 of file OrcidHandler.inc.php.

References $op, _setOrcidData(), DAORegistry\getDAO(), PluginRegistry\getPlugin(), and Config\getVar().

orcidVerify()

OrcidHandler::orcidVerify	(		$args,
			$request
	)

Verify an incoming author claim for an ORCiD association.

Parameters

$args	array
$request	PKPRequest

Definition at line 174 of file OrcidHandler.inc.php.

References _setOrcidData(), PKPServices\get(), Core\getCurrentDate(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), PluginRegistry\getPlugin(), and Config\getVar().

Field Documentation

TEMPLATE

const OrcidHandler::TEMPLATE = 'orcidVerify.tpl'

Definition at line 20 of file OrcidHandler.inc.php.

---

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

• OrcidHandler.inc.php