phergie / phergie-slack-connection
Data structure for containing information about a Slack client connection, analogous to Phergie\Irc\Connection
dev-master
2015-02-12 22:48 UTC
Requires
- php: >=5.3.3
Requires (Dev)
- phpunit/phpunit: 4.1.*
This package is not auto-updated.
Last update: 2024-10-30 06:38:27 UTC
README
A PHP data structure for containing client connection information per the Slack Real Time Messaging API.
Primarily used by Slack client implementations of the Phergie project.
Install
The recommended method of installation is through composer.
{ "minimum-stability": "dev", "require": { "phergie/phergie-slack-connection": "1.1.0" } }
Design goals
- Minimal dependencies: PHP 5.3.3+
- Simple easy-to-understand API
Usage
$connection = new \Phergie\Slack\Connection(); $connection->setToken('xoxb-##########'); $connection->setUsername('username'); $connection->setFirstName('hostname'); $connection->setLastName('servername'); $connection->setOption('option', 'value'); echo $connection->getToken(); echo $connection->getUsername(); echo $connection->getFirstName(); echo $connection->getLastName(); echo $connection->getOption('option');
Tests
To run the unit test suite:
curl -s https://getcomposer.org/installer | php
php composer.phar install
./vendor/bin/phpunit
License
Released under the BSD License. See LICENSE
.
Community
Check out #phergie on irc.freenode.net.