Open Journal Systems  3.3.0
PaymethodPlugin Class Reference
Inheritance diagram for PaymethodPlugin:
LazyLoadPlugin Plugin ManualPaymentPlugin PaypalPaymentPlugin

Public Member Functions

 getPaymentForm ($context, $queuedPayment)
 
 isConfigured ($context)
 
 saveSettings ($params, $slimRequest, $request)
 
- Public Member Functions inherited from LazyLoadPlugin
 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 getEnabled ($contextId=null)
 
 getName ()
 
 register ($category, $path, $mainContextId=null)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getActions ($request, $actionArgs)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDirName ()
 
 getDisplayName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getTemplatePath ($inCore=false)
 
 getTemplateResource ($template=null, $inCore=false)
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installControlledVocabs ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($args, $request)
 
 smartyPluginUrl ($params, $smarty)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Additional Inherited Members

- Data Fields inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 
- Protected Member Functions inherited from Plugin
 _registerTemplateResource ($inCore=false)
 

Detailed Description

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

Member Function Documentation

◆ getPaymentForm()

PaymethodPlugin::getPaymentForm (   $context,
  $queuedPayment 
)
abstract

Get the payment form for this plugin.

Parameters
$contextContext
$queuedPaymentQueuedPayment
Returns
Form

Reimplemented in PaypalPaymentPlugin, and ManualPaymentPlugin.

◆ isConfigured()

PaymethodPlugin::isConfigured (   $context)

Check whether this plugin is fully configured and ready for use.

Parameters
$contextContext
Returns
boolean

Reimplemented in PaypalPaymentPlugin, and ManualPaymentPlugin.

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

◆ saveSettings()

PaymethodPlugin::saveSettings (   $params,
  $slimRequest,
  $request 
)

Save settings for this payment method

Parameters
$paramsarray Params that have already been
$slimRequestRequest Slim request object
$requestRequest
Returns
array List of errors

Reimplemented in PaypalPaymentPlugin, and ManualPaymentPlugin.

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


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