PHP Class CitationPlugin, ojs

Inheritance: extends Plugin
Mostrar archivo Open project: pkp/ojs Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor
fetchCitation ( $article, $issue, $journal ) Return an HTML-formatted citation. Default implementation displays an HTML-based citation using the citation.tpl template in the plugin path.
getCitationFormatName ( ) Get the citation format name for this plugin.
isDownloadable ( ) : boolean Whether this citation format is a downloadable file format (eg - EndNote)
loadJavaScript ( $hookName, $args ) : null Load the JavaScript file to retrieve citation formats

Method Details

__construct() public method

Constructor
public __construct ( )

fetchCitation() public method

Return an HTML-formatted citation. Default implementation displays an HTML-based citation using the citation.tpl template in the plugin path.
public fetchCitation ( $article, $issue, $journal )
$article Article
$issue Issue
$journal Journal

getCitationFormatName() abstract public method

Get the citation format name for this plugin.
abstract public getCitationFormatName ( )

isDownloadable() public method

Whether this citation format is a downloadable file format (eg - EndNote)
public isDownloadable ( ) : boolean
return boolean

loadJavaScript() public method

Load the JavaScript file to retrieve citation formats
public loadJavaScript ( $hookName, $args ) : null
$hookName string Hook name
$args array Hook arguments. See `TemplateManager::display`
return null