Open Journal Systems  3.3.0
OAIMetadataFormatPlugin Class Reference
Inheritance diagram for OAIMetadataFormatPlugin:
Plugin OAIMetadataFormatPlugin_JATS OAIMetadataFormatPlugin_MARC OAIMetadataFormatPlugin_MARC21 OAIMetadataFormatPlugin_RFC1807 PKPOAIMetadataFormatPlugin_DC OAIMetadataFormatPlugin_DC

Public Member Functions

 callback_formatRequest ($hookName, $args)
 
 getFormatClass ()
 
 register ($category, $path, $mainContextId=null)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getActions ($request, $actionArgs)
 
 getCanDisable ()
 
 getCanEnable ()
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDirName ()
 
 getDisplayName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getName ()
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getTemplatePath ($inCore=false)
 
 getTemplateResource ($template=null, $inCore=false)
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installControlledVocabs ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($args, $request)
 
 smartyPluginUrl ($params, $smarty)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Static Public Member Functions

static getMetadataPrefix ()
 
static getNamespace ()
 
static getSchema ()
 

Additional Inherited Members

- Data Fields inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 
- Protected Member Functions inherited from Plugin
 _registerTemplateResource ($inCore=false)
 

Detailed Description

Abstract class for OAI Metadata format plugins.

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

Member Function Documentation

◆ callback_formatRequest()

OAIMetadataFormatPlugin::callback_formatRequest (   $hookName,
  $args 
)

◆ getFormatClass()

OAIMetadataFormatPlugin::getFormatClass ( )
abstract

◆ getMetadataPrefix()

static OAIMetadataFormatPlugin::getMetadataPrefix ( )
static

◆ getNamespace()

◆ getSchema()

◆ register()

OAIMetadataFormatPlugin::register (   $category,
  $path,
  $mainContextId = null 
)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters
$categoryString Name of category plugin was registered to
$pathString The path the plugin was found in
$mainContextIdinteger To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.
Returns
boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from Plugin.

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

References Plugin\addLocaleData(), Plugin\getEnabled(), and HookRegistry\register().


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