PayPalPlugin Class Reference

PayPal Paymethod plugin class. More...

Inheritance diagram for PayPalPlugin:

List of all members.

Public Member Functions
	displayPaymentForm ($queuedPaymentId, &$queuedPayment)
	displayPaymentSettingsForm (&$params, &$smarty)
	getDescription ()
	getDisplayName ()
	getInstallDataFile ()
	getInstallSchemaFile ()
	getName ()
	getSettingsFormFieldNames ()
	handle ($args)
	isConfigured ()
	isCurlInstalled ()
	register ($category, $path)

---

Detailed Description

PayPal Paymethod plugin class.

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

---

Member Function Documentation

PayPalPlugin.displayPaymentForm	(	$	queuedPaymentId,
		&$	queuedPayment
	)

Display the payment form

Parameters:

	$queuedPaymentId	int
	$queuedPayment	QueuedPayment

Definition at line 110 of file PayPalPlugin.inc.php.

References getDescription(), Request.getJournal(), Locale.getLocale(), TemplateManager.getManager(), getName(), PaymethodPlugin.getTemplatePath(), Request.getUser(), isConfigured(), String.substr(), and Request.url().

PayPalPlugin.displayPaymentSettingsForm	(	&$	params,
		&$	smarty
	)

Display the settings form

Parameters:

	$params
	$smarty	Smarty

Reimplemented from PaymethodPlugin.

Definition at line 100 of file PayPalPlugin.inc.php.

References isCurlInstalled().

PayPalPlugin.getDescription

(

)

Get a description of the plugin

Returns:

String

Reimplemented from PaymethodPlugin.

Definition at line 40 of file PayPalPlugin.inc.php.

References Locale.translate().

Referenced by displayPaymentForm().

PayPalPlugin.getDisplayName

(

)

Get the Plugin's display name

Returns:

String

Reimplemented from Plugin.

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

References Locale.translate().

PayPalPlugin.getInstallDataFile

(

)

Get the filename of the install data for this plugin. Subclasses using SQL tables should override this.

Returns:

string

Reimplemented from Plugin.

Definition at line 302 of file PayPalPlugin.inc.php.

References Plugin.getPluginPath().

PayPalPlugin.getInstallSchemaFile

(

)

Get the filename of the ADODB schema for this plugin. Subclasses using SQL tables should override this.

Returns:

string

Reimplemented from Plugin.

Definition at line 298 of file PayPalPlugin.inc.php.

References Plugin.getPluginPath().

PayPalPlugin.getName

(

)

Get the Plugin's internal name

Returns:

String

Reimplemented from PaymethodPlugin.

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

Referenced by displayPaymentForm(), and handle().

PayPalPlugin.getSettingsFormFieldNames

(

)

Get an array of the fields in the settings form

Returns:

array

Reimplemented from PaymethodPlugin.

Definition at line 64 of file PayPalPlugin.inc.php.

Referenced by isConfigured().

PayPalPlugin.handle

(

$

args

)

Handle incoming requests/notifications

Reimplemented from PaymethodPlugin.

Definition at line 144 of file PayPalPlugin.inc.php.

References DAORegistry.getDAO(), Request.getJournal(), OJSPaymentManager.getManager(), TemplateManager.getManager(), getName(), Request.getUserVar(), and Request.url().

PayPalPlugin.isConfigured

(

)

Check if plugin is configured and ready for use

Returns:

bool

Reimplemented from PaymethodPlugin.

Definition at line 80 of file PayPalPlugin.inc.php.

References Request.getJournal(), getSettingsFormFieldNames(), and isCurlInstalled().

Referenced by displayPaymentForm().

PayPalPlugin.isCurlInstalled

(

)

return if required Curl is installed

Returns:

bool

Definition at line 72 of file PayPalPlugin.inc.php.

Referenced by displayPaymentSettingsForm(), and isConfigured().

PayPalPlugin.register	(	$	category,
		$	path
	)

Register plugin

Returns:

bool

Reimplemented from PaymethodPlugin.

Definition at line 48 of file PayPalPlugin.inc.php.

References Plugin.addLocaleData(), Config.getVar(), and DAORegistry.registerDAO().

---

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

• plugins/paymethod/paypal/PayPalPlugin.inc.php