Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
PaymethodPlugin Class Reference
Inheritance diagram for PaymethodPlugin:
Plugin PKPPlugin ManualPaymentPlugin PayPalPlugin

Public Member Functions

 _smartyDisplayPaymentSettingsForm ($hookName, $args)
 displayPaymentForm ($queuedPaymentId, $key, &$queuedPayment, $request)
 displayPaymentSettingsForm (&$params, &$smarty)
 getDescription ()
 getName ()
 getSettingsFormFieldNames ()
 getTemplatePath ()
 handle ($args, &$request)
 isConfigured ()
 PaymethodPlugin ()
 register ($category, $path)
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 getNewJournalPluginSettingsFile ()
 getSetting ($journalId, $name)
 Plugin ()
 updateSetting ($journalId, $name, $value, $type=null)
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 addHelpData ($locale=null)
 addLocaleData ($locale=null)
 getCategory ()
 getContextSpecificPluginSettingsFile ()
 getContextSpecificSetting ($context, $name)
 getCurrentVersion ()
 getDescription ()
 getDisplayName ()
 getHelpMappingFilename ()
 getHideManagement ()
 getInstallDataFile ()
 getInstallEmailTemplateDataFile ()
 getInstallEmailTemplatesFile ()
 getInstallFilterConfigFiles ()
 getInstallSchemaFile ()
 getInstallSitePluginSettingsFile ()
 getLocaleFilename ($locale)
 getManagementVerbs ()
 getName ()
 getPluginPath ()
 getSeq ()
 getSettingMainContext ()
 getTemplatePath ()
 import ($class)
 installContextSpecificSettings ($hookName, $args)
 installData ($hookName, $args)
 installEmailTemplateData ($hookName, $args)
 installEmailTemplates ($hookName, $args)
 installFilters ($hookName, $args)
 installLocale ($hookName, $args)
 installSiteSettings ($hookName, $args)
 isSitePlugin ()
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 PKPPlugin ()
 register ($category, $path)
 smartyPluginUrl ($params, &$smarty)
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 updateSchema ($hookName, $args)

Detailed Description

Abstract class for paymethod plugins.

Definition at line 18 of file

Member Function Documentation

PaymethodPlugin::_smartyDisplayPaymentSettingsForm (   $hookName,

This is a hook wrapper that is responsible for calling displayPaymentSettingsForm. Subclasses should override displayPaymentSettingsForm as necessary.


Definition at line 92 of file

References displayPaymentSettingsForm(), and getName().

PaymethodPlugin::displayPaymentForm (   $queuedPaymentId,

Display the payment form.


Definition at line 73 of file

PaymethodPlugin::displayPaymentSettingsForm ( $params,

Display the payment settings form.


Definition at line 108 of file

References getTemplatePath().

Referenced by _smartyDisplayPaymentSettingsForm().

PaymethodPlugin::getDescription ( )

Get a description of this plugin.

Definition at line 55 of file

PaymethodPlugin::getName ( )

Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).

String name of plugin

Definition at line 48 of file

Referenced by _smartyDisplayPaymentSettingsForm().

PaymethodPlugin::getSettingsFormFieldNames ( )

Fetch the settings form field names.


Definition at line 116 of file

PaymethodPlugin::getTemplatePath ( )

Get the Template path for this plugin.

Definition at line 62 of file

Referenced by ManualPaymentPlugin\displayPaymentForm(), PayPalPlugin\displayPaymentForm(), and displayPaymentSettingsForm().

PaymethodPlugin::handle (   $args,

Handle an incoming request from a user callback or an external payment processing system.


Definition at line 126 of file

PaymethodPlugin::isConfigured ( )

Determine whether or not the payment plugin is configured for use.


Definition at line 81 of file

PaymethodPlugin::PaymethodPlugin ( )


Definition at line 22 of file

PaymethodPlugin::register (   $category,

Called as a plugin is registered to the registry. Subclasses over- riding this method should call the parent method first.

$categoryString Name of category plugin was registered to
$pathString The path the plugin was found in
boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

Definition at line 34 of file

References HookRegistry\register().

The documentation for this class was generated from the following file: