Phlack eases the creation of Slack Integrations in PHP.
Update: Phlack now contains a partial implementation of the Slack API. For details, see the API Docs section below.
via Composer
{
"require": {
"mcrumm/phlack": "dev-master"
}
}Create a hash containing your slack username and integrations token.
Your username is the unique portion of your Slack subdomain. For example, if your subdomain was groundctrl.slack.com, your username will be groundctrl.
<?php
$config = [ 'username' => 'my_slack_user', 'token' => 'my_slack_token' ]);Get a Phlack object by instantiating it with a PhlackClient or using its static factory() method.
<?php
//...
use Crummy\Phlack\Phlack;
$phlack = Phlack::factory($config);<?php
use Crummy\Phlack\Bridge\Guzzle\PhlackClient;
use Crummy\Phlack\Phlack;
$client = PhlackClient::factory($config);
$phlack = new Phlack($client);The PhlackClient is simply a web service client implemented with Guzzle. Examine its service description for more details.
A Phlack Message takes care of structuring the payload for Slack's Incoming Webhooks integration.
<?php
//...
use Crummy\Phlack\Message\Message;
$message = new Message('Hello, from phlack!');
echo 'The message payload: ' . PHP_EOL:
echo $message;A MessageBuilder is also provided:
<?php
// ...
$messageBuilder = $phlack->getMessageBuilder();
$messageBuilder
->setText('I was created in the MessageBuilder')
->setChannel('testing')
->setIconEmoji('ghost');
$message = $messageBuilder->create();Use Phlack's send() command to fire off the message:
<?php
// ...
$response = $phlack->send($message);
if (200 != $response['status']) {
die('FAIL! - ' . $response['text']);
}
echo 'The message was sent: ' . $message;The MessageResponse hash contains the status, reason, and text from the response.
Responses from the Incoming Webhooks Integration are very sparse. Success messages will simply return a status of 200. Error messages will contain more details in the response text and reason.
See the examples directory for more use cases.
Programmatic access to the Slack API is provided via the ApiClient.
Note: Currently, bearer token authentication is the only supported authentication method. Contributions toward OAuth2 support would be greatly appreciated.
Get an ApiClient object by instantiating it with a hash containing your API token, or passing a config hash to its factory method.
<?php
use Crummy\Phlack\Bridge\Guzzle\ApiClient;
$slack = ApiClient::factory([ 'token' => 'my_bearer_token' ]);<?php
use Crummy\Phlack\Bridge\Guzzle\ApiClient;
$slack = new ApiClient([ 'token' => 'my_bearer_token' ]);The methods currently implemented are:
Consult the client's service description for information on the responses returned by the API methods.
<?php
use Crummy\Phlack\Bridge\Guzzle\ApiClient;
$config = [ 'token' => 'my_bearer_token' ];
$slack = new ApiClient($config);
echo 'Fetching Channels List...' . PHP_EOL;
$result = $slack->ListChannels();
if (!$result['ok']) {
die('FAIL! Error was: ' . $result['error'] . PHP_EOL);
}
foreach ($result['channels'] as $channel) {
printf('%s: %s' . PHP_EOL, $channel['name'], $channel['purpose']['value']);
}The ListFilesIterator eases the ability to iterate through multiple pages of data from the Slack API. Using the iterator eliminates the need to manually call the API multiple times to retrieve all pages of the result set.
<?php
//...
$iterator = $slack->getIterator('ListFiles');
$i = 0;
foreach ($iterator as $file) {
$i++;
echo $file['title'] . PHP_EOL;
}
echo PHP_EOL . 'Retrieved ' . $i . ' files.' . PHP_EOL;A complete example is available in the examples directory.
Note: The ListFilesIterator is not strictly necessary to page through file results, but it's certainly easier than the alternative. An example without the iterator is also available.
See the API examples directory for more use cases.
Any undocumented portion of this library should be considered EXPERIMENTAL AT BEST. Proceed with caution, and, as always, pull requests are welcome.
- The regex in the LinkFormatter was pulled directly from StevenSloan and his slack-notifier project.