Docs For Class Payment

$action = ''

[line 108]

Processing action.

This should be set to one of the PAYMENT_PROCESS_ACTION_* constants.

Type:

int

[ Top ]

$amount = 0

[line 122]

The transaction amount.

Type:

double

[ Top ]

$customerId = ''

[line 136]

Customer identifier

Var: string or int

Type:

mixed

[ Top ]

$description = ''

[line 115]

A description of the transaction (used by some processors to send information to the client, normally not a required field).

Type:

string

[ Top ]

$invoiceNumber = ''

[line 129]

An invoice number.

Var: string or int

Type:

mixed

[ Top ]

$login = ''

[line 92]

Your login name to use for authentication to the online processor.

Type:

string

[ Top ]

$password = ''

[line 99]

Your password to use for authentication to the online processor.

Type:

string

[ Top ]

$transactionSource =

[line 145]

Transaction source.

This should be set to one of the PAYMENT_PROCESS_SOURCE_* constants.

Type:

int

[ Top ]

factory [line 180]

mixed &factory(
string
$type, [array
$options = false])

Return an instance of a specific processor.

Return: Instance of the processor object, or a PEAR_Error object.

Parameters:

string	`$type`	—	Name of the processor
array	`$options`	—	Options for the processor

[ Top ]

fieldExists [line 280]

boolean fieldExists(
string
$field)

Determines if a field exists.

Return: true if field exists, false otherwise
Author: Ian Eure <mailto:ieure@php.net>

Parameters:

string $field — Field to check

[ Top ]

getFields [line 295]

array getFields(
)

Get a list of fields.

This function returns an array containing all the possible fields which may be set.

Return: Array of valid fields.
Access: public
Author: Ian Eure <mailto:ieure@php.net>

[ Top ]

getOption [line 327]

mixed getOption(
string
$option)

Get an option value.

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

Parameters:

string $option — Option to get

[ Top ]

isError [line 394]

void isError(
mixed
$obj)

Statically check a Payment_Result class for error

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

Parameters:

mixed $obj —

[ Top ]

isRequired [line 268]

boolean isRequired(
string
$field)

Determine if a field is required.

Return: true if required, false if optional.

Parameters:

string $field — Field to check

[ Top ]

isSuccess [line 376]

void isSuccess(
mixed
$obj)

Statically check a Payment_Result class for success

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

Parameters:

mixed $obj —

[ Top ]

set [line 223]

void set(
string
$field, string
$value)

Set a value.

This will set a value, such as the credit card number. If the requested field is not part of the basic set of supported fields, it is set in $_options.

Parameters:

string	`$field`	—	The field to set
string	`$value`	—	The value to set

[ Top ]

setFrom [line 203]

void setFrom(
array
$where)

Set many fields.

Parameters:

array $where — Associative array of data to set, in the format 'field' => 'value',

[ Top ]

setOption [line 340]

void setOption(
string
$option, mixed
$value)

Set an option value

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

Parameters:

string	`$option`	—	Option name to set
mixed	`$value`	—	Value to set

[ Top ]

setOptions [line 314]

void setOptions(
[Array
$options = false], [Array
$defaultOptions = false])

Set class options.

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

Parameters:

Array	`$options`	—	Options to set
Array	`$defaultOptions`	—	Default options

[ Top ]

Class: Payment_Process

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$action = ''

$amount = 0

$customerId = ''

$description = ''

$invoiceNumber = ''

$login = ''

$password = ''

$transactionSource =

Method Detail

factory [line 180]

Parameters:

fieldExists [line 280]

Parameters:

getFields [line 295]

getOption [line 327]

Parameters:

isError [line 394]

Parameters:

isRequired [line 268]

Parameters:

isSuccess [line 376]

Parameters:

set [line 223]

Parameters:

setFrom [line 203]

Parameters:

setOption [line 340]

Parameters:

setOptions [line 314]

Parameters: