phergie/phergie-irc-plugin-react-commandhelp

Phergie plugin for providing usage information for available bot commands to users

2.1.1 2016-04-25 23:29 UTC

README

Phergie plugin for providing usage information for available bot commands to users.

This plugin is intended to complement the Command plugin.

Build Status

Install

The recommended method of installation is through composer.

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

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

Configuration

    // All configuration is optional
    new \Phergie\Irc\Plugin\React\CommandHelp\Plugin([

        // List of plugins that subscribe to command events
        // Used to return a list of available commands to users
        // All elements must implement \Phergie\Irc\Bot\React\PluginInterface
        'plugins' => [
            new Phergie\Irc\Plugin\React\TableFlip\Plugin()
        ],

        // Text to precede the list of available commands when providing it to
        // users
        'listText' => 'Available commands: ',

    ]),

Usage

This plugin provides a "help" command that can be invoked with or without parameters.

If it is invoked without parameters, it will respond with a list of all available commands, which is obtained from the value of the 'plugins' configuration setting based on the command events to which those plugins subscribe.

If it is invoked with parameters, it will assume the first parameter to be a command name and emit an event for the plugin supporting that command to respond to.

For example, if the first parameter value is 'foo', the plugin will emit a 'command.foo.help' event that the plugin supporting the "foo" command can subscribe to. This event's parameters will be an object implementing CommandEventInterface (the event originally received by the CommandHelp plugin) and an object implementing EventQueueInterface (which the receiving plugin can use to respond with information about its "foo" command to the user who invoked the "help" command).

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.