Payment_Process2
[ class tree: Payment_Process2 ] [ index: Payment_Process2 ] [ all elements ]

Class: Payment_Process2

Source Location: /Payment_Process2-0.3.1/Payment/Process2.php

Class Overview


Payment_Process2


Author(s):

Version:

  • Release: @package_version@

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 72]
Payment_Process2


[ Top ]


Class Variables

$_defaultOptions = array()

[line 144]

  • Access: protected

Type:   mixed


[ Top ]



Method Detail

factory   [line 155]

Payment_Process2_Driver factory( string $type, [array $options = array()])

Return an instance of a specific processor.
  • Throws: Payment_Process2_Exception
  • Access: public

Parameters:

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

[ Top ]

fieldExists   [line 209]

boolean fieldExists( string $field)

Determines if a field exists.
  • Return: true if field exists, false otherwise
  • Author: Ian Eure <ieure@php.net>
  • Todo: Is this used?
  • Access: public

Parameters:

string   $field     Field to check

[ Top ]

getFields   [line 225]

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.
  • Author: Ian Eure <ieure@php.net>
  • Todo: Is this used?
  • Access: public

[ Top ]

getOption   [line 265]

mixed getOption( string $option)

Get an option value.
  • Return: Option value
  • Author: Ian Eure <ieure@php.net>
  • Todo: Is this used?
  • Access: public

Parameters:

string   $option     Option to get

[ Top ]

isRequired   [line 194]

boolean isRequired( string $field)

Determine if a field is required.
  • Return: t rue if required, false if optional.
  • Todo: Is this used?
  • Access: public

Parameters:

string   $field     Field to check

[ Top ]

isSuccess   [line 294]

bool isSuccess( Payment_Process2_Result $obj)

Statically check a Payment_Result class for success

Parameters:

mixed   $obj     Object to check

[ Top ]

setOption   [line 281]

void setOption( string $option, mixed $value)

Set an option value

Parameters:

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

[ Top ]

setOptions   [line 248]

void setOptions( [array $options = array()], [array $defaultOptions = array()])

Set class options.
  • Author: Ian Eure <ieure@php.net>
  • Todo: Is this used?
  • Access: public

Parameters:

array   $options     Options to set
array   $defaultOptions     Default options

[ Top ]


Documentation generated on Mon, 25 Oct 2010 12:30:15 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.