classes/plugins/CitationPlugin.inc.php

Go to the documentation of this file.

<?php

//$Id$

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

   function getName() {
      // This should not be used as this is an abstract class
      return 'CitationPlugin';
   }

   function getDisplayName() {
      // This name should never be displayed because child classes
      // will override this method.
      return 'Abstract Citation Plugin';
   }

   function getCitationFormatName() {
      // Subclasses must override.
      fatalError('ABSTRACT METHOD');
   }

   function getDescription() {
      return 'This is the CitationPlugin base class. Its functions can be overridden by subclasses to provide citation support.';
   }

   function displayCitationHook($hookName, $args) {
      $params =& $args[0];
      $templateMgr =& $args[1];
      $output =& $args[2];

      $output .= $templateMgr->fetch($this->getTemplatePath() . '/citation.tpl');
      return true;
   }

   function displayCitation(&$paper, &$conference, &$schedConf) {
      HookRegistry::register('Template::RT::CaptureCite', array(&$this, 'displayCitationHook'));
      $templateMgr =& TemplateManager::getManager();
      $templateMgr->assign_by_ref('citationPlugin', $this);
      $templateMgr->assign('paper', $paper);
      $templateMgr->assign('conference', $conference);
      $templateMgr->assign('schedConf', $schedConf);
      $templateMgr->display('rt/captureCite.tpl');
   }

   function fetchCitation(&$paper, &$conference, &$schedConf) {
      $templateMgr =& TemplateManager::getManager();
      $templateMgr->assign_by_ref('citationPlugin', $this);
      $templateMgr->assign('paper', $paper);
      $templateMgr->assign('conference', $conference);
      $templateMgr->assign('schedConf', $schedConf);
      return $templateMgr->fetch($this->getTemplatePath() . '/citation.tpl');
   }
}

?>

---