Open Journal Systems  3.3.0
Omnipay\Common Namespace Reference

Namespaces

 Exception
 
 Http
 
 Message
 

Data Structures

class  AbstractGateway
 
class  AbstractGatewayTest
 
class  AbstractGatewayTest_MockAbstractGateway
 
class  AbstractGatewayTest_MockAbstractRequest
 
class  CreditCard
 
class  CreditCardTest
 
class  Currency
 
class  CurrencyTest
 
class  GatewayFactory
 
class  GatewayFactoryTest
 
interface  GatewayInterface
 
class  Helper
 
class  HelperTest
 
class  Issuer
 
class  IssuerTest
 
class  Item
 
class  ItemBag
 
class  ItemBagTest
 
interface  ItemInterface
 
class  ItemTest
 
class  PaymentMethod
 
class  PaymentMethodTest
 

Functions

 getParameter ($key)
 
 getParameters ()
 
 initialize (array $parameters=[])
 
 setParameter ($key, $value)
 
 validate (... $args)
 

Variables

trait ParametersTrait
 

Detailed Description

Base payment gateway class

Credit Card class

Currency class

Omnipay Gateway Factory class

Payment gateway interface

Helper class

Issuer

Cart Item

Cart Item Bag

Cart Item interface

Payment Method

Function Documentation

◆ getParameter()

Omnipay\Common\getParameter (   $key)
protected

Get one parameter.

Parameters
string$keyParameter key
Returns
mixed A single parameter value.

Definition at line 40 of file ParametersTrait.php.

◆ getParameters()

Omnipay\Common\getParameters ( )

Get all parameters.

Returns
array An associative array of parameters.

Definition at line 50 of file ParametersTrait.php.

◆ initialize()

Omnipay\Common\initialize ( array  $parameters = [])

Initialize the object with parameters.

If any unknown parameters passed, they will be ignored.

Parameters
array$parametersAn associative array of parameters
Returns
$this.

Definition at line 63 of file ParametersTrait.php.

References Omnipay\Common\Helper\initialize().

◆ setParameter()

Omnipay\Common\setParameter (   $key,
  $value 
)
protected

Set one parameter.

Parameters
string$keyParameter key
mixed$valueParameter value
Returns
$this

Definition at line 27 of file ParametersTrait.php.

◆ validate()

Omnipay\Common\validate (   $args)

Validate the request.

This method is called internally by gateways to avoid wasting time with an API call when the request is clearly invalid.

Parameters
string... a variable length list of required parameters
Exceptions
InvalidRequestException

Definition at line 79 of file ParametersTrait.php.

Variable Documentation

◆ ParametersTrait

trait Omnipay::Common\ParametersTrait
Initial value:
{
protected $parameters

Definition at line 9 of file ParametersTrait.php.