README

Laravel Akeneo 客户端

使用官方的 akeneo/api-php-client 连接到您的 Akeneo 实例。此包将简化 Laravel 的配置、依赖注入和测试。

如果启用，它还提供了一个端点来接收 Akeneo 事件。

示例用法

<?php

use JustBetter\AkeneoClient\Client\Akeneo;

public function __construct(Akeneo $akeneo)
{
    $product = $akeneo->getProductApi()->get('1000');
}

安装

安装 composer 包。

composer require justbetter/laravel-akeneo-client

默认情况下，此包将需要 akeneo/api-php-client 的最新版本。您应该查看 兼容性表 以确定您项目所需的版本。

composer require akeneo/api-php-client "^9.0"

设置

可选，发布包的配置。

php artisan vendor:publish --provider="JustBetter\AkeneoClient\ServiceProvider" --tag=config

配置

将以下值添加到您的 .env 文件中。

AKENEO_URL=
AKENEO_CLIENT_ID=
AKENEO_SECRET=
AKENEO_USERNAME=
AKENEO_PASSWORD=

AKENEO_EVENT_SECRET=

事件

如果您已 启用 Akeneo 的事件订阅，您将能够监听这些事件。

事件 webhook 是 /akeneo/event。这可以通过您的 akeneo 配置文件中的 prefix 进行配置。

所有 事件都可用。

<?php

use Illuminate\Support\Facades\Event;
use JustBetter\AkeneoClient\Events\ProductCreatedEvent;

Event::listen(function (ProductCreatedEvent $event): void {
    //
});

测试

此包可以非常轻松地进行 Akeneo 调用的测试和模拟。

<?php

use Illuminate\Support\Facades\Http;
use JustBetter\AkeneoClient\Client\Akeneo;

// This will fake Akeneo credentials and a sign in.
Akeneo::fake();

// Fake the specific call you will be using
Http::fake([
    'akeneo/api/rest/v1/products/1000' => Http::response([
        'identifier' => '1000',
        'enabled' => true,
        'family' => 'hydras',
        'categories' => [],
        'groups' => [],
        'parent' => null,
        'values' => [
            'name' => [
                [
                    'locale' => 'nl_NL',
                    'scope' => 'ecommerce',
                    'data' => 'Ziggy',
                ],
            ],
        ],
    ]),
]);

// Get the product with the fake response
$response = $akeneo->getProductApi()->get('1000');

质量

为确保此包的质量，请运行以下命令

composer quality

这将执行三个任务

1. 确保所有测试都通过
2. 使用静态代码分析检查任何问题
3. 检查代码是否格式正确

贡献

有关详细信息，请参阅 CONTRIBUTING。

安全漏洞

请审查我们关于如何报告安全漏洞的 安全策略。

鸣谢

• Ramon Rietdijk
• 所有贡献者

许可

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