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

Public Member Functions

 getAssocDescription ()
 
 getCompletedPaymentId ()
 
 getDescription ()
 
 getJournalId ()
 
 getName ()
 
 getPayMethodPluginName ()
 
 getTimestamp ()
 
 getType ()
 
 isMembership ()
 
 isSubscription ()
 
 OJSCompletedPayment ()
 
 setCompletedPaymentId ($queuedPaymentId)
 
 setJournalId ($journalId)
 
 setPayMethodPluginName ($payMethod)
 
 setTimestamp ($timestamp)
 
 setType ($type)
 
- 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

Class describing a payment ready to be in the database.

See Also
OJSCompletedPaymentDAO

Definition at line 23 of file OJSCompletedPayment.inc.php.

Member Function Documentation

OJSCompletedPayment::getAssocDescription ( )

Get some information about the assocId for display.

Returns
String

Definition at line 321 of file OJSCompletedPayment.inc.php.

References DAORegistry\getDAO().

OJSCompletedPayment::getCompletedPaymentId ( )

Get the ID of the payment.

Returns
int

Definition at line 53 of file OJSCompletedPayment.inc.php.

OJSCompletedPayment::getDescription ( )

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

Returns
string

Definition at line 178 of file OJSCompletedPayment.inc.php.

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

OJSCompletedPayment::getJournalId ( )

Get the journal ID of the payment.

Returns
int

Definition at line 61 of file OJSCompletedPayment.inc.php.

Referenced by getDescription(), and getName().

OJSCompletedPayment::getName ( )

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

Returns
string

Definition at line 95 of file OJSCompletedPayment.inc.php.

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

OJSCompletedPayment::getPayMethodPluginName ( )

Get the method of payment.

Returns
String

Definition at line 285 of file OJSCompletedPayment.inc.php.

OJSCompletedPayment::getTimestamp ( )

Get the row id of the payment.

Returns
int

Definition at line 269 of file OJSCompletedPayment.inc.php.

OJSCompletedPayment::getType ( )

Set the Payment Type

Returns
$type int

Definition at line 85 of file OJSCompletedPayment.inc.php.

OJSCompletedPayment::isMembership ( )

Display-related get Methods Check if the type is a membership

Returns
bool

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

OJSCompletedPayment::isSubscription ( )

Check if the type is a subscription

Returns
bool

Definition at line 313 of file OJSCompletedPayment.inc.php.

OJSCompletedPayment::OJSCompletedPayment ( )

Constructor

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

OJSCompletedPayment::setCompletedPaymentId (   $queuedPaymentId)

Get/set methods Set the ID of the payment.

Parameters
$queuedPaymentIdint

Definition at line 45 of file OJSCompletedPayment.inc.php.

OJSCompletedPayment::setJournalId (   $journalId)

Set the journal ID of the payment.

Parameters
$journalIdint

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

OJSCompletedPayment::setPayMethodPluginName (   $payMethod)

Set the method of payment.

Parameters
$journalIdString

Definition at line 293 of file OJSCompletedPayment.inc.php.

OJSCompletedPayment::setTimestamp (   $timestamp)

Set the id of payment

Parameters
$dtint/string *nix timestamp or ISO datetime string

Definition at line 277 of file OJSCompletedPayment.inc.php.

OJSCompletedPayment::setType (   $type)

Set the Payment Type

Parameters
$typeint

Definition at line 77 of file OJSCompletedPayment.inc.php.


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