From 0868e0642f694bf5c08951f67f5a4b7eadde041a Mon Sep 17 00:00:00 2001
From: Jacek Kowalski <Jacek@jacekk.info>
Date: Thu, 05 Sep 2013 21:22:22 +0000
Subject: [PATCH] Zmiana numeru wersji na 2.6, testy jednostkowe niektórych klas (PHPUnit), dodanych wiele komentarzy dotyczących metod oraz atrybutów (Doxygen), aktualizacja instrukcji instalacji i aktualizacji.
---
class/BotModule.php | 40 ++++++++++++++++++++++++++++++++++++++--
1 files changed, 38 insertions(+), 2 deletions(-)
diff --git a/class/BotModule.php b/class/BotModule.php
index 87df80e..482edd5 100644
--- a/class/BotModule.php
+++ b/class/BotModule.php
@@ -1,11 +1,47 @@
<?php
class BotModuleException extends Exception {}
-interface BotModule {
-}
+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);
}
?>
\ No newline at end of file
--
Gitblit v1.9.1