The following bundle
is based on Omnipay package and its components.
It supports Symfony 4.4, 5.x, 6.x and PHP 7.4+, 8.0.x, 8.1.x
via Composer
$ composer require janwebdev/symfony-omnipay-bundle
Make sure it is enabled in ./config/bundles.php
file:
// ...
Janwebdev\OmnipayBundle\OmnipayBundle::class => ['all' => true],
This bundle provides a new service called OmnipayManager
. It contains a single method get()
, which returns a fully-configured gateway. Use dependency injection to use service:
<?php
// ...
public function makePayment(OmnipayManager $omnipay)
{
$stripe = $omnipay->get('Stripe');
$paypal = $omnipay->get('PayPal_Express');
// ...
get()
receives payment integration name as string, as it is called in Omnipay package
You can then use these gateways like usual.
Note: Gateways are "cached" - calling get('Some_Gateway')
multiple times will always return the same object.
Create config file ./config/packages/omnipay.yaml
or copy-paste from example.
Gateways can be configured in this file, i.e.:
omnipay:
gateways:
# Your config goes here
For example, to configure the Stripe and PayPal Express gateways:
omnipay:
gateways:
Stripe:
apiKey: sk_test_BQokikJOvBiI2HlWgH4olfQ2
PayPal_Express:
username: test-facilitator_api1.example.com
password: 3MPI3VB4NVQ3XSVF
signature: 6fB0XmM3ODhbVdfev2hUXL2x7QWxXlb1dERTKhtWaABmpiCK1wtfcWd.
testMode: false
solutionType: Sole
landingPage: Login
NOTE: Consider using parameters and/or ENV variables instead of storing credentials directly in your omnipay.yaml
file like that.
The method names should be whatever you'd typically pass into Omnipay::create()
.
The configuration settings vary per gateway - see
Configuring Gateways in the Omnipay documentation for more details.
Custom gateways can be registered via the container by tagging them with omnipay.gateway
:
# services.yaml
services:
my.custom.gateway:
class: Path\To\CustomGateway
tags:
- { name: omnipay.gateway, alias: CustomGateway }
# omnipay.yaml
omnipay:
methods:
# Reference the gateway alias here
CustomGateway:
apiKey: pa$$w0rd
You can then obtain the fully-configured gateway by its alias:
// ...
private function getCustomGateway(OmnipayManager $omnipay): GatewayInteface
{
return $omnipay->get('CustomGateway');
}
// ...
Add default gateway key to your config:
# omnipay.yaml
omnipay:
gateways:
MyGateway1:
apiKey: pa$$w0rd
MyGateway2:
apiKey: pa$$w0rd
default: MyGateway1
You can now get default gateway instance:
$omnipay->getDefaultGateway();
If need to disable a gateway but want to keep all the configuration add disabled
key to the config:
# omnipay.yaml
omnipay:
gateways:
MyGateway1:
apiKey: pa$$w0rd
MyGateway2:
apiKey: pa$$w0rd
disabled: [ MyGateway1 ]
MyGateway1
gateway will be skipped during gateway registration now.
If you need specific gateway selection mechanism or need to get multiple gateways at once consider to extend
default bundle's Omnipay service. Create your custom App\Omnipay\MyService
class, extend it from base class and add custom getters.
For
example, you might want to get all gateways which implement some interface.
<?php
// App/Omnipay/MyService.php
namespace App\Omnipay;
use App\Payment\Processing\Gateway\CardSavingInterface;
use Janwebdev\OmnipayBundle\Manager\OmnipayManager as BaseOmnipay;
use Omnipay\Common\GatewayInterface;
class MyService extends BaseOmnipay
{
/**
* @return CardSavingInterface[]
*/
public function getCardSavingGateways(): array
{
return array_filter($this->registeredGateways, function (GatewayInterface $gateway) {
return $gateway instanceof CardSavingInterface;
});
}
}
#services.yaml
parameters:
omnipay.class: App\Omnipay\MyService
Now you should be able to get "card-saving"-aware gateways in your application:
// ...
foreach ($omnipay->getCardSavingGateways() as $gateway) {
$gateway->saveCreditCard($creditCard); // assuming saveCreditCard is a part of CardSavingInterface interface
}
// ...
By default gateway is initialized only when you call get()
method. If you use custom getters (like
getCardSavingGateways
from example above) with $this->registeredGateways
inside you might want to initialize them
automatically during registration. Simply add appropriate config key:
# omnipay.yaml
omnipay:
gateways:
MyGateway1:
apiKey: @pa$$w0rd#
init_on_boot: true
$ phpunit
Please see CHANGELOG for more information what has changed recently.
The MIT License (MIT). Please see License File for more information.