Open Monograph Press  3.3.0
PaypalPaymentPlugin Class Reference
Inheritance diagram for PaypalPaymentPlugin:
PaymethodPlugin LazyLoadPlugin Plugin

Public Member Functions

 addSettings ($hookName, $form)
 
 getDescription ()
 
 getDisplayName ()
 
 getInstallEmailTemplatesFile ()
 
 getName ()
 
 getPaymentForm ($context, $queuedPayment)
 
 getTemplatePath ($inCore=false)
 
 handle ($args, $request)
 
 isConfigured ($context)
 
 register ($category, $path, $mainContextId=null)
 
 saveSettings ($params, $slimRequest, $request)
 
- Public Member Functions inherited from LazyLoadPlugin
 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 getEnabled ($contextId=null)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getActions ($request, $actionArgs)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDirName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 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

Paypal payment plugin class.

Definition at line 19 of file PaypalPaymentPlugin.inc.php.

Member Function Documentation

◆ addSettings()

PaypalPaymentPlugin::addSettings (   $hookName,
  $form 
)

Add settings to the payments form

Parameters
$hookNamestring
$formFormComponent

Definition at line 60 of file PaypalPaymentPlugin.inc.php.

References PKPApplication\get(), and Plugin\getSetting().

◆ getDescription()

PaypalPaymentPlugin::getDescription ( )
See also
Plugin::getDescription

Reimplemented from Plugin.

Definition at line 38 of file PaypalPaymentPlugin.inc.php.

◆ getDisplayName()

PaypalPaymentPlugin::getDisplayName ( )
See also
Plugin::getDisplayName

Reimplemented from Plugin.

Definition at line 31 of file PaypalPaymentPlugin.inc.php.

◆ getInstallEmailTemplatesFile()

PaypalPaymentPlugin::getInstallEmailTemplatesFile ( )
See also
Plugin::getInstallEmailTemplatesFile

Reimplemented from Plugin.

Definition at line 188 of file PaypalPaymentPlugin.inc.php.

References Plugin\getPluginPath().

◆ getName()

PaypalPaymentPlugin::getName ( )
See also
Plugin::getName

Reimplemented from LazyLoadPlugin.

Definition at line 24 of file PaypalPaymentPlugin.inc.php.

Referenced by handle().

◆ getPaymentForm()

PaypalPaymentPlugin::getPaymentForm (   $context,
  $queuedPayment 
)

Get the payment form for this plugin.

Parameters
$contextContext
$queuedPaymentQueuedPayment
Returns
Form

Reimplemented from PaymethodPlugin.

Definition at line 130 of file PaypalPaymentPlugin.inc.php.

◆ getTemplatePath()

PaypalPaymentPlugin::getTemplatePath (   $inCore = false)

Return the canonical template path of this plug-in

Parameters
$inCoreReturn the core template path if true.
Returns
string|null

Reimplemented from Plugin.

Definition at line 195 of file PaypalPaymentPlugin.inc.php.

◆ handle()

PaypalPaymentPlugin::handle (   $args,
  $request 
)

◆ isConfigured()

PaypalPaymentPlugin::isConfigured (   $context)

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

Parameters
$contextContext
Returns
boolean

Reimplemented from PaymethodPlugin.

Definition at line 138 of file PaypalPaymentPlugin.inc.php.

References Plugin\getSetting().

◆ register()

PaypalPaymentPlugin::register (   $category,
  $path,
  $mainContextId = null 
)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters
$categoryString Name of category plugin was registered to
$pathString The path the plugin was found in
$mainContextIdinteger To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.
Returns
boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from LazyLoadPlugin.

Definition at line 45 of file PaypalPaymentPlugin.inc.php.

References Plugin\addLocaleData(), and HookRegistry\register().

◆ saveSettings()

PaypalPaymentPlugin::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 from PaymethodPlugin.

Definition at line 105 of file PaypalPaymentPlugin.inc.php.

References Plugin\$request, and Plugin\updateSetting().


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