classes/plugins/OAIMetadataFormatPlugin.inc.php

Go to the documentation of this file.

<?php

// $Id$


import('plugins.Plugin');
import('oai.OAIStruct');

class OAIMetadataFormatPlugin extends Plugin {
   function OAIMetadataFormatPlugin() {
      parent::Plugin();
   }

   function register($category, $path) {
      if (parent::register($category, $path)) {
         $this->addLocaleData();
         HookRegistry::register('OAI::metadataFormats', array(&$this, 'callback_formatRequest'));
         return true;
      }
      return false;
   }

   function getName() {
      return 'Base OAIMetadata plugin class: abstract function getName()';
   }

   function getDisplayName() {
      return 'Base OAIMetadata plugin class: abstract function getDisplayName()';
   }

   function getDescription() {
      return 'Base OAIMetadata plugin class: abstract function getDescription()';
   }

   function getMetadataPrefix() {
      return 'Base OAIMetadata plugin class: abstract function getMetadataPrefix()';
   }

   function getSchema() {
      return '';
   }

   function getNamespace() {
      return '';
   }

   function getFormatClass() {
      return 'Base OAIMetadata plugin class: abstract function getFormatClass()';
   }

   function callback_formatRequest($hookName, $args) {
      $namesOnly = $args[0];
      $identifier = $args[1];
      $formats =& $args[2];

      if ($namesOnly) {
         $formats = array_merge($formats,array($this->getMetadataPrefix()));
      } else {
         $formatClass = $this->getFormatClass();
         $formats = array_merge(
            $formats,
            array($this->getMetadataPrefix() => new $formatClass($this->getMetadataPrefix(), $this->getSchema(), $this->getNamespace()))
         );
      }
      return false;
   }
}

?>

---