application/city/main/class_BaseCitySystem.php

   1 <?php
   2 /**
   3  * A general city (simulation) system class
   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 class BaseCitySystem extends BaseFrameworkSystem {
  25         // Exception codes
  26         const EXCEPTION_UNSUPPORTED_ERROR_HANDLER     = 0x900;
  27         const EXCEPTION_BASE64_ENCODING_NOT_MODULO_4  = 0x901;
  28
  29         // Message status codes
  30         const MESSAGE_STATUS_CODE_OKAY = 'OKAY';
  31
  32         /**
  33          * An instance of a city
  34          */
  35         private $cityInstance = NULL;
  36
  37         /**
  38          * Protected constructor
  39          *
  40          * @param       $className      Name of the class
  41          * @return      void
  42          */
  43         protected function __construct ($className) {
  44                 // Call parent constructor
  45                 parent::__construct($className);
  46         }
  47
  48         /**
  49          * Getter for city instance
  50          *
  51          * @return      $cityInstance   An instance of a city city
  52          */
  53         public final function getCityInstance () {
  54                 return $this->cityInstance;
  55         }
  56
  57         /**
  58          * Setter for city instance
  59          *
  60          * @param       $cityInstance   An instance of a city city
  61          * @return      void
  62          */
  63         protected final function setCityInstance (CityHelper $cityInstance) {
  64                 $this->cityInstance = $cityInstance;
  65         }
  66
  67         /**
  68          * "Getter" for a printable state name
  69          *
  70          * @return      $stateName      Name of the city's state in a printable format
  71          */
  72         public final function getPrintableState () {
  73                 // Default is 'null'
  74                 $stateName = 'null';
  75
  76                 // Get the state instance
  77                 $stateInstance = $this->getStateInstance();
  78
  79                 // Is it an instance of Stateable?
  80                 if ($stateInstance instanceof Stateable) {
  81                         // Then use that state name
  82                         $stateName = $stateInstance->getStateName();
  83                 } // END - if
  84
  85                 // Return result
  86                 return $stateName;
  87         }
  88 }
  89
  90 // [EOF]
  91 ?>