CitationPlugin Class Reference
[Plugins]
Abstract class for citation plugins.
More...
Public Member Functions | |
| cite (&$article, &$issue) | |
| displayCitation ($hookName, $args) | |
| getCitationFormatName () | |
| getDescription () | |
| getDisplayName () | |
| getName () | |
Detailed Description
Abstract class for citation plugins.Definition at line 18 of file CitationPlugin.inc.php.
Member Function Documentation
| CitationPlugin.cite | ( | &$ | article, | |
| &$ | issue | |||
| ) |
Return an HTML-formatted citation. Default implementation displays an HTML-based citation using the citation.tpl template in the plugin path.
- Parameters:
-
$article object $issue object
Reimplemented in EndNoteCitationPlugin, ProCiteCitationPlugin, and RefManCitationPlugin.
Definition at line 75 of file CitationPlugin.inc.php.
References TemplateManager.getManager(), and HookRegistry.register().
| CitationPlugin.displayCitation | ( | $ | hookName, | |
| $ | args | |||
| ) |
Used by the cite function to embed an HTML citation in the templates/rt/captureCite.tpl template, which ships with OJS.
Definition at line 59 of file CitationPlugin.inc.php.
| CitationPlugin.getCitationFormatName | ( | ) |
Get the citation format name for this plugin.
Reimplemented in AbntCitationPlugin, ApaCitationPlugin, BibtexCitationPlugin, CbeCitationPlugin, EndNoteCitationPlugin, MlaCitationPlugin, ProCiteCitationPlugin, RefManCitationPlugin, RefWorksCitationPlugin, and TurabianCitationPlugin.
Definition at line 43 of file CitationPlugin.inc.php.
| CitationPlugin.getDescription | ( | ) |
Get a description of the plugin.
Reimplemented from Plugin.
Reimplemented in AbntCitationPlugin, ApaCitationPlugin, BibtexCitationPlugin, CbeCitationPlugin, EndNoteCitationPlugin, MlaCitationPlugin, ProCiteCitationPlugin, RefManCitationPlugin, RefWorksCitationPlugin, and TurabianCitationPlugin.
Definition at line 51 of file CitationPlugin.inc.php.
| CitationPlugin.getDisplayName | ( | ) |
Get the display name of this plugin. This name is displayed on the Journal Manager's setup page 5, for example.
- Returns:
- String
Reimplemented from Plugin.
Reimplemented in AbntCitationPlugin, ApaCitationPlugin, BibtexCitationPlugin, CbeCitationPlugin, EndNoteCitationPlugin, MlaCitationPlugin, ProCiteCitationPlugin, RefManCitationPlugin, RefWorksCitationPlugin, and TurabianCitationPlugin.
Definition at line 34 of file CitationPlugin.inc.php.
| CitationPlugin.getName | ( | ) |
Get the name of this plugin. The name must be unique within its category.
- Returns:
- String name of plugin
Reimplemented from Plugin.
Reimplemented in AbntCitationPlugin, ApaCitationPlugin, BibtexCitationPlugin, CbeCitationPlugin, EndNoteCitationPlugin, MlaCitationPlugin, ProCiteCitationPlugin, RefManCitationPlugin, RefWorksCitationPlugin, and TurabianCitationPlugin.
Definition at line 24 of file CitationPlugin.inc.php.
The documentation for this class was generated from the following file:
- classes/plugins/CitationPlugin.inc.php
