ApaCitationPlugin Class Reference
[Plugins_citationFormats_apa]

APA citation format plugin. More...

Inheritance diagram for ApaCitationPlugin:

CitationPlugin Plugin List of all members.

Public Member Functions

 cite (&$paper)
 getCitationFormatName ()
 getDescription ()
 getDisplayName ()
 getName ()
 register ($category, $path)

Detailed Description

APA citation format plugin.

Definition at line 19 of file ApaCitationPlugin.inc.php.


Member Function Documentation

ApaCitationPlugin.cite ( &$  paper  ) 

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

Parameters:
$paper object

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

References CitationPlugin.displayCitation().

ApaCitationPlugin.getCitationFormatName (  ) 

Get the citation format name for this plugin.

Reimplemented from CitationPlugin.

Definition at line 39 of file ApaCitationPlugin.inc.php.

ApaCitationPlugin.getDescription (  ) 

Get a description of the plugin.

Reimplemented from CitationPlugin.

Definition at line 43 of file ApaCitationPlugin.inc.php.

ApaCitationPlugin.getDisplayName (  ) 

Get the display name of this plugin.

Returns:
String

Reimplemented from CitationPlugin.

Definition at line 35 of file ApaCitationPlugin.inc.php.

ApaCitationPlugin.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 31 of file ApaCitationPlugin.inc.php.

ApaCitationPlugin.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 20 of file ApaCitationPlugin.inc.php.


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7