https://github.com/vimeo/payment-gateway-logger
https://github.com/vimeo/payment-gateway-logger
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vimeo/payment-gateway-logger
- Owner: vimeo
- License: mit
- Created: 2019-03-29T00:45:40.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-10T22:50:55.000Z (over 1 year ago)
- Last Synced: 2024-09-17T00:36:18.642Z (over 1 year ago)
- Language: PHP
- Size: 38.1 KB
- Stars: 3
- Watchers: 17
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Installation
Package is installed via [Composer](http://getcomposer.org/). To install, simply add it to your `composer.json` file:
```json
{
"require": {
"vimeo/payment-gateway-logger": "^1.0"
}
}
```
And run composer to update your dependencies:
```
$ curl -s http://getcomposer.org/installer | php
$ php composer.phar update
```
## Usage
Logging capabilities for Omnipay gateways via an `EventSubscriberInterface` subscriber for Omnipay payment gateway-specific events.
These events are dispatched via the HTTP client's `EventDispatcherInterface`.
* The omnipay gateway needs to be updated to emit any of the `RequestEvent`, `ResponseEvent` or `ErrorEvent` objects.
For example in the gateway's `sendData()` methods we can do:
```PHP
$event_dispatcher = $this->httpClient->getEventDispatcher();
$event_dispatcher->dispatch(Constants::OMNIPAY_REQUEST_BEFORE_SEND, new RequestEvent($request));
```
Logging Errors and Responses events can be emitted like so
```PHP
$event_dispatcher->dispatch(Constants::OMNIPAY_REQUEST_ERROR new ErrorEvent($exception, $request));
$event_dispatcher->dispatch(Constants::OMNIPAY_RESPONSE_SUCCESS, new ResponseEvent($response));
```
`OmnipayGatewayRequestSubscriber.php` takes in a logger of type `LoggerInterface` which will listen to and log these events.
The subscriber can be set up to listen to these events when instantiating the HTTP client for the gateway like so:
```PHP
$httpClient = new GuzzleClient();
$gateway = Omnipay::create('Vindicia', $httpClient);
$eventDispatcher = $httpClient->getEventDispatcher();
$eventDispatcher->addSubscriber(new OmnipayGatewayRequestSubscriber($gateway_name, new LoggerClassThatImplementsPSRInterface()));
```