PHP Class PKPPaymethodPlugin, pkp-lib

Inheritance: extends Plugin

Datei anzeigen Open project: pkp/pkp-lib Class Usage Examples

Public Methods

Method	Description
__construct ( )	Constructor
_smartyDisplayPaymentSettingsForm ( $hookName, $args )	This is a hook wrapper that is responsible for calling displayPaymentSettingsForm. Subclasses should override displayPaymentSettingsForm as necessary.
displayPaymentForm ( $queuedPaymentId, $queuedPayment, $request )	Display the payment form.
displayPaymentSettingsForm ( &$params, $smarty )	Display the payment settings form.
getRequiredSettingsFormFieldNames ( ) : array	Fetch the required form field names.
getSettingsFormFieldNames ( ) : array	Fetch the settings form field names.
getTemplatePath ( $inCore = false )
handle ( $args, $request )	Handle an incoming request from a user callback or an external payment processing system.
isConfigured ( ) : boolean	Determine whether or not the payment plugin is configured for use.
register ( $category, $path ) : boolean	Called as a plugin is registered to the registry. Subclasses over- riding this method should call the parent method first.

Method Details

__construct() public method

Constructor

public __construct ( )

_smartyDisplayPaymentSettingsForm() public method

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

public _smartyDisplayPaymentSettingsForm ( $hookName, $args )
$hookName		string
$args		array

displayPaymentForm() abstract public method

Display the payment form.

abstract public displayPaymentForm ( $queuedPaymentId, $queuedPayment, $request )
$queuedPaymentId		int
$queuedPayment		QueuedPayment
$request		PKPRequest

displayPaymentSettingsForm() public method

Display the payment settings form.

public displayPaymentSettingsForm ( &$params, $smarty )
$params		array
$smarty		Smarty

getRequiredSettingsFormFieldNames() public method

Fetch the required form field names.

public getRequiredSettingsFormFieldNames ( ) : array
return	array

getSettingsFormFieldNames() public method

Fetch the settings form field names.

public getSettingsFormFieldNames ( ) : array
return	array

getTemplatePath() public method

public getTemplatePath ( $inCore = false )

handle() public method

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

public handle ( $args, $request )
$args		array
$request		PKPRequest

isConfigured() abstract public method

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

abstract public isConfigured ( ) : boolean
return	boolean

register() public method

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

public register ( $category, $path ) : boolean
$category		String Name of category plugin was registered to
$path		String The path the plugin was found in
return	boolean	True iff plugin initialized successfully; if false, the plugin will not be registered.