Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/colinodell/omnipay-bundle
Omnipay bundle for Symfony 2.3+ and 3.0+
https://github.com/colinodell/omnipay-bundle
omnipay php symfony symfony-bundle symfony2 symfony3
Last synced: 3 months ago
JSON representation
Omnipay bundle for Symfony 2.3+ and 3.0+
- Host: GitHub
- URL: https://github.com/colinodell/omnipay-bundle
- Owner: colinodell
- License: mit
- Archived: true
- Created: 2015-03-19T15:40:11.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-09-25T12:22:56.000Z (over 6 years ago)
- Last Synced: 2024-09-26T04:01:50.011Z (3 months ago)
- Topics: omnipay, php, symfony, symfony-bundle, symfony2, symfony3
- Language: PHP
- Homepage:
- Size: 52.7 KB
- Stars: 7
- Watchers: 3
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# omnipay-bundle
[](https://github.com/colinodell/omnipay-bundle/releases)
[](LICENSE.md)
[](https://travis-ci.org/colinodell/omnipay-bundle)
[](https://scrutinizer-ci.com/g/colinodell/omnipay-bundle/code-structure)
[](https://scrutinizer-ci.com/g/colinodell/omnipay-bundle)
[](https://packagist.org/packages/colinodell/omnipay-bundle)
Simple bundle for implementing [Omnipay](http://omnipay.thephpleague.com/) in your Symfony application.
## Versions
| omnipay-bundle | Symfony | Omnipay | PHP |
|-----------------|------------|---------|------|
| **1.x** | 2.x or 3.x | **2.x** | 5.4+ |
| **2.x** | 2.x or 3.x | **3.x** | 5.6+ |
## Install
Via Composer
``` bash
$ composer require colinodell/omnipay-bundle
```
Enable the bundle in your `AppKernel.php`:
```php
new ColinODell\OmnipayBundle\OmnipayBundle(),
```
## Usage
This bundle provides a new service called `Omnipay`. It contains a single method `get()`, which returns a fully-configured gateway for you to use:
``` php
$stripe = $this->get('omnipay')->get('Stripe');
$paypal = $this->get('omnipay')->get('PayPal_Express');
```
You can then use these gateways like usual.
**Note:** Gateways are "cached" - calling `get('Some_Gateway')` multiple times will always return the same object.
## Configuration
Gateways can be configured in your `app/config/config.yml` file
``` yml
omnipay:
methods:
# Your config goes here
```
For example, to configure the [Stripe](https://github.com/thephpleague/omnipay-stripe) and [PayPal Express](https://github.com/thephpleague/omnipay-paypal) gateways:
``` yml
omnipay:
methods:
Stripe:
apiKey: sk_test_BQokikJOvBiI2HlWgH4olfQ2
PayPal_Express:
username: test-facilitator_api1.example.com
password: 3MPI3VB4NVQ3XSVF
signature: 6fB0XmM3ODhbVdfev2hUXL2x7QWxXlb1dERTKhtWaABmpiCK1wtfcWd.
testMode: false
solutionType: Sole
landingPage: Login
```
**NOTE:** You should probably consider using parameters instead of storing credentials directly in your `config.yml` like that.
The method names should be whatever you'd typically pass into `Omnipay::create()`. The configuration settings vary per gateway - see
[Configuring Gateways](http://omnipay.thephpleague.com/gateways/configuring/) in the Omnipay documentation for more details.
## Registering Custom Gateways
Custom gateways can be registered via the container by tagging them with `omnipay.gateway`:
```yml
# services.yml
services:
my.test.gateway:
class: Path\To\MyTestGateway
tags:
- { name: omnipay.gateway, alias: MyTest }
# config.yml
omnipay:
methods:
# Reference the gateway alias here
MyTest:
apiKey: abcd1234!@#
```
You can then obtain the fully-configured gateway by its alias:
```php
$this->get('omnipay')->get('MyTest');
```
## Additional configuration and customization
### Default gateway
Add default gateway key to your config:
```yml
# config.yml
omnipay:
methods:
MyGateway1:
apiKey: abcd1234!@#
MyGateway2:
apiKey: abcd45678!@#
default_gateway: MyGateway1
```
You can now get default gateway instance:
```php
$omnipay->getDefaultGateway();
```
### Disabling gateways
If need to disable a gateway but want to keep all the configuration add `disabled_gateways` key to the config:
```yml
# config.yml
omnipay:
methods:
MyGateway1:
apiKey: abcd1234!@#
MyGateway2:
apiKey: abcd45678!@#
disabled_gateways: [ MyGateway1 ]
```
`MyGateway1` gateway will be skipped during gateway registration now.
### Customizing Omnipay service
If you need specific gateway selection mechanism or need to get multiple gateways at once consider to extend
default Omnipay service. Create your custom Omnipay class, extend it from base class and add custom getters. For
example, you might want to get all gateways which implement some interface.
```php
registeredGateways, function (GatewayInterface $gateway) {
return $gateway instanceof VaultAwareGateway;
});
}
}
```
```yml
#services.yml
parameters:
omnipay.class: AppBundle\Omnipay\Omnipay
```
Now you should be able to get vault-aware gateways in your application:
```php
foreach ($omnipay->getVaultAwareGateways() as $gateway) {
$gateway->saveCreditCard($creditCard); // assuming saveCreditCard is a part of VaultAwareGateway interface
}
```
### Initialize gateways on registration
By default gateway is initialized only when you call `get()` method. If you use custom getters (like
`getVaultAwareGateways` from example above) with `$this->registeredGateways` inside you might want to initialize them
automatically during registration. Simply add appropriate config key:
```yml
# config.yml
omnipay:
methods:
MyGateway1:
apiKey: abcd1234!@#
initialize_gateway_on_registration: true
```
## Testing
``` bash
$ phpunit
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Colin O'Dell](https://github.com/colinodell)
- [All Contributors](https://github.com/colinodell/omnipay-bundle/graphs/contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.