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

Public Member Functions

 addSettings ($hookName, $form)
 
 getDescription ()
 
 getDisplayName ()
 
 getInstallEmailTemplatesFile ()
 
 getName ()
 
 getPaymentForm ($context, $queuedPayment)
 
 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)
 
 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

Manual payment plugin class.

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

Member Function Documentation

◆ addSettings()

ManualPaymentPlugin::addSettings (   $hookName,
  $form 
)

Add settings to the payments form

Parameters
$hookNamestring
$formFormComponent

Definition at line 59 of file ManualPaymentPlugin.inc.php.

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

◆ getDescription()

ManualPaymentPlugin::getDescription ( )

Get a description of this plugin.

Returns
string

Reimplemented from Plugin.

Definition at line 37 of file ManualPaymentPlugin.inc.php.

◆ getDisplayName()

ManualPaymentPlugin::getDisplayName ( )

Get the display name for this plugin.

Returns
string

Reimplemented from Plugin.

Definition at line 30 of file ManualPaymentPlugin.inc.php.

◆ getInstallEmailTemplatesFile()

ManualPaymentPlugin::getInstallEmailTemplatesFile ( )

Get the filename of the email templates for this plugin. Subclasses using email templates should override this.

Returns
string

Reimplemented from Plugin.

Definition at line 176 of file ManualPaymentPlugin.inc.php.

References Plugin\getPluginPath().

◆ getName()

ManualPaymentPlugin::getName ( )

Protected methods (may be overridden by custom plugins) 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

Reimplemented from LazyLoadPlugin.

Definition at line 23 of file ManualPaymentPlugin.inc.php.

◆ getPaymentForm()

ManualPaymentPlugin::getPaymentForm (   $context,
  $queuedPayment 
)

Get the payment form for this plugin.

Parameters
$contextContext
$queuedPaymentQueuedPayment
Returns
Form

Reimplemented from PaymethodPlugin.

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

References Application\getPaymentManager(), Plugin\getTemplateResource(), isConfigured(), and AppLocale\requireComponents().

◆ handle()

ManualPaymentPlugin::handle (   $args,
  $request 
)

Handle incoming requests/notifications

Parameters
$argsarray
$requestPKPRequest

Definition at line 128 of file ManualPaymentPlugin.inc.php.

References $op, Plugin\$request, DAORegistry\getDAO(), PKPTemplateManager\getManager(), Application\getPaymentManager(), and AppLocale\requireComponents().

◆ isConfigured()

ManualPaymentPlugin::isConfigured (   $context)

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

Parameters
$contextContext
Returns
boolean

Reimplemented from PaymethodPlugin.

Definition at line 96 of file ManualPaymentPlugin.inc.php.

References Plugin\getSetting().

Referenced by getPaymentForm().

◆ register()

ManualPaymentPlugin::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 44 of file ManualPaymentPlugin.inc.php.

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

◆ saveSettings()

ManualPaymentPlugin::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 86 of file ManualPaymentPlugin.inc.php.

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


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