mike182uk / paypal-ipn-listener
PHP PayPal IPN (即时支付通知) 监听器
Requires
- php: ^7.1 || ^8.0
- guzzlehttp/guzzle: ^6.2 || ^7.0
- symfony/event-dispatcher: ^4.3 || ^5.0 || ^6.0
Requires (Dev)
- beberlei/assert: ^3.0
- behat/behat: ^3.3
- friendsofphp/php-cs-fixer: ^2.0
- phpspec/phpspec: ^4.3||^5.1||^6.1
README
PHP PayPal IPN (即时支付通知) 监听器
索引
先决条件
- PHP >=7.1.0
- 了解 PayPal 即时支付通知系统的工作原理(见 这里)
安装
composer require mike182uk/paypal-ipn-listener
架构
该包由几个相互协作的组件组成
Listener
- 监听并处理 IPN 消息Verifier
- 使用 PayPal 验证 IPN 消息Service
- 与 PayPal 通信Message
- IPN 消息的包装器MessageFactory
- 从数据源创建新的消息实例EventDispatcher
- 分发事件
监听器使用 MessageFactory
创建 Message
。然后将 Message
传递给 Verifier
,该 Verifier
使用 Service
与 PayPal 通信。监听器使用 EventDispatcher
分发与 IPN 消息验证结果相关的事件。
MessageFactory
和 Service
组件是可交换的组件。
此包提供了 2 个消息工厂
Mdb\PayPal\Ipn\MessageFactory\InputStreamMessageFactory
- 从php://input
流创建消息Mdb\PayPal\Ipn\MessageFactory\ArrayMessageFactory
- 从传递给setData
方法的数组创建消息
此包提供了 1 个服务
Mdb\PayPal\Ipn\Service\GuzzleService
- 使用 Guzzle 与 PayPal 通信
用法
您可以选择手动构建监听器对象,也可以使用监听器构建器。此包提供了 2 个监听器构建器
Mdb\PayPal\Ipn\ListenerBuilder\Guzzle\InputStreamListenerBuilder
- 使用 guzzle 服务和输入流消息工厂构建监听器Mdb\PayPal\Ipn\ListenerBuilder\Guzzle\ArrayListenerBuilder
- 使用 guzzle 服务和数组消息工厂构建监听器
使用监听器构建器是构建监听器对象的首选方法。
使用监听器构建器
use Mdb\PayPal\Ipn\ListenerBuilder\Guzzle\InputStreamListenerBuilder as ListenerBuilder; $listener = (new ListenerBuilder)->build();
手动构建监听器
use GuzzleHttp\Client; use Mdb\PayPal\Ipn\InputStream; use Mdb\PayPal\Ipn\Listener; use Mdb\PayPal\Ipn\MessageFactory\InputStreamMessageFactory; use Mdb\PayPal\Ipn\Service\GuzzleService; use Mdb\PayPal\Ipn\Verifier; use Symfony\Component\EventDispatcher\EventDispatcher; $service = new GuzzleService( new Client(), 'https://www.sandbox.paypal.com/cgi-bin/webscr' ); $verifier = new Verifier($service); $messageFactory = new InputStreamMessageFactory(new InputStream()); $listener = new Listener( $messageFactory, $verifier, new EventDispatcher() );
手动创建监听器需要大量的配置。监听器构建器的任务是抽象出这些逻辑。
订阅事件
创建监听器对象后,您可以订阅它将分发的事件
use Mdb\PayPal\Ipn\Event\MessageVerifiedEvent; use Mdb\PayPal\Ipn\Event\MessageInvalidEvent; use Mdb\PayPal\Ipn\Event\MessageVerificationFailureEvent; $listener->onVerified(function (MessageVerifiedEvent $event) { $ipnMessage = $event->getMessage(); // IPN message was verified, everything is ok! Do your processing logic here... }); $listener->onInvalid(function (MessageInvalidEvent $event) { $ipnMessage = $event->getMessage(); // IPN message was was invalid, something is not right! Do your logging here... }); $listener->onVerificationFailure(function (MessageVerificationFailureEvent $event) { $error = $event->getError(); // Something bad happend when trying to communicate with PayPal! Do your logging here... });
在订阅事件时,您可以使用任何 callable
class IpnProcessor { public function onVerified(MessageVerifiedEvent $event) { $message = $event->getMessage(); // ... } } $listener->onVerified(array(new IpnProcessor, 'onVerified'));
class IpnProcessor { public static function onVerified(MessageVerifiedEvent $event) { $message = $event->getMessage(); // ... } } $listener->onVerified(array('IpnProcessor', 'onVerified'));
监听 IPN 消息
要启动此过程,您需要监听 IPN 消息
$listener->listen();
完整示例
use Mdb\PayPal\Ipn\Event\MessageVerifiedEvent; use Mdb\PayPal\Ipn\Event\MessageInvalidEvent; use Mdb\PayPal\Ipn\Event\MessageVerificationFailureEvent; use Mdb\PayPal\Ipn\ListenerBuilder\Guzzle\InputStreamListenerBuilder as ListenerBuilder; $listener = (new ListenerBuilder)->build(); $listener->onVerified(function (MessageVerifiedEvent $event) { $ipnMessage = $event->getMessage(); // IPN message was verified, everything is ok! Do your processing logic here... }); $listener->onInvalid(function (MessageInvalidEvent $event) { $ipnMessage = $event->getMessage(); // IPN message was was invalid, something is not right! Do your logging here... }); $listener->onVerificationFailure(function (MessageVerificationFailureEvent $event) { $error = $event->getError(); // Something bad happend when trying to communicate with PayPal! Do your logging here... }); $listener->listen();
沙盒模式
当使用提供的监听器构建器之一时,您可以将监听器设置为使用 PayPal 的沙盒进行测试
$listenerBuilder = new ListenerBuilder(); $listenerBuilder->useSandbox(); // use PayPal sandbox $listener = $listenerBuilder->build();
您可以在示例目录中找到一些完整的用法示例。
扩展
要创建自己的服务,您必须实现 Mdb\PayPal\Ipn\Service
。
要创建自己的消息工厂,您必须实现 Mdb\PayPal\Ipn\MessageFactory
。
要创建自己的监听器构建器,最好是扩展 Mdb\PayPal\Ipn\ListenerBuilder
,因为这提供了创建监听器构建器所需的大部分样板代码。
您会注意到,在使用提供的Guzzle监听器构建器时,有一个公开的useSandbox
方法。您可以通过使用Mdb\PayPal\Ipn\ListenerBuilder\ModeDependentServiceEndpoint
特质(请参阅Mdb\PayPal\Ipn\ListenerBuilder\GuzzleListenerBuilder
以获取用法示例)来将此功能添加到监听器构建器中。
注意
测试
PayPal提供了一个IPN模拟器,请在此处访问:https://developer.paypal.com/dashboard/ipnSimulator。