Docs For Class Charge

Class Charge

Description

Located in /Charge.php (line 13)

ClientObject
   |
   --Charge

Variable Summary

int $index

bool $isPrepaid

PaymentPlan $paymentPlan

DateTime $processedDate

String $type

Method Summary

Charge __construct ([DateTime $createDate = null], [DateTime $processedDate = null], [bool $isPrepaid = null], [String $type = null], [int $merchantAccountCode = null], [PaymentPlan $paymentPlan = null], [String $code = null], [int $id = null])

void equals ( $anotherObject)

DateTime getBillingDate ()

int getIndex ()

bool getIsPrepaid ()

Charge getNextCharge ()

PaymentPlan getPaymentPlan ()

int getPosition ()

Charge getPrevCharge ()

DateTime getProcessedDate ()

String getType ()

void setIndex (int $index)

void setIsPrepaid (bool $isPrepaid)

void setPaymentPlan (PaymentPlan $paymentPlan)

void setProcessedDate (DateTime $processedDate)

void setType (String $type)

void type ()

Variables

int $index (line 32)

var: Sequential number of the charge within PaymentPlan. 0 indicates that the charge will be processed in the next billing process, 1 - the one after the next and so on
access: private

bool $isPrepaid (line 22)

var: If true, payment was taken against this charge. This doesn't guarantee that the invoice created from this charge will be automatically paid
access: private

PaymentPlan $paymentPlan (line 36)

var: Reference to the PaymentPlan holding the charges.
access: private

DateTime $processedDate (line 17)

var: Date when the charge was processed by the invoicing process.
access: private

String $type (line 26)

var: TYpe of charge.
access: private

Inherited Variables

Inherited from ClientObject

ClientObject::$code
ClientObject::$createDate
ClientObject::$id
ClientObject::$merchantAccountCode
ClientObject::$_hashCode

Methods

Constructor __construct (line 49)

Instantiates a new charge.

DateTime $createDate: createDate the create date
DateTime $processedDate: processedDate the processed date
bool $isPrepaid: isPrepaid the is prepaid
String $type: type the type
int $merchantAccountCode: merchantAccountCode the merchant account code
PaymentPlan $paymentPlan: paymentPlan the payment plan
String $code: code the code
int $id: id the id

equals (line 197)

access: public

void equals ( $anotherObject)

$anotherObject

getBillingDate (line 120)

Returns the date when this charge will be processed if no changes are made to the PaymentPlan or it's BillingCycle.

return: Returns the billingDate
access: public

DateTime getBillingDate ()

getIndex (line 176)

Gets the index.

return: the index

int getIndex ()

getIsPrepaid (line 83)

Gets the is prepaid.

return: Returns the isPrepaid
access: public

bool getIsPrepaid ()

getNextCharge (line 147)

Returns charge that follows this charge in the billing sequence.

return: the next charge
access: public

Charge getNextCharge ()

getPaymentPlan (line 129)

Gets the payment plan.

return: the payment plan
access: public

PaymentPlan getPaymentPlan ()

getPosition (line 167)

Returns sequential position of this charge within the PaymentPlan.

Returns sequential position of this charge within the PaymentPlan. Unlike index, automatically adjusts its value when changes to payment plan are made

return: the position
access: public

int getPosition ()

getPrevCharge (line 156)

Returns charge that precedes this charge in the billing sequence.

return: the prev charge
access: public

Charge getPrevCharge ()

getProcessedDate (line 65)

Gets the processed date.

return: Returns the processedDate
access: public

DateTime getProcessedDate ()

getType (line 101)

Gets the type.

return: Returns the type
access: public

String getType ()

setIndex (line 185)

Sets the index.

void setIndex (int $index)

int $index: index the new index

setIsPrepaid (line 92)

Set a value to isPrepaid.

access: public

void setIsPrepaid (bool $isPrepaid)

bool $isPrepaid: isPrepaid the is prepaid

setPaymentPlan (line 138)

Sets the payment plan.

access: public

void setPaymentPlan (PaymentPlan $paymentPlan)

PaymentPlan $paymentPlan: paymentPlan the new payment plan

setProcessedDate (line 74)

Set a value to processedDate.

void setProcessedDate (DateTime $processedDate)

DateTime $processedDate: processedDate the processed date

setType (line 110)

Set a value to type.

void setType (String $type)

String $type: type the type

type (line 189)

access: public

void type ()

Redefinition of:

ClientObject::type(): Returns the type of the object instance using library's terminology In most cases it will match ClassName, but when a single class may represent multiple conceptual objects, the value will differ.

Inherited Methods

Inherited From ClientObject

ClientObject::getCode()
ClientObject::getCreateDate()
ClientObject::getId()
ClientObject::getMerchantAccountCode()
ClientObject::hashCode()
ClientObject::setCode()
ClientObject::setId()
ClientObject::setMerchantAccountCode()
ClientObject::type()

Documentation generated on Thu, 20 Mar 2008 16:22:13 -0400 by phpDocumentor 1.4.0