Added missing interface

[hub.git] / application / hub / interfaces / chat / class_Chatter.php

diff --git a/application/hub/interfaces/chat/class_Chatter.php b/application/hub/interfaces/chat/class_Chatter.php
index f92865e77407b869d861051cd0ba60a2eecc237f..ee00bc1d80384eecb084331475de94c5e0ff4ff1 100644 (file)
--- a/application/hub/interfaces/chat/class_Chatter.php
+++ b/application/hub/interfaces/chat/class_Chatter.php
@@ -1,12 +1,13 @@
 <?php
 /**
- * An interface for chatter
+ * An interface for chatter classes
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
  * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
+ * @todo               We need to find a better name for this interface
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -22,6 +23,46 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 interface Chatter extends FrameworkInterface {
+       /**
+        * Method to "bootstrap" the chatter. This step does also apply provided
+        * command-line arguments stored in the request instance. You should now
+        * get it from calling $this->getRequestInstance().
+        *
+        * @return      void
+        */
+       function doBootstrapping ();
+
+       /**
+        * Outputs the console teaser. This should only be executed on startup or
+        * full restarts. This method generates some space around the teaser.
+        *
+        * @return      void
+        */
+       function outputConsoleTeaser ();
+
+       /**
+        * Add some chatter-specific filters
+        *
+        * @param       $controllerInstance             An object of a Controller instance
+        * @param       $responseInstance               An object of a Responseable instance
+        * @return      void
+        */
+       function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance);
+
+       /**
+        * Enables/disables the chatter (just sets a flag)
+        *
+        * @param       $version        Version number of this chatter
+        * @return      void
+        */
+       function enableIsActive ($isActive = true);
+
+       /**
+        * Determines wether the chatter is active
+        *
+        * @return      $isActive       Wether the chatter is active
+        */
+       function isActive ();
 }
 
 // [EOF]