Download the PHP package phergie/phergie-irc-plugin-react-commandhelp without Composer
On this page you can find all versions of the php package phergie/phergie-irc-plugin-react-commandhelp. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package phergie-irc-plugin-react-commandhelp
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-commandhelp
Phergie plugin for providing usage information for available bot commands to users.
This plugin is intended to complement the Command plugin.
Install
The recommended method of installation is through composer.
See Phergie documentation for more information on installing and enabling plugins.
Configuration
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:
License
Released under the BSD License. See LICENSE
.
All versions of phergie-irc-plugin-react-commandhelp with dependencies
phergie/phergie-irc-plugin-react-command Version ~2