MetadataPlugin.inc.php

<?php
 
import('lib.pkp.classes.plugins.Plugin');
 
// Define the well-known file name for controlled vocabulary data.
define('METADATA_PLUGIN_VOCAB_DATAFILE', 'controlledVocabs.xml');
 
abstract class MetadataPlugin extends Plugin {
 
   //
   // Override public methods from Plugin
   //
   function register($category, $path, $mainContextId = null) {
      if (!parent::register($category, $path, $mainContextId)) return false;
      $this->addLocaleData();
      return true;
   }
 
   function getInstallControlledVocabFiles() {
      // Search the well-known locations for vocabulary data files. If
      // one is found then return it.
      $pluginPath = $this->getPluginPath();
      $wellKnownVocabLocations = array(
         './'.$pluginPath.'/schema/'.METADATA_PLUGIN_VOCAB_DATAFILE,
         './lib/pkp/'.$pluginPath.'/schema/'.METADATA_PLUGIN_VOCAB_DATAFILE
      );
 
      $controlledVocabFiles = parent::getInstallControlledVocabFiles();
      foreach ($wellKnownVocabLocations as $wellKnownVocabLocation) {
         if (file_exists($wellKnownVocabLocation)) $controlledVocabFiles[] = $wellKnownVocabLocation;
      }
      return $controlledVocabFiles;
   }
 
   abstract function supportsFormat($format);
 
   abstract function getSchemaObject($format);
}