Overview

Namespaces

  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
    • Tests
      • Batch
      • Cache
      • Common
        • Cache
        • Exception
      • Http
        • Curl
        • Exception
        • Message
          • Header
      • Inflection
      • Iterator
      • Log
      • Message
      • Mock
      • Parser
        • Cookie
        • Message
      • Parsers
        • UriTemplate
      • Plugin
        • Async
        • Backoff
        • Cache
        • Cookie
          • CookieJar
        • CurlAuth
        • ErrorResponse
        • History
        • Log
        • Md5
        • Mock
        • Oauth
        • Redirect
      • Service
        • Builder
        • Command
          • LocationVisitor
            • Request
            • Response
        • Description
        • Exception
        • Mock
          • Command
            • Sub
          • Model
        • Resource
      • Stream
  • None
  • Omnipay
    • Common
      • Exception
      • Message
    • Dummy
      • Message
    • VivaPayments
      • Message
  • PHP

Classes

  • AbstractGateway
  • CreditCard
  • Currency
  • GatewayFactory
  • Helper
  • Issuer
  • Item
  • ItemBag
  • PaymentMethod

Interfaces

  • GatewayInterface
  • ItemInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class GatewayFactory

Omnipay Gateway Factory class

This class abstracts a set of gateways that can be independently registered, accessed, and used.

Note that static calls to the Omnipay class are routed to this class by the static call router (__callStatic) in Omnipay.

Example:

// Create a gateway for the PayPal ExpressGateway
  // (routes to GatewayFactory::create)
  $gateway = Omnipay::create('ExpressGateway');
Namespace: Omnipay\Common
See: Omnipay\Omnipay
Located at Common/GatewayFactory.php
Methods summary
public array
# all( )

All available gateways

All available gateways

Returns

array
An array of gateway names
public
# replace( array $gateways )

Replace the list of available gateways

Replace the list of available gateways

Parameters

$gateways
An array of gateway names
public
# register( string $className )

Register a new gateway

Register a new gateway

Parameters

$className
Gateway name
public array
# find( )

Automatically find and register all officially supported gateways

Automatically find and register all officially supported gateways

Returns

array
An array of gateway names
public Omnipay\Common\GatewayInterface
# create( string $class, Guzzle\Http\ClientInterface $httpClient = null, Symfony\Component\HttpFoundation\Request $httpRequest = null )

Create a new gateway instance

Create a new gateway instance

Parameters

$class
Gateway name
$httpClient
A Guzzle HTTP Client implementation
$httpRequest
A Symfony HTTP Request implementation

Returns

Omnipay\Common\GatewayInterface
An object of class $class is created and returned

Throws

RuntimeException
If no such gateway is found
public array
# getSupportedGateways( )

Get a list of supported gateways which may be available

Get a list of supported gateways which may be available

Returns

array
Omnipay Viva Payments Gateway Module API Documentation API documentation generated by ApiGen