README.md

This project is abandoned

This repo is being kept for posterity and will be archived in a readonly state. If you're interested it can be forked under a new Composer namespace/GitHub organization.

phergie/phergie-irc-plugin-react-quit

Phergie plugin for providing a command to instruct the bot to terminate a connection.

Install

The recommended method of installation is through composer.

composer require phergie/phergie-irc-plugin-react-quit

See Phergie documentation for more information on installing and enabling plugins.

Note that this plugin depends on the Command plugin plugin, which is installed as a dependency by composer but must still be enabled in your Phergie configuration file to be available to this plugin.

Configuration

return array(
    'plugins' = array(
        new \Phergie\Irc\Plugin\React\Command\Plugin, // dependency
        
        new \Phergie\Irc\Plugin\React\Quit\Plugin(array(
        
            // Optional: sprintf-compatible template for the message sent when the bot
            // quits; takes one parameter, a string containing the nick of the user who
            // initiated the command to quit
            'message' => 'because %s said so',
        
        )),
    )
);

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.