Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
CitationApiHandler Class Reference
Inheritance diagram for CitationApiHandler:
PKPHandler

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 
 checkAllCitations ($args, $request)
 
 CitationApiHandler ()
 
- 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 API for backend citation manipulation.

Definition at line 22 of file CitationApiHandler.inc.php.

Member Function Documentation

CitationApiHandler::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 37 of file CitationApiHandler.inc.php.

References PKPHandler\addPolicy().

CitationApiHandler::checkAllCitations (   $args,
  $request 
)

Check (parse and lookup) all raw citations

NB: This handler method is meant to be called by the parallel processing framework (see ProcessDAO::spawnProcesses()). Executing this handler in parallel will significantly improve citation checking performance.

The 'citation_checking_max_processes' config parameter limits the number of parallel processes that can be started in parallel.

Parameters
$argsarray
$requestPKPRequest

Definition at line 61 of file CitationApiHandler.inc.php.

References DAORegistry\getDAO().

CitationApiHandler::CitationApiHandler ( )

Constructor.

Definition at line 26 of file CitationApiHandler.inc.php.


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