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