nexylan/slack

A simple PHP package for sending messages to Slack, with a focus on ease of use and elegant syntax.

Thursday, January 18, 2018
by Soullivaneuh
Repository
3 Watchers
13 Stars
31,140 Installations

PHP
1 Dependents
0 Suggesters
2 Forks
3 Open issues
26 Versions
57 % Grown

The README.md

Slack for PHP

A simple PHP package for sending messages to Slack with incoming webhooks, focused on ease-of-use and elegant syntax., _(*1)

, _(*2)

, _(*3)

, _(*4)

Symfony integration: Slack bundle

This repository started from a fork of the popular maknz/slack library, which is not maintained anymore., _(*5)

The 1.x branch and all the related releases are an exact copy of the original repository and are under the BSD 2-clause "Simplified" License., _(*6)

The next releases will be under the MIT license. See the current LICENSE file for more details., _(*7)

Requirements

PHP 7.3+

Installation

You can install the package using the Composer package manager. You can install it by running this command in your project root:, _(*8)

composer require nexylan/slack

We also follow PSR-7, PSR-17 and PSR-18 standards for HTTP messaging. It allows you to use any HTTP client following this convention and make the library maintenability better for us., _(*9)

So you need to install an HTTP client following those standards. We recommand to use the popular HTTPlug project, but you are free to choose the more convinient one for you., _(*10)

Then create an incoming webhook on your Slack account for the package to use. You'll need the webhook URL to instantiate the client (or for the configuration file if using Laravel)., _(*11)

Basic Usage

Instantiate the client

In this example, we use the HTTPlug discovery component to bring the needed PSR tools., _(*12)

use Http\Discovery\Psr17FactoryDiscovery;
use Http\Discovery\Psr18ClientDiscovery;

use Nexy\Slack\Client;

$client = new Client(
    Psr18ClientDiscovery::find(),
    Psr17FactoryDiscovery::findRequestFactory(),
    Psr17FactoryDiscovery::findStreamFactory(),
    'https://hooks.slack.com/...',
    [
        'username' => 'Cyril', // Default messages are sent from 'Cyril'
        'channel' => '#accounting', // Default messages are sent to '#accounting'
        'link_names' => true
    ]
);

Note: The $options last parameter is optional., _(*13)

Settings

The default settings are pretty good, but you may wish to set up default behaviour for your client to be used for all messages sent. All settings are optional and you don't need to provide any. Where not provided, we'll fallback to what is configured on the webhook integration, which are managed at Slack, or our sensible defaults., _(*14)

Field	Type	Description
`channel`	string	The default channel that messages will be sent to
`sticky_channel`	bool	If set to true, all messages will be sent to the default channel only (defaults to false). It can be useful for dev/test environments.
`username`	string	The default username for your bot
`icon`	string	The default icon that messages will be sent with, either `:emoji:` or a URL to an image
`link_names`	bool	Whether names like `@regan` or `#accounting` should be linked in the message (defaults to false)
`unfurl_links`	bool	Whether Slack should unfurl text-based URLs (defaults to false)
`unfurl_media`	bool	Whether Slack should unfurl media-based URLs, like tweets or Youtube videos (defaults to true)
`allow_markdown`	bool	Whether markdown should be parsed in messages, or left as plain text (defaults to true)
`markdown_in_attachments`	array	Which attachment fields should have markdown parsed (defaults to none)

Sending messages

Sending a basic message (preview)

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

Sending a message to a non-default channel

$client->to('#accounting')->send('Are we rich yet?');

Sending a message to a user

$client->to('@regan')->send('Yo!');

Sending a message to a channel as a different bot name (preview)

$client->from('Jake the Dog')->to('@FinnTheHuman')->send('Adventure time!');

Sending a message with a different icon (preview)

// Either with a Slack emoji
$client->to('@regan')->withIcon(':ghost:')->send('Boo!');

// or a URL
$client->to('#accounting')->withIcon('http://example.com/accounting.png')->send('Some accounting notification');

Send an attachment (preview)

$client->to('#operations')->attach((new \Nexy\Slack\Attachment())
    ->setFallback('Server health: good')
    ->setText('Server health: good')
    ->setColor('danger')
)->send('New alert from the monitoring system'); // no message, but can be provided if you'd like

Send an attachment with fields (preview)

$client->to('#operations')->attach((new \Nexy\Slack\Attachment())
    ->setFallback('Current server stats')
    ->setText('Current server stats')
    ->setColor('danger')
    ->setFields([
        new \Nexy\Slack\AttachmentField(
            'Cpu usage',
            '90%',
            true // whether the field is short enough to sit side-by-side other fields, defaults to false
        ),
        new \Nexy\Slack\AttachmentField('RAM usage', '2.5GB of 4GB', true),
    ])
)->send('New alert from the monitoring system'); // no message, but can be provided if you'd like

Send an attachment with an author (preview)

$client->to('@regan')->attach((new \Nexy\Slack\Attachment())
    ->setFallback('Keep up the great work! I really love how the app works.')
    ->setText('Keep up the great work! I really love how the app works.')
    ->setAuthorName('Jan Appleseed')
    ->setAuthorLink('https://yourapp.com/feedback/5874601')
    ->setAuthorIcon('https://static.pexels.com/photos/61120/pexels-photo-61120-large.jpeg')
)->send('New user feedback');

Advanced usage

Markdown

By default, Markdown is enabled for message text, but disabled for attachment fields. This behaviour can be configured in settings, or on the fly:, _(*15)

Send a message enabling or disabling Markdown

$client->to('#weird')->disableMarkdown()->send('Disable *markdown* just for this message');

$client->to('#general')->enableMarkdown()->send('Enable _markdown_ just for this message');

Send an attachment specifying which fields should have Markdown enabled

$client->to('#operations')->attach((new \Nexy\Slack\Attachment())
    ->setFallback('It is all broken, man')
    ->setText('It is _all_ broken, man')
    ->setPretext('From user: *JimBob*')
    ->setColor('danger')
    ->setMarkdownFields(['pretext', 'text'])
)->send('New alert from the monitoring system');

Explicit message creation

For convenience, message objects are created implicitly by calling message methods on the client. We can however do this explicitly to avoid hitting the magic method., _(*16)

// Implicitly
$client->to('@regan')->send('I am sending this implicitly');

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

$message->to('@regan')->setText('I am sending this explicitly');

$message->send();

Attachments

When using attachments, the easiest way is to provide an array of data as shown in the examples, which is actually converted to an Attachment object under the hood. You can also attach an Attachment object to the message:, _(*17)

$attachment = (new Attachment())
    ->setFallback('Some fallback text')
    ->setText('The attachment text')
;

// Explicitly create a message from the client
// rather than using the magic passthrough methods
$message = $client->createMessage();

$message->attach($attachment);

// Explicitly set the message text rather than
// implicitly through the send method
$message->setText('Hello world')->send();

You can also set the attachments and fields directly if you have a whole lot of them:, _(*18)

// implicitly create a message and set the attachments
$client->setAttachments($bigArrayOfAttachments);

// or explicitly
$client->createMessage()->setAttachments($bigArrayOfAttachments);

$attachment = new Attachment();

$attachment->setFields($bigArrayOfFields);

Contributing

If you're having problems, spot a bug, or have a feature suggestion, please log and issue on Github. If you'd like to have a crack yourself, fork the package and make a pull request. Please include tests for any added or changed functionality. If it's a bug, include a regression test., _(*19)

The Versions

18/01 2018

dev-master

9999999-dev

A simple PHP package for sending messages to Slack, with a focus on ease of use and elegant syntax.

library slack

A simple PHP package for sending messages to Slack, with a focus on ease of use and elegant syntax.

nexylan/slack

The README.md

Slack for PHP

Requirements

Installation

Basic Usage

Instantiate the client

Settings

Sending messages

Sending a basic message (preview)

Sending a message to a non-default channel

Sending a message to a user

Sending a message to a channel as a different bot name (preview)

Sending a message with a different icon (preview)

Send an attachment (preview)

Send an attachment with fields (preview)

Send an attachment with an author (preview)

Advanced usage

Markdown

Send a message enabling or disabling Markdown

Send an attachment specifying which fields should have Markdown enabled

Explicit message creation

Attachments

Contributing

The Versions

dev-master

The Requires

The Development Requires

by Sullivan Senechal

by maknz

v2.0.0

The Requires

The Development Requires

by Sullivan Senechal

by maknz

dev-strict-types

The Requires

The Development Requires

by Sullivan Senechal

by maknz

dev-constructors-rewamp

The Requires

The Development Requires

by Sullivan Senechal

by maknz

dev-revert-33-magic-call-remove

The Requires

The Development Requires

by Sullivan Senechal

by maknz

dev-limited-chained-call

The Requires

The Development Requires

by Sullivan Senechal

by maknz

dev-magic-call-remove

The Requires

The Development Requires

by Sullivan Senechal

by maknz

dev-private-prepare-payload

The Requires

The Development Requires

by Sullivan Senechal

by maknz

dev-final

The Requires

The Development Requires

by Sullivan Senechal

by maknz

dev-underscore-to-camel

The Requires

The Development Requires

by Sullivan Senechal

by maknz

dev-option-resolver

The Requires

The Development Requires