PHPFlow

Flowdock API Library in PHP

Require

PHP Version 5.3.10

Installation

First make ure you have pulled the submodule 'lib/PHPFlow'. If not run the following commands

git submodule init
git submodule update

If you dont have composer installed, install it in the project

curl -sS https://getcomposer.org/installer | php

Then run the install

php composer.phar install

Configuration

Rename './config/config.php.sample' to './config/config.php' and configure it by setting your USER_TOKEN and the bot name if you want to.

DEFINE('BOT_NAME', 'BOT_NAME');
DEFINE('USER_TOKEN', 'yourultraprivateusrtoken');

Rename './lib/PFBFlowRegister.class.php.sample' to ./lib/PFBFlowRegister.class.php' and configure it by adding all channels (flows) you want to use. *customName1: a custom name you want to give *company: the company name *flowN: the flow name *flowN_token: the token of the flow

class PFBFlowRegister extends PFBBaseFlowRegister
{
    static public $flows = array(
        "customName1" => array("flow" => array("company", "flow1"), "token" => "flow1_token"),
        "customName2" => array("flow" => array("company", "flow2"), "token" => "flow2_token"),
        "customName3" => array("flow" => array("company", "flow3"), "token" => "flow3_token"),
    );
}

Open the file './PHPFlowBot.php'

// We have to call init before using the class.
PHPFlowBot::init();

// We run the bot by giving the list of flow we want to listen to.
// We can specify the flow by giving the customName setted in the class 'PFBFlowRegister'.
PHPFlowBot::streamFlow(PFBFlowRegister::$flows);

Run it

php ./PHPFlowBot.php

Enjoy!

Plugins

All plugins are in the './plugins' folder.

Create a plugin

To write your own plugin, create class in the './plugins' folder. Your plugin have to extends the abstract class 'PFBPlugin' from the './lib' folder. Then implement the 'hook' method which takes one parameter '$input'. '$input' is the decoded json message sent by the Flowdock API.

class PingPlugin extends PFBPlugin {

    function hook($input)
    {
        if (!isset($input->external_user_name)) {
            if (($input->event == "message") && ($input->content == "!ping")) {
                PHPFlowBot::pushToFlow($this->getOriginFlow(), "@" . PHPFlowBot::getUserById($input->user)->nick . " pong");
            }
        }
    }
}

Enable plugins

To enable plugins, open the file './lib/PFBPluginsBasket.class.php'. Then instantiate your plugin as a new entry in $this->plugins.

class PFBPluginsBasket extends PFBBasePluginsBasket
{
    protected function registerPlugins()
    {
        $this->plugins = array(
            new PingPlugin(),
            new TestPlugin(),
            new ImAlivePlugin(),
        );
    }
}