classes/plugins/GatewayPlugin.inc.php

Go to the documentation of this file.

<?php

//$Id$

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

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

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

   function getDescription() {
      return 'This is the GatewayPlugin base class. Its functions can be overridden by subclasses to provide import/export functionality for various formats.';
   }

   function smartyPluginUrl($params, &$smarty) {
      $path = array($this->getCategory(), $this->getName());
      if (is_array($params['path'])) {
         $params['path'] = array_merge($path, $params['path']);
      } elseif (!empty($params['path'])) {
         $params['path'] = array_merge($path, array($params['path']));
      } else {
         $params['path'] = $path;
      }
      return $smarty->smartyUrl($params, $smarty);
   }

   function getManagementVerbs() {
      $verbs = array();
      if ($this->getEnabled()) {
         $verbs[] = array(
            'disable',
            __('manager.plugins.disable')
         );
      } else {
         $verbs[] = array(
            'enable',
            __('manager.plugins.enable')
         );
      }
      return $verbs;
   }

   function getEnabled() {
      $conference =& Request::getConference();
      if (!$conference) return false;
      return $this->getSetting($conference->getId(), 0, 'enabled');
   }

   function setEnabled($enabled) {
      $conference =& Request::getConference();
      if ($conference) {
         $this->updateSetting(
            $conference->getId(),
            0,
            'enabled',
            $enabled?true:false
         );
         return true;
      }
      return false;
   }

   function manage($verb, $args) {
      $templateManager =& TemplateManager::getManager();
      $templateManager->register_function('plugin_url', array(&$this, 'smartyPluginUrl'));
      switch ($verb) {
         case 'enable': $this->setEnabled(true); break;
         case 'disable': $this->setEnabled(false); break;
      }
      return false;
   }

   function fetch($args) {
      // Subclasses should override this function.
      return false;
   }
}
?>

---