Jacek Kowalski
2014-06-11 5ab2921256e688e2f005b04bfe08f8c8bb91fd68
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
<?php
class BotModuleException extends Exception {}
 
interface BotModule {}
 
/**
 * Interfejs klasy inicjującej moduł bota
 */
interface BotModuleInit {
    /**
     * Funkcja zwracająca listę obsługiwanych komend.
     * Przykład:
     * <pre>array(
     *   'komenda' => array(
     *     array(
     *       'file' => 'komenda.php',
     *       'class' => 'bot_NAZWAMODULU_module',
     *       'method' => 'komenda1',
     *       'params' => 'parametr_do_funkcji',
     *     ),
     *     array(
     *       'file' => 'komenda.php',
     *       'class' => 'bot_NAZWAMODULU_module',
     *       'method' => 'komenda2',
     *     ),
     *   ),
     *   '*' => array(
     *     array(
     *       'file' => 'test.php',
     *       'class' => 'NAZWAMODULU_test',
     *       'method' => 'komenda_test',
     *     ),
     *   ),
     * )</pre>
     * @return array Lista obsługiwanych komend
     */
    function register();
    
    /**
     * Zwraca pomoc dla polecenia lub skróconą listę poleceń
     * obsługiwanych przez dany moduł.
     * @param string|NULL $params Nazwa komendy
     * @return BotMsg Pomoc dla komendy
     */
    function help($params = NULL);
}
?>