Class: Payment_Process_Common

Source Location: /Payment_Process-0.5.8/Process/Common.php

Class Overview

PEAR
   |
   --Payment_Process
      |
      --Payment_Process_Common

Payment_Process

Author(s):

Ian Eure <mailto:ieure at php.net>

Version:

@version@

Child classes:

Payment_Process_AuthorizeNet: Payment_Process_AuthorizeNet

Payment_Process_Transfirst: Payment_Process_Transfirst

Payment_Process_TrustCommerce: Payment_Process_TrustCommerce

Payment_Process_Dummy: Payment_PAYMENT_PROCESS_Dummy

Inherited Variables

Class: Payment_Process

Payment_Process::$action
Payment_Process::$amount
Payment_Process::$customerId
Payment_Process::$description
Payment_Process::$invoiceNumber
Payment_Process::$login
Payment_Process::$password
Payment_Process::$transactionSource

Inherited Methods

Class: Payment_Process

Payment_Process::factory(): Return an instance of a specific processor.
Payment_Process::fieldExists(): Determines if a field exists.
Payment_Process::getFields(): Get a list of fields.
Payment_Process::getOption(): Get an option value.
Payment_Process::isError(): Statically check a Payment_Result class for error
Payment_Process::isRequired(): Determine if a field is required.
Payment_Process::isSuccess(): Statically check a Payment_Result class for success
Payment_Process::set(): Set a value.
Payment_Process::setFrom(): Set many fields.
Payment_Process::setOption(): Set an option value
Payment_Process::setOptions(): Set class options.

Class Details

[line 25]
Payment_Process

Version: @version@
Author: Ian Eure <mailto:ieure@php.net>

[ Top ]

Class Variables

$_payment = null

[line 46]

$_payment

An internal reference to the Payment_Process_Type that is currently being processed.

Var: Instance of Payment_Type
See: Payment_Process_Common::setPayment()
Access: protected
Author: Joe Stump <mailto:joe@joestump.net>

Type:

mixed

[ Top ]

$_typeFieldMap = array()

[line 33]

$_typeFieldMap

Access: protected
Author: Joe Stump <mailto:joe@joestump.net>

Type:

mixed

[ Top ]

Method Detail

debug [line 275]

void debug(
string
$msg)

Print a debug message.

This will only print the message if 'debug' is set in the Processor options.

Author: Ian Eure <mailto:ieure@php.net>

Parameters:

string $msg — Message to print

[ Top ]

getResult [line 93]

void getResult(
)

Get transaction result.

This function should be overloaded by the processor.

[ Top ]

process [line 83]

void process(
)

Process the transaction.

This function should be overloaded by the processor.

Overridden in child classes as:

Payment_Process_AuthorizeNet::process(): Process the transaction.

Payment_Process_Transfirst::process(): Process the transaction.

Payment_Process_TrustCommerce::process(): Process the transaction.

Payment_Process_Dummy::process(): Process the (dummy) transaction

[ Top ]

setPayment [line 225]

bool setPayment(
mixed
$payment)

Set payment

Returns false if payment could not be set. This usually means the payment type is not valid or that the payment type is valid, but did not validate. It could also mean that the payment type is not supported by the given processor.

Access: public
Author: Joe Stump <mailto:joe@joestump.net>

Parameters:

mixed $payment — Object of Payment_Process_Type

[ Top ]

validate [line 55]

boolean validate(
)

Validate data before processing.

This function may be overloaded by the processor.

Return: true if validation succeeded, PEAR_Error if it failed.

[ Top ]