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          * An instance of a communicator
  39          */
  40         private $stateInstance = NULL;
  41
  42         /**
  43          * An instance of a communicator
  44          */
  45         private $communicatorInstance = NULL;
  46
  47         /**
  48          * Protected constructor
  49          *
  50          * @param       $className      Name of the class
  51          * @return      void
  52          */
  53         protected function __construct ($className) {
  54                 // Call parent constructor
  55                 parent::__construct($className);
  56         }
  57
  58         /**
  59          * Getter for city instance
  60          *
  61          * @return      $cityInstance   An instance of a city city
  62          */
  63         public final function getCityInstance () {
  64                 return $this->cityInstance;
  65         }
  66
  67         /**
  68          * Setter for city instance
  69          *
  70          * @param       $cityInstance   An instance of a city city
  71          * @return      void
  72          */
  73         protected final function setCityInstance (CityHelper $cityInstance) {
  74                 $this->cityInstance = $cityInstance;
  75         }
  76
  77         /**
  78          * Getter for communicator instance
  79          *
  80          * @return      $communicatorInstance   An instance of a Communicator class
  81          */
  82         public final function getCommunicatorInstance () {
  83                 return $this->communicatorInstance;
  84         }
  85
  86         /**
  87          * Setter for communicator instance
  88          *
  89          * @param       $communicatorInstance   An instance of a Communicator class
  90          * @return      void
  91          */
  92         protected final function setCommunicatorInstance (Communicator $communicatorInstance) {
  93                 $this->communicatorInstance = $communicatorInstance;
  94         }
  95
  96         /**
  97          * Setter for state instance
  98          *
  99          * @param       $stateInstance  A Stateable instance
 100          * @return      void
 101          */
 102         public final function setStateInstance (Stateable $stateInstance) {
 103                 $this->stateInstance = $stateInstance;
 104         }
 105
 106         /**
 107          * Getter for state instance
 108          *
 109          * @return      $stateInstance  A Stateable instance
 110          */
 111         public final function getStateInstance () {
 112                 return $this->stateInstance;
 113         }
 114
 115         /**
 116          * "Getter" for a printable state name
 117          *
 118          * @return      $stateName      Name of the city's state in a printable format
 119          */
 120         public final function getPrintableState () {
 121                 // Default is 'null'
 122                 $stateName = 'null';
 123
 124                 // Get the state instance
 125                 $stateInstance = $this->getStateInstance();
 126
 127                 // Is it an instance of Stateable?
 128                 if ($stateInstance instanceof Stateable) {
 129                         // Then use that state name
 130                         $stateName = $stateInstance->getStateName();
 131                 } // END - if
 132
 133                 // Return result
 134                 return $stateName;
 135         }
 136 }
 137
 138 // [EOF]
 139 ?>