Inheritance diagram for CitationStyleLanguagePlugin:

Public Member Functions
	downloadCitation ($request, $article, $citationStyle='ris', $issue=null)

	getActions ($request, $actionArgs)

	getArticleTemplateData ($hookName, $args)

	getCitation ($request, $article, $citationStyle='apa', $issue=null, $publication=null)

	getCitationDownloads ()

	getCitationStyleConfig ($styleId)

	getCitationStyles ()

	getDescription ()

	getDisplayName ()

	getEnabledCitationDownloads ($contextId=0)

	getEnabledCitationStyles ($contextId=0)

	getPrimaryStyleName ($contextId=0)

	loadStyle ($styleConfig)

	manage ($args, $request)

	mapCitationIds ($citations)

	register ($category, $path, $mainContextId=null)

	setPageHandler ($hookName, $params)

Public Member Functions inherited from LazyLoadPlugin
	getCanDisable ()

	getCanEnable ()

	getCurrentContextId ()

	getEnabled ($contextId=null)

	getName ()

	setEnabled ($enabled)

Public Member Functions inherited from Plugin
	__construct ()

	_overridePluginTemplates ($hookName, $args)

	addLocaleData ($locale=null)

	getCategory ()

	getContextSpecificPluginSettingsFile ()

	getCurrentVersion ()

	getDirName ()

	getEnabled ()

	getHideManagement ()

	getInstallControlledVocabFiles ()

	getInstallDataFile ()

	getInstallEmailTemplateDataFile ()

	getInstallEmailTemplatesFile ()

	getInstallFilterConfigFiles ()

	getInstallMigration ()

	getInstallSchemaFile ()

	getInstallSitePluginSettingsFile ()

	getLocaleFilename ($locale)

	getPluginPath ()

&	getRequest ()

	getSeq ()

	getSetting ($contextId, $name)

	getTemplatePath ($inCore=false)

	getTemplateResource ($template=null, $inCore=false)

	import ($class)

	installContextSpecificSettings ($hookName, $args)

	installControlledVocabs ($hookName, $args)

	installData ($hookName, $args)

	installEmailTemplateData ($hookName, $args)

	installEmailTemplates ($hookName, $args)

	installFilters ($hookName, $args)

	installLocale ($hookName, $args)

	installSiteSettings ($hookName, $args)

	isSitePlugin ()

	smartyPluginUrl ($params, $smarty)

	updateSchema ($hookName, $args)

	updateSetting ($contextId, $name, $value, $type=null)

Data Fields
	$_citationDownloads = array()

	$_citationStyles = array()

Data Fields inherited from Plugin
	$pluginCategory

	$pluginPath

	$request

Additional Inherited Members
Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

Citation Style Language plugin class.

Definition at line 20 of file CitationStyleLanguagePlugin.inc.php.

Member Function Documentation

◆ downloadCitation()

CitationStyleLanguagePlugin::downloadCitation	(	$request,
		$article,
		$citationStyle = `'ris'`,
		$issue = `null`
	)

Download a citation format

Downloadable citation formats can be used to import into third-party software.

Parameters

$request	Request
$article	Submission
$citationStyle	string Name of the citation style to use.
$issue	Issue Optional. Will fetch from db if not passed.

Returns: string

Definition at line 460 of file CitationStyleLanguagePlugin.inc.php.

References DAORegistry\getDAO().

◆ getActions()

CitationStyleLanguagePlugin::getActions	(	$request,
		$actionArgs
	)

See also: Plugin::getActions()

Reimplemented from Plugin.

Definition at line 491 of file CitationStyleLanguagePlugin.inc.php.

◆ getArticleTemplateData()

CitationStyleLanguagePlugin::getArticleTemplateData	(	$hookName,
		$args
	)

Retrieve citation information for the article details template. This method is hooked in before a template displays.

See also: ArticleHandler::view()

Parameters

$hookname	string
$args	array

Returns: false

Definition at line 266 of file CitationStyleLanguagePlugin.inc.php.

References Plugin\$request, getCitation(), getEnabledCitationDownloads(), getEnabledCitationStyles(), PKPTemplateManager\getManager(), and getPrimaryStyleName().

◆ getCitation()

CitationStyleLanguagePlugin::getCitation	(	$request,
		$article,
		$citationStyle = `'apa'`,
		$issue = `null`,
		$publication = `null`
	)

Get a specified citation for a given article

This citation format follows the csl-json schema and takes some direction from existing CSL mappings documented by Zotero and Mendeley.

See also: CSL-json schema https://github.com/citation-style-language/schema#csl-json-schema; Zotero's mappings https://aurimasv.github.io/z2csl/typeMap.xml#map-journalArticle; Mendeley's mappings http://support.mendeley.com/customer/portal/articles/364144-csl-type-mapping

Parameters

$request	Request
$article	Submission
$citationStyle	string Name of the citation style to use.
$issue	Issue Optional. Will fetch from db if not passed.
$publication	Publication Optional. A particular version

Returns: string

Definition at line 314 of file CitationStyleLanguagePlugin.inc.php.

References Plugin\$request, and DAORegistry\getDAO().

Referenced by getArticleTemplateData().

◆ getCitationDownloads()

CitationStyleLanguagePlugin::getCitationDownloads ( )

Get list of citation download formats available

Returns: array

Definition at line 181 of file CitationStyleLanguagePlugin.inc.php.

References $_citationDownloads, HookRegistry\call(), and Plugin\getTemplateResource().

Referenced by getCitationStyleConfig(), and getEnabledCitationDownloads().

◆ getCitationStyleConfig()

CitationStyleLanguagePlugin::getCitationStyleConfig ( $styleId )

Get citation config for a citation ID

Parameters

$styleId string Example: 'apa'

Returns: array

Definition at line 249 of file CitationStyleLanguagePlugin.inc.php.

References getCitationDownloads(), and getCitationStyles().

◆ getCitationStyles()

CitationStyleLanguagePlugin::getCitationStyles ( )

Get list of citation styles available

Returns: array

Definition at line 65 of file CitationStyleLanguagePlugin.inc.php.

References $_citationStyles, and HookRegistry\call().

Referenced by getCitationStyleConfig(), getEnabledCitationStyles(), and getPrimaryStyleName().

◆ getDescription()

CitationStyleLanguagePlugin::getDescription ( )

Get a description of this plugin.

Returns: string

Reimplemented from Plugin.

Definition at line 43 of file CitationStyleLanguagePlugin.inc.php.

◆ getDisplayName()

CitationStyleLanguagePlugin::getDisplayName ( )

Get the display name for this plugin.

Returns: string

Reimplemented from Plugin.

Definition at line 36 of file CitationStyleLanguagePlugin.inc.php.

◆ getEnabledCitationDownloads()

CitationStyleLanguagePlugin::getEnabledCitationDownloads ( $contextId = 0 )

Get enabled citation styles

Parameters

$contextId integer Journal ID

Returns: array

Definition at line 219 of file CitationStyleLanguagePlugin.inc.php.

References getCitationDownloads(), and Plugin\getSetting().

Referenced by getArticleTemplateData().

◆ getEnabledCitationStyles()

CitationStyleLanguagePlugin::getEnabledCitationStyles ( $contextId = 0 )

Get enabled citation styles

Parameters

$contextId integer Journal ID

Returns: array

Definition at line 162 of file CitationStyleLanguagePlugin.inc.php.

References getCitationStyles(), and Plugin\getSetting().

Referenced by getArticleTemplateData().

◆ getPrimaryStyleName()

CitationStyleLanguagePlugin::getPrimaryStyleName ( $contextId = 0 )

Get the primary style name or default to the first available style

Parameters

$contextId integer Journal ID

Returns: string

Definition at line 139 of file CitationStyleLanguagePlugin.inc.php.

References getCitationStyles(), and Plugin\getSetting().

Referenced by getArticleTemplateData().

◆ loadStyle()

CitationStyleLanguagePlugin::loadStyle ( $styleConfig )

Load a CSL style and return the contents as a string

Parameters

$styleConfig array CSL configuration to load

Definition at line 440 of file CitationStyleLanguagePlugin.inc.php.

◆ manage()

CitationStyleLanguagePlugin::manage	(	$args,
		$request
	)

See also: Plugin::manage()

Reimplemented from Plugin.

Definition at line 530 of file CitationStyleLanguagePlugin.inc.php.

◆ mapCitationIds()

CitationStyleLanguagePlugin::mapCitationIds ( $citations )

Pluck citation IDs from array of citations

Parameters

$citations array See getCitationStyles()

Returns: array

Definition at line 239 of file CitationStyleLanguagePlugin.inc.php.

◆ register()

CitationStyleLanguagePlugin::register	(	$category,
		$path,
		$mainContextId = `null`
	)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters

$category	String Name of category plugin was registered to
$path	String The path the plugin was found in
$mainContextId	integer To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.