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

Class: Payment_Process

Source Location: /Payment_Process-0.6.8/Process.php

Class Overview


Payment_Process


Author(s):

Version:

  • Release: @package_version@

Methods


Child classes:

Payment_Process_offline
Payment_Process_offline

Inherited Variables

Inherited Methods


Class Details

[line 146]
Payment_Process


[ Top ]


Method Detail

factory   [line 156]

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 192]

boolean fieldExists( string $field)

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

Parameters:

string   $field   —  Field to check

[ Top ]

getFields   [line 207]

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>
  • Access: public

[ Top ]

getOption   [line 243]

mixed getOption( string $option)

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

Parameters:

string   $option   —  Option to get

[ Top ]

isError   [line 324]

bool isError( mixed $obj)

Statically check a Payment_Result class for error

Parameters:

mixed   $obj   —  Object to check

[ Top ]

isRequired   [line 179]

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 304]

bool isSuccess( mixed $obj)

Statically check a Payment_Result class for success

Parameters:

mixed   $obj   —  Object to check

[ Top ]

setOption   [line 258]

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 228]

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

Set class options.

Parameters:

array   $options   —  Options to set
array   $defaultOptions   —  Default options

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:41:22 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.