Skip to content

enebe-nb/phergie-irc-plugin-react-tell

Repository files navigation

enebe-nb/phergie-irc-plugin-react-tell

Phergie plugin for send messages to users next time they are seen.

Build Status

Install

The recommended method of installation is through composer.

{
    "require": {
        "enebe-nb/phergie-irc-plugin-react-tell": "^1.0"
    }
}

See Phergie documentation for more information on installing plugins.

Configuration

return array(
    'plugins' => array(
        new \EnebeNb\Phergie\Plugin\Tell\Plugin(array(
            // Send a \PDO object to use that database,
            // or leave unsetted to store the messages into an array.
            'database' => new \PDO($mydsn, $myusername, $mypassword),

            // change the default command text from 'tell' to anything
            'custom-commands' => 'mycustomcommand',
            // or pick any number of commands
            'custom-commands' => array('tell', 'ask', 'remind'),
            // also works with comma-delimited strings
            'custom-commands' => 'tell,ask,remind',

            // create database table
            'create-database' => true,

            // set a maximum number of messages to be stored for an user
            // Default: 10
            'max-messages' => 20,
            // or remove the maximum
            'max-messages' => false,
        )),

        // phergie/phergie-irc-plugin-react-command
        // is required to listen for commands
        new \Phergie\Irc\Plugin\React\Command\Plugin(),
    ),
);

See phergie/phergie-irc-plugin-react-command for more information on Command Plugin.

Databases

This plugin is tested on following databases:

  • MySQL (it sets SQL_MODE to ANSI_QUOTES on construct)
  • PostgreSQL
  • SQLITE

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.

About

Phergie plugin for send messages to users next time they are seen.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages