README

Hyperf-support是一个用于流畅管理Slack、Trello和其他系统内票据和评论的包。由onix-systems-php制作。

安装

composer require onix-systems-php/hyperf-support

发布配置

php bin/hyperf.php vendor:publish onix-systems-php/hyperf-support

配置

配置app

1. domain - 应用程序URL，例如（https://github.com）。
2. name - 应用程序名称。
3. team_name - 支持团队的名称。
4. user_model_class - 用户模型路径。然后在模型类中实现OnixSystemsPHP\HyperfSupport\Contract\SupportUserInterface接口。

配置integrations.trello

1. key - API密钥。（您可以在https://trello.com/power-ups/admin中找到它）
2. token - 授权令牌。
3. webhook_url - app.domain + /v1/support/webhooks/trello。
4. board_name - Trello看板名称。
5. members - 对于每种票据类型，指定应该附加到Trello卡片上的成员。
6. lists - 指定票据每种状态与Trello上相应列表的映射。
7. custom_fields - 确定哪些自定义字段应该出现在Trello卡片上。
8. trigger_lists - 指定Trello上的触发列表。这些列表确定是否在票据移动到这些列表之一时通知用户。
9. is_private_discussion - 此选项必须是true或false。如果是true，Trello上票据下的讨论将是私密的，除了Trello之外任何人都可以看到。
10. keys_to_source - 指定your_api_username => your_source。

配置integrations.slack

1. token - 机器人授权密钥。
2. channel_id - Slack频道ID。
3. 不要忘记启用您的Slack机器人的订阅，并指定请求URL：app.domain + /v1/support/webhooks/trello。
4. app_icon - 您应用程序的图标URL。例如
5. trello_icon - Trello图标URL。（可选）
6. members - 对于每种票据类型，指定应该在Slack票据上提及的成员。不要使用'@'。
7. custom_fields - 确定哪些自定义字段应该显示在Slack票据上。
8. is_private_discussion - 此选项必须是true或false。如果是true，Slack上票据下的讨论将是私密的，除了Slack之外任何人都可以看到。
9. keys_to_source - 指定your_slack_channel_id => your_source。

配置routes

require_once './vendor/onix-systems-php/hyperf-support/publish/routes.php';

基本用法

创建简单票据

尝试通过POST方法将此JSON发送到/v1/support/tickets。

{
  "source": "default",
  "title": "Lorem ipsum.",
  "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.",
  "custom_fields": {
    "type": "Tweak",
    "level": 3,
    "priority": "Medium",
    "status": "New"
  },
  "page_url": "https://google.com"
}

您应该得到类似以下的对象

{
    "id": 1,
    "title": "Lorem ipsum.",
    "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.",
    "source": "default",
    "custom_fields": {
        "type": "Tweak",
        "level": 3,
        "status": "New",
        "priority": "Medium"
    },
    "created_by": 6,
    "modified_by": null,
    "deleted_by": null,
    "completed_at": null,
    "trello_id": "660bc45ce19c204556caf1f5",
    "trello_short_link": "qTHPdFoL",
    "slack_id": "1712047194.779679",
    "page_url": null,
    "created_at": "2024-04-02 08:39:54",
    "updated_at": "2024-04-02 08:40:36",
    "deleted_at": null,
    "files": []
}

最后，它应该出现在Slack和Trello上。

创建带文件的票据

逻辑与创建简单票据相同，但您需要传递包含文件ID的数组

{
    ...
    "files": [1, 2, 3]
}

最后，票据应该出现在Slack和Trello上，并附加了文件。

在Trello上更新票据。

每次当票据移动到Trello上的“完成”列表时，如果ticket.done_status是“完成”，则票据将被标记为“已完成”。