Open Journal Systems  3.3.0
MetadataPlugin Class Reference
Inheritance diagram for MetadataPlugin:
Plugin PKPDc11MetadataPlugin Dc11MetadataPlugin

Public Member Functions

 getInstallControlledVocabFiles ()
 
 getSchemaObject ($format)
 
 register ($category, $path, $mainContextId=null)
 
 supportsFormat ($format)
 
- 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 ()
 
 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)
 

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 metadata plugins.

Definition at line 22 of file MetadataPlugin.inc.php.

Member Function Documentation

◆ getInstallControlledVocabFiles()

MetadataPlugin::getInstallControlledVocabFiles ( )

This implementation looks for files that contain controlled vocabulary data. It can discover and return more than one file.

See also
Plugin::getInstallControlledVocabFiles()
Returns
array|null

Reimplemented from Plugin.

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

References Plugin\$pluginPath, and Plugin\getPluginPath().

◆ getSchemaObject()

MetadataPlugin::getSchemaObject (   $format)
abstract

Instantiate and return the schema object for this metadata format

Parameters
$formatstring The format to return the schema object for in case the plugin supports multiple formats.
Returns
mixed

Reimplemented in PKPDc11MetadataPlugin.

◆ register()

MetadataPlugin::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 30 of file MetadataPlugin.inc.php.

References Plugin\addLocaleData().

◆ supportsFormat()

MetadataPlugin::supportsFormat (   $format)
abstract

Get a unique id for this metadata format

Parameters
$formatstring The format to check for support.
Returns
string

Reimplemented in PKPDc11MetadataPlugin.


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