Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
AbntCitationPlugin Class Reference
Inheritance diagram for AbntCitationPlugin:
CitationPlugin Plugin PKPPlugin

Public Member Functions

 displayCitation (&$article, &$issue, &$journal)
 
 getCitationFormatName ()
 
 getDescription ()
 
 getDisplayName ()
 
 getLocalizedLocation ($journal)
 
 getManagementVerbs ()
 
 getName ()
 
 manage ($verb, $args, &$message)
 
 register ($category, $path)
 
 setBreadcrumbs ($isSubclass=false)
 
 smartyPluginUrl ($params, &$smarty)
 
- Public Member Functions inherited from CitationPlugin
 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

ABNT citation format plugin.

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

Member Function Documentation

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

Display an HTML-formatted citation. We register String::strtoupper modifier in order to convert author names to uppercase.

Parameters
$articleArticle
$issueIssue
$journalJournal

Definition at line 97 of file AbntCitationPlugin.inc.php.

AbntCitationPlugin::getCitationFormatName ( )
See Also
CitationFormatPlugin::getCitationFormatName

Definition at line 49 of file AbntCitationPlugin.inc.php.

AbntCitationPlugin::getDescription ( )
See Also
Plugin::getDescription

Definition at line 56 of file AbntCitationPlugin.inc.php.

AbntCitationPlugin::getDisplayName ( )
See Also
Plugin::getDisplayName

Definition at line 42 of file AbntCitationPlugin.inc.php.

AbntCitationPlugin::getLocalizedLocation (   $journal)

Get the localized location for citations in this journal

Parameters
$journalJournal
Returns
string

Definition at line 65 of file AbntCitationPlugin.inc.php.

References AppLocale\getLocale(), AppLocale\getPrimaryLocale(), and Plugin\getSetting().

AbntCitationPlugin::getManagementVerbs ( )

Display verbs for the management interface.

Returns
array

Definition at line 81 of file AbntCitationPlugin.inc.php.

AbntCitationPlugin::getName ( )

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

Returns
String name of plugin

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

Referenced by smartyPluginUrl().

AbntCitationPlugin::manage (   $verb,
  $args,
$message 
)

Execute a management verb on this plugin

Parameters
$verbstring
$argsarray
$messagestring If a message is returned from this by-ref argument then it will be displayed as a notification if (and only if) the method returns false.
Returns
boolean will redirect to the plugin category page if false, otherwise will remain on the same page

Definition at line 113 of file AbntCitationPlugin.inc.php.

References Request\getJournal(), PKPRequest\getUserVar(), AbntSettingsForm\readInputData(), and PKPRequest\redirect().

AbntCitationPlugin::register (   $category,
  $path 
)
See Also
Plugin::register

Definition at line 24 of file AbntCitationPlugin.inc.php.

References PKPPlugin\addLocaleData().

AbntCitationPlugin::setBreadcrumbs (   $isSubclass = false)

Set the page's breadcrumbs, given the plugin's tree of items to append.

Parameters
$subclassboolean

Definition at line 153 of file AbntCitationPlugin.inc.php.

References Request\url().

AbntCitationPlugin::smartyPluginUrl (   $params,
$smarty 
)

Extend the {url ...} smarty to support this plugin.

Definition at line 174 of file AbntCitationPlugin.inc.php.

References PKPPlugin\getCategory(), and getName().


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