Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($amount=null, $currencyCode=null, $userId=null, $assocId=null) | |
getAmount () | |
getAssocId () | |
getContextId () | |
getCurrencyCode () | |
getId () | |
getType () | |
getUserId () | |
setAmount ($amount) | |
setAssocId ($assocId) | |
setContextId ($contextId) | |
setCurrencyCode ($currencyCode) | |
setId ($paymentId) | |
setType ($type) | |
setUserId ($userId) | |
Data Fields | |
$_type | |
$amount | |
$assocId | |
$contextId | |
$currencyCode | |
$paymentId | |
$userId | |
Abstract class for payments.
DOES NOT inherit from DataObject for the sake of concise serialization
Definition at line 23 of file Payment.inc.php.
Payment::__construct | ( | $amount = null , |
|
$currencyCode = null , |
|||
$userId = null , |
|||
$assocId = null |
|||
) |
Constructor
$amount | number |
$currencyCode | string |
$userId | int |
$assocId | int optional |
Reimplemented in QueuedPayment.
Definition at line 73 of file Payment.inc.php.
References $amount, $assocId, $currencyCode, and $userId.
Payment::getAmount | ( | ) |
Get the payment amount
Definition at line 110 of file Payment.inc.php.
References $amount.
Payment::getAssocId | ( | ) |
Get the association ID for the payment.
Definition at line 194 of file Payment.inc.php.
References $assocId.
Payment::getContextId | ( | ) |
Get the context ID for the payment.
Definition at line 135 of file Payment.inc.php.
References $contextId.
Payment::getCurrencyCode | ( | ) |
Get the currency code for the transaction (ISO 4217)
Definition at line 127 of file Payment.inc.php.
References $currencyCode.
Payment::getId | ( | ) |
Get the row id of the payment.
Definition at line 84 of file Payment.inc.php.
References $paymentId.
Payment::getType | ( | ) |
Get the type of this payment (PAYMENT_TYPE_...)
Definition at line 160 of file Payment.inc.php.
Payment::getUserId | ( | ) |
Get the user ID of the customer.
Definition at line 177 of file Payment.inc.php.
References $userId.
Payment::setAmount | ( | $amount | ) |
Set the payment amount
$amount | numeric |
Definition at line 102 of file Payment.inc.php.
References $amount.
Payment::setAssocId | ( | $assocId | ) |
Set the association ID for the payment.
$assocId | int |
Definition at line 186 of file Payment.inc.php.
References $assocId.
Payment::setContextId | ( | $contextId | ) |
Set the context ID for the payment.
$contextId | int |
Definition at line 143 of file Payment.inc.php.
References $contextId.
Payment::setCurrencyCode | ( | $currencyCode | ) |
Set the currency code for the transaction (ISO 4217)
$currencyCode | string |
Definition at line 119 of file Payment.inc.php.
References $currencyCode.
Payment::setId | ( | $paymentId | ) |
Set the id of payment
$paymentId | int |
Definition at line 93 of file Payment.inc.php.
References $paymentId.
Payment::setType | ( | $type | ) |
Set the type for this payment (PAYMENT_TYPE_...)
$type | int PAYMENT_TYPE_... |
Definition at line 152 of file Payment.inc.php.
Payment::setUserId | ( | $userId | ) |
Set the user ID of the customer.
$userId | int |
Definition at line 169 of file Payment.inc.php.
References $userId.
int Payment::$_type |
PAYMENT_TYPE_...
Definition at line 64 of file Payment.inc.php.
numeric Payment::$amount |
amount of payment in $currencyCode units
Definition at line 40 of file Payment.inc.php.
Referenced by QueuedPayment\__construct(), __construct(), getAmount(), and setAmount().
int Payment::$assocId |
association ID for payment
Definition at line 58 of file Payment.inc.php.
Referenced by QueuedPayment\__construct(), __construct(), getAssocId(), and setAssocId().
int Payment::$contextId |
Context ID
Definition at line 34 of file Payment.inc.php.
Referenced by getContextId(), and setContextId().
string Payment::$currencyCode |
ISO 4217 alpha currency code
Definition at line 46 of file Payment.inc.php.
Referenced by QueuedPayment\__construct(), __construct(), getCurrencyCode(), and setCurrencyCode().
int Payment::$paymentId |
int Payment::$userId |
user ID of customer making payment
Definition at line 52 of file Payment.inc.php.
Referenced by QueuedPayment\__construct(), __construct(), getUserId(), and setUserId().