README

此仓库包含一个用于redlink-api-php-client的简单Symfony Bundle。

要求

此版本支持PHP >= 7.2和Symfony >= 4.4.0。

安装

请确保已全局安装Composer，具体请参阅Composer文档中的安装章节。

使用Symfony Flex的应用程序

获取Composer后，您必须安装PSR HTTP客户端实现（如果您还没有 - 例如Guzzle / Buzz）

$ composer require guzzlehttp/guzzle

接下来，您应该使用Composer安装此软件包

$ composer require --no-scripts plotkabytes/redlink-api-php-client plotkabytes/redlink-api-symfony-bundle

不使用Symfony Flex的应用程序

步骤1：下载Bundle

步骤与“使用Symfony Flex的应用程序”章节中相同。

步骤2：启用Bundle

然后，通过将其添加到项目中config/bundles.php文件中已注册的Bundle列表中来启用Bundle

// config/bundles.php

return [
    // ...
    Plotkabytes\RedlinkApiBundle\PlotkabytesRedlinkApiBundle.php::class => ['all' => true],
];

步骤3：配置Bundle

然后，通过在config/packages/plotkabytes_redlink_api.yaml文件中添加以下配置来配置Bundle

# config/packages/plotkabytes_redlink_api.yaml
plotkabytes_redlink_api:
  clients:
    client_name:
      authorization_key: HERE_INSERT_AUTHORIZATION_KEY
      application_key: HERE_INSERT_APPLICATION_KEY
      alias: OPTIONAL_CLIENT_ALIAS
      default: false

步骤4：清除缓存

在配置Bundle后可能需要清除symfony缓存。

$ bin/console cache:clear

步骤5：注册服务

在config/services.yaml文件中添加以下内容

# config/services.yaml
services:
  
    # ...
    # Other services
    # ...
  
    App\Controller\DefaultController:
        arguments: {$client: '@plotkabytes_redlink_api.client.default'}

步骤6：使用Bundle

<?php
namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Plotkabytes\RedlinkApi;

class DefaultController extends AbstractController {

    private $client;

    public function __construct(DefaultClient $client) {
        $this->client = $client;
    }
}

版本控制

我们使用Semantic Versioning 2.0.0。

给定版本号MAJOR.MINOR.PATCH，当您进行不兼容的API更改时，增加MAJOR版本，当您以向后兼容的方式添加功能时，增加MINOR版本，当您进行向后兼容的错误修复时，增加PATCH版本。

• MAJOR版本
• MINOR版本
• PATCH版本

MAJOR.MINOR.PATCH格式的预发布标签和构建元数据可作为扩展。

贡献

我们乐意接受问题报告和审阅以及接受pull请求。请随意以任何方式做出贡献。

作者

Mateusz Żyła mateusz.zylaa@gmail.com

许可证

Redlink Api Symfony Bundle是在MIT许可证（MIT）下授权的。