avto-dev / b2b-api-php-laravel
Requires
- php: ^5.6 || >=7.0
- ext-json: *
- avto-dev/b2b-api-php: ^2.5
- laravel/framework: >=5.4.3 <5.8.0
Requires (Dev)
- laravel/laravel: >=5.4.3 <5.8.0
- mockery/mockery: 0.9.* || ~1.0
- phpunit/phpunit: ~5.7.10 || ^6.4 || ~7.0 <7.5.0
README
此包已被废弃
包已被废弃并将很快完全移除。请迁移到此包。
您必须尽快更新您的应用程序!
B2B API 工作的扩展客户端
使用此包,您可以通过几个简单的步骤将 B2B API 服务集成到您的 Laravel 应用程序中。
有关 B2B API 客户端的更详细信息,请参阅其存储库。
安装
要在终端中安装此包,请执行以下命令
$ composer require avto-dev/b2b-api-php-laravel "^2.0.11"
此操作需要安装
composer
。要安装它,请点击此链接。
请注意,需要固定要安装包的主版本。
此包不使用自动注册其服务提供者(该功能在 Laravel v5.5.x 中出现)。还建议创建自己的服务提供者类,继承自该包提供的类,然后注册它。此建议的原因非常简单 - 这样您可以获得更精细的覆盖容器初始化逻辑和覆盖提供的方法的能力。
之后,在./app/Providers
目录下创建名为B2BApiServiceProvider.php
的文件,内容如下
<?php namespace App\Providers; use AvtoDev\B2BApiLaravel\B2BApiServiceProvider as VendorB2BApiServiceProvider; /** * Class B2BApiServiceProvider. */ class B2BApiServiceProvider extends VendorB2BApiServiceProvider { // }
然后,在文件./config/app.php
的providers
部分注册此服务提供者
'providers' => [ // ... App\Providers\B2BApiServiceProvider::class, ]
然后使用以下命令“发布”包所需的资源
$ ./artisan vendor:publish --provider="App\Providers\B2BApiServiceProvider"
此命令将创建一个名为
./config/b2b-api-client.php
的文件,其中包含“默认”设置,您应将其替换为自己的设置。
然后打开文件./config/b2b-api-client.php
,并指定连接到 B2B API 服务器的凭据。
包的新版本可能会在配置文件中添加新的选项。请记住定期检查这一点。
使用
此包注册了2个 IoC 容器
- 报告类型存储库:
AvtoDev\B2BApiLaravel\ReportTypes\ReportTypesRepository
- B2B API 服务:
AvtoDev\B2BApiLaravel\B2BApiService
报告类型存储库负责从配置文件中初始加载报告类型数据,并提供方便的访问方式(例如,检查其是否存在、提取等)。
可以通过直接按名称提取类或别名,或使用ReportTypesRepositoryFacade
门面来访问它。
B2B API 服务旨在提供方便的访问客户实例,通过使用->client()
方法,同时也实现了对报告的基本操作(例如,创建、获取报告内容以及更新报告数据,无需手动生成授权令牌)。此外,它还包含其他方法,具体请参阅服务源代码。
有关如何使用客户端的详细信息,请参阅此存储库。
可以通过直接通过类名或别名提取,也可以通过B2BApiServiceFacade
外观类访问它。
事件
您可以设置以下事件的监听器
AvtoDev\B2BApiLaravel\Events\BeforeRequestSending
- 在向 B2B API 服务发送请求之前发生;AvtoDev\B2BApiLaravel\Events\AfterRequestSending
- 在向 B2B API 服务发送请求之后发生。
有关如何使用事件监听器的详细信息,请参阅此链接。
测试
对于包测试,我们使用phpunit
框架。只需在您的终端中写入
$ git clone git@github.com:avto-dev/b2b-api-php-laravel.git ./b2b-api-php-laravel && cd $_ $ composer install $ composer test
变更日志
变更日志可以在此处找到。
支持
如果您发现任何包错误,请在当前存储库中创建一个问题。
许可证
这是一个开源软件,许可协议为MIT 许可证。