mremi / flowdock
A PHP library to interact with the Flowdock API
Installs: 16 158
Dependents: 1
Suggesters: 1
Security: 0
Stars: 5
Watchers: 3
Forks: 2
Open Issues: 1
Requires
- php: >=5.3.3
- guzzle/guzzle: ~3.7
- symfony/console: ~2.5
Requires (Dev)
- phpunit/phpunit: ~4.1
This package is auto-updated.
Last update: 2024-10-18 03:48:12 UTC
README
This library allows you to interact with the Flowdock API.
Basic Docs
Installation
Only 1 step:
Download Flowdock using composer
Add Flowdock in your composer.json:
{ "require": { "mremi/flowdock": "dev-master" } }
Now tell composer to download the library by running the command:
$ php composer.phar update mremi/flowdock
Composer will install the library to your project's vendor/mremi
directory.
Push API
Chat
<?php use Mremi\Flowdock\Api\Push\ChatMessage; use Mremi\Flowdock\Api\Push\Push; $message = ChatMessage::create() ->setContent('This message has been sent with mremi/flowdock PHP library') ->setExternalUserName('mremi') ->addTag('#hello-world'); $push = new Push('your_flow_api_token'); if (!$push->sendChatMessage($message, array('connect_timeout' => 1, 'timeout' => 1))) { // handle errors... $message->getResponseErrors(); }
You can also do it in your console, look at the help message:
$ bin/flowdock send-chat-message --help
Some arguments are mandatory:
$ bin/flowdock send-chat-message your_flow_api_token "This message has been sent with mremi/flowdock PHP library" mremi
Some options are available:
$ bin/flowdock send-chat-message your_flow_api_token "This message has been sent with mremi/flowdock PHP library" mremi --message-id=12 --tags="#hello" --tags="#world" --options='{"connect_timeout":1,"timeout":1}'
Team Inbox
<?php use Mremi\Flowdock\Api\Push\Push; use Mremi\Flowdock\Api\Push\TeamInboxMessage; $message = TeamInboxMessage::create() ->setSource('source') ->setFromAddress('from.mremi@test.com') ->setSubject('subject') ->setContent('This message has been sent with mremi/flowdock PHP library'); $push = new Push('your_flow_api_token'); if (!$push->sendTeamInboxMessage($message, array('connect_timeout' => 1, 'timeout' => 1))) { // handle errors... $message->getResponseErrors(); }
You can also do it in your console, look at the help message:
$ bin/flowdock send-team-inbox-message --help
Some arguments are mandatory:
$ bin/flowdock send-team-inbox-message your_flow_api_token source "from.mremi@test.com" subject "This message has been sent with mremi/flowdock PHP library"
Some options are available:
$ bin/flowdock send-team-inbox-message your_flow_api_token source "from.mremi@test.com" subject "This message has been sent with mremi/flowdock PHP library" --from-name=mremi --reply-to="to.mremi@test.com" --project=project --format=html --link="http://www.flowdock.com/" --tags="#hello" --tags="#world" --options='{"connect_timeout":1,"timeout":1}'
...and more features coming soon...
Contribution
Any question or feedback? Open an issue and I will try to reply quickly.
A feature is missing here? Feel free to create a pull request to solve it!
I hope this has been useful and has helped you. If so, share it and recommend it! :)