PLNHandler Class Reference

Inheritance diagram for PLNHandler:

Public Member Functions
	authorize ($request, &$args, $roleAssignments)
	deposits ($args, $request)
	index ($args, $request)
	status ($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)
	initialize ($request)
	markRoleAssignmentsChecked ()
	requireSSL ()
	setApiToken ($apiToken)
	setDispatcher ($dispatcher)
	setEnforceRestrictedSite ($enforceRestrictedSite)
	setId ($id)
	setupTemplate ($request)
	validate ($requiredContexts=null, $request=null)

Protected Member Functions
	_getPlugin ()

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 PLN requests.

Definition at line 15 of file PLNHandler.inc.php.

Member Function Documentation

_getPlugin()

PLNHandler::_getPlugin ( )

protected

Get the Usage Stats plugin object

Returns

PLNPlugin

Definition at line 97 of file PLNHandler.inc.php.

References PluginRegistry\getPlugin().

authorize()

PLNHandler::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 28 of file PLNHandler.inc.php.

References PKPHandler\addPolicy().

deposits()

PLNHandler::deposits	(		$args,
			$request
	)

Provide an endpoint for the PLN staging server to retrieve a deposit

Parameters

array	$args
Request	$request

Returns

bool

Definition at line 42 of file PLNHandler.inc.php.

References DAORegistry\getDAO(), and PKPString\mime_content_type().

index()

PLNHandler::index	(		$args,
			$request
	)

Index handler: redirect to journal page.

Parameters

$args	array
$request	PKPRequest

Reimplemented from PKPHandler.

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

status()

PLNHandler::status	(		$args,
			$request
	)

Display status of deposit(s)

Parameters

array	$args
Request	$request

Definition at line 82 of file PLNHandler.inc.php.

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

---

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

• PLNHandler.inc.php