timfeid/slack

Slack integration with PHP

1.0.1 2017-05-16 14:32 UTC

Requires

• php: >=5.5.0
• ext-mbstring: *
• guzzlehttp/guzzle: ~6.0

Requires (Dev)

• fzaninotto/faker: ~1.4
• mockery/mockery: 0.9.*
• phpunit/phpunit: 4.2.*

MIT

• Tim Feid

README

This package will utilize Slack's incoming webhooks.

Requirements

• PHP 7+
• PHP mbstring extension

Basic Usage

Create a client

// Quick istantiation
$client = new TimFeid\Slack\Client('https://hooks.slack.com...');

// Instantiate with default params
$pamas = [
    'username' => 'Tim Feid',
    'channel' => '#general',
    'unfurl_media' => true,
];

$client = new TimFeid\Slack\Client('https://hooks.slack.com...', $params);

Customizing a message

// Explicitly create a default message
$message = $client->createMessage();

// Set parameters on the message
$message->text = 'This is the text';
$message->icon = ':slack:';

// Or like this
$message['text'] = 'This is the text';

// Or using fluent methods
$message->write('This is the text')->icon(':slack:')->from('username')->to('channel');

// Create a default message from text
$message = $client->write('The text here');

// Create a message with all the parameters you wish to send
$params = [
    'username' => 'Tim Feid',
    'channel' => '#general',
    'text' => 'It\'s happening!',
    'icon' => ':poop:',
    'attachments' => [
        [
            'fallback' => 'This is fallback text',
            'text' => 'Some text on the attachment',
            'image_url' => 'http://placehold.it/320x240',
            'fields' => [
                'title' => 'Field title',
                'value' => 'Field value',
                'short' => false,
            ],
        ],
    ],
];
$message = $client->createMessage($params);

Sending a message

Send a basic, default message

$client->send('Hello world!');

Send a message to a different channel

$client->to('#general')->send('Hello world!');

Send a direct message with a different username

$client->to('@username')->from('Bob')->send('Hello!');

Fluent sending

// Implicitly
$message = $message->write('This is the text')->to('channel/@username')->from('username')->icon(':slack:');
$message->send();

// Explicitly
$message->to('channel/@username')->from('username')->icon(':slack:')->send('This is the text');