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          * Method to "bootstrap" the city. This step does also apply provided
  27          * command-line arguments stored in the request instance. You should now
  28          * get it from calling $this->getRequestInstance().
  29          *
  30          * @return      void
  31          */
  32         function doBootstrapping ();
  33
  34         /**
  35          * Outputs the console teaser. This should only be executed on startup or
  36          * full restarts. This method generates some space around the teaser.
  37          *
  38          * @return      void
  39          */
  40         function outputConsoleTeaser ();
  41
  42         /**
  43          * Add some city-specific filters
  44          *
  45          * @return      void
  46          */
  47         function addExtraCityFilters ();
  48
  49         /**
  50          * Activates the hub by doing some final preparation and setting
  51          * $hubIsActive to TRUE.
  52          *
  53          * @param       $requestInstance        A Requestable class
  54          * @param       $responseInstance       A Responseable class
  55          * @return      void
  56          */
  57         function activateCity (Requestable $requestInstance, Responseable $responseInstance);
  58
  59         /**
  60          * Updates/refreshes city data (e.g. state).
  61          *
  62          * @return      void
  63          */
  64         function updateCityData ();
  65
  66         /**
  67          * Adds extra tasks to the given handler for this city
  68          *
  69          * @param       $handlerInstance        An instance of a HandleableTask class
  70          * @return      void
  71          */
  72         function addExtraTasks (HandleableTask $handlerInstance);
  73 }
  74
  75 // [EOF]
  76 ?>