Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
OJSQueuedPayment Class Reference
Inheritance diagram for OJSQueuedPayment:
QueuedPayment Payment

Public Member Functions

 getDescription ()
 
 getJournalId ()
 
 getName ()
 
 getRequestUrl ()
 
 getType ()
 
 setJournalId ($journalId)
 
 setRequestUrl ($url)
 
 setType ($type)
 
- Public Member Functions inherited from QueuedPayment
 getQueuedPaymentId ()
 
 QueuedPayment ($amount, $currencyCode, $userId=null, $assocId=null)
 
 setQueuedPaymentId ($queuedPaymentId)
 
- Public Member Functions inherited from Payment
 getAmount ()
 
 getAssocId ()
 
 getCurrencyCode ()
 
 getDescription ()
 
 getId ()
 
 getName ()
 
 getUserId ()
 
 Payment ($amount=null, $currencyCode=null, $userId=null, $assocId=null)
 
 setAmount ($amount)
 
 setAssocId ($assocId)
 
 setCurrencyCode ($currencyCode)
 
 setId ($paymentId)
 
 setUserId ($userId)
 

Detailed Description

Queued payment data structure for OJS.

Definition at line 19 of file OJSQueuedPayment.inc.php.

Member Function Documentation

OJSQueuedPayment::getDescription ( )

Returns the description of the QueuedPayment. Pulled from Journal Settings if present, or from locale file otherwise. For subscriptions, pulls subscription type name.

Returns
string

Definition at line 155 of file OJSQueuedPayment.inc.php.

References DAORegistry\getDAO(), and getJournalId().

OJSQueuedPayment::getJournalId ( )

Get the journal ID of the payment.

Returns
int

Definition at line 33 of file OJSQueuedPayment.inc.php.

Referenced by getDescription(), and getName().

OJSQueuedPayment::getName ( )

Returns the name of the QueuedPayment. Pulled from Journal Settings if present, or from locale file otherwise. For subscriptions, pulls subscription type name.

Returns
string

Definition at line 69 of file OJSQueuedPayment.inc.php.

References DAORegistry\getDAO(), and getJournalId().

OJSQueuedPayment::getRequestUrl ( )

Get the request URL.

Returns
string

Definition at line 258 of file OJSQueuedPayment.inc.php.

OJSQueuedPayment::getType ( )

Get the type of this payment (PAYMENT_TYPE_...)

Returns
int PAYMENT_TYPE_...

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

OJSQueuedPayment::setJournalId (   $journalId)

Set the journal ID of the payment.

Parameters
$journalIdint
Returns
$journalId int New journal ID

Definition at line 42 of file OJSQueuedPayment.inc.php.

OJSQueuedPayment::setRequestUrl (   $url)

Set the request URL.

Parameters
$urlstring
Returns
string New URL

Definition at line 250 of file OJSQueuedPayment.inc.php.

OJSQueuedPayment::setType (   $type)

Set the type for this payment (PAYMENT_TYPE_...)

Parameters
$typeint PAYMENT_TYPE_...
Returns
int New payment type

Definition at line 51 of file OJSQueuedPayment.inc.php.


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