Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
OAIMetadataFormatPlugin Class Reference
Inheritance diagram for OAIMetadataFormatPlugin:
Plugin PKPPlugin OAIMetadataFormatPlugin_MARC OAIMetadataFormatPlugin_MARC21 OAIMetadataFormatPlugin_NLM OAIMetadataFormatPlugin_RFC1807 PKPOAIMetadataFormatPlugin_DC OAIMetadataFormatPlugin_DC

Public Member Functions

 getDescription ()
 
 getDisplayName ()
 
 getFormatClass ()
 
 getMetadataPrefix ()
 
 getName ()
 
 register ($category, $path)
 
- 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 OAI Metadata format plugins.

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

Member Function Documentation

OAIMetadataFormatPlugin::getDescription ( )

Get a description of this plugin.

Definition at line 59 of file OAIMetadataFormatPlugin.inc.php.

OAIMetadataFormatPlugin::getDisplayName ( )

Get the display name for this plugin.

Definition at line 52 of file OAIMetadataFormatPlugin.inc.php.

OAIMetadataFormatPlugin::getFormatClass ( )

Get a hold of the class that does the formatting.

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

OAIMetadataFormatPlugin::getMetadataPrefix ( )

Get the metadata prefix for this plugin's format.

Definition at line 66 of file OAIMetadataFormatPlugin.inc.php.

OAIMetadataFormatPlugin::getName ( )

Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).

Returns
String name of plugin

Definition at line 45 of file OAIMetadataFormatPlugin.inc.php.

OAIMetadataFormatPlugin::register (   $category,
  $path 
)

Called as a plugin is registered to the registry

Parameters
$categoryString Name of category plugin was registered to
Returns
boolean True if plugin initialized successfully; if false, the plugin will not be registered.

Definition at line 30 of file OAIMetadataFormatPlugin.inc.php.

References PKPPlugin\addLocaleData(), and HookRegistry\register().


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