OMPCompletedPayment Class Reference [Payment_omp]

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

List of all members.

Public Member Functions
	getAssocDescription ()
	getDescription ()
	getName ()
	getPayMethodPluginName ()
	getPressId ()
	getTimestamp ()
	getType ()
	OMPCompletedPayment ()
	setPayMethodPluginName ($payMethod)
	setPressId ($pressId)
	setTimestamp ($timestamp)
	setType ($type)

---

Detailed Description

Class describing a payment ready to be in the database.

See also:

OMPCompletedPaymentDAO

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

---

Member Function Documentation

OMPCompletedPayment.getAssocDescription

(

)

Display-related get Methods Get some information about the assocId for display.

Returns:

String

Definition at line 147 of file OMPCompletedPayment.inc.php.

OMPCompletedPayment.getDescription

(

)

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

Returns:

string

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

References getPressId().

OMPCompletedPayment.getName

(

)

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

Returns:

string

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

References getPressId().

OMPCompletedPayment.getPayMethodPluginName

(

)

Get the method of payment.

Returns:

String

Definition at line 127 of file OMPCompletedPayment.inc.php.

OMPCompletedPayment.getPressId

(

)

Get/set methods Get the press ID of the payment.

Returns:

int

Definition at line 43 of file OMPCompletedPayment.inc.php.

Referenced by getDescription(), and getName().

OMPCompletedPayment.getTimestamp

(

)

Get the row id of the payment.

Returns:

int

Definition at line 111 of file OMPCompletedPayment.inc.php.

OMPCompletedPayment.getType

(

)

Set the Payment Type

Returns:

$type int

Definition at line 67 of file OMPCompletedPayment.inc.php.

OMPCompletedPayment.OMPCompletedPayment

(

)

Constructor

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

OMPCompletedPayment.setPayMethodPluginName

(

$

payMethod

)

Set the method of payment.

Parameters:

$pressId

String

Definition at line 135 of file OMPCompletedPayment.inc.php.

OMPCompletedPayment.setPressId

(

$

pressId

)

Set the press ID of the payment.

Parameters:

$pressId

int

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

OMPCompletedPayment.setTimestamp

(

$

timestamp

)

Set the id of payment

Parameters:

$dt

int/string *nix timestamp or ISO datetime string

Definition at line 119 of file OMPCompletedPayment.inc.php.

OMPCompletedPayment.setType

(

$

type

)

Set the Payment Type

Parameters:

$type

int

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

---

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

• classes/payment/omp/OMPCompletedPayment.inc.php