Open Journal Systems  2.4.3
 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)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
getRangeInfo ($rangeName, $contextData=null)
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 hashPageContext ($contextData=array())
 
 index ()
 
 initialize (&$request, $args=null)
 
 PKPHandler ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

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 
)
See Also
PKPHandler::authorize()

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: