Open Journal Systems  3.3.0
CitationStyleLanguageHandler Class Reference
Inheritance diagram for CitationStyleLanguageHandler:
Handler PKPHandler

Public Member Functions

 _setupRequest ($args, $request)
 
 download ($args, $request)
 
 get ($args, $request)
 
- Public Member Functions inherited from PKPHandler
 __construct ()
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments)
 
 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

 $article = null
 
 $citationStyle = ''
 
 $issue = null
 
 $publication = null
 
 $returnJson = false
 
- 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

Handle router requests for the citation style language plugin.

Definition at line 18 of file CitationStyleLanguageHandler.inc.php.

Member Function Documentation

◆ _setupRequest()

CitationStyleLanguageHandler::_setupRequest (   $args,
  $request 
)

Generate a citation based on page parameters

Parameters
$argsarray
$requestPKPRequest

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

References PKPServices\get(), DAORegistry\getDAO(), and PluginRegistry\loadCategory().

Referenced by download(), and get().

◆ download()

CitationStyleLanguageHandler::download (   $args,
  $request 
)

Download a citation in a downloadable format

Parameters
$argsarray
$requestPKPRequest

Definition at line 83 of file CitationStyleLanguageHandler.inc.php.

References _setupRequest(), and PluginRegistry\getPlugin().

◆ get()

CitationStyleLanguageHandler::get (   $args,
  $request 
)

Get a citation style

Parameters
$argsarray
$requestPKPRequest
Returns
null|JSONMessage

Definition at line 56 of file CitationStyleLanguageHandler.inc.php.

References _setupRequest(), and PluginRegistry\getPlugin().

Field Documentation

◆ $article

Submission CitationStyleLanguageHandler::$article = null

article being requested

Definition at line 23 of file CitationStyleLanguageHandler.inc.php.

◆ $citationStyle

array CitationStyleLanguageHandler::$citationStyle = ''

citation style being requested

Definition at line 41 of file CitationStyleLanguageHandler.inc.php.

◆ $issue

Issue CitationStyleLanguageHandler::$issue = null

issue of the publication being requested

Definition at line 35 of file CitationStyleLanguageHandler.inc.php.

◆ $publication

Publication CitationStyleLanguageHandler::$publication = null

publication being requested

Definition at line 29 of file CitationStyleLanguageHandler.inc.php.

◆ $returnJson

bool CitationStyleLanguageHandler::$returnJson = false

Whether or not to return citation in JSON format

Definition at line 47 of file CitationStyleLanguageHandler.inc.php.


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