PHPackages                             fred/laravel-slack - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. fred/laravel-slack

ActiveLibrary[Utility & Helpers](/categories/utility)

fred/laravel-slack
==================

slack service provider and message composer

1.2.0(5y ago)16MITPHPPHP >=7.2CI failing

Since Jul 17Pushed 5y agoCompare

[ Source](https://github.com/Fred07/laravel-slack)[ Packagist](https://packagist.org/packages/fred/laravel-slack)[ RSS](/packages/fred-laravel-slack/feed)WikiDiscussions master Synced today

READMEChangelog (3)Dependencies (3)Versions (5)Used By (0)

[![Build Status](https://camo.githubusercontent.com/d463de28c4bcb82a76bc716cbad8ef48b35c80a891f9961de5e1e72852602554/68747470733a2f2f7472617669732d63692e636f6d2f4672656430372f6c61726176656c2d736c61636b2e7376673f6272616e63683d6d6173746572)](https://travis-ci.com/Fred07/laravel-slack)

slack service provider
======================

[](#slack-service-provider)

本專案以 service provider 方式

提供 `laravel/lumen` 專案操作 slack 物件

傳遞 `錯誤/訊息` 至 slack channel

安裝
--

[](#安裝)

執行 composer 安裝，在根目錄下指令

```
composer require fred/laravel-slack

```

`laravel/lumen` 專案下設定 `SlackServiceProvider`

\[lumen\] - 在 `/bootstrap/app.php` 加入

```
$app->register(Fred\SlackService\SlackServiceProvider::class);
```

\[laravel\] - 支援 laravel auto discovery

若 laravel 版本不支援則需手動加入 `/config/app.php`

```
'providers' => [
    //...

    Fred\SlackService\SlackServiceProvider::class,
];
```

套用設定檔
-----

[](#套用設定檔)

\[laravel\] - 在專案目錄下透過 artisan 指令

```
$ php artisan vendor:publish --provider="Fred\SlackService\SlackServiceProvider" --tag="config"
```

\[lumen\] - 在 `/config` 資料夾下放入 `slack.php`

---

到 `/config/slack.php` 設定內容:

```
return [
    // 可設定多組 client 面對不同的 slack channel 及用途
    // key 值必需做區分
    'clients'   =>  [
        // 'clientName' => []
        // service provider 將綁定名稱為 "slack-{client_name}" 的 instance 在 container 中
        'error-report' => [
            'endpoint' => 'https://hooks.slack.com/services/xxxxxxx',  // slack web hook url
            'channel'  => 'my-test-channel',                           // slack channel
            'username' => 'Error Report'                               // slack messages' user name
        ],
        'custom-name' => [
            // 其他組 slack client 設定
        ],
    ],
];
```

使用方式
----

[](#使用方式)

以下依據上述的註冊範例延伸

基本傳遞訊息:

```
$slack = app('slack-error-report');
$slack->compose(function (Message $message) {
    $message->setText('slack message sending!');
    return $message;
})->send();
```

透過 `MessageComposer` 套用模板，強化訊息內容

```
$slack = app('slack-error-report');
$slack->compose(function (Message $message) {
    // 產生 MessageComposer 物件
    $messageComposer = new Fred\SlackServiceProvider\MessageComposer($message);

    // 套用模板所需的參數和值，預設使用 Exception template
    $data = [
        'exceptionContent' => 'Invalid user id',
        'requestContent' => 'https://oobox.com.tw',
        'envContent' => 'testing',
        'timeContent' => Carbon\Carbon::now()->toDateTimeString(),
        'traceContent' => "error trace code",
    ];
    $messageComposer->apply($data);
    return $messageComposer->getMessage();
})->send();
```

**預設模板 (Exception template) 可帶入之變數列表**

- exceptionTitle: 例外標題 (default: Exception)
- exceptionContent: 例外內容
- requestTitle: 請求 url 標題 (default: Request)
- requestContent: 請求 url
- envTitle: 環境標題 (default: Environment)
- envContent: 環境
- timeTitle: 時間標題 (default: Time)
- timeContent: 時間
- traceTitle: code trace 標題 (default: Trace)
- traceContent: code trace

### 自訂模板

[](#自訂模板)

欲自訂模板請參考 `slack` payload 文件，範例可參考套件預設的 exception template `/src/templates/ExceptionTemplate.php`

產生 MessageComposer 物件後帶入自訂的模板路徑

```
// ...

// 產生 MessageComposer 物件
$messageComposer = new Fred\SlackServiceProvider\MessageComposer($message);

// 帶入自定義的模板路徑
$messageComposer->useTemplate('/path/to/template');

// 後續組成資料
$data = [];
$messageComposer->apply($data);
return $messageComposer->getMessage();

// ...
```

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~246 days

Total

3

Last Release

1996d ago

PHP version history (2 changes)1.0PHP >=7.1

1.1.0PHP >=7.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/cb72ccd665e28b1c9f94a8c5dc10921d9b92ea6c29fe190289d53aa489f33cfb?d=identicon)[Fred07](/maintainers/Fred07)

---

Top Contributors

[![Fred07](https://avatars.githubusercontent.com/u/2677063?v=4)](https://github.com/Fred07 "Fred07 (4 commits)")

---

Tags

laravellumenphp7service-providerslack

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/fred-laravel-slack/health.svg)

```
[![Health](https://phpackages.com/badges/fred-laravel-slack/health.svg)](https://phpackages.com/packages/fred-laravel-slack)
```

###  Alternatives

[shlinkio/shlink

A self-hosted and PHP-based URL shortener application with CLI and REST interfaces

4.8k4.3k](/packages/shlinkio-shlink)[ralphjsmit/laravel-helpers

A package containing handy helpers for your Laravel-application.

13704.6k2](/packages/ralphjsmit-laravel-helpers)[dhlparcel/magento2-plugin

DHL Parcel plugin for Magento 2

11180.5k2](/packages/dhlparcel-magento2-plugin)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

255.2k](/packages/aedart-athenaeum)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)