PHP Interface Omnipay\Common\GatewayInterface

This interface class defines the standard functions that any Omnipay gateway needs to define.
See also: AbstractGateway
Mostrar archivo Open project: omnipay/common Interface Usage Examples

Public Methods

Method Description
getDefaultParameters ( ) Define gateway parameters, in the following format:
getName ( ) Get gateway display name
getParameters ( ) : array Get all gateway parameters
getShortName ( ) Get gateway short name
initialize ( array $parameters = [] ) Initialize gateway with parameters

Method Details

getDefaultParameters() public method

array( 'username' => '', // string variable 'testMode' => false, // boolean variable 'landingPage' => array('billing', 'login'), // enum variable, first item is default );
public getDefaultParameters ( )

getName() public method

This can be used by carts to get the display name for each gateway.
public getName ( )

getParameters() public method

Get all gateway parameters
public getParameters ( ) : array
return array

getShortName() public method

This name can be used with GatewayFactory as an alias of the gateway class, to create new instances of this gateway.
public getShortName ( )

initialize() public method

Initialize gateway with parameters
public initialize ( array $parameters = [] )
$parameters array