RefManCitationPlugin Class Reference
[Plugins_citationFormats_refMan]

Reference Manager citation format plugin. More...

Inheritance diagram for RefManCitationPlugin:

List of all members.

Public Member Functions
	cite (&$article, &$issue)
	getCitationFormatName ()
	getDescription ()
	getDisplayName ()
	getName ()
	register ($category, $path)

---

Detailed Description

Reference Manager citation format plugin.

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

---

Member Function Documentation

RefManCitationPlugin.cite	(	&$	article,
		&$	issue
	)

Return a custom-formatted citation.

Parameters:

	$article	object
	$issue	object

Reimplemented from CitationPlugin.

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

References TemplateManager.getManager().

RefManCitationPlugin.getCitationFormatName

(

)

Get the citation format name for this plugin.

Reimplemented from CitationPlugin.

Definition at line 40 of file RefManCitationPlugin.inc.php.

References Locale.translate().

RefManCitationPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented from CitationPlugin.

Definition at line 44 of file RefManCitationPlugin.inc.php.

References Locale.translate().

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

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

References Locale.translate().

RefManCitationPlugin.getName

(

)

Get the name of this plugin. The name must be unique within its category.

Returns:

String name of plugin

Reimplemented from CitationPlugin.

Definition at line 32 of file RefManCitationPlugin.inc.php.

RefManCitationPlugin.register	(	$	category,
		$	path
	)

Called as a plugin is registered to the registry. Subclasses over- riding this method should call the parent method first.

Parameters:

	$category	String Name of category plugin was registered to
	$path	String The path the plugin was found in

Returns:

boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

Reimplemented from Plugin.

Definition at line 21 of file RefManCitationPlugin.inc.php.

References Plugin.addLocaleData().

---

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

• plugins/citationFormats/refMan/RefManCitationPlugin.inc.php