classes/plugins/PaymethodPlugin.inc.php

Go to the documentation of this file.

<?php

import('plugins.Plugin');

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

   function register($category, $path) {
      $success = parent::register($category, $path);
      if ($success) {
         HookRegistry::register('Template::Manager::Payment::displayPaymentSettingsForm', array(&$this, '_smartyDisplayPaymentSettingsForm'));
      }
      return $success;
   }

   function getName() {
      return 'PaymethodPlugin';
   }

   function getDescription() {
      return 'This is the base payment method plugin class. It contains no concrete implementation. Its functions must be overridden by subclasses to provide actual functionality.';
   }

   function getTemplatePath() {
      return parent::getTemplatePath() . 'templates' . DIRECTORY_SEPARATOR ;
   }

   function displayPaymentForm($queuedPaymentId, $key, &$queuedPayment) {
      die('ABSTRACT METHOD');
   }

   function isConfigured() {
      return false; // Abstract; should be implemented in subclasses
   }

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

      if (isset($params['plugin']) && $params['plugin'] == $this->getName()) {
         $output .= $this->displayPaymentSettingsForm($params, $smarty);
      }
      return false;
   }

   function displayPaymentSettingsForm(&$params, &$smarty) {
      return $smarty->fetch($this->getTemplatePath() . 'settingsForm.tpl');
   }

   function getSettingsFormFieldNames() {
      return array(); // Subclasses should override
   }

   function handle($args) {
      // Subclass should override.
      Request::redirect(null, null, 'index');
   }
}

?>

---