README

用于与 Cerpus Metadata Service 通信的 PHP 库

安装

使用 composer 需求此包

composer require cerpus/metadataservice-client

Laravel

当 composer 完成后，将服务提供者添加到 config/app.php 中的 providers 数组

Cerpus\MetadataServiceClient\Providers\MetadataServiceClientServiceProvider::class,

在 config/app.php 中的 alias 数组中添加以下内容

'MetadataService' => \Cerpus\MetadataServiceClient\MetadataServiceClient::class,

发布包中的配置文件

php artisan vendor:publish --provider="Cerpus\MetadataServiceClient\Providers\MetadataServiceClientServiceProvider" --tag=config

Lumen

尚未测试，但应该可以工作。如果不起作用，欢迎您更新此文档！

在 app/Providers/AppServiceProvider.php 中添加服务提供者

public function register()
{
    $this->app->register(Cerpus\MetadataServiceClient\Providers\MetadataServiceClientServiceProvider::class);
}

取消注释 bootstrap/app.php 中加载服务提供者的行

$app->register(App\Providers\AppServiceProvider::class);

编辑配置文件

编辑 config/metadataservice-client.php

<?php
return [
    "adapters" => [
        "cerpus-metadata" => [
            "handler" => \Cerpus\MetadataServiceClient\Adapters\MetadataServiceAdapter::class,
            "base-url" => '<url to service>',
        ],
    ],
];

开发人员设置示例

<?php

return [
    "adapters" => [
        "cerpus-metadata" => [
            "handler" => \Cerpus\MetadataServiceClient\Adapters\CerpusMetadataServiceAdapter::class,
            "base-url" => env('METADATA_SERVER'),
        ],
    ],
];

用法

从 Laravel 容器解析

$cerpusMetadata = app(Cerpus\MetadataServiceClient\Contracts\MetadataServiceContract::class)

或别名

$cerpusMetadata = CerpusMetadataServiceAdapter::<Class Method>

或直接

$cerpusMetadata = new Cerpus\MetadataServiceClient\Adapters\CerpusMetadataServiceAdapter(Client $client);

最后一个是 不推荐 的。

类方法

方法调用在失败时返回对象或抛出异常。

更多信息

参见Confluence Metadata 存储服务 API 文档

许可证

此包根据 GNU 通用公共许可证 3.0 发布。有关更多信息，请参阅 LICENSE 文件。