Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
OMPCompletedPayment Class Reference
Inheritance diagram for OMPCompletedPayment:
Payment

Public Member Functions

 getAssocDescription ()
 
 getDescription ()
 
 getName ()
 
 getPayMethodPluginName ()
 
 getPressId ()
 
 getTimestamp ()
 
 getType ()
 
 OMPCompletedPayment ()
 
 setPayMethodPluginName ($payMethod)
 
 setPressId ($pressId)
 
 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)
 

Additional Inherited Members

- Public Attributes inherited from Payment
 $amount
 
 $assocId
 
 $currencyCode
 
 $paymentId
 
 $userId
 

Detailed Description

Class describing a payment ready to be in the database.

See Also
OMPCompletedPaymentDAO

Definition at line 23 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 148 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 96 of file OMPCompletedPayment.inc.php.

References DAORegistry\getDAO(), and 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 78 of file OMPCompletedPayment.inc.php.

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

OMPCompletedPayment::getPayMethodPluginName ( )

Get the method of payment.

Returns
String

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

OMPCompletedPayment::getPressId ( )

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

Returns
int

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

Referenced by getDescription(), and getName().

OMPCompletedPayment::getTimestamp ( )

Get the row id of the payment.

Returns
int

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

OMPCompletedPayment::getType ( )

Set the Payment Type

Returns
$type int

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

OMPCompletedPayment::OMPCompletedPayment ( )

Constructor

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

OMPCompletedPayment::setPayMethodPluginName (   $payMethod)

Set the method of payment.

Parameters
$pressIdString

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

OMPCompletedPayment::setPressId (   $pressId)

Set the press ID of the payment.

Parameters
$pressIdint

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

OMPCompletedPayment::setTimestamp (   $timestamp)

Set the id of payment

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

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

OMPCompletedPayment::setType (   $type)

Set the Payment Type

Parameters
$typeint

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


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