moiseskalebe/slack-dispatcher-php

简单的Slack消息发布器

v1.2.2 2023-11-10 23:03 UTC

This package is auto-updated.

Last update: 2024-09-11 01:06:01 UTC


README

简介

欢迎使用Slack App Message Dispatcher,这是一个将开发者和团队之间的Slack沟通变得极其简单和高效的工具。这个应用程序源于记录事件和个性化通知团队的需求,为寻求与Slack平台流畅集成的开发者提供了一个创新的解决方案,以简化他们的生活。

在反思通信过程优化时,产生了创建一个包的想法,该包不仅简化了应用程序中的操作通知,而且提供了灵活的消息处理。Slack App Message Dispatcher不仅仅是一个工具;它是一个促进者,旨在使开发者和团队之间的交互更加敏捷和个性化。

探索Slack App Message Dispatcher,了解它如何改变您的团队在Slack上的沟通方式。

目录

  1. 简介
  2. 目录
  3. 要求
  4. 安装
  5. 使用
  6. 示例
  7. 贡献

要求

需要PHP 8.1+

安装

要安装此依赖项,只需执行以下命令

composer require moiseskalebe/slack-dispatcher-php

使用

首先,您需要前往Slack网站并获取您应用程序的URL。

访问网站后,您将打开应用程序的设置,滚动到页面底部至“Webhook URL”部分。

获取应用程序的webhook链接后,您可以继续定义连接和要发送的消息的详细信息。

设置模型

<?php

declare(strict_types=1);

use MoisesK\SlackDispatcherPHP\Attachment;
use MoisesK\SlackDispatcherPHP\Collection\AttachmentFieldCollection;
use MoisesK\SlackDispatcherPHP\MessageDispatcher;
use MoisesK\SlackDispatcherPHP\Dto\AttachmentAuthor;
use MoisesK\SlackDispatcherPHP\Dto\AttachmentField;
use MoisesK\SlackDispatcherPHP\Dto\AttachmentFooter;
use MoisesK\SlackDispatcherPHP\Dto\AttachmentTitle;
use MoisesK\SlackDispatcherPHP\SlackAppMessage;

require __DIR__ . '/vendor/autoload.php';

// Todos os parâmetros do anexo(Attachment) são opcionais.
$attachment = new Attachment([
    'color' => '#36a64f',
    'pretext' => 'Este e o Pretexto do anexo',
    'author' => new AttachmentAuthor(
        authorName: 'Nome do Autor',
        authorIcon: "https://example.com"
    ),
    'title' => new AttachmentTitle(
        title: 'Titulo do anexo',
        titleLink: "https://example.com"

    ),
    'text' => 'Texto do anexo. Você pode usar *negrito*, _itálico_, e [links](https://example.com) no texto.',
    'fields' => new AttachmentFieldCollection([
        new AttachmentField(
            title: 'campo 1',
            value: 'valor 1',
            short: false
        )
    ]),
    'imageUrl' => "https://example.com",
    'footer' => new AttachmentFooter(
        footer: 'Rodapé do anexo',
        footerIcon: "https://example.com"
    ),
    'ts' => '123456789'
]);

// Crie uma instância da classe SlackAppMessage
$slackMessage = new SlackAppMessage('https://hooks.slack.com/services/.....');

// Defina o texto do Cabeçalho da Mensagem
$slackMessage->setHeaderText('Texto da Mensagem');

// Adicione um Anexo
$slackMessage->addAttachment($attachment);

// Envie a mensagem para o app
$slackMessage->dispatch();

示例

看看您的消息将如何呈现的示例

贡献

此项目的贡献通过Pull Requests (PRs) 进行。在提交贡献之前,请确保遵循以下步骤

  1. 创建仓库分叉

    • 将仓库分叉到您的GitHub账户。
    • 将分叉的仓库克隆到您的本地计算机。
  2. 创建贡献分支

    • 创建一个新的分支来工作于您的贡献。
  3. 进行修改

    • 在代码中实施必要的更改。
  4. 测试您的更改

    • 确保您的更改按预期工作。
    • 如果适用,执行额外的测试。
  5. 发送Pull Request:

    • 提交您的更改。
    • 向主仓库发送Pull Request。

Pull Request指南

在发送Pull Request时,请遵循以下指南

  • 清楚地描述您的Pull Request引入的更改。
  • 包括有关更改原因的详细信息。
  • 如果可能,通过问题编号引用特定问题。

为了使Pull Request的审查过程更加高效,以下是一些个人偏好

  • 使用与项目其他部分一致的风格进行编码。
  • 为新的功能或修复包括单元测试。
  • 保持提交信息清晰简洁。

快乐的编码!🚀