application/city/interfaces/helper/city/class_CityHelper.php

   1 <?php
   2 /**
   3  * An interface for "city-helper" classes
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2015 City Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 interface CityHelper extends Helper, AddableCriteria {
  25         /**
  26          * Initializes the city daemon
  27          *
  28          * @return      void
  29          */
  30         function bootstrapInitCityDaemon ();
  31
  32         /**
  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().
  36          *
  37          * @return      void
  38          */
  39         function doBootstrapping ();
  40
  41         /**
  42          * Outputs the console teaser. This should only be executed on startup or
  43          * full restarts. This method generates some space around the teaser.
  44          *
  45          * @return      void
  46          */
  47         function outputConsoleTeaser ();
  48
  49         /**
  50          * Add some city-specific filters
  51          *
  52          * @return      void
  53          */
  54         function addExtraCityFilters ();
  55
  56         /**
  57          * Activates the city daemon by doing some final preparation and setting
  58          * $cityIsActive to TRUE.
  59          *
  60          * @param       $requestInstance        A Requestable class
  61          * @param       $responseInstance       A Responseable class
  62          * @return      void
  63          */
  64         function activateCityDaemon (Requestable $requestInstance, Responseable $responseInstance);
  65
  66         /**
  67          * Updates/refreshes city data (e.g. state).
  68          *
  69          * @return      void
  70          */
  71         function updateCityData ();
  72
  73         /**
  74          * Adds extra tasks to the given handler for this city
  75          *
  76          * @param       $handlerInstance        An instance of a HandleableTask class
  77          * @return      void
  78          */
  79         function addExtraTasks (HandleableTask $handlerInstance);
  80 }
  81
  82 // [EOF]
  83 ?>