matteocacciola/vopay-php-sdk

VoPay PHP SDK

1.1 2022-10-12 18:21 UTC

This package is auto-updated.

Last update: 2024-09-12 22:51:34 UTC


README

这是一个用于PHP的SDK,用于将平台与VoPay支付网关接口连接。使用VoPay API v2

特性

  • 遵循PSR-0约定和编码标准:易于自动加载
  • 轻量且快速,得益于API类按需加载
  • 经过广泛测试
  • 适用于Symfony、Laravel和其他Web应用程序框架

要求

  • PHP >= 7.4,并安装cURL扩展
  • Guzzle >= 7.0.1库
  • (可选) PHPUnit以运行测试

安装

最简单的方法是使用Composer安装,只需运行

composer require matteocacciola/vopay-sdk

或将以下内容添加到您的composer.json文件的require部分

"matteocacciola/vopay-sdk"

基本用法

use DataMat\VoPay\VoPay;

$client = new VoPay('account_id', 'api-key', 'api_secret');

$client对象为您提供了访问整个VoPay API的权限。例如:如果您想访问与VoPay账户相关的端点集,您只需编写

$account = $client->account();

同样,例如,使用VoPay EFT端点

$account = $client->electronicFundsTransfer();

等等。

API覆盖范围

目前,所有API都由该SDK支持。

测试

该软件包为每个端点子集提供了模拟:您只需传递一个简单的参数给模拟器,就可以轻松模拟成功或失败响应。

以下是一个示例。

在服务中,例如,您可以有以下方法

/**
 * @param string $endpoint
 *
 * @return VoPayContract
 * @throws \Exception
 */
protected function buildVopayEndpointGroup(string $endpoint) : VoPayContract
{
    return $this->apiVopay->{$endpoint}();
}

返回端点子集,如accountelectronicFundsTransfer等。通俗地说,$endpointDataMat\VoPay\VoPay客户端提供的方法名称之一。

然后,以下是您可以在测试中模拟的内容

use Mockery\MockInterface;
use DataMat\VoPay\Endpoints\Mocks\ElectronicFundsTransfer;

// $shouldTestSucceed is a boolean: true if the mocked response from the VoPay API should succeed, false otherwise
$this->partialMock(SomeClass::class, function (MockInterface $mock) use ($shouldTestSucceed) {
    $mock->shouldReceive('buildVopayEndpointGroup')
        ->with('electronicFundsTransfer')
        ->andReturn(new ElectronicFundsTransfer($shouldTestSucceed));
});

文档

贡献

欢迎对核心库、测试和文档进行改进的pull requests。

无保证

此软件包是免费分发,免费提供。它不附带任何保证,无论是明示的还是暗示的。源代码提供给您方便。VoPay不对其质量或支持承担任何责任。

许可证

MIT许可证(MIT)

版权所有 (c) 2016 Phillip Shipley

特此授予任何获得本软件及其相关文档副本(以下简称“软件”)的人免费使用该软件的权利,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本,并允许提供软件的人进行此类操作,但须遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

本软件按照“现状”提供,不提供任何形式的保证,无论是明示的、暗示的,还是包括但不限于适用性、特定用途的适用性和非侵权性保证。在任何情况下,作者或版权所有者均不对任何索赔、损害或其他责任负责,无论是由合同行为、侵权行为或其他原因引起的,与软件或软件的使用或其他相关活动有关。