Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
CitationPlugin Class Reference
Inheritance diagram for CitationPlugin:
Plugin PKPPlugin AbntCitationPlugin ApaCitationPlugin BibtexCitationPlugin CbeCitationPlugin EndNoteCitationPlugin MlaCitationPlugin ProCiteCitationPlugin RefManCitationPlugin RefWorksCitationPlugin TurabianCitationPlugin

Public Member Functions

 displayCitation (&$article, &$issue, &$journal)
 
 displayCitationHook ($hookName, $args)
 
 fetchCitation (&$article, &$issue, &$journal)
 
 getCitationFormatName ()
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 
 getNewJournalPluginSettingsFile ()
 
 getSetting ($journalId, $name)
 
 Plugin ()
 
 updateSetting ($journalId, $name, $value, $type=null)
 
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 
 addHelpData ($locale=null)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHelpMappingFilename ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
 getSeq ()
 
 getSettingMainContext ()
 
 getTemplatePath ()
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 
 PKPPlugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 

Detailed Description

Abstract class for citation plugins.

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

Member Function Documentation

CitationPlugin::displayCitation ( $article,
$issue,
$journal 
)

Display an HTML-formatted citation. Default implementation displays an HTML-based citation using the citation.tpl template in the plugin path.

Parameters
$articleobject
$issueobject

Definition at line 78 of file CitationPlugin.inc.php.

References HookRegistry\register().

CitationPlugin::displayCitationHook (   $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 62 of file CitationPlugin.inc.php.

References PKPPlugin\getTemplatePath().

CitationPlugin::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.

Parameters
$articleobject
$issueobject

Definition at line 95 of file CitationPlugin.inc.php.

References PKPPlugin\getTemplatePath().

CitationPlugin::getCitationFormatName ( )

Get the citation format name for this plugin.

Definition at line 46 of file CitationPlugin.inc.php.

CitationPlugin::getDescription ( )

Get a description of the plugin.

Definition at line 54 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

Definition at line 37 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

Definition at line 28 of file CitationPlugin.inc.php.


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