README

目的

Bold Shopify Toolkit 是一个基于 Symfony 和 Shopify 的包装器，可以轻松地与 Shopify 进行交互。目的是集成 Shopify 提供的 API，并为访问这些端点的模型和服务保持一致的数据结构。

入门

此包与依赖注入容器配合使用最佳，因为需要解决许多依赖项。

先决条件

使用此包，您需要将以下接口绑定到模型。

• ShopAccessInfo
• ShopBaseInfo
• ApplicationInfo
• ApiSleeper

本包已包含一个示例 API Sleeper。

Laravel: （见 AppServiceProvider.php）

    $this->app->bind(\BoldApps\ShopifyToolkit\Contracts\ApiSleeper::class,
            \BoldApps\ShopifyToolkit\Support\ShopifyApiHandler::class);

安装

添加到 composer.json

$ composer require bold-commerce/bold-shopify-toolkit

在请求生命周期中绑定适当的模型。

    $this->app->bind(\BoldApps\ShopifyToolkit\Contracts\ApiSleeper::class,
            \BoldApps\ShopifyToolkit\Support\ShopifyApiHandler::class);

    ...

对于使用容器系统的应用程序，此操作如下所示

        $shopifyApiHandler = new ShopifyApiHandler();
        $this->getContainer()->addShared(RequestHookInterface::class, $shopifyApiHandler);
        $this->getContainer()->addShared(ApiSleeper::class, $shopifyApiHandler);

上述代码可以是服务提供器类的一部分

在调用工具包的服务和/或模型之前，绑定将使用工具包的商店。

// $shop - Eloquent model containing at least the myshopify_domain ("example.myshopify.com")
app()->instance(BoldApps\ShopifyToolkit\Contracts\ShopBaseInfo::class, $shop);
 
// $accessToken - Contains the access token string created when the shop installed the app
app()->instance(BoldApps\ShopifyToolkit\Contracts\ShopAccessInfo::class, $accessToken);

运行测试

$ vendor/bin/phpunit tests

提供了一个 Dockerfile，用于以与 Circle 相同的方式运行测试

$ ./runtests.sh

示例

创建代表您想要使用的 API 的服务

$variantService = new BoldApps\ShopifyToolkit\Services\Variant();
//OR
$variantService = app()->make(BoldApps\ShopifyToolkit\Services\Variant::class);

获取单个变体模型

/** @var BoldApps\ShopifyToolkit\Models\Variant $variant */
$variant = $variantService->getById(2641814487051);
 
$variant->getPrice(); //99.0

获取变体模型集合并使用产品 ID 过滤，以仅获取它们的标题

/** @var Illuminate\Support\Collection $variants */
$variants = $variantService->getAllByProductId(327661486091, ["fields" => "title"]);
 
/** @var BoldApps\ShopifyToolkit\Models\Variant $variant */
foreach ($variants as $variant) {
    $title = $variant->getTitle(); //"Default title"
}

更新变体

$variant->setOption1("Not pink");
 
$updatedVariant = $variantService->update($variant);
 
$updatedVariant->getOption1(); //"Not pink"

查看 tests/VariantTest.php 以了解如何序列化和反序列化模型的一个示例。

待办事项

• 添加更多测试
• 添加 ShopifyApiHandler 的高级使用示例

贡献

欢迎拉取请求和想法！打开一个问题，我们来谈谈。

版本控制

我们使用 SemVer 进行版本控制。有关可用的版本，请参阅本存储库的 标签。

许可

本项目采用 Apache 2 许可证 - 详细信息请参阅 LICENSE.md 文件。

致谢

• 感谢 Shopify 为我们提供了最佳的开发者网络！
• 感谢 Bold Commerce 开发者为这个惊人的包所作的贡献。