Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
OJSPaymentManager Class Reference
Inheritance diagram for OJSPaymentManager:
PaymentManager

Public Member Functions

 acceptGiftPayments ()
 
 acceptGiftSubscriptionPayments ()
 
 acceptSubscriptionPayments ()
 
createCompletedPayment ($queuedPayment, $payMethod)
 
createQueuedPayment ($journalId, $type, $userId, $assocId, $amount, $currencyCode=null)
 
 donationEnabled ()
 
 fastTrackEnabled ()
 
 fulfillQueuedPayment (&$queuedPayment, $payMethodPluginName=null)
 
getPaymentPlugin ()
 
 isConfigured ()
 
 membershipEnabled ()
 
 OJSPaymentManager (&$request)
 
 onlyPdfEnabled ()
 
 publicationEnabled ()
 
 purchaseArticleEnabled ()
 
 purchaseIssueEnabled ()
 
 submissionEnabled ()
 
- Public Member Functions inherited from PaymentManager
 displayConfigurationForm ()
 
 displayPaymentForm ($queuedPaymentId, &$queuedPayment)
 
 fulfillQueuedPayment (&$queuedPayment)
 
getPaymentPlugin ()
 
getQueuedPayment ($queuedPaymentId)
 
 isConfigured ()
 
 PaymentManager (&$request)
 
 queuePayment (&$queuedPayment, $expiryDate=null)
 

Detailed Description

Provides payment management functions.

See Also
OJSQueuedPayment

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

Member Function Documentation

OJSPaymentManager::acceptGiftPayments ( )

Determine whether gift payments are enabled.

Returns
boolean true iff this fee is enabled.

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

References acceptGiftSubscriptionPayments().

OJSPaymentManager::acceptGiftSubscriptionPayments ( )

Determine whether gift subscription payments are enabled.

Returns
boolean true iff this fee is enabled.

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

References isConfigured().

Referenced by acceptGiftPayments().

OJSPaymentManager::acceptSubscriptionPayments ( )

Determine whether subscription fees are enabled.

Returns
boolean true iff this fee is enabled.

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

References isConfigured().

& OJSPaymentManager::createCompletedPayment (   $queuedPayment,
  $payMethod 
)

Create a completed payment from a queued payment.

Parameters
$queuedPaymentQueuedPayment Payment to complete.
$payMethodstring Name of payment plugin used.
Returns
OJSCompletedPayment

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

Referenced by fulfillQueuedPayment().

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

Create a queued payment.

Parameters
$journalIdint ID of journal payment applies under
$typeint PAYMENT_TYPE_...
$userIdint ID of user responsible for payment
$assocIdint ID of associated entity
$amountnumeric Amount of currency $currencyCode
$currencyCodestring optional ISO 4217 currency code
Returns
QueuedPayment

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

References DAORegistry\getDAO().

OJSPaymentManager::donationEnabled ( )

Determine whether donations are enabled.

Returns
boolean true iff this fee is enabled.

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

References isConfigured().

OJSPaymentManager::fastTrackEnabled ( )

Determine whether fast track fees are enabled.

Returns
boolean true iff this fee is enabled.

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

References isConfigured().

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

Fulfill a queued payment.

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

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

References createCompletedPayment(), Validation\encryptCredentials(), Validation\generatePassword(), Core\getCurrentDate(), DAORegistry\getDAO(), AppLocale\requireComponents(), SubscriptionAction\sendOnlinePaymentNotificationEmail(), and Validation\suggestUsername().

& OJSPaymentManager::getPaymentPlugin ( )

Get the payment plugin.

Returns
PaymentPlugin

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

References PluginRegistry\loadCategory().

OJSPaymentManager::isConfigured ( )
OJSPaymentManager::membershipEnabled ( )

Determine whether publication fees are enabled.

Returns
boolean true iff this fee is enabled.

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

References isConfigured().

OJSPaymentManager::OJSPaymentManager ( $request)

Constructor

Parameters
$requestPKPRequest

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

OJSPaymentManager::onlyPdfEnabled ( )

Determine whether PDF-only article purchase fees are enabled.

Returns
boolean true iff this fee is enabled.

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

References isConfigured().

OJSPaymentManager::publicationEnabled ( )

Determine whether publication fees are enabled.

Returns
boolean true iff this fee is enabled.

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

References isConfigured().

OJSPaymentManager::purchaseArticleEnabled ( )

Determine whether article purchase fees are enabled.

Returns
boolean true iff this fee is enabled.

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

References isConfigured().

OJSPaymentManager::purchaseIssueEnabled ( )

Determine whether issue purchase fees are enabled.

Returns
boolean true iff this fee is enabled.

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

References isConfigured().

OJSPaymentManager::submissionEnabled ( )

Determine whether submission fees are enabled.

Returns
boolean true iff this fee is enabled.

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

References isConfigured().


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