Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
CitationApiHandler Class Reference
Inheritance diagram for CitationApiHandler:

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 ()
 requireSSL ()
 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

Member Function Documentation

CitationApiHandler::authorize ( $request,
See Also

Definition at line 37 of file

References PKPHandler\addPolicy().

CitationApiHandler::checkAllCitations (   $args,

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.


Definition at line 61 of file

References DAORegistry\getDAO().

CitationApiHandler::CitationApiHandler ( )


Definition at line 26 of file

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