3 * An interface for "city-helper" classes
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2015 City Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 interface CityHelper extends Helper, AddableCriteria {
26 * Initializes the city daemon
30 function bootstrapInitCityDaemon ();
33 * Method to "bootstrap" the city. This step does also apply provided
34 * command-line arguments stored in the request instance. You should now
35 * get it from calling $this->getRequestInstance().
39 function doBootstrapping ();
42 * Outputs the console teaser. This should only be executed on startup or
43 * full restarts. This method generates some space around the teaser.
47 function outputConsoleTeaser ();
50 * Add some city-specific filters
54 function addExtraCityFilters ();
57 * Activates the city daemon by doing some final preparation and setting
58 * $cityIsActive to TRUE.
60 * @param $requestInstance A Requestable class
61 * @param $responseInstance A Responseable class
64 function activateCityDaemon (Requestable $requestInstance, Responseable $responseInstance);
67 * Updates/refreshes city data (e.g. state).
71 function updateCityData ();
74 * Adds extra tasks to the given handler for this city
76 * @param $handlerInstance An instance of a HandleableTask class
79 function addExtraTasks (HandleableTask $handlerInstance);
82 * Checks whether at least one map requires expansion
84 * @return $requiresExpansion Whether a map requires expansion
86 function isMapPendingExpansion ();