Download the PHP package dansmaculotte/paypal-ipn-listener without Composer
On this page you can find all versions of the php package dansmaculotte/paypal-ipn-listener. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dansmaculotte/paypal-ipn-listener
More information about dansmaculotte/paypal-ipn-listener
Files in dansmaculotte/paypal-ipn-listener
Package paypal-ipn-listener
Short Description A PayPal IPN (Instant Payment Notification) listener for PHP
License MIT
Informations about the package paypal-ipn-listener
PayPal IPN Listener
A PayPal IPN (Instant Payment Notification) listener for PHP
Index
- Prerequisites
- Installation
- Architecture
- Usage
- Extending
- Notes
Prerequisites
- PHP ^7.2
- A good understanding of how the PayPal Instant Payment Notification system works. See https://developer.paypal.com/webapps/developer/docs/classic/ipn/integration-guide/IPNIntro/
Installation
Architecture
This package is made up of several components that work together:
Listener
- Listens for and processes the IPN messagesVerifier
- Verifies the IPN message with PayPalService
- Communicates with PayPalMessage
- Wrapper around the IPN messageMessageFactory
- Creates a new message instance from a data sourceEventDispatcher
- Dispatches events
The listener creates a Message
using a MessageFactory
. The Message
is passed to the Verifier
which uses a Service
to communicate with PayPal. The Listener
uses the EventDispatcher
to dispatch events relating to the outcome of the IPN message verification.
The MessageFactory
and Service
components are swappable components.
This package provides 2 message factories:
DansMaCulotte\PayPal\Ipn\MessageFactory\InputStreamMessageFactory
- Creates a message from thephp://input
streamDansMaCulotte\PayPal\Ipn\MessageFactory\ArrayMessageFactory
- Creates a message from an array passed to thesetData
method
This package provides 1 service:
DansMaCulotte\PayPal\Ipn\Service\GuzzleService
- Uses Guzzle to communicate with PayPal
Usage
You can either build up the listener object manually or you can use a listener builder. This package provides 2 listener builders:
DansMaCulotte\PayPal\Ipn\ListenerBuilder\Guzzle\InputStreamListenerBuilder
- Builds a listener using the guzzle service and the input stream message factoryDansMaCulotte\PayPal\Ipn\ListenerBuilder\Guzzle\ArrayListenerBuilder
- Builds a listener using the guzzle service and the array message factory
Using a listener builder is the preferred way of building up a listener object.
Using a listener builder
Building up the listener manually
A lot of plumbing is needed to create the listener manually. The job of the listener builder is to abstract away this logic.
Subscribing to events
Once you have created the listener object you can subscribe to the events that it will dispatch:
You can use any callable when subscribing to an event:
Listening for IPN messages
The last thing you need to do to kick of the process is listen for an IPN message:
Full Example
Sandbox mode
When using one of the provided listener builders you can set your listener to use PayPal's sandbox for testing purposes:
You can find some full usage examples in the examples directory.
Extending
To create your own service you must implement DansMaCulotte\PayPal\Ipn\Service
.
To create your own message factory you must implement DansMaCulotte\PayPal\Ipn\MessageFactory
.
To create your own listener builder it is best to extend DansMaCulotte\PayPal\Ipn\ListenerBuilder
as this provides most of the boilerplate code needed to create a listener builder.
You will notice that when using any of the provided guzzle listener builders that there is a useSandbox
method exposed. You can add this functionality to your listener builder by using the DansMaCulotte\PayPal\Ipn\ListenerBuilder\ModeDependentServiceEndpoint
trait (see DansMaCulotte\PayPal\Ipn\ListenerBuilder\GuzzleListenerBuilder
for usage example).
Notes
Testing
PayPal provides an IPN simulator here: https://developer.paypal.com/webapps/developer/applications/ipn_simulator
All versions of paypal-ipn-listener with dependencies
guzzlehttp/guzzle Version ^7.4
symfony/event-dispatcher Version ^4.4.0|^5.0.7|^6.0