jivesh/laravel-slack

一个用于与 Slack 集成的极简 Laravel 扩展包

维护者

详细信息

github.com/gahlawat/laravel-slack

主页

源代码

问题

安装量: 36,538

依赖者: 2

建议者: 0

安全性: 0

星标: 25

关注者: 3

分支: 7

公开问题: 1

2.1.2 2018-04-04 07:50 UTC

Requires

Requires (Dev)

MIT 5bacf661bbf7a0796b792259b709925454e5ec71

  • Jivesh Gahlawat <jiveshsg.woop@gmail.com>

laravelslack

This package is not auto-updated.

Last update: 2024-09-28 18:05:20 UTC

README

Author Travis Quality Score Code Climate Total Downloads Packagist Version Software License SensioLabsInsight

一个非常小巧且轻量级的 Slack API 集成，用于向您的团队 Slack 账户发布通知或任何类型的消息。

要求

  • Laravel 框架 5+

安装

使用 Composer 包管理器，在项目根目录下运行以下命令来安装此包

$ composer require jivesh/laravel-slack

注册包

  • 此包支持 Laravel v5.5 中引入的自动发现功能，因此它是自动注册的。您可以直接跳转到下面的“配置”部分。

  • 如果您的应用程序运行在 Laravel v5.4 或更低版本，请按照以下步骤进行注册

  • 在您的 config/app.php 文件中，将以下代码添加到您的 providers 数组中，以便集成包的服务提供者。

/**
 * Package Service Provider
 */

'providers' => [
    // ...

    Gahlawat\Slack\SlackServiceProvider::class,
],
  • 同样在您的 config/app.php 文件中，将以下代码复制到您的 aliases 数组中，以使用 Facades 实现更优雅的 Laravel 语法。
/**
 * Package Alias
 */

'aliases' => [
    // ...

    'Slack' => Gahlawat\Slack\Facade\Slack::class,
],

配置

  • 在您的 Slack 账户上为该包创建一个 入站 webhook 并复制生成的 Webhook URL。

  • 在项目根目录中运行以下命令以生成包的配置文件。

$ php artisan vendor:publish
  • 现在编辑 config/slack.php 并粘贴在上述第一步中生成的 incoming-webhook 值。
  • 您可以从这里可选地设置默认用户名和显示在您的 Slack 应用程序中的表情图标。

使用

  • 使用此命令在任何 PHP 代码中实时发送任何消息到您的 Slack 账户
\Slack::send("your-message");
  • 反斜杠表示该函数的全局命名空间作用域，您可以通过 using 它在文件顶部导入 Slack 命名空间
use Slack;
  • 然后，您可以通过以下方式调用此 Facade，无需使用 \
Slack::send("your-message");
  • 您可以通过使用可选的第二和第三参数来更改任何消息在 Slack 应用程序中的默认名称和/或显示图标。
  • 要向任何用户私下发送此消息，请使用第四个参数作为 @username
  • 要向任何频道公开发送此消息，请使用第四个参数作为 #channel
Slack::send("your-message" [,"display-name" [,"display-emoji"] [,"#channel" or "@username"]]);

// here [] indicates optional parameters

请参阅此 表情符号速查表 以查看可用的表情符号图标。