spinbits/baselinker-sdk

PHP 与 Baselinker 集成 https://api.baselinker.com/

1.0.2 2022-02-01 08:36 UTC

This package is auto-updated.

Last update: 2024-09-23 16:21:43 UTC


README

Latest Version on Packagist Software License Build Status Total Downloads

需要帮助?

给我们发邮件 hello@spinbits.io

描述

此包是 BaseLinker 连接器(“集成文件”)通信的实现。有关详细信息,请参阅 https://connectors.baselinker.com/exec/docs/index.php

此包仅提供核心动作处理器。它已准备好通过您的自有电商(Sylius 或其他基于 PHP 的产品)动作处理器进行扩展。

要集成 Sylius,请访问 https://github.com/spinbits/sylius-baselinker-plugin

安装

通过 Composer

$ composer require spinbits/baselinker-sdk

用法

为了使用此包,实例化您的 Baselinker 处理器

$baselinkerPassword = 'secret-password';
$baselinkerHandler = new Spinbits\BaselinkerSdk\RequestHandler($baselinkerPassword);

使用来自 BaseLinker API 的 $actionName 注册示例处理器

$fileVersionHandler = new Spinbits\BaselinkerSdk\Handler\Common\FileVersionActionHandler();
$baselinkerHandler->registerHandler('FileVersion', $fileVersionHandler);

您还可以使用一些依赖参数注册处理器

$supportedMethods = new Spinbits\BaselinkerSdk\Handler\Common\SupportedMethodsActionHandler($baselinkerHandler);
$baselinkerHandler->registerHandler('SupportedMethodsActionHandler', $supportedMethods);

在处理请求之前,您应该创建一个 Input 对象,该对象接收作为 POST 请求参数传递的数组。假设 $request 是例如 Symfony\Component\HttpFoundation\Request 对象。我们可以使用

$input = new Spinbits\BaselinkerSdk\Rest\Input($request->request->all());

为了处理传入的请求,您可以只需运行

$response = $baselinkerHandler->handle($input);

返回给控制器的结果是

$response->getContent();
/* returns example response:
[
    'platform' => "Common spinbits baslinker plugin",
    'version' => "4.0.0",
    'standard' => 4,
]
*/

可以在 src\Handler\Common 中找到适用于所有实现的常见示例处理器。

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

测试

$ composer test

贡献

有关详细信息,请参阅 CONTRIBUTING

安全

如果您发现任何与安全相关的问题,请通过电子邮件 office@spinbits.io 发送,而不是使用问题跟踪器。

许可

MIT 许可证(MIT)。有关更多信息,请参阅 许可文件