Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PaymethodPlugin Class Reference
Inheritance diagram for PaymethodPlugin:
Plugin ManualPaymentPlugin PayPalPlugin

Public Member Functions

 displayPaymentForm ($queuedPaymentId, $key, &$queuedPayment, $request)
 
 displayPaymentSettingsForm (&$params, &$smarty)
 
 getDescription ()
 
 getName ()
 
 getSettingsFormFieldNames ()
 
 getTemplatePath ($inCore=false)
 
 handle ($args, $request)
 
 isConfigured ()
 
 PaymethodPlugin ()
 
- Public Member Functions inherited from Plugin
 _getContextSpecificInstallationHook ()
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbLinkAction ($request, $verb)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getSettingMainContext ()
 
 getTemplatePath ($inCore=false)
 
 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, &$pluginModalContent=null)
 
 Plugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Additional Inherited Members

- Public Attributes inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 

Detailed Description

Abstract class for paymethod plugins.

Definition at line 18 of file PaymethodPlugin.inc.php.

Member Function Documentation

PaymethodPlugin::displayPaymentForm (   $queuedPaymentId,
  $key,
$queuedPayment,
  $request 
)

Display the payment form.

Parameters
$queuedPaymentIdint
$keystring
$queuedPaymentQueuedPayment
$requestPKPRequest

Definition at line 57 of file PaymethodPlugin.inc.php.

PaymethodPlugin::displayPaymentSettingsForm ( $params,
$smarty 
)

Display the payment settings form.

Parameters
$paramsarray
$smartySmarty

Definition at line 74 of file PaymethodPlugin.inc.php.

References getTemplatePath().

PaymethodPlugin::getDescription ( )

Get a description of this plugin.

Definition at line 39 of file PaymethodPlugin.inc.php.

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).

Returns
String name of plugin

Definition at line 32 of file PaymethodPlugin.inc.php.

PaymethodPlugin::getSettingsFormFieldNames ( )

Fetch the settings form field names.

Returns
array

Definition at line 82 of file PaymethodPlugin.inc.php.

PaymethodPlugin::getTemplatePath (   $inCore = false)
PaymethodPlugin::handle (   $args,
  $request 
)

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

Parameters
$argsarray
$requestPKPRequest

Definition at line 92 of file PaymethodPlugin.inc.php.

References Plugin\$request.

PaymethodPlugin::isConfigured ( )

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

Returns
boolean

Definition at line 65 of file PaymethodPlugin.inc.php.

PaymethodPlugin::PaymethodPlugin ( )

Constructor

Definition at line 22 of file PaymethodPlugin.inc.php.


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