CitationPlugin Class Reference
[Plugins]

Abstract class for citation plugins. More...

Inheritance diagram for CitationPlugin:

List of all members.

Public Member Functions
	CitationPlugin ()
	displayCitation (&$paper, &$conference, &$schedConf)
	displayCitationHook ($hookName, $args)
	fetchCitation (&$paper, &$conference, &$schedConf)
	getCitationFormatName ()
	getDescription ()
	getDisplayName ()
	getName ()

---

Detailed Description

Abstract class for citation plugins.

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

---

Member Function Documentation

CitationPlugin.displayCitation	(	&$	paper,
		&$	conference,
		&$	schedConf
	)

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

Parameters:

	$paper	object
	$conference	object
	$schedConf	object

Reimplemented in EndNoteCitationPlugin.

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

References displayCitationHook().

Referenced by ApaCitationPlugin.cite().

CitationPlugin.displayCitationHook	(	$	hookName,
		$	args
	)

Used by the cite function to embed an HTML citation in the templates/rt/captureCite.tpl template, which ships with OCS.

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

References Plugin.getTemplatePath().

Referenced by displayCitation().

CitationPlugin.fetchCitation	(	&$	paper,
		&$	conference,
		&$	schedConf
	)

Return an HTML-formatted citation.

Parameters:

	$paper	object
	$conference	object
	$schedConf	object

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

References Plugin.getTemplatePath().

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 45 of file CitationPlugin.inc.php.

CitationPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented in AbntCitationPlugin, ApaCitationPlugin, BibtexCitationPlugin, CbeCitationPlugin, EndNoteCitationPlugin, MlaCitationPlugin, ProCiteCitationPlugin, RefManCitationPlugin, RefWorksCitationPlugin, and TurabianCitationPlugin.

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

CitationPlugin.getDisplayName

(

)

Get the display name of this plugin.

Returns:

String

Reimplemented in AbntCitationPlugin, ApaCitationPlugin, BibtexCitationPlugin, CbeCitationPlugin, EndNoteCitationPlugin, MlaCitationPlugin, ProCiteCitationPlugin, RefManCitationPlugin, RefWorksCitationPlugin, and TurabianCitationPlugin.

Definition at line 36 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 in AbntCitationPlugin, ApaCitationPlugin, BibtexCitationPlugin, CbeCitationPlugin, EndNoteCitationPlugin, MlaCitationPlugin, ProCiteCitationPlugin, RefManCitationPlugin, RefWorksCitationPlugin, and TurabianCitationPlugin.

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

---

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

• classes/plugins/CitationPlugin.inc.php

---