hnhdigital-os/laravel-slack

Laravel integration for the hnhdigital-os/php-slack package.

dev-master 2017-07-04 01:13 UTC

This package is auto-updated.

Last update: 2020-09-21 17:04:02 UTC


README

   _____ _            _       __             _                               _ 
  / ____| |          | |     / _|           | |                             | |
 | (___ | | __ _  ___| | __ | |_ ___  _ __  | |     __ _ _ __ __ ___   _____| |
  \___ \| |/ _` |/ __| |/ / |  _/ _ \| '__| | |    / _` | '__/ _` \ \ / / _ \ |
  ____) | | (_| | (__|   <  | || (_) | |    | |___| (_| | | | (_| |\ V /  __/ |
 |_____/|_|\__,_|\___|_|\_\ |_| \___/|_|    |______\__,_|_|  \__,_| \_/ \___|_|
                                                                               

Provides Slack for Laravel.

Latest Stable Version Total Downloads Latest Unstable Version Built for Laravel License

StyleCI Issue Count Code Climate

This package has been adapted by H&H|Digital, an Australian botique developer. Visit us at hnh.digital.

Install

Via composer:

$ composer require bluora/laravel-slack dev-master

Enable the service provider by editing config/app.php:

    'providers' => [
        ...
        Bluora\LaravelSlack\ServiceProvider::class,
        ...
    ];

Enable the facade by editing config/app.php:

    'aliases' => [
        ...
        'Slack' => Bluora\LaravelSlack\Facade::class,
        ...
    ];

Then create an incoming webhook for each Slack team you'd like to send messages to. You'll need the webhook URL(s) in order to configure this package.

Finally, publish the config file with php artisan vendor:publish. You'll find it at config/slack.php.

Configuration

The config file comes with defaults and placeholders. Configure at least one team and any defaults you'd like to change.

Usage

// Send a message to the default channel
Slack::send('Hello world!');

// Send a message to a different channel
Slack::to('#accounting')->send('Are we rich yet?');

// Send a private message
Slack::to('@username')->send('psst!');

Contributing

Please see CONTRIBUTING for details.

Credits

License

The BSD 2-clause. Please see License File for more information.