Open Journal Systems  3.3.0
OJSPaymentManager Class Reference
Inheritance diagram for OJSPaymentManager:
PaymentManager

Public Member Functions

 createCompletedPayment ($queuedPayment, $payMethod, $userId=null)
 
 createQueuedPayment ($request, $type, $userId, $assocId, $amount, $currencyCode=null)
 
 fulfillQueuedPayment ($request, $queuedPayment, $payMethodPluginName=null)
 
 getPaymentName ($payment)
 
 getPaymentPlugin ()
 
 isConfigured ()
 
 membershipEnabled ()
 
 onlyPdfEnabled ()
 
 publicationEnabled ()
 
 purchaseArticleEnabled ()
 
 purchaseIssueEnabled ()
 
- Public Member Functions inherited from PaymentManager
 __construct ($context)
 
 displayConfigurationForm ()
 
 fulfillQueuedPayment ($request, $queuedPayment)
 
 getPaymentForm ($queuedPayment)
 
 getQueuedPayment ($queuedPaymentId)
 
 queuePayment ($queuedPayment, $expiryDate=null)
 

Additional Inherited Members

- Data Fields inherited from PaymentManager
 $_context
 

Detailed Description

Provides payment management functions.

See also
QueuedPayment

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

Member Function Documentation

◆ createCompletedPayment()

OJSPaymentManager::createCompletedPayment (   $queuedPayment,
  $payMethod,
  $userId = null 
)

Create a completed payment from a queued payment.

Parameters
$queuedPaymentQueuedPayment Payment to complete.
$payMethodstring Name of payment plugin used.
$userIdint User ID to attribute payment to (if unspecified, will be taken from queued payment)
Returns
CompletedPayment

Definition at line 101 of file OJSPaymentManager.inc.php.

Referenced by fulfillQueuedPayment().

◆ createQueuedPayment()

OJSPaymentManager::createQueuedPayment (   $request,
  $type,
  $userId,
  $assocId,
  $amount,
  $currencyCode = null 
)

Create a queued payment.

Parameters
$requestPKPRequest
$typeint PAYMENT_TYPE_...
$userIdint ID of user responsible for payment
$assocIdint ID of associated entity
$amountfloat Amount of currency $currencyCode
$currencyCodestring optional ISO 4217 currency code
Returns
QueuedPayment

Definition at line 50 of file OJSPaymentManager.inc.php.

References DAORegistry\getDAO().

◆ fulfillQueuedPayment()

OJSPaymentManager::fulfillQueuedPayment (   $request,
  $queuedPayment,
  $payMethodPluginName = null 
)

Fulfill a queued payment.

Parameters
$requestPKPRequest
$queuedPaymentQueuedPayment
$payMethodPluginNamestring Name of payment plugin.
Returns
mixed Dependent on payment type.

Definition at line 179 of file OJSPaymentManager.inc.php.

References createCompletedPayment(), fatalError(), DAORegistry\getDAO(), and SubscriptionAction\sendOnlinePaymentNotificationEmail().

◆ getPaymentName()

OJSPaymentManager::getPaymentName (   $payment)

Fetch the name of the description.

Returns
string

Definition at line 305 of file OJSPaymentManager.inc.php.

References DAORegistry\getDAO().

◆ getPaymentPlugin()

OJSPaymentManager::getPaymentPlugin ( )

Get the payment plugin.

Returns
PaymethodPlugin

Reimplemented from PaymentManager.

Definition at line 162 of file OJSPaymentManager.inc.php.

References PluginRegistry\loadCategory().

◆ isConfigured()

OJSPaymentManager::isConfigured ( )

Determine whether the payment system is configured.

Returns
boolean true iff configured

Reimplemented from PaymentManager.

Definition at line 36 of file OJSPaymentManager.inc.php.

Referenced by membershipEnabled(), onlyPdfEnabled(), publicationEnabled(), purchaseArticleEnabled(), and purchaseIssueEnabled().

◆ membershipEnabled()

OJSPaymentManager::membershipEnabled ( )

Determine whether publication fees are enabled.

Returns
boolean true iff this fee is enabled.

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

References isConfigured().

◆ onlyPdfEnabled()

OJSPaymentManager::onlyPdfEnabled ( )

Determine whether PDF-only article purchase fees are enabled.

Returns
boolean true iff this fee is enabled.

Definition at line 154 of file OJSPaymentManager.inc.php.

References isConfigured().

◆ publicationEnabled()

OJSPaymentManager::publicationEnabled ( )

Determine whether publication fees are enabled.

Returns
boolean true iff this fee is enabled.

Definition at line 122 of file OJSPaymentManager.inc.php.

References isConfigured().

◆ purchaseArticleEnabled()

OJSPaymentManager::purchaseArticleEnabled ( )

Determine whether article purchase fees are enabled.

Returns
boolean true iff this fee is enabled.

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

References isConfigured().

◆ purchaseIssueEnabled()

OJSPaymentManager::purchaseIssueEnabled ( )

Determine whether issue purchase fees are enabled.

Returns
boolean true iff this fee is enabled.

Definition at line 146 of file OJSPaymentManager.inc.php.

References isConfigured().


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