3 * An interface for chatter classes
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
10 * @todo We need to find a better name for this interface
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 interface Chatter extends FrameworkInterface {
27 * Method to "bootstrap" the chatter. This step does also apply provided
28 * command-line arguments stored in the request instance. You should now
29 * get it from calling $this->getRequestInstance().
33 function doBootstrapping ();
36 * Outputs the console teaser. This should only be executed on startup or
37 * full restarts. This method generates some space around the teaser.
41 function outputConsoleTeaser ();
44 * Add some chatter-specific filters
46 * @param $controllerInstance An object of a Controller instance
47 * @param $responseInstance An object of a Responseable instance
50 function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance);
53 * Enables/disables the chatter (just sets a flag)
55 * @param $version Version number of this chatter
58 function enableIsActive ($isActive = true);
61 * Determines whether the chatter is active
63 * @return $isActive Whether the chatter is active