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

Public Member Functions

 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)
 

Public Attributes

 $amount
 
 $assocId
 
 $currencyCode
 
 $paymentId
 
 $userId
 

Detailed Description

Abstract class for payments.

DOES NOT inherit from DataObject for the sake of concise serialization

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

Member Function Documentation

Payment::getAmount ( )

Get the payment amount

Returns
numeric

Definition at line 94 of file Payment.inc.php.

Payment::getAssocId ( )

Get the association ID for the payment.

Returns
int

Definition at line 163 of file Payment.inc.php.

Referenced by OMPQueuedPayment\getType().

Payment::getCurrencyCode ( )

Get the currency code for the transaction (ISO 4217)

Returns
string

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

Payment::getDescription ( )

Get a description of the transaction.

Returns
string

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

Payment::getId ( )

Get the row id of the payment.

Returns
int

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

Payment::getName ( )

Get the name of the transaction.

Returns
string

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

Payment::getUserId ( )

Get the user ID of the customer.

Returns
int

Definition at line 146 of file Payment.inc.php.

Payment::Payment (   $amount = null,
  $currencyCode = null,
  $userId = null,
  $assocId = null 
)

Constructor

Definition at line 57 of file Payment.inc.php.

Payment::setAmount (   $amount)

Set the payment amount

Parameters
$amountnumeric
Returns
numeric new amount

Definition at line 86 of file Payment.inc.php.

Payment::setAssocId (   $assocId)

Set the association ID for the payment.

Parameters
$assocIdint
Returns
int New association ID

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

Payment::setCurrencyCode (   $currencyCode)

Set the currency code for the transaction (ISO 4217)

Parameters
$currencyCodestring
Returns
string new currency code

Definition at line 103 of file Payment.inc.php.

Payment::setId (   $paymentId)

Set the id of payment

Parameters
$paymentIdint
Returns
int new payment id

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

Payment::setUserId (   $userId)

Set the user ID of the customer.

Parameters
$userIdint
Returns
int New user ID

Definition at line 138 of file Payment.inc.php.

Member Data Documentation

numeric Payment::$amount

amount of payment in $currencyCode units

Definition at line 34 of file Payment.inc.php.

Referenced by QueuedPayment\QueuedPayment().

int Payment::$assocId

association ID for payment

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

Referenced by QueuedPayment\QueuedPayment().

string Payment::$currencyCode

ISO 4217 alpha currency code

Definition at line 40 of file Payment.inc.php.

Referenced by QueuedPayment\QueuedPayment().

int Payment::$paymentId

payment id

Definition at line 28 of file Payment.inc.php.

int Payment::$userId

user ID of customer making payment

Definition at line 46 of file Payment.inc.php.

Referenced by QueuedPayment\QueuedPayment().


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