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 格式的扩展可用。

贡献

我们非常乐意接收问题报告并审查和接受拉取请求。请随意以任何方式贡献。

作者

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

许可证

Redlink Api Symfony Bundle 在以下许可证下发布：MIT 许可证 (MIT)。