8

[irbot.git] / plugins / sample-plugin.inc.php

<?php
class sample implements plugin {
        private $IRCConn,$formater;
        private $message;

        public function __construct($main) {
                $this->IRCConn = IRCConn::GetInstance();
                $this->formater = text_format::GetInstance();
        }

        public function commands_list() {
                $commands = array(
                        'method1' => array( // !sample method1
                                'accepted_args' => 0,
                                'help' => 'some help for this method1',
                                'type' => 'public',
                        ),
                        'method2' => array( // !sample method2 arg
                                'accepted_args' => 1,
                                // the \n chr in a double quote string create a new line (2 PRIVMSG)
                                'help' => "some help for this method2\n".$this->formater->bold('one arg').' requier',
                                'type' => 'public',
                        ),
                        'method3' => array( // /msg BotName sample method3 arg
                                'accepted_args' => 1,
                                'help' => 'some help for this method3',
                                'type' => 'private',
                        ),
                );
                return $commands;
        }

        public function current_message ($message) {
                /*
                $message = array (
                        'type' => PRIVMSG|NOTICE,
                        'from' => Nick (reply to),
                        'to' => BotName / ChannelName,
                        'message' => The message
                );
                */
                $this->message = $message;
        }

        function method1 () {
                $this->IRCConn->privmsg(IRCConn::$channel,'This is the method1');
        }

        function method2 ($query) {
                $this->IRCConn->privmsg(IRCConn::$channel,'This is the method2 : '.$query);
        }

        function method3 ($query,$replyto) {
                $this->IRCConn->privmsg($replyto,'This is the method3 : '.$query);
        }
}
?>