classes/plugins/BlockPlugin.inc.php

<?php

// $Id: BlockPlugin.inc.php,v 1.9 2008/07/01 01:16:10 asmecher Exp $


define('BLOCK_CONTEXT_LEFT_SIDEBAR',      0x00000001);
define('BLOCK_CONTEXT_RIGHT_SIDEBAR',     0x00000002);
define('BLOCK_CONTEXT_HOMEPAGE',    0x00000003);

class BlockPlugin extends Plugin {
   function register($category, $path) {
      $success = parent::register($category, $path);
      if ($success && $this->getEnabled()) {
         $contextMap =& $this->getContextMap();
         $blockContext = $this->getBlockContext();
         if (isset($contextMap[$blockContext])) {
            $hookName = $contextMap[$blockContext];
            HookRegistry::register($hookName, array(&$this, 'callback'));
         }
      }
      return $success;
   }

   function getBlockContext() {
      $journal =& Request::getJournal();
      $journalId = ($journal?$journal->getJournalId():0);
      return $this->getSetting($journalId, 'context');
   }

   function setBlockContext($context) {
      $journal =& Request::getJournal();
      $journalId = ($journal?$journal->getJournalId():0);
      return $this->updateSetting($journalId, 'context', $context, 'int');
   }

   function getSupportedContexts() {
      fatalError('ABSTRACT METHOD');
   }

   function getEnabled() {
      $journal =& Request::getJournal();
      $journalId = ($journal?$journal->getJournalId():0);
      return $this->getSetting($journalId, 'enabled');
   }

   function setEnabled($enabled) {
      $journal =& Request::getJournal();
      $journalId = ($journal?$journal->getJournalId():0);
      return $this->updateSetting($journalId, 'enabled', $enabled, 'bool');
   }

   function getSeq() {
      $journal =& Request::getJournal();
      $journalId = ($journal?$journal->getJournalId():0);
      return $this->getSetting($journalId, 'seq');
   }

   function setSeq($i) {
      $journal =& Request::getJournal();
      $journalId = ($journal?$journal->getJournalId():0);
      return $this->updateSetting($journalId, 'seq', $i, 'int');
   }

   function &getContextMap() {
      static $contextMap = array(
         BLOCK_CONTEXT_LEFT_SIDEBAR => 'Templates::Common::LeftSidebar',
         BLOCK_CONTEXT_RIGHT_SIDEBAR => 'Templates::Common::RightSidebar',
         BLOCK_CONTEXT_HOMEPAGE => 'Templates::Index::journal'
      );
      HookRegistry::call('BlockPlugin::getContextMap', array(&$this, &$contextMap));
      return $contextMap;
   }

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

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

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

   function getBlockTemplateFilename() {
      return 'block.tpl';
   }

   function getContents(&$templateMgr) {
      $blockTemplateFilename = $this->getBlockTemplateFilename();
      if ($blockTemplateFilename === null) return '';
      return $templateMgr->fetch($this->getTemplatePath() . '/' . $blockTemplateFilename);
   }

   function callback($hookName, &$args) {
      $params =& $args[0];
      $smarty =& $args[1];
      $output =& $args[2];
      $output .= $this->getContents($smarty);
   }
}

?>

---