markenwerk/slack-client

A basic Slack client library providing simple posting to Slack channels using the webhook API.

PHP Slack Client

, _(*1)

A basic Slack client library providing simple posting to Slack channels using the webhook API., _(*2)

Installation

```{json} { "require": { "markenwerk/slack-client": "~2.0" } }, <sub>(*3)</sub>

## Usage

### Autoloading and namesapce

```{php}  
require_once('path/to/vendor/autoload.php');

Posting to a channel or member

The following example will post to a Slack channel or member looking like this:, <sub>(*4)</sub>

, <sub>(*5)</sub>

Setup the API client

```{php} use Markenwerk\SlackClient\SlackClient;, <sub>(*6)</sub>

$client = new SlackClient(); $client ->setSubdomainName('markenwerk') ->setToken('') ->setUsername('PHP SlackClient');, <sub>(*7)</sub>

#### Setup a Slack message with attachments

```{php}
use Markenwerk\SlackClient\SlackAttachment;
use Markenwerk\SlackClient\SlackAttachmentField;
use Markenwerk\SlackClient\SlackMessage;

$message = new SlackMessage();
$message
    ->setText('A basic Slack client library providing simple posting to Slack channels using the webhook API.')
    ->setIconUrl('https://avatars2.githubusercontent.com/u/5921253?v=3&s=200')
    ->setUnfurlLinks(true)
    ->setUnfurlMedia(true);

$attachment = new SlackAttachment();
$attachment
    ->setText('A basic Slack client library providing simple posting to Slack channels using the webhook API.')
    ->setPretext('A basic Slack client library.')
    ->setFallback('A basic Slack client library providing simple posting to Slack channels using the webhook API.')
    ->setColor(SlackAttachment::COLOR_WARNING);

$shortAttachmentField = new SlackAttachmentField();
$shortAttachmentField
    ->setTitle('Short field')
    ->setValue('Some chars')
    ->setShort(true);

$anotherShortAttachmentField = new SlackAttachmentField();
$anotherShortAttachmentField
    ->setTitle('Short field')
    ->setValue('Some chars')
    ->setShort(true);

$attachmentField = new SlackAttachmentField();
$attachmentField
    ->setTitle('Regular field')
    ->setValue('Some more chars')
    ->setShort(false);

$anotherAttachmentField = new SlackAttachmentField();
$anotherAttachmentField
    ->setTitle('Regular field')
    ->setValue('Some more chars')
    ->setShort(false);

$attachment
    ->addField($shortAttachmentField)
    ->addField($anotherShortAttachmentField)
    ->addField($attachmentField)
    ->addField($anotherAttachmentField);

$message->addAttachment($attachment);

Post to a channel

```{php} $client->postToChannel('#channel', $message);, <sub>(*8)</sub>

#### Post to a member

```{php}
$client->postToMember('@member', $message);

Exception handling

PHP Basic HTTP Client provides different exceptions – also provided by the PHP Common Exceptions project – for proper handling.
You can find more information about PHP Common Exceptions at Github., <sub>(*9)</sub>

Exceptions to be expected

In general you should expect that any setter method could thrown an \InvalidArgumentException. The following exceptions could get thrown while using PHP Slack Client., <sub>(*10)</sub>

• Markenwerk\CommonException\ParserException\StringifyException on posting to Slack
• Markenwerk\CommonException\NetworkException\UnexpectedResponseException on posting to Slack
• Markenwerk\CommonException\NetworkException\ConnectionTimeoutException on posting to Slack
• Markenwerk\CommonException\NetworkException\CurlException on posting to Slack

Contribution

Contributing to our projects is always very appreciated.
But: please follow the contribution guidelines written down in the CONTRIBUTING.md document., <sub>(*11)</sub>

License

PHP Slack Client is under the MIT license., <sub>(*12)</sub>