remade / rave-widget
Rave的轻量级支付请求库;适用于Laravel应用和一般使用Composer的PHP应用
Requires
- cakephp/event: dev-master
- catfan/medoo: ^1.5
- guzzlehttp/guzzle: ^6.3
- illuminate/support: ~5.5.0|~5.6.0
- nesbot/carbon: ^1.26
- twig/twig: ^2.0
This package is not auto-updated.
Last update: 2021-04-17 12:33:07 UTC
README
一个轻量级的库,用于管理Laravel应用和一般PHP项目的Rave支付请求和响应
入门
以下说明将帮助您在本地机器上复制项目并进行开发和测试。有关如何在实时系统上部署项目的说明,请参阅部署。
先决条件
PHP >= 7.1
PHP PDO Extension
Laravel
Laravel >= 5.5.0
安装
composer require remade/rave-widget
之后,在Laravel上运行 php artisan vendor:publish --provider=Remade\RaveWidget\Laravel\ServiceProvider
用法
定义配置值
$configuration_values = [
'database' => [
'database_type' => 'mysql',
'database_name' => 'my_db_name',
'server' => 'my_db_host_address',
'username' => 'my_db_username',
'password' => 'my_db_password',
],
'widget' => [
'payment_request_table_name' => 'payment_request_table', //default
],
'rave' => [
'public_key' => '*******************************************', //get from rave
'secret_key' => '*******************************************', //get from rave
'environment' => 'test|live',
]
];
Laravel应用中,配置已发布到应用的配置路径中的rave.widget.php
文件。根据需要编辑。
初始化Widget对象可以通过两种方式之一完成。无论您选择哪种方式,都不会有任何缺点。
您可以通过创建一个新的配置类实例并使用它来实例化Widget
$config = new \Remade\RaveWidget\Core\Configuration($configuration_values);
$widget = new \Remade\RaveWidget\Widget($config);
或者您可以直接使用配置值初始化
$widget = new \Remade\RaveWidget\Widget($configuration_values);
Laravel已经处理了所有这些。在您更新了Laravel应用配置路径中的rave.widget.php
文件后,widget实例将可用
$widget = RaveWidget::instance();
设置支付
支付详细信息设置在支付对象上。此对象通过$widget->payment()
可用
$wigdet->payment()->setEmail('mail4remi@yahoo.com')->setAmount(100)->setCurrency('NGN');
可用方法
setAmount(decimal)
setPaymentMethod(string)
setDescription(string)
setLogo(url)
setTitle(string)
setCountry(string)
setCurrency(string)
setEmail(email)
setFirstname(string)
setLastname(string)
setPhoneNumber(string)
setPayButtonText(string)
setRedirectUrl(url)
setMetaData(array)
所有设置属性方法都有一个等效的获取方法,例如setAmount(amount)
和getAmount()
设置配置
您可以在运行时更新配置值。配置实例在Widget实例上可用,即$widget->configuration()
制作支付请求
$widget = \RaveWidget::instance();
$widget->payment()->setEmail('mail4remi@gmail.com')->setAmount(100)->setCurrency('NGN');
$widget->makePaymentRequest($render)
$render
是一个字符串,默认值为self_hosted
。可接受值为self_hosted
、rave_hosted
和data
验证支付
$transaction = $widget->verifyTransaction($transactionReference)
这通常在回调/webhook响应时调用。
运行测试
phpunit
贡献
请阅读CONTRIBUTING.md以了解我们的行为准则和向我们提交pull请求的过程。
版本
我们使用 SemVer 进行版本管理。有关可用的版本,请参阅此存储库的标签。
许可证
本项目采用MIT许可证 - 请参阅LICENSE.md文件以获取详细信息