OJSCompletedPayment Class Reference
[Payment_ojs]

Class describing a payment ready to be in the database. More...

Inheritance diagram for OJSCompletedPayment:

List of all members.

Public Member Functions
	getAssocDescription ()
	getCompletedPaymentId ()
	getDescription ()
	getJournalId ()
	getName ()
	getPayMethodPluginName ()
	getTimestamp ()
	getType ()
	getUsername ()
	isMembership ()
	isSubscription ()
	OJSCompletedPayment ()
	setCompletedPaymentId ($queuedPaymentId)
	setJournalId ($journalId)
	setPayMethodPluginName ($payMethod)
	setTimestamp ($timestamp)
	setType ($type)

---

Detailed Description

Class describing a payment ready to be in the database.

See also:

OJSCompletedPaymentDAO

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

---

Member Function Documentation

OJSCompletedPayment.getAssocDescription

(

)

Get some information about the assocId for display.

Returns:

String

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

References DAORegistry.getDAO(), and Locale.translate().

OJSCompletedPayment.getCompletedPaymentId

(

)

Get the ID of the payment.

Returns:

int

Definition at line 55 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

Reimplemented from Payment.

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

References DAORegistry.getDAO(), getJournalId(), and Locale.translate().

OJSCompletedPayment.getJournalId

(

)

Get the journal ID of the payment.

Returns:

int

Definition at line 63 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

Reimplemented from Payment.

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

References DAORegistry.getDAO(), getJournalId(), and Locale.translate().

OJSCompletedPayment.getPayMethodPluginName

(

)

Get the method of payment.

Returns:

String

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

OJSCompletedPayment.getTimestamp

(

)

Get the row id of the payment.

Returns:

int

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

OJSCompletedPayment.getType

(

)

Set the Payment Type

Returns:

$type int

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

OJSCompletedPayment.getUsername

(

)

Get the username from the userId in the payment

Returns:

String

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

References DAORegistry.getDAO().

OJSCompletedPayment.isMembership

(

)

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

Returns:

bool

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

OJSCompletedPayment.isSubscription

(

)

Check if the type is a subscription

Returns:

bool

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

OJSCompletedPayment.OJSCompletedPayment

(

)

Constructor

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

OJSCompletedPayment.setCompletedPaymentId

(

$

queuedPaymentId

)

Get/set methods Set the ID of the payment.

Parameters:

$queuedPaymentId

int

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

OJSCompletedPayment.setJournalId

(

$

journalId

)

Set the journal ID of the payment.

Parameters:

$journalId

int

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

OJSCompletedPayment.setPayMethodPluginName

(

$

payMethod

)

Set the method of payment.

Parameters:

$journalId

String

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

OJSCompletedPayment.setTimestamp

(

$

timestamp

)

Set the id of payment

Parameters:

$dt

int/string *nix timestamp or ISO datetime string

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

OJSCompletedPayment.setType

(

$

type

)

Set the Payment Type

Parameters:

$type

int

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

---

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

• classes/payment/ojs/OJSCompletedPayment.inc.php